From fcf292c650dba6576d9bfa4f25e8dec55465444c Mon Sep 17 00:00:00 2001 From: Lari Hotari Date: Mon, 14 Oct 2024 20:40:39 +0300 Subject: [PATCH 1/9] update rest-apidoc for 4.0.0 --- static/swagger/4.0.0/swagger.json | 36143 ++++++++++++++++ static/swagger/4.0.0/swaggerfunctions.json | 2047 + static/swagger/4.0.0/swaggerlookup.json | 319 + static/swagger/4.0.0/swaggerpackages.json | 627 + static/swagger/4.0.0/swaggersink.json | 1449 + static/swagger/4.0.0/swaggersource.json | 1404 + static/swagger/4.0.0/swaggertransactions.json | 1537 + static/swagger/4.0.0/v2/swagger.json | 36143 ++++++++++++++++ static/swagger/4.0.0/v2/swaggerlookup.json | 319 + static/swagger/4.0.0/v3/swaggerfunctions.json | 2047 + static/swagger/4.0.0/v3/swaggerpackages.json | 627 + static/swagger/4.0.0/v3/swaggersink.json | 1449 + static/swagger/4.0.0/v3/swaggersource.json | 1404 + .../swagger/4.0.0/v3/swaggertransactions.json | 1537 + static/swagger/restApiVersions.json | 19 + 15 files changed, 87071 insertions(+) create mode 100644 static/swagger/4.0.0/swagger.json create mode 100644 static/swagger/4.0.0/swaggerfunctions.json create mode 100644 static/swagger/4.0.0/swaggerlookup.json create mode 100644 static/swagger/4.0.0/swaggerpackages.json create mode 100644 static/swagger/4.0.0/swaggersink.json create mode 100644 static/swagger/4.0.0/swaggersource.json create mode 100644 static/swagger/4.0.0/swaggertransactions.json create mode 100644 static/swagger/4.0.0/v2/swagger.json create mode 100644 static/swagger/4.0.0/v2/swaggerlookup.json create mode 100644 static/swagger/4.0.0/v3/swaggerfunctions.json create mode 100644 static/swagger/4.0.0/v3/swaggerpackages.json create mode 100644 static/swagger/4.0.0/v3/swaggersink.json create mode 100644 static/swagger/4.0.0/v3/swaggersource.json create mode 100644 static/swagger/4.0.0/v3/swaggertransactions.json diff --git a/static/swagger/4.0.0/swagger.json b/static/swagger/4.0.0/swagger.json new file mode 100644 index 000000000000..68eae463bd6a --- /dev/null +++ b/static/swagger/4.0.0/swagger.json @@ -0,0 +1,36143 @@ +{ + "basePath": "/admin/v2", + "definitions": { + "AllocatorStats": { + "properties": { + "directArenas": { + "items": { + "$ref": "#/definitions/PoolArenaStats" + }, + "type": "array" + }, + "heapArenas": { + "items": { + "$ref": "#/definitions/PoolArenaStats" + }, + "type": "array" + }, + "normalCacheSize": { + "format": "int32", + "type": "integer" + }, + "numDirectArenas": { + "format": "int32", + "type": "integer" + }, + "numHeapArenas": { + "format": "int32", + "type": "integer" + }, + "numThreadLocalCaches": { + "format": "int32", + "type": "integer" + }, + "smallCacheSize": { + "format": "int32", + "type": "integer" + }, + "usedDirectMemory": { + "format": "int64", + "type": "integer" + }, + "usedHeapMemory": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "AuthPolicies": { + "properties": { + "namespaceAuthentication": { + "additionalProperties": { + "items": { + "enum": [ + "produce", + "consume", + "functions", + "sources", + "sinks", + "packages" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "type": "object" + }, + "subscriptionAuthentication": { + "additionalProperties": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "type": "object" + }, + "topicAuthentication": { + "additionalProperties": { + "additionalProperties": { + "items": { + "enum": [ + "produce", + "consume", + "functions", + "sources", + "sinks", + "packages" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "type": "object" + }, + "type": "object" + } + }, + "type": "object" + }, + "AuthenticationDataSource": { + "properties": { + "commandData": { + "type": "string" + }, + "httpAuthType": { + "type": "string" + }, + "peerAddress": { + "$ref": "#/definitions/SocketAddress" + }, + "subscription": { + "type": "string" + }, + "tlsCertificates": { + "items": { + "$ref": "#/definitions/Certificate" + }, + "type": "array" + } + }, + "type": "object" + }, + "AuthenticationParameters": { + "properties": { + "clientAuthenticationDataSource": { + "$ref": "#/definitions/AuthenticationDataSource" + }, + "clientRole": { + "type": "string" + }, + "originalPrincipal": { + "type": "string" + } + }, + "type": "object" + }, + "AutoFailoverPolicyData": { + "properties": { + "parameters": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "policyType": { + "enum": [ + "min_available" + ], + "type": "string" + } + }, + "type": "object" + }, + "AutoSubscriptionCreationOverride": { + "properties": { + "allowAutoSubscriptionCreation": { + "type": "boolean" + } + }, + "type": "object" + }, + "AutoSubscriptionCreationOverrideImpl": { + "properties": { + "allowAutoSubscriptionCreation": { + "type": "boolean" + } + }, + "type": "object" + }, + "AutoTopicCreationOverride": { + "properties": { + "allowAutoTopicCreation": { + "type": "boolean" + }, + "defaultNumPartitions": { + "format": "int32", + "type": "integer" + }, + "topicType": { + "type": "string" + } + }, + "type": "object" + }, + "AutoTopicCreationOverrideImpl": { + "properties": { + "allowAutoTopicCreation": { + "type": "boolean" + }, + "defaultNumPartitions": { + "format": "int32", + "type": "integer" + }, + "topicType": { + "type": "string" + } + }, + "type": "object" + }, + "BacklogQuota": { + "properties": { + "limit": { + "format": "int64", + "type": "integer" + }, + "limitSize": { + "format": "int64", + "type": "integer" + }, + "limitTime": { + "format": "int32", + "type": "integer" + }, + "policy": { + "enum": [ + "producer_request_hold", + "producer_exception", + "consumer_backlog_eviction" + ], + "type": "string" + } + }, + "type": "object" + }, + "BacklogQuotaImpl": { + "properties": { + "limit": { + "format": "int64", + "type": "integer" + }, + "limitSize": { + "format": "int64", + "type": "integer" + }, + "limitTime": { + "format": "int32", + "type": "integer" + }, + "policy": { + "enum": [ + "producer_request_hold", + "producer_exception", + "consumer_backlog_eviction" + ], + "type": "string" + } + }, + "type": "object" + }, + "BitSet": { + "properties": { + "empty": { + "type": "boolean" + } + }, + "type": "object" + }, + "BookieAffinityGroupData": { + "properties": { + "bookkeeperAffinityGroupPrimary": { + "type": "string" + }, + "bookkeeperAffinityGroupSecondary": { + "type": "string" + } + }, + "type": "object" + }, + "BookieAffinityGroupDataImpl": { + "properties": { + "bookkeeperAffinityGroupPrimary": { + "type": "string" + }, + "bookkeeperAffinityGroupSecondary": { + "type": "string" + } + }, + "type": "object" + }, + "BookieInfo": { + "properties": { + "hostname": { + "type": "string" + }, + "rack": { + "type": "string" + } + }, + "type": "object" + }, + "BookiesClusterInfo": { + "properties": { + "bookies": { + "items": { + "$ref": "#/definitions/RawBookieInfo" + }, + "type": "array" + } + }, + "type": "object" + }, + "BrokerInfo": { + "properties": { + "brokerId": { + "type": "string" + }, + "serviceUrl": { + "type": "string" + } + }, + "type": "object" + }, + "BrokerNamespaceIsolationData": { + "description": "The namespace isolation data for a given broker", + "properties": { + "brokerName": { + "description": "The broker name", + "example": "broker1:8080", + "type": "string" + }, + "namespaceRegex": { + "description": "The namespace-isolation policies attached to this broker", + "items": { + "type": "string" + }, + "type": "array" + }, + "policyName": { + "description": "Policy name", + "example": "my-policy", + "type": "string" + }, + "primary": { + "type": "boolean" + } + }, + "type": "object" + }, + "BundlesData": { + "properties": { + "boundaries": { + "items": { + "type": "string" + }, + "type": "array" + }, + "numBundles": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "BundlesDataImpl": { + "properties": { + "boundaries": { + "items": { + "type": "string" + }, + "type": "array" + }, + "numBundles": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "Certificate": { + "properties": { + "encoded": { + "items": { + "format": "byte", + "type": "string" + }, + "type": "array" + }, + "publicKey": { + "$ref": "#/definitions/PublicKey" + }, + "type": { + "type": "string" + } + }, + "type": "object" + }, + "ClusterData": { + "description": "The configuration data for a cluster", + "properties": { + "authenticationParameters": { + "description": "Authentication parameters when client would like to connect to cluster.", + "type": "string" + }, + "authenticationPlugin": { + "description": "Authentication plugin when client would like to connect to cluster.", + "example": "org.apache.pulsar.client.impl.auth.AuthenticationToken", + "type": "string" + }, + "brokerClientCertificateFilePath": { + "description": "TLS certificate file for internal client, used by the internal client to authenticate with Pulsar brokers", + "type": "string" + }, + "brokerClientKeyFilePath": { + "description": "TLS private key file for internal client, used by the internal client to authenticate with Pulsar brokers", + "type": "string" + }, + "brokerClientSslFactoryPlugin": { + "description": "SSL Factory plugin used by internal client to generate the SSL Context and Engine", + "type": "string" + }, + "brokerClientSslFactoryPluginParams": { + "description": "Parameters used by the internal client's SSL factory plugin to generate the SSL Context and Engine", + "type": "string" + }, + "brokerClientTlsEnabled": { + "description": "Enable TLS when talking with other brokers in the same cluster (admin operation) or different clusters (replication)", + "type": "boolean" + }, + "brokerClientTlsEnabledWithKeyStore": { + "description": "Whether internal client use KeyStore type to authenticate with other Pulsar brokers", + "type": "boolean" + }, + "brokerClientTlsKeyStore": { + "description": "TLS KeyStore path for internal client, used by the internal client to authenticate with Pulsar brokers", + "type": "string" + }, + "brokerClientTlsKeyStorePassword": { + "description": "TLS KeyStore password for internal client, used by the internal client to authenticate with Pulsar brokers", + "type": "string" + }, + "brokerClientTlsKeyStoreType": { + "description": "TLS KeyStore type configuration for internal client: JKS, PKCS12, used by the internal client to authenticate with Pulsar brokers", + "type": "string" + }, + "brokerClientTlsTrustStore": { + "description": "TLS TrustStore path for internal client used by the internal client to authenticate with Pulsar brokers", + "type": "string" + }, + "brokerClientTlsTrustStorePassword": { + "description": "TLS TrustStore password for internal client used by the internal client to authenticate with Pulsar brokers", + "type": "string" + }, + "brokerClientTlsTrustStoreType": { + "description": "TLS TrustStore type configuration for internal client: JKS, PKCS12 used by the internal client to authenticate with Pulsar brokers", + "example": "JKS", + "type": "string" + }, + "brokerClientTrustCertsFilePath": { + "description": "Path for the trusted TLS certificate file for outgoing connection to a server (broker)", + "type": "string" + }, + "brokerServiceUrl": { + "description": "The broker service url (for produce and consume operations)", + "example": "pulsar://pulsar.example.com:6650", + "type": "string" + }, + "brokerServiceUrlTls": { + "description": "The secured broker service url (for produce and consume operations)", + "example": "pulsar+ssl://pulsar.example.com:6651", + "type": "string" + }, + "listenerName": { + "description": "listenerName when client would like to connect to cluster", + "type": "string" + }, + "peerClusterNames": { + "description": "A set of peer cluster names", + "items": { + "type": "string" + }, + "type": "array" + }, + "proxyProtocol": { + "description": "protocol to decide type of proxy routing eg: SNI-routing", + "enum": [ + "SNI" + ], + "example": "SNI", + "type": "string" + }, + "proxyServiceUrl": { + "description": "Proxy-service url when client would like to connect to broker via proxy.", + "example": "pulsar+ssl://ats-proxy.example.com:4443 or pulsar://ats-proxy.example.com:4080", + "type": "string" + }, + "serviceUrl": { + "description": "The HTTP rest service URL (for admin operations)", + "example": "http://pulsar.example.com:8080", + "type": "string" + }, + "serviceUrlTls": { + "description": "The HTTPS rest service URL (for admin operations)", + "example": "https://pulsar.example.com:8443", + "type": "string" + }, + "tlsAllowInsecureConnection": { + "description": "Allow TLS connections to servers whose certificate cannot be verified to have been signed by a trusted certificate authority.", + "type": "boolean" + } + }, + "type": "object" + }, + "ClusterUrl": { + "properties": { + "brokerServiceUrl": { + "type": "string" + }, + "brokerServiceUrlTls": { + "type": "string" + }, + "empty": { + "type": "boolean" + }, + "serviceUrl": { + "type": "string" + }, + "serviceUrlTls": { + "type": "string" + } + }, + "type": "object" + }, + "CompactionStats": { + "properties": { + "lastCompactionDurationTimeInMills": { + "format": "int64", + "type": "integer" + }, + "lastCompactionFailedTimestamp": { + "format": "int64", + "type": "integer" + }, + "lastCompactionRemovedEventCount": { + "format": "int64", + "type": "integer" + }, + "lastCompactionSucceedTimestamp": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "CompactionStatsImpl": { + "properties": { + "lastCompactionDurationTimeInMills": { + "format": "int64", + "type": "integer" + }, + "lastCompactionFailedTimestamp": { + "format": "int64", + "type": "integer" + }, + "lastCompactionRemovedEventCount": { + "format": "int64", + "type": "integer" + }, + "lastCompactionSucceedTimestamp": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "CompletableFuture": { + "properties": { + "cancelled": { + "type": "boolean" + }, + "completedExceptionally": { + "type": "boolean" + }, + "done": { + "type": "boolean" + }, + "numberOfDependents": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "CompletableFutureClusterData": { + "properties": { + "cancelled": { + "type": "boolean" + }, + "completedExceptionally": { + "type": "boolean" + }, + "done": { + "type": "boolean" + }, + "numberOfDependents": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "CompletableFutureListSchemaAndMetadata": { + "properties": { + "cancelled": { + "type": "boolean" + }, + "completedExceptionally": { + "type": "boolean" + }, + "done": { + "type": "boolean" + }, + "numberOfDependents": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "CompletableFutureLong": { + "properties": { + "cancelled": { + "type": "boolean" + }, + "completedExceptionally": { + "type": "boolean" + }, + "done": { + "type": "boolean" + }, + "numberOfDependents": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "CompletableFuturePairBooleanSchemaCompatibilityStrategy": { + "properties": { + "cancelled": { + "type": "boolean" + }, + "completedExceptionally": { + "type": "boolean" + }, + "done": { + "type": "boolean" + }, + "numberOfDependents": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "CompletableFuturePartitionedTopicMetadata": { + "properties": { + "cancelled": { + "type": "boolean" + }, + "completedExceptionally": { + "type": "boolean" + }, + "done": { + "type": "boolean" + }, + "numberOfDependents": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "CompletableFutureResourceQuota": { + "properties": { + "cancelled": { + "type": "boolean" + }, + "completedExceptionally": { + "type": "boolean" + }, + "done": { + "type": "boolean" + }, + "numberOfDependents": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "CompletableFutureSchemaAndMetadata": { + "properties": { + "cancelled": { + "type": "boolean" + }, + "completedExceptionally": { + "type": "boolean" + }, + "done": { + "type": "boolean" + }, + "numberOfDependents": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "CompletableFutureSchemaMetadata": { + "properties": { + "cancelled": { + "type": "boolean" + }, + "completedExceptionally": { + "type": "boolean" + }, + "done": { + "type": "boolean" + }, + "numberOfDependents": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "CompletableFutureSchemaVersion": { + "properties": { + "cancelled": { + "type": "boolean" + }, + "completedExceptionally": { + "type": "boolean" + }, + "done": { + "type": "boolean" + }, + "numberOfDependents": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "CompletableFutureVoid": { + "properties": { + "cancelled": { + "type": "boolean" + }, + "completedExceptionally": { + "type": "boolean" + }, + "done": { + "type": "boolean" + }, + "numberOfDependents": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "ConnectorDefinition": { + "properties": { + "description": { + "type": "string" + }, + "name": { + "type": "string" + }, + "sinkClass": { + "type": "string" + }, + "sinkConfigClass": { + "type": "string" + }, + "sourceClass": { + "type": "string" + }, + "sourceConfigClass": { + "type": "string" + } + }, + "type": "object" + }, + "ConsumerStats": { + "properties": { + "address": { + "type": "string" + }, + "appId": { + "type": "string" + }, + "availablePermits": { + "format": "int32", + "type": "integer" + }, + "avgMessagesPerEntry": { + "format": "int32", + "type": "integer" + }, + "blockedConsumerOnUnackedMsgs": { + "type": "boolean" + }, + "bytesOutCounter": { + "format": "int64", + "type": "integer" + }, + "chunkedMessageRate": { + "format": "double", + "type": "number" + }, + "clientVersion": { + "type": "string" + }, + "connectedSince": { + "type": "string" + }, + "consumerName": { + "type": "string" + }, + "drainingHashes": { + "items": { + "$ref": "#/definitions/DrainingHash" + }, + "type": "array" + }, + "drainingHashesClearedTotal": { + "format": "int64", + "type": "integer" + }, + "drainingHashesCount": { + "format": "int32", + "type": "integer" + }, + "drainingHashesUnackedMessages": { + "format": "int32", + "type": "integer" + }, + "keyHashRangeArrays": { + "items": { + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + }, + "type": "array" + }, + "keyHashRanges": { + "items": { + "type": "string" + }, + "type": "array" + }, + "lastAckedTimestamp": { + "format": "int64", + "type": "integer" + }, + "lastConsumedFlowTimestamp": { + "format": "int64", + "type": "integer" + }, + "lastConsumedTimestamp": { + "format": "int64", + "type": "integer" + }, + "messageAckRate": { + "format": "double", + "type": "number" + }, + "metadata": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "msgOutCounter": { + "format": "int64", + "type": "integer" + }, + "msgRateOut": { + "format": "double", + "type": "number" + }, + "msgRateRedeliver": { + "format": "double", + "type": "number" + }, + "msgThroughputOut": { + "format": "double", + "type": "number" + }, + "readPositionWhenJoining": { + "type": "string" + }, + "unackedMessages": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "CursorDetails": { + "properties": { + "cursorBacklog": { + "format": "int64", + "type": "integer" + }, + "cursorLedgerId": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "CursorInfo": { + "properties": { + "creationDate": { + "type": "string" + }, + "cursorsLedgerId": { + "format": "int64", + "type": "integer" + }, + "individualDeletedMessages": { + "items": { + "$ref": "#/definitions/MessageRangeInfo" + }, + "type": "array" + }, + "markDelete": { + "$ref": "#/definitions/PositionInfo" + }, + "modificationDate": { + "type": "string" + }, + "properties": { + "additionalProperties": { + "format": "int64", + "type": "integer" + }, + "type": "object" + }, + "version": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "CursorStats": { + "properties": { + "active": { + "type": "boolean" + }, + "cursorLedger": { + "format": "int64", + "type": "integer" + }, + "cursorLedgerLastEntry": { + "format": "int64", + "type": "integer" + }, + "individuallyDeletedMessages": { + "type": "string" + }, + "lastLedgerSwitchTimestamp": { + "type": "string" + }, + "markDeletePosition": { + "type": "string" + }, + "messagesConsumedCounter": { + "format": "int64", + "type": "integer" + }, + "numberOfEntriesSinceFirstNotAckedMessage": { + "format": "int64", + "type": "integer" + }, + "pendingReadOps": { + "format": "int32", + "type": "integer" + }, + "properties": { + "additionalProperties": { + "format": "int64", + "type": "integer" + }, + "type": "object" + }, + "readPosition": { + "type": "string" + }, + "state": { + "type": "string" + }, + "subscriptionHavePendingRead": { + "type": "boolean" + }, + "subscriptionHavePendingReplayRead": { + "type": "boolean" + }, + "totalNonContiguousDeletedMessagesRange": { + "format": "int32", + "type": "integer" + }, + "waitingReadOp": { + "type": "boolean" + } + }, + "type": "object" + }, + "DelayedDeliveryPolicies": { + "properties": { + "active": { + "type": "boolean" + }, + "maxDeliveryDelayInMillis": { + "format": "int64", + "type": "integer" + }, + "tickTime": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "DeleteSchemaResponse": { + "properties": { + "version": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "DispatchRate": { + "properties": { + "dispatchThrottlingRateInByte": { + "format": "int64", + "type": "integer" + }, + "dispatchThrottlingRateInMsg": { + "format": "int32", + "type": "integer" + }, + "ratePeriodInSecond": { + "format": "int32", + "type": "integer" + }, + "relativeToPublishRate": { + "type": "boolean" + } + }, + "type": "object" + }, + "DispatchRateImpl": { + "properties": { + "dispatchThrottlingRateInByte": { + "format": "int64", + "type": "integer" + }, + "dispatchThrottlingRateInMsg": { + "format": "int32", + "type": "integer" + }, + "ratePeriodInSecond": { + "format": "int32", + "type": "integer" + }, + "relativeToPublishRate": { + "type": "boolean" + } + }, + "type": "object" + }, + "DrainingHash": { + "properties": { + "blockedAttempts": { + "format": "int32", + "type": "integer" + }, + "hash": { + "format": "int32", + "type": "integer" + }, + "unackMsgs": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "EntryFilters": { + "properties": { + "entryFilterNames": { + "type": "string" + } + }, + "type": "object" + }, + "FailureDomain": { + "description": "The data of a failure domain configuration in a cluster", + "properties": { + "brokers": { + "description": "The collection of brokers in the same failure domain", + "example": "[ 'broker-1', 'broker-2' ]", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "FunctionInstanceStatsData": { + "properties": { + "avgProcessLatency": { + "format": "double", + "type": "number" + }, + "lastInvocation": { + "format": "int64", + "type": "integer" + }, + "oneMin": { + "$ref": "#/definitions/FunctionInstanceStatsDataBase" + }, + "processedSuccessfullyTotal": { + "format": "int64", + "type": "integer" + }, + "receivedTotal": { + "format": "int64", + "type": "integer" + }, + "systemExceptionsTotal": { + "format": "int64", + "type": "integer" + }, + "userExceptionsTotal": { + "format": "int64", + "type": "integer" + }, + "userMetrics": { + "additionalProperties": { + "format": "double", + "type": "number" + }, + "type": "object" + } + }, + "type": "object" + }, + "FunctionInstanceStatsDataBase": { + "properties": { + "avgProcessLatency": { + "format": "double", + "type": "number" + }, + "processedSuccessfullyTotal": { + "format": "int64", + "type": "integer" + }, + "receivedTotal": { + "format": "int64", + "type": "integer" + }, + "systemExceptionsTotal": { + "format": "int64", + "type": "integer" + }, + "userExceptionsTotal": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "Functions": { + "properties": { + "listOfConnectors": { + "items": { + "$ref": "#/definitions/ConnectorDefinition" + }, + "type": "array" + } + }, + "type": "object" + }, + "FunctionsV2": { + "properties": { + "listOfConnectors": { + "items": { + "$ref": "#/definitions/ConnectorDefinition" + }, + "type": "array" + } + }, + "type": "object" + }, + "FunctionsV2WorkerService": { + "properties": { + "listOfConnectors": { + "items": { + "$ref": "#/definitions/ConnectorDefinition" + }, + "type": "array" + } + }, + "type": "object" + }, + "FunctionsWorkerService": { + "properties": { + "listOfConnectors": { + "items": { + "$ref": "#/definitions/ConnectorDefinition" + }, + "type": "array" + } + }, + "type": "object" + }, + "GetAllVersionsSchemaResponse": { + "properties": { + "getSchemaResponses": { + "items": { + "$ref": "#/definitions/GetSchemaResponse" + }, + "type": "array" + } + }, + "type": "object" + }, + "GetSchemaResponse": { + "properties": { + "data": { + "type": "string" + }, + "properties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "timestamp": { + "format": "int64", + "type": "integer" + }, + "type": { + "enum": [ + "NONE", + "STRING", + "JSON", + "PROTOBUF", + "AVRO", + "BOOLEAN", + "INT8", + "INT16", + "INT32", + "INT64", + "FLOAT", + "DOUBLE", + "DATE", + "TIME", + "TIMESTAMP", + "KEY_VALUE", + "INSTANT", + "LOCAL_DATE", + "LOCAL_TIME", + "LOCAL_DATE_TIME", + "PROTOBUF_NATIVE", + "BYTES", + "AUTO", + "AUTO_CONSUME", + "AUTO_PUBLISH" + ], + "type": "string" + }, + "version": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "InactiveTopicPolicies": { + "properties": { + "deleteWhileInactive": { + "type": "boolean" + }, + "inactiveTopicDeleteMode": { + "enum": [ + "delete_when_no_subscriptions", + "delete_when_subscriptions_caught_up" + ], + "type": "string" + }, + "maxInactiveDurationSeconds": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "InternalConfigurationData": { + "properties": { + "bookkeeperMetadataServiceUri": { + "type": "string" + }, + "configurationMetadataStoreUrl": { + "type": "string" + }, + "configurationStoreServers": { + "type": "string" + }, + "ledgersRootPath": { + "type": "string" + }, + "metadataStoreUrl": { + "type": "string" + }, + "stateStorageServiceUrl": { + "type": "string" + }, + "zookeeperServers": { + "type": "string" + } + }, + "type": "object" + }, + "IsCompatibilityResponse": { + "properties": { + "compatibility": { + "type": "boolean" + }, + "schemaCompatibilityStrategy": { + "type": "string" + } + }, + "type": "object" + }, + "KubernetesContainerFactory": { + "properties": { + "changeConfigMap": { + "type": "string" + }, + "changeConfigMapNamespace": { + "type": "string" + }, + "configAdminCLI": { + "type": "string" + }, + "cpuOverCommitRatio": { + "format": "double", + "type": "number" + }, + "customLabels": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "expectedMetricsCollectionInterval": { + "format": "int32", + "type": "integer" + }, + "extraFunctionDependenciesDir": { + "type": "string" + }, + "functionDockerImages": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "functionInstanceClassPath": { + "type": "string" + }, + "gracePeriodSeconds": { + "format": "int32", + "type": "integer" + }, + "grpcPort": { + "format": "int32", + "type": "integer" + }, + "imagePullPolicy": { + "type": "string" + }, + "installUserCodeDependencies": { + "type": "boolean" + }, + "jobName": { + "type": "string" + }, + "jobNamespace": { + "type": "string" + }, + "k8Uri": { + "type": "string" + }, + "kubernetesFunctionAuthProviderConfig": { + "additionalProperties": { + "type": "object" + }, + "type": "object" + }, + "memoryOverCommitRatio": { + "format": "double", + "type": "number" + }, + "metricsPort": { + "format": "int32", + "type": "integer" + }, + "narExtractionDirectory": { + "type": "string" + }, + "percentMemoryPadding": { + "format": "int32", + "type": "integer" + }, + "pulsarAdminUrl": { + "type": "string" + }, + "pulsarDockerImageName": { + "type": "string" + }, + "pulsarRootDir": { + "type": "string" + }, + "pulsarServiceUrl": { + "type": "string" + }, + "pythonDependencyRepository": { + "type": "string" + }, + "pythonExtraDependencyRepository": { + "type": "string" + }, + "submittingInsidePod": { + "type": "boolean" + } + }, + "type": "object" + }, + "LedgerDetails": { + "properties": { + "entries": { + "format": "int64", + "type": "integer" + }, + "ledgerId": { + "format": "int64", + "type": "integer" + }, + "size": { + "format": "int64", + "type": "integer" + }, + "timestamp": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "LedgerInfo": { + "properties": { + "entries": { + "format": "int64", + "type": "integer" + }, + "ledgerId": { + "format": "int64", + "type": "integer" + }, + "metadata": { + "type": "string" + }, + "offloaded": { + "type": "boolean" + }, + "size": { + "format": "int64", + "type": "integer" + }, + "underReplicated": { + "type": "boolean" + } + }, + "type": "object" + }, + "LoadReport": { + "properties": { + "allocatedBandwidthIn": { + "format": "double", + "type": "number" + }, + "allocatedBandwidthOut": { + "format": "double", + "type": "number" + }, + "allocatedCPU": { + "format": "double", + "type": "number" + }, + "allocatedMemory": { + "format": "double", + "type": "number" + }, + "allocatedMsgRateIn": { + "format": "double", + "type": "number" + }, + "allocatedMsgRateOut": { + "format": "double", + "type": "number" + }, + "bandwidthIn": { + "$ref": "#/definitions/ResourceUsage" + }, + "bandwidthOut": { + "$ref": "#/definitions/ResourceUsage" + }, + "brokerVersionString": { + "type": "string" + }, + "bundleGains": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "bundleLosses": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "bundleStats": { + "additionalProperties": { + "$ref": "#/definitions/NamespaceBundleStats" + }, + "type": "object" + }, + "cpu": { + "$ref": "#/definitions/ResourceUsage" + }, + "directMemory": { + "$ref": "#/definitions/ResourceUsage" + }, + "lastUpdate": { + "format": "int64", + "type": "integer" + }, + "loadManagerClassName": { + "type": "string" + }, + "loadReportType": { + "type": "string" + }, + "memory": { + "$ref": "#/definitions/ResourceUsage" + }, + "msgRateIn": { + "format": "double", + "type": "number" + }, + "msgRateOut": { + "format": "double", + "type": "number" + }, + "msgThroughputIn": { + "format": "double", + "type": "number" + }, + "msgThroughputOut": { + "format": "double", + "type": "number" + }, + "name": { + "type": "string" + }, + "nonPersistentTopicsEnabled": { + "type": "boolean" + }, + "numBundles": { + "format": "int32", + "type": "integer" + }, + "numConsumers": { + "format": "int32", + "type": "integer" + }, + "numProducers": { + "format": "int32", + "type": "integer" + }, + "numTopics": { + "format": "int64", + "type": "integer" + }, + "overLoaded": { + "type": "boolean" + }, + "persistentTopicsEnabled": { + "type": "boolean" + }, + "preAllocatedBandwidthIn": { + "format": "double", + "type": "number" + }, + "preAllocatedBandwidthOut": { + "format": "double", + "type": "number" + }, + "preAllocatedCPU": { + "format": "double", + "type": "number" + }, + "preAllocatedMemory": { + "format": "double", + "type": "number" + }, + "preAllocatedMsgRateIn": { + "format": "double", + "type": "number" + }, + "preAllocatedMsgRateOut": { + "format": "double", + "type": "number" + }, + "protocols": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "pulsarServiceUrl": { + "type": "string" + }, + "pulsarServiceUrlTls": { + "type": "string" + }, + "startTimestamp": { + "format": "int64", + "type": "integer" + }, + "systemResourceUsage": { + "$ref": "#/definitions/SystemResourceUsage" + }, + "timestamp": { + "format": "int64", + "type": "integer" + }, + "underLoaded": { + "type": "boolean" + }, + "webServiceUrl": { + "type": "string" + }, + "webServiceUrlTls": { + "type": "string" + } + }, + "type": "object" + }, + "LongRunningProcessStatus": { + "properties": { + "lastError": { + "type": "string" + }, + "status": { + "enum": [ + "NOT_RUN", + "RUNNING", + "SUCCESS", + "ERROR" + ], + "type": "string" + } + }, + "type": "object" + }, + "LongSchemaVersion": { + "properties": { + "version": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "ManagedLedgerInfo": { + "properties": { + "creationDate": { + "type": "string" + }, + "cursors": { + "additionalProperties": { + "$ref": "#/definitions/CursorInfo" + }, + "type": "object" + }, + "ledgers": { + "items": { + "$ref": "#/definitions/LedgerInfo" + }, + "type": "array" + }, + "modificationDate": { + "type": "string" + }, + "properties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "terminatedPosition": { + "$ref": "#/definitions/PositionInfo" + }, + "version": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "MemoryLimit": { + "properties": { + "absoluteValue": { + "format": "int64", + "type": "integer" + }, + "percentOfMaxDirectMemory": { + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "MessageId": { + "type": "object" + }, + "MessageIdAdv": { + "properties": { + "ackSet": { + "$ref": "#/definitions/BitSet" + }, + "batchIndex": { + "format": "int32", + "type": "integer" + }, + "batchSize": { + "format": "int32", + "type": "integer" + }, + "entryId": { + "format": "int64", + "type": "integer" + }, + "firstChunkMessageId": { + "$ref": "#/definitions/MessageIdAdv" + }, + "ledgerId": { + "format": "int64", + "type": "integer" + }, + "partitionIndex": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "MessageRangeInfo": { + "properties": { + "from": { + "$ref": "#/definitions/PositionInfo" + }, + "to": { + "$ref": "#/definitions/PositionInfo" + } + }, + "type": "object" + }, + "Metrics": { + "properties": { + "dimensions": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "metrics": { + "additionalProperties": { + "type": "object" + }, + "type": "object" + } + }, + "type": "object" + }, + "NamespaceBundleStats": { + "properties": { + "cacheSize": { + "format": "int64", + "type": "integer" + }, + "consumerCount": { + "format": "int32", + "type": "integer" + }, + "msgRateIn": { + "format": "double", + "type": "number" + }, + "msgRateOut": { + "format": "double", + "type": "number" + }, + "msgThroughputIn": { + "format": "double", + "type": "number" + }, + "msgThroughputOut": { + "format": "double", + "type": "number" + }, + "producerCount": { + "format": "int32", + "type": "integer" + }, + "topics": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "NamespaceIsolationData": { + "description": "The data of namespace isolation configuration", + "properties": { + "auto_failover_policy": { + "$ref": "#/definitions/AutoFailoverPolicyData", + "description": "The data of auto-failover policy configuration", + "example": "{ \"policy_type\": \"min_available\" \"parameters\": { \"\": \"\" }}" + }, + "namespaces": { + "description": "The list of namespaces to apply this namespace isolation data", + "items": { + "type": "string" + }, + "type": "array" + }, + "primary": { + "description": "The list of primary brokers for serving the list of namespaces in this isolation policy", + "items": { + "type": "string" + }, + "type": "array" + }, + "secondary": { + "description": "The list of secondary brokers for serving the list of namespaces in this isolation policy", + "items": { + "type": "string" + }, + "type": "array" + }, + "unload_scope": { + "description": "The type of unload to perform while applying the new isolation policy.", + "enum": [ + "all_matching", + "none", + "changed" + ], + "example": "'changed' (default) for unloading only the namespaces whose placement is actually changing. 'all_matching' for unloading all matching namespaces. 'none' for not unloading any namespaces.", + "type": "string" + } + }, + "type": "object" + }, + "NamespaceOwnershipStatus": { + "properties": { + "broker_assignment": { + "enum": [ + "primary", + "secondary", + "shared" + ], + "type": "string" + }, + "is_active": { + "type": "boolean" + }, + "is_controlled": { + "type": "boolean" + } + }, + "type": "object" + }, + "NonPersistentPartitionedTopicStatsImpl": { + "properties": { + "abortedTxnCount": { + "format": "int64", + "type": "integer" + }, + "averageMsgSize": { + "format": "double", + "type": "number" + }, + "backlogQuotaLimitSize": { + "format": "int64", + "type": "integer" + }, + "backlogQuotaLimitTime": { + "format": "int64", + "type": "integer" + }, + "backlogSize": { + "format": "int64", + "type": "integer" + }, + "bytesInCounter": { + "format": "int64", + "type": "integer" + }, + "bytesOutCounter": { + "format": "int64", + "type": "integer" + }, + "bytesOutInternalCounter": { + "format": "int64", + "type": "integer" + }, + "committedTxnCount": { + "format": "int64", + "type": "integer" + }, + "compaction": { + "$ref": "#/definitions/CompactionStatsImpl" + }, + "deduplicationStatus": { + "type": "string" + }, + "delayedMessageIndexSizeInBytes": { + "format": "int64", + "type": "integer" + }, + "earliestMsgPublishTimeInBacklogs": { + "format": "int64", + "type": "integer" + }, + "lastOffloadFailureTimeStamp": { + "format": "int64", + "type": "integer" + }, + "lastOffloadLedgerId": { + "format": "int64", + "type": "integer" + }, + "lastOffloadSuccessTimeStamp": { + "format": "int64", + "type": "integer" + }, + "metadata": { + "$ref": "#/definitions/PartitionedTopicMetadata" + }, + "msgChunkPublished": { + "type": "boolean" + }, + "msgDropRate": { + "format": "double", + "type": "number" + }, + "msgInCounter": { + "format": "int64", + "type": "integer" + }, + "msgOutCounter": { + "format": "int64", + "type": "integer" + }, + "msgRateIn": { + "format": "double", + "type": "number" + }, + "msgRateOut": { + "format": "double", + "type": "number" + }, + "msgThroughputIn": { + "format": "double", + "type": "number" + }, + "msgThroughputOut": { + "format": "double", + "type": "number" + }, + "nonContiguousDeletedMessagesRanges": { + "format": "int32", + "type": "integer" + }, + "nonContiguousDeletedMessagesRangesSerializedSize": { + "format": "int32", + "type": "integer" + }, + "offloadedStorageSize": { + "format": "int64", + "type": "integer" + }, + "oldestBacklogMessageAgeSeconds": { + "format": "int64", + "type": "integer" + }, + "oldestBacklogMessageSubscriptionName": { + "type": "string" + }, + "ongoingTxnCount": { + "format": "int64", + "type": "integer" + }, + "ownerBroker": { + "type": "string" + }, + "partitions": { + "additionalProperties": { + "$ref": "#/definitions/NonPersistentTopicStatsImpl" + }, + "type": "object" + }, + "publishRateLimitedTimes": { + "format": "int64", + "type": "integer" + }, + "publishers": { + "items": { + "$ref": "#/definitions/NonPersistentPublisherStats" + }, + "readOnly": true, + "type": "array" + }, + "replication": { + "additionalProperties": { + "$ref": "#/definitions/NonPersistentReplicatorStats" + }, + "readOnly": true, + "type": "object" + }, + "storageSize": { + "format": "int64", + "type": "integer" + }, + "subscriptions": { + "additionalProperties": { + "$ref": "#/definitions/NonPersistentSubscriptionStats" + }, + "readOnly": true, + "type": "object" + }, + "systemTopicBytesInCounter": { + "format": "int64", + "type": "integer" + }, + "topicEpoch": { + "format": "int64", + "type": "integer" + }, + "waitingPublishers": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "NonPersistentPublisherStats": { + "properties": { + "accessMode": { + "enum": [ + "Shared", + "Exclusive", + "ExclusiveWithFencing", + "WaitForExclusive" + ], + "type": "string" + }, + "address": { + "type": "string" + }, + "averageMsgSize": { + "format": "double", + "type": "number" + }, + "chunkedMessageRate": { + "format": "double", + "type": "number" + }, + "clientVersion": { + "type": "string" + }, + "connectedSince": { + "type": "string" + }, + "metadata": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "msgDropRate": { + "format": "double", + "type": "number" + }, + "msgRateIn": { + "format": "double", + "type": "number" + }, + "msgThroughputIn": { + "format": "double", + "type": "number" + }, + "producerId": { + "format": "int64", + "type": "integer" + }, + "producerName": { + "type": "string" + }, + "supportsPartialProducer": { + "type": "boolean" + } + }, + "type": "object" + }, + "NonPersistentReplicatorStats": { + "properties": { + "bytesInCount": { + "format": "int64", + "type": "integer" + }, + "bytesOutCount": { + "format": "int64", + "type": "integer" + }, + "connected": { + "type": "boolean" + }, + "inboundConnectedSince": { + "type": "string" + }, + "inboundConnection": { + "type": "string" + }, + "msgDropCount": { + "format": "int64", + "type": "integer" + }, + "msgDropRate": { + "format": "double", + "type": "number" + }, + "msgExpiredCount": { + "format": "int64", + "type": "integer" + }, + "msgInCount": { + "format": "int64", + "type": "integer" + }, + "msgOutCount": { + "format": "int64", + "type": "integer" + }, + "msgRateExpired": { + "format": "double", + "type": "number" + }, + "msgRateIn": { + "format": "double", + "type": "number" + }, + "msgRateOut": { + "format": "double", + "type": "number" + }, + "msgThroughputIn": { + "format": "double", + "type": "number" + }, + "msgThroughputOut": { + "format": "double", + "type": "number" + }, + "outboundConnectedSince": { + "type": "string" + }, + "outboundConnection": { + "type": "string" + }, + "replicationBacklog": { + "format": "int64", + "type": "integer" + }, + "replicationDelayInSeconds": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "NonPersistentSubscriptionStats": { + "properties": { + "activeConsumerName": { + "type": "string" + }, + "allowOutOfOrderDelivery": { + "type": "boolean" + }, + "backlogSize": { + "format": "int64", + "type": "integer" + }, + "blockedSubscriptionOnUnackedMsgs": { + "type": "boolean" + }, + "bytesOutCounter": { + "format": "int64", + "type": "integer" + }, + "chunkedMessageRate": { + "format": "double", + "type": "number" + }, + "consumers": { + "items": { + "$ref": "#/definitions/ConsumerStats" + }, + "type": "array" + }, + "consumersAfterMarkDeletePosition": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "delayedMessageIndexSizeInBytes": { + "format": "int64", + "type": "integer" + }, + "drainingHashesClearedTotal": { + "format": "int64", + "type": "integer" + }, + "drainingHashesCount": { + "format": "int32", + "type": "integer" + }, + "drainingHashesUnackedMessages": { + "format": "int32", + "type": "integer" + }, + "durable": { + "type": "boolean" + }, + "earliestMsgPublishTimeInBacklog": { + "format": "int64", + "type": "integer" + }, + "filterAcceptedMsgCount": { + "format": "int64", + "type": "integer" + }, + "filterProcessedMsgCount": { + "format": "int64", + "type": "integer" + }, + "filterRejectedMsgCount": { + "format": "int64", + "type": "integer" + }, + "filterRescheduledMsgCount": { + "format": "int64", + "type": "integer" + }, + "keySharedMode": { + "type": "string" + }, + "lastAckedTimestamp": { + "format": "int64", + "type": "integer" + }, + "lastConsumedFlowTimestamp": { + "format": "int64", + "type": "integer" + }, + "lastConsumedTimestamp": { + "format": "int64", + "type": "integer" + }, + "lastExpireTimestamp": { + "format": "int64", + "type": "integer" + }, + "lastMarkDeleteAdvancedTimestamp": { + "format": "int64", + "type": "integer" + }, + "messageAckRate": { + "format": "double", + "type": "number" + }, + "msgBacklog": { + "format": "int64", + "type": "integer" + }, + "msgBacklogNoDelayed": { + "format": "int64", + "type": "integer" + }, + "msgDelayed": { + "format": "int64", + "type": "integer" + }, + "msgDropRate": { + "format": "double", + "type": "number" + }, + "msgInReplay": { + "format": "int64", + "type": "integer" + }, + "msgOutCounter": { + "format": "int64", + "type": "integer" + }, + "msgRateExpired": { + "format": "double", + "type": "number" + }, + "msgRateOut": { + "format": "double", + "type": "number" + }, + "msgRateRedeliver": { + "format": "double", + "type": "number" + }, + "msgThroughputOut": { + "format": "double", + "type": "number" + }, + "nonContiguousDeletedMessagesRanges": { + "format": "int32", + "type": "integer" + }, + "nonContiguousDeletedMessagesRangesSerializedSize": { + "format": "int32", + "type": "integer" + }, + "replicated": { + "type": "boolean" + }, + "subscriptionProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "totalMsgExpired": { + "format": "int64", + "type": "integer" + }, + "type": { + "type": "string" + }, + "unackedMessages": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "NonPersistentTopicStatsImpl": { + "properties": { + "abortedTxnCount": { + "format": "int64", + "type": "integer" + }, + "averageMsgSize": { + "format": "double", + "type": "number" + }, + "backlogQuotaLimitSize": { + "format": "int64", + "type": "integer" + }, + "backlogQuotaLimitTime": { + "format": "int64", + "type": "integer" + }, + "backlogSize": { + "format": "int64", + "type": "integer" + }, + "bytesInCounter": { + "format": "int64", + "type": "integer" + }, + "bytesOutCounter": { + "format": "int64", + "type": "integer" + }, + "bytesOutInternalCounter": { + "format": "int64", + "type": "integer" + }, + "committedTxnCount": { + "format": "int64", + "type": "integer" + }, + "compaction": { + "$ref": "#/definitions/CompactionStatsImpl" + }, + "deduplicationStatus": { + "type": "string" + }, + "delayedMessageIndexSizeInBytes": { + "format": "int64", + "type": "integer" + }, + "earliestMsgPublishTimeInBacklogs": { + "format": "int64", + "type": "integer" + }, + "lastOffloadFailureTimeStamp": { + "format": "int64", + "type": "integer" + }, + "lastOffloadLedgerId": { + "format": "int64", + "type": "integer" + }, + "lastOffloadSuccessTimeStamp": { + "format": "int64", + "type": "integer" + }, + "msgChunkPublished": { + "type": "boolean" + }, + "msgDropRate": { + "format": "double", + "type": "number" + }, + "msgInCounter": { + "format": "int64", + "type": "integer" + }, + "msgOutCounter": { + "format": "int64", + "type": "integer" + }, + "msgRateIn": { + "format": "double", + "type": "number" + }, + "msgRateOut": { + "format": "double", + "type": "number" + }, + "msgThroughputIn": { + "format": "double", + "type": "number" + }, + "msgThroughputOut": { + "format": "double", + "type": "number" + }, + "nonContiguousDeletedMessagesRanges": { + "format": "int32", + "type": "integer" + }, + "nonContiguousDeletedMessagesRangesSerializedSize": { + "format": "int32", + "type": "integer" + }, + "offloadedStorageSize": { + "format": "int64", + "type": "integer" + }, + "oldestBacklogMessageAgeSeconds": { + "format": "int64", + "type": "integer" + }, + "oldestBacklogMessageSubscriptionName": { + "type": "string" + }, + "ongoingTxnCount": { + "format": "int64", + "type": "integer" + }, + "ownerBroker": { + "type": "string" + }, + "publishRateLimitedTimes": { + "format": "int64", + "type": "integer" + }, + "publishers": { + "items": { + "$ref": "#/definitions/NonPersistentPublisherStats" + }, + "readOnly": true, + "type": "array" + }, + "replication": { + "additionalProperties": { + "$ref": "#/definitions/NonPersistentReplicatorStats" + }, + "readOnly": true, + "type": "object" + }, + "storageSize": { + "format": "int64", + "type": "integer" + }, + "subscriptions": { + "additionalProperties": { + "$ref": "#/definitions/NonPersistentSubscriptionStats" + }, + "readOnly": true, + "type": "object" + }, + "systemTopicBytesInCounter": { + "format": "int64", + "type": "integer" + }, + "topicEpoch": { + "format": "int64", + "type": "integer" + }, + "waitingPublishers": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "OffloadPolicies": { + "properties": { + "fileSystemProfilePath": { + "type": "string" + }, + "fileSystemURI": { + "type": "string" + }, + "gcsManagedLedgerOffloadBucket": { + "type": "string" + }, + "gcsManagedLedgerOffloadMaxBlockSizeInBytes": { + "format": "int32", + "type": "integer" + }, + "gcsManagedLedgerOffloadReadBufferSizeInBytes": { + "format": "int32", + "type": "integer" + }, + "gcsManagedLedgerOffloadRegion": { + "type": "string" + }, + "gcsManagedLedgerOffloadServiceAccountKeyFile": { + "type": "string" + }, + "managedLedgerOffloadBucket": { + "type": "string" + }, + "managedLedgerOffloadDeletionLagInMillis": { + "format": "int64", + "type": "integer" + }, + "managedLedgerOffloadDriver": { + "type": "string" + }, + "managedLedgerOffloadMaxBlockSizeInBytes": { + "format": "int32", + "type": "integer" + }, + "managedLedgerOffloadMaxThreads": { + "format": "int32", + "type": "integer" + }, + "managedLedgerOffloadPrefetchRounds": { + "format": "int32", + "type": "integer" + }, + "managedLedgerOffloadReadBufferSizeInBytes": { + "format": "int32", + "type": "integer" + }, + "managedLedgerOffloadRegion": { + "type": "string" + }, + "managedLedgerOffloadServiceEndpoint": { + "type": "string" + }, + "managedLedgerOffloadThresholdInBytes": { + "format": "int64", + "type": "integer" + }, + "managedLedgerOffloadThresholdInSeconds": { + "format": "int64", + "type": "integer" + }, + "managedLedgerOffloadedReadPriority": { + "enum": [ + "BOOKKEEPER_FIRST", + "TIERED_STORAGE_FIRST" + ], + "type": "string" + }, + "offloadersDirectory": { + "type": "string" + }, + "s3ManagedLedgerOffloadBucket": { + "type": "string" + }, + "s3ManagedLedgerOffloadCredentialId": { + "type": "string" + }, + "s3ManagedLedgerOffloadCredentialSecret": { + "type": "string" + }, + "s3ManagedLedgerOffloadMaxBlockSizeInBytes": { + "format": "int32", + "type": "integer" + }, + "s3ManagedLedgerOffloadReadBufferSizeInBytes": { + "format": "int32", + "type": "integer" + }, + "s3ManagedLedgerOffloadRegion": { + "type": "string" + }, + "s3ManagedLedgerOffloadRole": { + "type": "string" + }, + "s3ManagedLedgerOffloadRoleSessionName": { + "type": "string" + }, + "s3ManagedLedgerOffloadServiceEndpoint": { + "type": "string" + } + }, + "type": "object" + }, + "OffloadPoliciesImpl": { + "properties": { + "fileSystemDriver": { + "type": "boolean" + }, + "fileSystemProfilePath": { + "type": "string" + }, + "fileSystemURI": { + "type": "string" + }, + "gcsDriver": { + "type": "boolean" + }, + "gcsManagedLedgerOffloadBucket": { + "type": "string" + }, + "gcsManagedLedgerOffloadMaxBlockSizeInBytes": { + "format": "int32", + "type": "integer" + }, + "gcsManagedLedgerOffloadReadBufferSizeInBytes": { + "format": "int32", + "type": "integer" + }, + "gcsManagedLedgerOffloadRegion": { + "type": "string" + }, + "gcsManagedLedgerOffloadServiceAccountKeyFile": { + "type": "string" + }, + "managedLedgerExtraConfigurations": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "managedLedgerOffloadBucket": { + "type": "string" + }, + "managedLedgerOffloadDeletionLagInMillis": { + "format": "int64", + "type": "integer" + }, + "managedLedgerOffloadDriver": { + "type": "string" + }, + "managedLedgerOffloadMaxBlockSizeInBytes": { + "format": "int32", + "type": "integer" + }, + "managedLedgerOffloadMaxThreads": { + "format": "int32", + "type": "integer" + }, + "managedLedgerOffloadPrefetchRounds": { + "format": "int32", + "type": "integer" + }, + "managedLedgerOffloadReadBufferSizeInBytes": { + "format": "int32", + "type": "integer" + }, + "managedLedgerOffloadRegion": { + "type": "string" + }, + "managedLedgerOffloadServiceEndpoint": { + "type": "string" + }, + "managedLedgerOffloadThresholdInBytes": { + "format": "int64", + "type": "integer" + }, + "managedLedgerOffloadThresholdInSeconds": { + "format": "int64", + "type": "integer" + }, + "managedLedgerOffloadedReadPriority": { + "enum": [ + "BOOKKEEPER_FIRST", + "TIERED_STORAGE_FIRST" + ], + "type": "string" + }, + "offloadersDirectory": { + "type": "string" + }, + "s3Driver": { + "type": "boolean" + }, + "s3ManagedLedgerOffloadBucket": { + "type": "string" + }, + "s3ManagedLedgerOffloadCredentialId": { + "type": "string" + }, + "s3ManagedLedgerOffloadCredentialSecret": { + "type": "string" + }, + "s3ManagedLedgerOffloadMaxBlockSizeInBytes": { + "format": "int32", + "type": "integer" + }, + "s3ManagedLedgerOffloadReadBufferSizeInBytes": { + "format": "int32", + "type": "integer" + }, + "s3ManagedLedgerOffloadRegion": { + "type": "string" + }, + "s3ManagedLedgerOffloadRole": { + "type": "string" + }, + "s3ManagedLedgerOffloadRoleSessionName": { + "type": "string" + }, + "s3ManagedLedgerOffloadServiceEndpoint": { + "type": "string" + } + }, + "type": "object" + }, + "OffloadProcessStatus": { + "properties": { + "firstUnoffloadedMessage": { + "$ref": "#/definitions/MessageId" + }, + "lastError": { + "type": "string" + }, + "status": { + "enum": [ + "NOT_RUN", + "RUNNING", + "SUCCESS", + "ERROR" + ], + "type": "string" + } + }, + "type": "object" + }, + "OutputStream": { + "type": "object" + }, + "PartitionedManagedLedgerInfo": { + "properties": { + "creationDate": { + "type": "string" + }, + "cursors": { + "additionalProperties": { + "$ref": "#/definitions/CursorInfo" + }, + "type": "object" + }, + "ledgers": { + "items": { + "$ref": "#/definitions/LedgerInfo" + }, + "type": "array" + }, + "modificationDate": { + "type": "string" + }, + "partitions": { + "additionalProperties": { + "$ref": "#/definitions/ManagedLedgerInfo" + }, + "type": "object" + }, + "properties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "terminatedPosition": { + "$ref": "#/definitions/PositionInfo" + }, + "version": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "PartitionedTopicInternalStats": { + "properties": { + "metadata": { + "$ref": "#/definitions/PartitionedTopicMetadata" + }, + "partitions": { + "additionalProperties": { + "$ref": "#/definitions/PersistentTopicInternalStats" + }, + "type": "object" + } + }, + "type": "object" + }, + "PartitionedTopicMetadata": { + "properties": { + "deleted": { + "type": "boolean" + }, + "partitions": { + "format": "int32", + "type": "integer" + }, + "properties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + } + }, + "type": "object" + }, + "PartitionedTopicStatsImpl": { + "properties": { + "abortedTxnCount": { + "format": "int64", + "type": "integer" + }, + "averageMsgSize": { + "format": "double", + "type": "number" + }, + "backlogQuotaLimitSize": { + "format": "int64", + "type": "integer" + }, + "backlogQuotaLimitTime": { + "format": "int64", + "type": "integer" + }, + "backlogSize": { + "format": "int64", + "type": "integer" + }, + "bytesInCounter": { + "format": "int64", + "type": "integer" + }, + "bytesOutCounter": { + "format": "int64", + "type": "integer" + }, + "bytesOutInternalCounter": { + "format": "int64", + "type": "integer" + }, + "committedTxnCount": { + "format": "int64", + "type": "integer" + }, + "compaction": { + "$ref": "#/definitions/CompactionStatsImpl" + }, + "deduplicationStatus": { + "type": "string" + }, + "delayedMessageIndexSizeInBytes": { + "format": "int64", + "type": "integer" + }, + "earliestMsgPublishTimeInBacklogs": { + "format": "int64", + "type": "integer" + }, + "lastOffloadFailureTimeStamp": { + "format": "int64", + "type": "integer" + }, + "lastOffloadLedgerId": { + "format": "int64", + "type": "integer" + }, + "lastOffloadSuccessTimeStamp": { + "format": "int64", + "type": "integer" + }, + "metadata": { + "$ref": "#/definitions/PartitionedTopicMetadata" + }, + "msgChunkPublished": { + "type": "boolean" + }, + "msgInCounter": { + "format": "int64", + "type": "integer" + }, + "msgOutCounter": { + "format": "int64", + "type": "integer" + }, + "msgRateIn": { + "format": "double", + "type": "number" + }, + "msgRateOut": { + "format": "double", + "type": "number" + }, + "msgThroughputIn": { + "format": "double", + "type": "number" + }, + "msgThroughputOut": { + "format": "double", + "type": "number" + }, + "nonContiguousDeletedMessagesRanges": { + "format": "int32", + "type": "integer" + }, + "nonContiguousDeletedMessagesRangesSerializedSize": { + "format": "int32", + "type": "integer" + }, + "offloadedStorageSize": { + "format": "int64", + "type": "integer" + }, + "oldestBacklogMessageAgeSeconds": { + "format": "int64", + "type": "integer" + }, + "oldestBacklogMessageSubscriptionName": { + "type": "string" + }, + "ongoingTxnCount": { + "format": "int64", + "type": "integer" + }, + "ownerBroker": { + "type": "string" + }, + "partitions": { + "additionalProperties": { + "$ref": "#/definitions/TopicStats" + }, + "type": "object" + }, + "publishRateLimitedTimes": { + "format": "int64", + "type": "integer" + }, + "publishers": { + "items": { + "$ref": "#/definitions/PublisherStats" + }, + "type": "array" + }, + "replication": { + "additionalProperties": { + "$ref": "#/definitions/ReplicatorStats" + }, + "type": "object" + }, + "storageSize": { + "format": "int64", + "type": "integer" + }, + "subscriptions": { + "additionalProperties": { + "$ref": "#/definitions/SubscriptionStats" + }, + "type": "object" + }, + "systemTopicBytesInCounter": { + "format": "int64", + "type": "integer" + }, + "topicEpoch": { + "format": "int64", + "type": "integer" + }, + "waitingPublishers": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "PendingBookieOpsStats": { + "properties": { + "cursorLedgerCloseOp": { + "format": "int64", + "type": "integer" + }, + "cursorLedgerCreateOp": { + "format": "int64", + "type": "integer" + }, + "cursorLedgerDeleteOp": { + "format": "int64", + "type": "integer" + }, + "cursorLedgerOpenOp": { + "format": "int64", + "type": "integer" + }, + "dataLedgerCloseOp": { + "format": "int64", + "type": "integer" + }, + "dataLedgerCreateOp": { + "format": "int64", + "type": "integer" + }, + "dataLedgerDeleteOp": { + "format": "int64", + "type": "integer" + }, + "dataLedgerOpenOp": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "PersistencePolicies": { + "properties": { + "bookkeeperAckQuorum": { + "format": "int32", + "type": "integer" + }, + "bookkeeperEnsemble": { + "format": "int32", + "type": "integer" + }, + "bookkeeperWriteQuorum": { + "format": "int32", + "type": "integer" + }, + "managedLedgerMaxMarkDeleteRate": { + "format": "double", + "type": "number" + }, + "managedLedgerStorageClassName": { + "type": "string" + } + }, + "type": "object" + }, + "PersistentOfflineTopicStats": { + "properties": { + "brokerName": { + "type": "string" + }, + "cursorDetails": { + "additionalProperties": { + "$ref": "#/definitions/CursorDetails" + }, + "type": "object" + }, + "dataLedgerDetails": { + "items": { + "$ref": "#/definitions/LedgerDetails" + }, + "type": "array" + }, + "messageBacklog": { + "format": "int64", + "type": "integer" + }, + "statGeneratedAt": { + "format": "date-time", + "type": "string" + }, + "storageSize": { + "format": "int64", + "type": "integer" + }, + "topicName": { + "type": "string" + }, + "totalMessages": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "PersistentTopicInternalStats": { + "properties": { + "compactedLedger": { + "$ref": "#/definitions/LedgerInfo" + }, + "currentLedgerEntries": { + "format": "int64", + "type": "integer" + }, + "currentLedgerSize": { + "format": "int64", + "type": "integer" + }, + "cursors": { + "additionalProperties": { + "$ref": "#/definitions/CursorStats" + }, + "type": "object" + }, + "entriesAddedCounter": { + "format": "int64", + "type": "integer" + }, + "lastConfirmedEntry": { + "type": "string" + }, + "lastLedgerCreatedTimestamp": { + "type": "string" + }, + "lastLedgerCreationFailureTimestamp": { + "type": "string" + }, + "ledgers": { + "items": { + "$ref": "#/definitions/LedgerInfo" + }, + "type": "array" + }, + "numberOfEntries": { + "format": "int64", + "type": "integer" + }, + "pendingAddEntriesCount": { + "format": "int32", + "type": "integer" + }, + "schemaLedgers": { + "items": { + "$ref": "#/definitions/LedgerInfo" + }, + "type": "array" + }, + "state": { + "type": "string" + }, + "totalSize": { + "format": "int64", + "type": "integer" + }, + "waitingCursorsCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "PersistentTopicStats": { + "properties": { + "averageMsgSize": { + "format": "double", + "type": "number" + }, + "backlogQuotaLimitSize": { + "format": "int64", + "type": "integer" + }, + "backlogQuotaLimitTime": { + "format": "int64", + "type": "integer" + }, + "backlogSize": { + "format": "int64", + "type": "integer" + }, + "bytesInCounter": { + "format": "int64", + "type": "integer" + }, + "bytesOutCounter": { + "format": "int64", + "type": "integer" + }, + "compaction": { + "$ref": "#/definitions/CompactionStats" + }, + "deduplicationStatus": { + "type": "string" + }, + "delayedMessageIndexSizeInBytes": { + "format": "int64", + "type": "integer" + }, + "earliestMsgPublishTimeInBacklogs": { + "format": "int64", + "type": "integer" + }, + "msgChunkPublished": { + "type": "boolean" + }, + "msgInCounter": { + "format": "int64", + "type": "integer" + }, + "msgOutCounter": { + "format": "int64", + "type": "integer" + }, + "msgRateIn": { + "format": "double", + "type": "number" + }, + "msgRateOut": { + "format": "double", + "type": "number" + }, + "msgThroughputIn": { + "format": "double", + "type": "number" + }, + "msgThroughputOut": { + "format": "double", + "type": "number" + }, + "nonContiguousDeletedMessagesRanges": { + "format": "int32", + "type": "integer" + }, + "nonContiguousDeletedMessagesRangesSerializedSize": { + "format": "int32", + "type": "integer" + }, + "offloadedStorageSize": { + "format": "int64", + "type": "integer" + }, + "oldestBacklogMessageAgeSeconds": { + "format": "int64", + "type": "integer" + }, + "oldestBacklogMessageSubscriptionName": { + "type": "string" + }, + "ownerBroker": { + "type": "string" + }, + "publishers": { + "items": { + "$ref": "#/definitions/PublisherStats" + }, + "type": "array" + }, + "replication": { + "additionalProperties": { + "$ref": "#/definitions/ReplicatorStats" + }, + "type": "object" + }, + "storageSize": { + "format": "int64", + "type": "integer" + }, + "subscriptions": { + "additionalProperties": { + "$ref": "#/definitions/SubscriptionStats" + }, + "type": "object" + }, + "topicEpoch": { + "format": "int64", + "type": "integer" + }, + "waitingPublishers": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "Policies": { + "properties": { + "allowed_clusters": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "auth_policies": { + "$ref": "#/definitions/AuthPolicies" + }, + "autoSubscriptionCreationOverride": { + "$ref": "#/definitions/AutoSubscriptionCreationOverride" + }, + "autoTopicCreationOverride": { + "$ref": "#/definitions/AutoTopicCreationOverride" + }, + "backlog_quota_map": { + "additionalProperties": { + "$ref": "#/definitions/BacklogQuota" + }, + "type": "object" + }, + "bundles": { + "$ref": "#/definitions/BundlesData" + }, + "clusterDispatchRate": { + "additionalProperties": { + "$ref": "#/definitions/DispatchRateImpl" + }, + "type": "object" + }, + "clusterSubscribeRate": { + "additionalProperties": { + "$ref": "#/definitions/SubscribeRate" + }, + "type": "object" + }, + "compaction_threshold": { + "format": "int64", + "type": "integer" + }, + "deduplicationEnabled": { + "type": "boolean" + }, + "deduplicationSnapshotIntervalSeconds": { + "format": "int32", + "type": "integer" + }, + "delayed_delivery_policies": { + "$ref": "#/definitions/DelayedDeliveryPolicies" + }, + "deleted": { + "type": "boolean" + }, + "dispatcherPauseOnAckStatePersistentEnabled": { + "type": "boolean" + }, + "encryption_required": { + "type": "boolean" + }, + "entryFilters": { + "$ref": "#/definitions/EntryFilters" + }, + "inactive_topic_policies": { + "$ref": "#/definitions/InactiveTopicPolicies" + }, + "is_allow_auto_update_schema": { + "type": "boolean" + }, + "latency_stats_sample_rate": { + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "type": "object" + }, + "max_consumers_per_subscription": { + "format": "int32", + "type": "integer" + }, + "max_consumers_per_topic": { + "format": "int32", + "type": "integer" + }, + "max_producers_per_topic": { + "format": "int32", + "type": "integer" + }, + "max_subscriptions_per_topic": { + "format": "int32", + "type": "integer" + }, + "max_topics_per_namespace": { + "format": "int32", + "type": "integer" + }, + "max_unacked_messages_per_consumer": { + "format": "int32", + "type": "integer" + }, + "max_unacked_messages_per_subscription": { + "format": "int32", + "type": "integer" + }, + "message_ttl_in_seconds": { + "format": "int32", + "type": "integer" + }, + "migrated": { + "type": "boolean" + }, + "offload_deletion_lag_ms": { + "format": "int64", + "type": "integer" + }, + "offload_policies": { + "$ref": "#/definitions/OffloadPolicies" + }, + "offload_threshold": { + "format": "int64", + "type": "integer" + }, + "offload_threshold_in_seconds": { + "format": "int64", + "type": "integer" + }, + "persistence": { + "$ref": "#/definitions/PersistencePolicies" + }, + "properties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "publishMaxMessageRate": { + "additionalProperties": { + "$ref": "#/definitions/PublishRate" + }, + "type": "object" + }, + "replication_clusters": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "replicatorDispatchRate": { + "additionalProperties": { + "$ref": "#/definitions/DispatchRateImpl" + }, + "type": "object" + }, + "resource_group_name": { + "type": "string" + }, + "retention_policies": { + "$ref": "#/definitions/RetentionPolicies" + }, + "schema_auto_update_compatibility_strategy": { + "enum": [ + "AutoUpdateDisabled", + "Backward", + "Forward", + "Full", + "AlwaysCompatible", + "BackwardTransitive", + "ForwardTransitive", + "FullTransitive" + ], + "type": "string" + }, + "schema_compatibility_strategy": { + "enum": [ + "UNDEFINED", + "ALWAYS_INCOMPATIBLE", + "ALWAYS_COMPATIBLE", + "BACKWARD", + "FORWARD", + "FULL", + "BACKWARD_TRANSITIVE", + "FORWARD_TRANSITIVE", + "FULL_TRANSITIVE" + ], + "type": "string" + }, + "schema_validation_enforced": { + "type": "boolean" + }, + "subscriptionDispatchRate": { + "additionalProperties": { + "$ref": "#/definitions/DispatchRateImpl" + }, + "type": "object" + }, + "subscription_auth_mode": { + "enum": [ + "None", + "Prefix" + ], + "type": "string" + }, + "subscription_expiration_time_minutes": { + "format": "int32", + "type": "integer" + }, + "subscription_types_enabled": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "topicDispatchRate": { + "additionalProperties": { + "$ref": "#/definitions/DispatchRateImpl" + }, + "type": "object" + } + }, + "type": "object" + }, + "PoolArenaStats": { + "properties": { + "chunkLists": { + "items": { + "$ref": "#/definitions/PoolChunkListStats" + }, + "type": "array" + }, + "numActiveAllocations": { + "format": "int64", + "type": "integer" + }, + "numActiveHugeAllocations": { + "format": "int64", + "type": "integer" + }, + "numActiveNormalAllocations": { + "format": "int64", + "type": "integer" + }, + "numActiveSmallAllocations": { + "format": "int64", + "type": "integer" + }, + "numAllocations": { + "format": "int64", + "type": "integer" + }, + "numChunkLists": { + "format": "int32", + "type": "integer" + }, + "numDeallocations": { + "format": "int64", + "type": "integer" + }, + "numHugeAllocations": { + "format": "int64", + "type": "integer" + }, + "numHugeDeallocations": { + "format": "int64", + "type": "integer" + }, + "numNormalAllocations": { + "format": "int64", + "type": "integer" + }, + "numNormalDeallocations": { + "format": "int64", + "type": "integer" + }, + "numSmallAllocations": { + "format": "int64", + "type": "integer" + }, + "numSmallDeallocations": { + "format": "int64", + "type": "integer" + }, + "numSmallSubpages": { + "format": "int32", + "type": "integer" + }, + "smallSubpages": { + "items": { + "$ref": "#/definitions/PoolSubpageStats" + }, + "type": "array" + } + }, + "type": "object" + }, + "PoolChunkListStats": { + "properties": { + "chunks": { + "items": { + "$ref": "#/definitions/PoolChunkStats" + }, + "type": "array" + }, + "maxUsage": { + "format": "int32", + "type": "integer" + }, + "minUsage": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "PoolChunkStats": { + "properties": { + "chunkSize": { + "format": "int32", + "type": "integer" + }, + "freeBytes": { + "format": "int32", + "type": "integer" + }, + "usage": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "PoolSubpageStats": { + "properties": { + "elementSize": { + "format": "int32", + "type": "integer" + }, + "maxNumElements": { + "format": "int32", + "type": "integer" + }, + "numAvailable": { + "format": "int32", + "type": "integer" + }, + "pageSize": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "PositionInfo": { + "properties": { + "entryId": { + "format": "int64", + "type": "integer" + }, + "ledgerId": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "PostSchemaPayload": { + "properties": { + "properties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "schema": { + "type": "string" + }, + "type": { + "type": "string" + } + }, + "type": "object" + }, + "PostSchemaResponse": { + "properties": { + "version": { + "$ref": "#/definitions/SchemaVersion" + } + }, + "type": "object" + }, + "ProcessContainerFactory": { + "properties": { + "extraFunctionDependenciesDir": { + "type": "string" + }, + "javaInstanceJarLocation": { + "type": "string" + }, + "logDirectory": { + "type": "string" + }, + "pythonInstanceLocation": { + "type": "string" + } + }, + "type": "object" + }, + "PublicKey": { + "properties": { + "algorithm": { + "type": "string" + }, + "encoded": { + "items": { + "format": "byte", + "type": "string" + }, + "type": "array" + }, + "format": { + "type": "string" + } + }, + "type": "object" + }, + "PublishRate": { + "properties": { + "publishThrottlingRateInByte": { + "format": "int64", + "type": "integer" + }, + "publishThrottlingRateInMsg": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "PublisherStats": { + "properties": { + "accessMode": { + "enum": [ + "Shared", + "Exclusive", + "ExclusiveWithFencing", + "WaitForExclusive" + ], + "type": "string" + }, + "address": { + "type": "string" + }, + "averageMsgSize": { + "format": "double", + "type": "number" + }, + "chunkedMessageRate": { + "format": "double", + "type": "number" + }, + "clientVersion": { + "type": "string" + }, + "connectedSince": { + "type": "string" + }, + "metadata": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "msgRateIn": { + "format": "double", + "type": "number" + }, + "msgThroughputIn": { + "format": "double", + "type": "number" + }, + "producerId": { + "format": "int64", + "type": "integer" + }, + "producerName": { + "type": "string" + }, + "supportsPartialProducer": { + "type": "boolean" + } + }, + "type": "object" + }, + "RawBookieInfo": { + "properties": { + "bookieId": { + "type": "string" + } + }, + "type": "object" + }, + "ReplicatorStats": { + "properties": { + "bytesInCount": { + "format": "int64", + "type": "integer" + }, + "bytesOutCount": { + "format": "int64", + "type": "integer" + }, + "connected": { + "type": "boolean" + }, + "inboundConnectedSince": { + "type": "string" + }, + "inboundConnection": { + "type": "string" + }, + "msgExpiredCount": { + "format": "int64", + "type": "integer" + }, + "msgInCount": { + "format": "int64", + "type": "integer" + }, + "msgOutCount": { + "format": "int64", + "type": "integer" + }, + "msgRateExpired": { + "format": "double", + "type": "number" + }, + "msgRateIn": { + "format": "double", + "type": "number" + }, + "msgRateOut": { + "format": "double", + "type": "number" + }, + "msgThroughputIn": { + "format": "double", + "type": "number" + }, + "msgThroughputOut": { + "format": "double", + "type": "number" + }, + "outboundConnectedSince": { + "type": "string" + }, + "outboundConnection": { + "type": "string" + }, + "replicationBacklog": { + "format": "int64", + "type": "integer" + }, + "replicationDelayInSeconds": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "ResetCursorData": { + "properties": { + "batchIndex": { + "format": "int32", + "type": "integer" + }, + "entryId": { + "format": "int64", + "type": "integer" + }, + "excluded": { + "type": "boolean" + }, + "ledgerId": { + "format": "int64", + "type": "integer" + }, + "partitionIndex": { + "format": "int32", + "type": "integer" + }, + "properties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + } + }, + "type": "object" + }, + "ResourceDescription": { + "properties": { + "resourceUsage": { + "additionalProperties": { + "$ref": "#/definitions/ResourceUsage" + }, + "type": "object" + }, + "usagePct": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "ResourceGroup": { + "properties": { + "dispatchRateInBytes": { + "format": "int64", + "type": "integer" + }, + "dispatchRateInMsgs": { + "format": "int32", + "type": "integer" + }, + "publishRateInBytes": { + "format": "int64", + "type": "integer" + }, + "publishRateInMsgs": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "ResourceQuota": { + "properties": { + "bandwidthIn": { + "format": "double", + "type": "number" + }, + "bandwidthOut": { + "format": "double", + "type": "number" + }, + "dynamic": { + "type": "boolean" + }, + "memory": { + "format": "double", + "type": "number" + }, + "msgRateIn": { + "format": "double", + "type": "number" + }, + "msgRateOut": { + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "ResourceUnit": { + "properties": { + "availableResource": { + "$ref": "#/definitions/ResourceDescription" + }, + "resourceId": { + "type": "string" + } + }, + "type": "object" + }, + "ResourceUsage": { + "properties": { + "limit": { + "format": "double", + "type": "number" + }, + "usage": { + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "Resources": { + "properties": { + "cpu": { + "format": "double", + "type": "number" + }, + "disk": { + "format": "int64", + "type": "integer" + }, + "ram": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "RetentionPolicies": { + "properties": { + "retentionSizeInMB": { + "format": "int64", + "type": "integer" + }, + "retentionTimeInMinutes": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "SchemaVersion": { + "type": "object" + }, + "Sinks": { + "properties": { + "listOfConnectors": { + "items": { + "$ref": "#/definitions/ConnectorDefinition" + }, + "type": "array" + }, + "sinkList": { + "items": { + "$ref": "#/definitions/ConnectorDefinition" + }, + "type": "array" + } + }, + "type": "object" + }, + "SinksWorkerService": { + "properties": { + "listOfConnectors": { + "items": { + "$ref": "#/definitions/ConnectorDefinition" + }, + "type": "array" + }, + "sinkList": { + "items": { + "$ref": "#/definitions/ConnectorDefinition" + }, + "type": "array" + } + }, + "type": "object" + }, + "SocketAddress": { + "type": "object" + }, + "Sources": { + "properties": { + "listOfConnectors": { + "items": { + "$ref": "#/definitions/ConnectorDefinition" + }, + "type": "array" + }, + "sourceList": { + "items": { + "$ref": "#/definitions/ConnectorDefinition" + }, + "type": "array" + } + }, + "type": "object" + }, + "SourcesWorkerService": { + "properties": { + "listOfConnectors": { + "items": { + "$ref": "#/definitions/ConnectorDefinition" + }, + "type": "array" + }, + "sourceList": { + "items": { + "$ref": "#/definitions/ConnectorDefinition" + }, + "type": "array" + } + }, + "type": "object" + }, + "SubscribeRate": { + "properties": { + "ratePeriodInSecond": { + "format": "int32", + "type": "integer" + }, + "subscribeThrottlingRatePerConsumer": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "SubscriptionStats": { + "properties": { + "activeConsumerName": { + "type": "string" + }, + "allowOutOfOrderDelivery": { + "type": "boolean" + }, + "backlogSize": { + "format": "int64", + "type": "integer" + }, + "blockedSubscriptionOnUnackedMsgs": { + "type": "boolean" + }, + "bytesOutCounter": { + "format": "int64", + "type": "integer" + }, + "chunkedMessageRate": { + "format": "double", + "type": "number" + }, + "consumers": { + "items": { + "$ref": "#/definitions/ConsumerStats" + }, + "type": "array" + }, + "consumersAfterMarkDeletePosition": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "delayedMessageIndexSizeInBytes": { + "format": "int64", + "type": "integer" + }, + "drainingHashesClearedTotal": { + "format": "int64", + "type": "integer" + }, + "drainingHashesCount": { + "format": "int32", + "type": "integer" + }, + "drainingHashesUnackedMessages": { + "format": "int32", + "type": "integer" + }, + "durable": { + "type": "boolean" + }, + "earliestMsgPublishTimeInBacklog": { + "format": "int64", + "type": "integer" + }, + "filterAcceptedMsgCount": { + "format": "int64", + "type": "integer" + }, + "filterProcessedMsgCount": { + "format": "int64", + "type": "integer" + }, + "filterRejectedMsgCount": { + "format": "int64", + "type": "integer" + }, + "filterRescheduledMsgCount": { + "format": "int64", + "type": "integer" + }, + "keySharedMode": { + "type": "string" + }, + "lastAckedTimestamp": { + "format": "int64", + "type": "integer" + }, + "lastConsumedFlowTimestamp": { + "format": "int64", + "type": "integer" + }, + "lastConsumedTimestamp": { + "format": "int64", + "type": "integer" + }, + "lastExpireTimestamp": { + "format": "int64", + "type": "integer" + }, + "lastMarkDeleteAdvancedTimestamp": { + "format": "int64", + "type": "integer" + }, + "messageAckRate": { + "format": "double", + "type": "number" + }, + "msgBacklog": { + "format": "int64", + "type": "integer" + }, + "msgBacklogNoDelayed": { + "format": "int64", + "type": "integer" + }, + "msgDelayed": { + "format": "int64", + "type": "integer" + }, + "msgInReplay": { + "format": "int64", + "type": "integer" + }, + "msgOutCounter": { + "format": "int64", + "type": "integer" + }, + "msgRateExpired": { + "format": "double", + "type": "number" + }, + "msgRateOut": { + "format": "double", + "type": "number" + }, + "msgRateRedeliver": { + "format": "double", + "type": "number" + }, + "msgThroughputOut": { + "format": "double", + "type": "number" + }, + "nonContiguousDeletedMessagesRanges": { + "format": "int32", + "type": "integer" + }, + "nonContiguousDeletedMessagesRangesSerializedSize": { + "format": "int32", + "type": "integer" + }, + "replicated": { + "type": "boolean" + }, + "subscriptionProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "totalMsgExpired": { + "format": "int64", + "type": "integer" + }, + "type": { + "type": "string" + }, + "unackedMessages": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "SystemResourceUsage": { + "properties": { + "bandwidthIn": { + "$ref": "#/definitions/ResourceUsage" + }, + "bandwidthOut": { + "$ref": "#/definitions/ResourceUsage" + }, + "cpu": { + "$ref": "#/definitions/ResourceUsage" + }, + "directMemory": { + "$ref": "#/definitions/ResourceUsage" + }, + "memory": { + "$ref": "#/definitions/ResourceUsage" + } + }, + "type": "object" + }, + "TenantInfo": { + "description": "Information of adminRoles and allowedClusters for tenant", + "properties": { + "adminRoles": { + "description": "Comma separated list of auth principal allowed to administrate the tenant.", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "allowedClusters": { + "description": "Comma separated allowed clusters.", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "ThreadContainerFactory": { + "properties": { + "pulsarClientMemoryLimit": { + "$ref": "#/definitions/MemoryLimit" + }, + "threadGroupName": { + "type": "string" + } + }, + "type": "object" + }, + "TopicHashPositions": { + "properties": { + "bundle": { + "type": "string" + }, + "namespace": { + "type": "string" + }, + "topicHashPositions": { + "additionalProperties": { + "format": "int64", + "type": "integer" + }, + "type": "object" + } + }, + "type": "object" + }, + "TopicStats": { + "properties": { + "averageMsgSize": { + "format": "double", + "type": "number" + }, + "backlogQuotaLimitSize": { + "format": "int64", + "type": "integer" + }, + "backlogQuotaLimitTime": { + "format": "int64", + "type": "integer" + }, + "backlogSize": { + "format": "int64", + "type": "integer" + }, + "bytesInCounter": { + "format": "int64", + "type": "integer" + }, + "bytesOutCounter": { + "format": "int64", + "type": "integer" + }, + "compaction": { + "$ref": "#/definitions/CompactionStats" + }, + "deduplicationStatus": { + "type": "string" + }, + "delayedMessageIndexSizeInBytes": { + "format": "int64", + "type": "integer" + }, + "earliestMsgPublishTimeInBacklogs": { + "format": "int64", + "type": "integer" + }, + "msgChunkPublished": { + "type": "boolean" + }, + "msgInCounter": { + "format": "int64", + "type": "integer" + }, + "msgOutCounter": { + "format": "int64", + "type": "integer" + }, + "msgRateIn": { + "format": "double", + "type": "number" + }, + "msgRateOut": { + "format": "double", + "type": "number" + }, + "msgThroughputIn": { + "format": "double", + "type": "number" + }, + "msgThroughputOut": { + "format": "double", + "type": "number" + }, + "nonContiguousDeletedMessagesRanges": { + "format": "int32", + "type": "integer" + }, + "nonContiguousDeletedMessagesRangesSerializedSize": { + "format": "int32", + "type": "integer" + }, + "offloadedStorageSize": { + "format": "int64", + "type": "integer" + }, + "oldestBacklogMessageAgeSeconds": { + "format": "int64", + "type": "integer" + }, + "oldestBacklogMessageSubscriptionName": { + "type": "string" + }, + "ownerBroker": { + "type": "string" + }, + "publishers": { + "items": { + "$ref": "#/definitions/PublisherStats" + }, + "type": "array" + }, + "replication": { + "additionalProperties": { + "$ref": "#/definitions/ReplicatorStats" + }, + "type": "object" + }, + "storageSize": { + "format": "int64", + "type": "integer" + }, + "subscriptions": { + "additionalProperties": { + "$ref": "#/definitions/SubscriptionStats" + }, + "type": "object" + }, + "topicEpoch": { + "format": "int64", + "type": "integer" + }, + "waitingPublishers": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "WorkerConfig": { + "properties": { + "additionalEnabledConnectorUrlPatterns": { + "items": { + "type": "string" + }, + "type": "array" + }, + "additionalEnabledFunctionsUrlPatterns": { + "items": { + "type": "string" + }, + "type": "array" + }, + "additionalJavaRuntimeArguments": { + "items": { + "type": "string" + }, + "type": "array" + }, + "assignmentWriteMaxRetries": { + "format": "int32", + "type": "integer" + }, + "authenticateMetricsEndpoint": { + "type": "boolean" + }, + "authenticationEnabled": { + "type": "boolean" + }, + "authenticationProviders": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "authorizationEnabled": { + "type": "boolean" + }, + "authorizationProvider": { + "type": "string" + }, + "bookkeeperClientAuthenticationParameters": { + "type": "string" + }, + "bookkeeperClientAuthenticationParametersName": { + "type": "string" + }, + "bookkeeperClientAuthenticationPlugin": { + "type": "string" + }, + "brokerClientAuthenticationEnabled": { + "type": "boolean" + }, + "brokerClientAuthenticationParameters": { + "type": "string" + }, + "brokerClientAuthenticationPlugin": { + "type": "string" + }, + "brokerClientTrustCertsFilePath": { + "type": "string" + }, + "clientAuthenticationParameters": { + "type": "string" + }, + "clientAuthenticationPlugin": { + "type": "string" + }, + "clusterCoordinationTopic": { + "type": "string" + }, + "clusterCoordinationTopicName": { + "type": "string" + }, + "configurationMetadataStoreUrl": { + "type": "string" + }, + "configurationStoreServers": { + "type": "string" + }, + "connectorsDirectory": { + "type": "string" + }, + "downloadDirectory": { + "type": "string" + }, + "enableClassloadingOfBuiltinFiles": { + "type": "boolean" + }, + "enableClassloadingOfExternalFiles": { + "type": "boolean" + }, + "enableReferencingConnectorDirectoryFiles": { + "type": "boolean" + }, + "enableReferencingFunctionsDirectoryFiles": { + "type": "boolean" + }, + "exposeAdminClientEnabled": { + "type": "boolean" + }, + "failureCheckFreqMs": { + "format": "int64", + "type": "integer" + }, + "forwardSourceMessageProperty": { + "type": "boolean" + }, + "functionAssignmentTopic": { + "type": "string" + }, + "functionAssignmentTopicName": { + "type": "string" + }, + "functionAuthProviderClassName": { + "type": "string" + }, + "functionInstanceMaxResources": { + "$ref": "#/definitions/Resources" + }, + "functionInstanceMinResources": { + "$ref": "#/definitions/Resources" + }, + "functionInstanceResourceChangeInLockStep": { + "type": "boolean" + }, + "functionInstanceResourceGranularities": { + "$ref": "#/definitions/Resources" + }, + "functionMetadataTopic": { + "type": "string" + }, + "functionMetadataTopicName": { + "type": "string" + }, + "functionRuntimeFactoryClassName": { + "type": "string" + }, + "functionRuntimeFactoryConfigs": { + "additionalProperties": { + "type": "object" + }, + "type": "object" + }, + "functionWebServiceUrl": { + "type": "string" + }, + "functionsDirectory": { + "type": "string" + }, + "functionsWorkerEnablePackageManagement": { + "type": "boolean" + }, + "functionsWorkerServiceCustomConfigs": { + "additionalProperties": { + "type": "object" + }, + "type": "object" + }, + "functionsWorkerServiceNarPackage": { + "type": "string" + }, + "httpRequestsLimitEnabled": { + "type": "boolean" + }, + "httpRequestsMaxPerSecond": { + "format": "double", + "type": "number" + }, + "httpServerAcceptQueueSize": { + "format": "int32", + "type": "integer" + }, + "httpServerThreadPoolQueueSize": { + "format": "int32", + "type": "integer" + }, + "ignoreUnknownConfigFields": { + "type": "boolean" + }, + "includeStandardPrometheusMetrics": { + "type": "boolean" + }, + "initialBrokerReconnectMaxRetries": { + "format": "int32", + "type": "integer" + }, + "initializedDlogMetadata": { + "type": "boolean" + }, + "instanceLivenessCheckFreqMs": { + "format": "int64", + "type": "integer" + }, + "jvmGCMetricsLoggerClassName": { + "type": "string" + }, + "kinitCommand": { + "type": "string" + }, + "kubernetesContainerFactory": { + "$ref": "#/definitions/KubernetesContainerFactory" + }, + "maxConcurrentHttpRequests": { + "format": "int32", + "type": "integer" + }, + "maxHttpServerConnections": { + "format": "int32", + "type": "integer" + }, + "maxPendingAsyncRequests": { + "format": "int32", + "type": "integer" + }, + "metadataStoreAllowReadOnlyOperations": { + "type": "boolean" + }, + "metadataStoreCacheExpirySeconds": { + "format": "int32", + "type": "integer" + }, + "metadataStoreOperationTimeoutSeconds": { + "format": "int32", + "type": "integer" + }, + "metadataStoreSessionTimeoutMillis": { + "format": "int64", + "type": "integer" + }, + "narExtractionDirectory": { + "type": "string" + }, + "numFunctionPackageReplicas": { + "format": "int32", + "type": "integer" + }, + "numHttpServerThreads": { + "format": "int32", + "type": "integer" + }, + "processContainerFactory": { + "$ref": "#/definitions/ProcessContainerFactory" + }, + "properties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "proxyRoles": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "pulsarFunctionsCluster": { + "type": "string" + }, + "pulsarFunctionsNamespace": { + "type": "string" + }, + "pulsarServiceUrl": { + "type": "string" + }, + "pulsarWebServiceUrl": { + "type": "string" + }, + "rebalanceCheckFreqSec": { + "format": "int64", + "type": "integer" + }, + "rescheduleTimeoutMs": { + "format": "int64", + "type": "integer" + }, + "runtimeCustomizerClassName": { + "type": "string" + }, + "runtimeCustomizerConfig": { + "additionalProperties": { + "type": "object" + }, + "type": "object" + }, + "saslJaasClientAllowedIds": { + "type": "string" + }, + "saslJaasServerRoleTokenSignerSecretPath": { + "type": "string" + }, + "saslJaasServerSectionName": { + "type": "string" + }, + "schedulerClassName": { + "type": "string" + }, + "secretsProviderConfiguratorClassName": { + "type": "string" + }, + "secretsProviderConfiguratorConfig": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "stateStorageProviderImplementation": { + "type": "string" + }, + "stateStorageServiceUrl": { + "type": "string" + }, + "superUserRoles": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "threadContainerFactory": { + "$ref": "#/definitions/ThreadContainerFactory" + }, + "tlsAllowInsecureConnection": { + "type": "boolean" + }, + "tlsCertRefreshCheckDurationSec": { + "format": "int64", + "type": "integer" + }, + "tlsCertificateFilePath": { + "type": "string" + }, + "tlsEnableHostnameVerification": { + "type": "boolean" + }, + "tlsEnabled": { + "type": "boolean" + }, + "tlsEnabledWithKeyStore": { + "type": "boolean" + }, + "tlsKeyFilePath": { + "type": "string" + }, + "tlsKeyStore": { + "type": "string" + }, + "tlsKeyStorePassword": { + "type": "string" + }, + "tlsKeyStoreType": { + "type": "string" + }, + "tlsProvider": { + "type": "string" + }, + "tlsRequireTrustedClientCertOnConnect": { + "type": "boolean" + }, + "tlsTrustCertsFilePath": { + "type": "string" + }, + "tlsTrustChainBytes": { + "items": { + "format": "byte", + "type": "string" + }, + "type": "array" + }, + "tlsTrustStore": { + "type": "string" + }, + "tlsTrustStorePassword": { + "type": "string" + }, + "tlsTrustStoreType": { + "type": "string" + }, + "topicCompactionFrequencySec": { + "format": "int64", + "type": "integer" + }, + "uploadBuiltinSinksSources": { + "type": "boolean" + }, + "useCompactedMetadataTopic": { + "type": "boolean" + }, + "useTls": { + "type": "boolean" + }, + "validateConnectorConfig": { + "type": "boolean" + }, + "webServiceHaProxyProtocolEnabled": { + "type": "boolean" + }, + "webServiceLogDetailedAddresses": { + "type": "boolean" + }, + "webServiceTlsCiphers": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "webServiceTlsProtocols": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "webServiceTrustXForwardedFor": { + "type": "boolean" + }, + "workerHostname": { + "type": "string" + }, + "workerId": { + "type": "string" + }, + "workerListProbeIntervalSec": { + "format": "int32", + "type": "integer" + }, + "workerPort": { + "format": "int32", + "type": "integer" + }, + "workerPortTls": { + "format": "int32", + "type": "integer" + }, + "workerWebAddress": { + "type": "string" + }, + "workerWebAddressTls": { + "type": "string" + }, + "zooKeeperAllowReadOnlyOperations": { + "type": "boolean" + }, + "zooKeeperCacheExpirySeconds": { + "format": "int32", + "type": "integer" + }, + "zooKeeperOperationTimeoutSeconds": { + "format": "int32", + "type": "integer" + }, + "zooKeeperSessionTimeoutMillis": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "WorkerFunctionInstanceStats": { + "properties": { + "metrics": { + "$ref": "#/definitions/FunctionInstanceStatsData" + }, + "name": { + "type": "string" + } + }, + "type": "object" + }, + "WorkerInfo": { + "properties": { + "port": { + "format": "int32", + "type": "integer" + }, + "workerHostname": { + "type": "string" + }, + "workerId": { + "type": "string" + } + }, + "type": "object" + }, + "WorkerService": { + "properties": { + "functions": { + "$ref": "#/definitions/FunctionsWorkerService" + }, + "functionsV2": { + "$ref": "#/definitions/FunctionsV2WorkerService" + }, + "initialized": { + "type": "boolean" + }, + "sinks": { + "$ref": "#/definitions/SinksWorkerService" + }, + "sources": { + "$ref": "#/definitions/SourcesWorkerService" + }, + "workerConfig": { + "$ref": "#/definitions/WorkerConfig" + }, + "workers": { + "$ref": "#/definitions/WorkersWorkerService" + } + }, + "type": "object" + }, + "Workers": { + "type": "object" + }, + "WorkersWorkerService": { + "type": "object" + } + }, + "info": { + "description": "This provides the REST API for admin operations", + "license": { + "name": "Apache 2.0", + "url": "http://www.apache.org/licenses/LICENSE-2.0.html" + }, + "title": "Pulsar Admin REST API", + "version": "v2" + }, + "paths": { + "/bookies/all": { + "get": { + "description": "", + "operationId": "Bookies_getAllBookies", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/BookiesClusterInfo" + } + }, + "403": { + "description": "Don't have admin permission" + } + }, + "summary": "Gets raw information for all the bookies in the cluster", + "tags": [ + "bookies" + ] + } + }, + "/bookies/racks-info": { + "get": { + "description": "", + "operationId": "Bookies_getBookiesRackInfo", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "additionalProperties": { + "additionalProperties": { + "$ref": "#/definitions/BookieInfo" + }, + "type": "object" + }, + "type": "object" + } + }, + "403": { + "description": "Don't have admin permission" + } + }, + "summary": "Gets the rack placement information for all the bookies in the cluster", + "tags": [ + "bookies" + ] + } + }, + "/bookies/racks-info/{bookie}": { + "delete": { + "description": "", + "operationId": "Bookies_deleteBookieRackInfo", + "parameters": [ + { + "in": "path", + "name": "bookie", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + } + }, + "summary": "Removed the rack placement information for a specific bookie in the cluster", + "tags": [ + "bookies" + ] + }, + "get": { + "description": "", + "operationId": "Bookies_getBookieRackInfo", + "parameters": [ + { + "in": "path", + "name": "bookie", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/BookieInfo" + } + }, + "403": { + "description": "Don't have admin permission" + } + }, + "summary": "Gets the rack placement information for a specific bookie in the cluster", + "tags": [ + "bookies" + ] + }, + "post": { + "description": "", + "operationId": "Bookies_updateBookieRackInfo", + "parameters": [ + { + "description": "The bookie address", + "in": "path", + "name": "bookie", + "required": true, + "type": "string" + }, + { + "description": "The group", + "in": "query", + "name": "group", + "required": true, + "type": "string" + }, + { + "description": "The bookie info", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/BookieInfo" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + } + }, + "summary": "Updates the rack placement information for a specific bookie in the cluster (note. bookie address format:`address:port`)", + "tags": [ + "bookies" + ] + } + }, + "/broker-stats/allocator-stats/{allocator}": { + "get": { + "description": "", + "operationId": "BrokerStatsBase_getAllocatorStats", + "parameters": [ + { + "in": "path", + "name": "allocator", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/AllocatorStats" + } + }, + "403": { + "description": "Don't have admin permission" + } + }, + "summary": "Get the stats for the Netty allocator. Available allocators are 'default' and 'ml-cache'", + "tags": [ + "broker-stats" + ] + } + }, + "/broker-stats/bookieops": { + "get": { + "description": "Returns a nested map structure which Swagger does not fully support for display. Structure: Map>. Please refer to this structure for details.", + "operationId": "BrokerStatsBase_getPendingBookieOpsStats", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "additionalProperties": { + "$ref": "#/definitions/PendingBookieOpsStats" + }, + "type": "object" + } + }, + "403": { + "description": "Don't have admin permission" + } + }, + "summary": "Get pending bookie client op stats by namespace", + "tags": [ + "broker-stats" + ] + } + }, + "/broker-stats/broker-resource-availability/{tenant}/{namespace}": { + "get": { + "description": "This API gives the current broker availability in percent, each resource percentage usage is calculated and thensum of all of the resource usage percent is called broker-resource-availability

THIS API IS ONLY FOR USE BY TESTING FOR CONFIRMING NAMESPACE ALLOCATION ALGORITHM", + "operationId": "BrokerStats_getBrokerResourceAvailability", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Returns broker resource availability as Map>.Since `ResourceUnit` is an interface, its specific content is not determinable via class reflection. Refer to the source code or interface tests for detailed type definitions.", + "schema": { + "additionalProperties": { + "$ref": "#/definitions/ResourceUnit" + }, + "type": "object" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "409": { + "description": "Load-manager doesn't support operation" + } + }, + "summary": "Broker availability report", + "tags": [ + "broker-stats" + ] + } + }, + "/broker-stats/load-report": { + "get": { + "description": "consists of topics stats & systemResourceUsage", + "operationId": "BrokerStatsBase_getLoadReport", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/LoadReport" + } + }, + "403": { + "description": "Don't have admin permission" + } + }, + "summary": "Get Load for this broker", + "tags": [ + "broker-stats" + ] + } + }, + "/broker-stats/mbeans": { + "get": { + "description": "", + "operationId": "BrokerStatsBase_getMBeans", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "$ref": "#/definitions/Metrics" + }, + "type": "array" + } + }, + "403": { + "description": "Don't have admin permission" + } + }, + "summary": "Get all the mbean details of this broker JVM", + "tags": [ + "broker-stats" + ] + } + }, + "/broker-stats/metrics": { + "get": { + "description": "Requested should be executed by Monitoring agent on each broker to fetch the metrics", + "operationId": "BrokerStatsBase_getMetrics", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "$ref": "#/definitions/Metrics" + }, + "type": "array" + } + }, + "403": { + "description": "Don't have admin permission" + } + }, + "summary": "Gets the metrics for Monitoring", + "tags": [ + "broker-stats" + ] + } + }, + "/broker-stats/topics": { + "get": { + "description": "", + "operationId": "BrokerStats_getTopics2", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/OutputStream" + } + }, + "403": { + "description": "Don't have admin permission" + } + }, + "summary": "Get all the topic stats by namespace", + "tags": [ + "broker-stats" + ] + } + }, + "/brokers": { + "get": { + "description": "", + "operationId": "BrokersBase_getActiveBrokers", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "401": { + "description": "Authentication required" + }, + "403": { + "description": "This operation requires super-user access" + } + }, + "summary": "Get the list of active brokers (broker ids) in the local cluster.If authorization is not enabled", + "tags": [ + "brokers" + ] + } + }, + "/brokers/backlog-quota-check": { + "get": { + "description": "", + "operationId": "BrokersBase_backlogQuotaCheck", + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Everything is OK" + }, + "403": { + "description": "Don't have admin permission" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "An REST endpoint to trigger backlogQuotaCheck", + "tags": [ + "brokers" + ] + } + }, + "/brokers/configuration": { + "get": { + "description": "", + "operationId": "BrokersBase_getDynamicConfigurationName", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "403": { + "description": "You don't have admin permission to get configuration" + } + }, + "summary": "Get all updatable dynamic configurations's name", + "tags": [ + "brokers" + ] + } + }, + "/brokers/configuration/runtime": { + "get": { + "description": "", + "operationId": "BrokersBase_getRuntimeConfiguration", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + } + }, + "403": { + "description": "Don't have admin permission" + } + }, + "summary": "Get all runtime configurations. This operation requires Pulsar super-user privileges.", + "tags": [ + "brokers" + ] + } + }, + "/brokers/configuration/values": { + "get": { + "description": "", + "operationId": "BrokersBase_getAllDynamicConfigurations", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + } + }, + "403": { + "description": "You don't have admin permission to view configuration" + }, + "404": { + "description": "Configuration not found" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Get value of all dynamic configurations' value overridden on local config", + "tags": [ + "brokers" + ] + } + }, + "/brokers/configuration/{configName}": { + "delete": { + "description": "", + "operationId": "BrokersBase_deleteDynamicConfiguration", + "parameters": [ + { + "in": "path", + "name": "configName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Service configuration delete successfully" + }, + "403": { + "description": "You don't have admin permission to update service-configuration" + }, + "412": { + "description": "Invalid dynamic-config value" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Delete dynamic ServiceConfiguration into metadata only. This operation requires Pulsar super-user privileges.", + "tags": [ + "brokers" + ] + } + }, + "/brokers/configuration/{configName}/{configValue}": { + "post": { + "description": "", + "operationId": "BrokersBase_updateDynamicConfiguration", + "parameters": [ + { + "in": "path", + "name": "configName", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "configValue", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Service configuration updated successfully" + }, + "403": { + "description": "You don't have admin permission to update service-configuration" + }, + "404": { + "description": "Configuration not found" + }, + "412": { + "description": "Invalid dynamic-config value" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Update dynamic serviceconfiguration into zk only. This operation requires Pulsar super-user privileges.", + "tags": [ + "brokers" + ] + } + }, + "/brokers/health": { + "get": { + "description": "", + "operationId": "BrokersBase_healthCheck", + "parameters": [ + { + "description": "Topic Version", + "enum": [ + "V1", + "V2" + ], + "in": "query", + "name": "topicVersion", + "required": false, + "type": "string" + }, + { + "in": "query", + "name": "brokerId", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Everything is OK" + }, + "307": { + "description": "Current broker is not the target broker" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Cluster doesn't exist" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Run a healthCheck against the broker", + "tags": [ + "brokers" + ] + } + }, + "/brokers/internal-configuration": { + "get": { + "description": "", + "operationId": "BrokersBase_getInternalConfigurationData", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/InternalConfigurationData" + } + }, + "403": { + "description": "Don't have admin permission" + } + }, + "summary": "Get the internal configuration data", + "tags": [ + "brokers" + ] + } + }, + "/brokers/leaderBroker": { + "get": { + "description": "", + "operationId": "BrokersBase_getLeaderBroker", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/BrokerInfo" + } + }, + "401": { + "description": "Authentication required" + }, + "403": { + "description": "This operation requires super-user access" + }, + "404": { + "description": "Leader broker not found" + } + }, + "summary": "Get the information of the leader broker.", + "tags": [ + "brokers" + ] + } + }, + "/brokers/ready": { + "get": { + "description": "", + "operationId": "BrokersBase_isReady", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Broker is ready" + }, + "500": { + "description": "Broker is not ready" + } + }, + "summary": "Check if the broker is fully initialized", + "tags": [ + "brokers" + ] + } + }, + "/brokers/shutdown": { + "post": { + "description": "", + "operationId": "BrokersBase_shutDownBrokerGracefully", + "parameters": [ + { + "description": "if the value absent(value=0) means no concurrent limitation.", + "format": "int32", + "in": "query", + "name": "maxConcurrentUnloadPerSec", + "required": false, + "type": "integer" + }, + { + "default": true, + "in": "query", + "name": "forcedTerminateTopic", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Execute shutdown command successfully" + }, + "403": { + "description": "You don't have admin permission to update service-configuration" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Shutdown broker gracefully.", + "tags": [ + "brokers" + ] + } + }, + "/brokers/version": { + "get": { + "description": "", + "operationId": "BrokersBase_version", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Pulsar version", + "schema": { + "type": "string" + } + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Get version of current broker", + "tags": [ + "brokers" + ] + } + }, + "/brokers/{clusterName}/{brokerId}/ownedNamespaces": { + "get": { + "description": "", + "operationId": "BrokersBase_getOwnedNamespaces", + "parameters": [ + { + "in": "path", + "name": "clusterName", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "brokerId", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "additionalProperties": { + "$ref": "#/definitions/NamespaceOwnershipStatus" + }, + "type": "object" + } + }, + "307": { + "description": "Current broker doesn't serve the cluster" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Cluster doesn't exist" + } + }, + "summary": "Get the list of namespaces served by the specific broker id", + "tags": [ + "brokers" + ] + } + }, + "/brokers/{cluster}": { + "get": { + "description": "", + "operationId": "BrokersBase_getActiveBrokers", + "parameters": [ + { + "in": "path", + "name": "cluster", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "307": { + "description": "Current broker doesn't serve this cluster" + }, + "401": { + "description": "Authentication required" + }, + "403": { + "description": "This operation requires super-user access" + }, + "404": { + "description": "Cluster does not exist: cluster={clustername}" + } + }, + "summary": "Get the list of active brokers (broker ids) in the cluster.If authorization is not enabled, any cluster name is valid.", + "tags": [ + "brokers" + ] + } + }, + "/clusters": { + "get": { + "description": "", + "operationId": "ClustersBase_getClusters", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Return a list of clusters.", + "schema": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "500": { + "description": "Internal server error." + } + }, + "summary": "Get the list of all the Pulsar clusters.", + "tags": [ + "clusters" + ] + } + }, + "/clusters/{cluster}": { + "delete": { + "description": "This operation requires Pulsar superuser privileges.", + "operationId": "ClustersBase_deleteCluster", + "parameters": [ + { + "description": "The cluster name", + "in": "path", + "name": "cluster", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Cluster has been deleted." + }, + "403": { + "description": "Don't have admin permission or policies are read-only." + }, + "404": { + "description": "Cluster doesn't exist." + }, + "412": { + "description": "Cluster is not empty." + }, + "500": { + "description": "Internal server error." + } + }, + "summary": "Delete an existing cluster.", + "tags": [ + "clusters" + ] + }, + "get": { + "description": "This operation requires Pulsar superuser privileges.", + "operationId": "ClustersBase_getCluster", + "parameters": [ + { + "description": "The cluster name", + "in": "path", + "name": "cluster", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Return the cluster data.", + "schema": { + "$ref": "#/definitions/ClusterData" + } + }, + "403": { + "description": "Don't have admin permission." + }, + "404": { + "description": "Cluster doesn't exist." + }, + "500": { + "description": "Internal server error." + } + }, + "summary": "Get the configuration for the specified cluster.", + "tags": [ + "clusters" + ] + }, + "post": { + "description": "This operation requires Pulsar superuser privileges.", + "operationId": "ClustersBase_updateCluster", + "parameters": [ + { + "description": "The cluster name", + "in": "path", + "name": "cluster", + "required": true, + "type": "string" + }, + { + "description": "The cluster data", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterData" + }, + "x-examples": { + "application/json": "{\n \"serviceUrl\": \"http://pulsar.example.com:8080\",\n \"brokerServiceUrl\": \"pulsar://pulsar.example.com:6651\"\n}" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Cluster has been updated." + }, + "400": { + "description": "Bad request parameter." + }, + "403": { + "description": "Don't have admin permission or policies are read-only." + }, + "404": { + "description": "Cluster doesn't exist." + }, + "500": { + "description": "Internal server error." + } + }, + "summary": "Update the configuration for a cluster.", + "tags": [ + "clusters" + ] + }, + "put": { + "description": "This operation requires Pulsar superuser privileges, and the name cannot contain the '/' characters.", + "operationId": "ClustersBase_createCluster", + "parameters": [ + { + "description": "The cluster name", + "in": "path", + "name": "cluster", + "required": true, + "type": "string" + }, + { + "description": "The cluster data", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterData" + }, + "x-examples": { + "application/json": "{\n \"serviceUrl\": \"http://pulsar.example.com:8080\",\n \"brokerServiceUrl\": \"pulsar://pulsar.example.com:6651\",\n}" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Cluster has been created." + }, + "400": { + "description": "Bad request parameter." + }, + "403": { + "description": "You don't have admin permission to create the cluster." + }, + "409": { + "description": "Cluster already exists." + }, + "412": { + "description": "Cluster name is not valid." + }, + "500": { + "description": "Internal server error." + } + }, + "summary": "Create a new cluster.", + "tags": [ + "clusters" + ] + } + }, + "/clusters/{cluster}/failureDomains": { + "get": { + "description": "This operation requires Pulsar superuser privileges.", + "operationId": "ClustersBase_getFailureDomains", + "parameters": [ + { + "description": "The cluster name", + "in": "path", + "name": "cluster", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "additionalProperties": { + "$ref": "#/definitions/FailureDomain" + }, + "type": "object" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Get the cluster failure domains.", + "tags": [ + "clusters" + ] + } + }, + "/clusters/{cluster}/failureDomains/{domainName}": { + "delete": { + "description": "This operation requires Pulsar superuser privileges.", + "operationId": "ClustersBase_deleteFailureDomain", + "parameters": [ + { + "description": "The cluster name", + "in": "path", + "name": "cluster", + "required": true, + "type": "string" + }, + { + "description": "The failure domain name", + "in": "path", + "name": "domainName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Delete the failure domain of the cluster successfully" + }, + "403": { + "description": "Don't have admin permission or policy is read only" + }, + "404": { + "description": "FailureDomain doesn't exist" + }, + "412": { + "description": "Cluster doesn't exist" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Delete the failure domain of the cluster", + "tags": [ + "clusters" + ] + }, + "get": { + "description": "This operation requires Pulsar superuser privileges.", + "operationId": "ClustersBase_getDomain", + "parameters": [ + { + "description": "The cluster name", + "in": "path", + "name": "cluster", + "required": true, + "type": "string" + }, + { + "description": "The failure domain name", + "in": "path", + "name": "domainName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/FailureDomain" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "FailureDomain doesn't exist" + }, + "412": { + "description": "Cluster doesn't exist" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Get a domain in a cluster", + "tags": [ + "clusters" + ] + }, + "post": { + "description": "This operation requires Pulsar superuser privileges.", + "operationId": "ClustersBase_setFailureDomain", + "parameters": [ + { + "description": "The cluster name", + "in": "path", + "name": "cluster", + "required": true, + "type": "string" + }, + { + "description": "The failure domain name", + "in": "path", + "name": "domainName", + "required": true, + "type": "string" + }, + { + "description": "The configuration data of a failure domain", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FailureDomain" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Set the failure domain of the cluster successfully." + }, + "403": { + "description": "Don't have admin permission." + }, + "404": { + "description": "Failure domain doesn't exist." + }, + "409": { + "description": "Broker already exists in another domain." + }, + "412": { + "description": "Cluster doesn't exist." + }, + "500": { + "description": "Internal server error." + } + }, + "summary": "Set the failure domain of the cluster.", + "tags": [ + "clusters" + ] + } + }, + "/clusters/{cluster}/migrate": { + "get": { + "description": "This operation requires Pulsar superuser privileges.", + "operationId": "ClustersBase_getClusterMigration", + "parameters": [ + { + "description": "The cluster name", + "in": "path", + "name": "cluster", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Return the cluster data.", + "schema": { + "$ref": "#/definitions/ClusterData" + } + }, + "403": { + "description": "Don't have admin permission." + }, + "404": { + "description": "Cluster doesn't exist." + }, + "500": { + "description": "Internal server error." + } + }, + "summary": "Get the cluster migration configuration for the specified cluster.", + "tags": [ + "clusters" + ] + }, + "post": { + "description": "This operation requires Pulsar superuser privileges.", + "operationId": "ClustersBase_updateClusterMigration", + "parameters": [ + { + "description": "The cluster name", + "in": "path", + "name": "cluster", + "required": true, + "type": "string" + }, + { + "description": "Is cluster migrated", + "in": "query", + "name": "migrated", + "required": true, + "type": "boolean" + }, + { + "description": "The cluster url data", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterUrl" + }, + "x-examples": { + "application/json": "{\n \"serviceUrl\": \"http://pulsar.example.com:8080\",\n \"brokerServiceUrl\": \"pulsar://pulsar.example.com:6651\"\n}" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Cluster has been updated." + }, + "400": { + "description": "Cluster url must not be empty." + }, + "403": { + "description": "Don't have admin permission or policies are read-only." + }, + "404": { + "description": "Cluster doesn't exist." + }, + "500": { + "description": "Internal server error." + } + }, + "summary": "Update the configuration for a cluster migration.", + "tags": [ + "clusters" + ] + } + }, + "/clusters/{cluster}/namespaceIsolationPolicies": { + "get": { + "description": "This operation requires Pulsar superuser privileges.", + "operationId": "ClustersBase_getNamespaceIsolationPolicies", + "parameters": [ + { + "description": "The cluster name", + "in": "path", + "name": "cluster", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "additionalProperties": { + "$ref": "#/definitions/NamespaceIsolationData" + }, + "type": "object" + } + }, + "403": { + "description": "Don't have admin permission." + }, + "404": { + "description": "Cluster doesn't exist." + }, + "500": { + "description": "Internal server error." + } + }, + "summary": "Get the namespace isolation policies assigned to the cluster.", + "tags": [ + "clusters" + ] + } + }, + "/clusters/{cluster}/namespaceIsolationPolicies/brokers": { + "get": { + "description": "This operation requires Pulsar superuser privileges.", + "operationId": "ClustersBase_getBrokersWithNamespaceIsolationPolicy", + "parameters": [ + { + "description": "The cluster name", + "in": "path", + "name": "cluster", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "$ref": "#/definitions/BrokerNamespaceIsolationData" + }, + "type": "array", + "uniqueItems": true + } + }, + "403": { + "description": "Don't have admin permission." + }, + "404": { + "description": "Namespace-isolation policies not found." + }, + "412": { + "description": "Cluster doesn't exist." + }, + "500": { + "description": "Internal server error." + } + }, + "summary": "Get list of brokers with namespace-isolation policies attached to them.", + "tags": [ + "clusters" + ] + } + }, + "/clusters/{cluster}/namespaceIsolationPolicies/brokers/{broker}": { + "get": { + "description": "This operation requires Pulsar superuser privileges.", + "operationId": "ClustersBase_getBrokerWithNamespaceIsolationPolicy", + "parameters": [ + { + "description": "The cluster name", + "in": "path", + "name": "cluster", + "required": true, + "type": "string" + }, + { + "description": "The broker name (:)", + "in": "path", + "name": "broker", + "required": true, + "type": "string", + "x-example": "broker1:8080" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/BrokerNamespaceIsolationData" + } + }, + "403": { + "description": "Don't have admin permission." + }, + "404": { + "description": "Namespace-isolation policies/ Broker not found." + }, + "412": { + "description": "Cluster doesn't exist." + }, + "500": { + "description": "Internal server error." + } + }, + "summary": "Get a broker with namespace-isolation policies attached to it.", + "tags": [ + "clusters" + ] + } + }, + "/clusters/{cluster}/namespaceIsolationPolicies/{policyName}": { + "delete": { + "description": "This operation requires Pulsar superuser privileges.", + "operationId": "ClustersBase_deleteNamespaceIsolationPolicy", + "parameters": [ + { + "description": "The cluster name", + "in": "path", + "name": "cluster", + "required": true, + "type": "string" + }, + { + "description": "The namespace isolation policy name", + "in": "path", + "name": "policyName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Delete namespace isolation policy successfully." + }, + "403": { + "description": "Don't have admin permission or policies are read only." + }, + "404": { + "description": "Namespace isolation policy doesn't exist." + }, + "412": { + "description": "Cluster doesn't exist." + }, + "500": { + "description": "Internal server error." + } + }, + "summary": "Delete namespace isolation policy.", + "tags": [ + "clusters" + ] + }, + "get": { + "description": "This operation requires Pulsar superuser privileges.", + "operationId": "ClustersBase_getNamespaceIsolationPolicy", + "parameters": [ + { + "description": "The cluster name", + "in": "path", + "name": "cluster", + "required": true, + "type": "string" + }, + { + "description": "The name of the namespace isolation policy", + "in": "path", + "name": "policyName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/NamespaceIsolationData" + } + }, + "403": { + "description": "Don't have admin permission." + }, + "404": { + "description": "Policy doesn't exist." + }, + "412": { + "description": "Cluster doesn't exist." + }, + "500": { + "description": "Internal server error." + } + }, + "summary": "Get the single namespace isolation policy assigned to the cluster.", + "tags": [ + "clusters" + ] + }, + "post": { + "description": "This operation requires Pulsar superuser privileges.", + "operationId": "ClustersBase_setNamespaceIsolationPolicy", + "parameters": [ + { + "description": "The cluster name", + "in": "path", + "name": "cluster", + "required": true, + "type": "string" + }, + { + "description": "The namespace isolation policy name", + "in": "path", + "name": "policyName", + "required": true, + "type": "string" + }, + { + "description": "The namespace isolation policy data", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NamespaceIsolationData" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Set namespace isolation policy successfully." + }, + "400": { + "description": "Namespace isolation policy data is invalid." + }, + "403": { + "description": "Don't have admin permission or policies are read-only." + }, + "404": { + "description": "Namespace isolation policy doesn't exist." + }, + "412": { + "description": "Cluster doesn't exist." + }, + "500": { + "description": "Internal server error." + } + }, + "summary": "Set namespace isolation policy.", + "tags": [ + "clusters" + ] + } + }, + "/clusters/{cluster}/peers": { + "get": { + "description": "This operation requires Pulsar superuser privileges.", + "operationId": "ClustersBase_getPeerCluster", + "parameters": [ + { + "description": "The cluster name", + "in": "path", + "name": "cluster", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "403": { + "description": "Don't have admin permission." + }, + "404": { + "description": "Cluster doesn't exist." + }, + "500": { + "description": "Internal server error." + } + }, + "summary": "Get the peer-cluster data for the specified cluster.", + "tags": [ + "clusters" + ] + }, + "post": { + "description": "This operation requires Pulsar superuser privileges.", + "operationId": "ClustersBase_setPeerClusterNames", + "parameters": [ + { + "description": "The cluster name", + "in": "path", + "name": "cluster", + "required": true, + "type": "string" + }, + { + "description": "The list of peer cluster names", + "in": "body", + "name": "body", + "required": true, + "schema": { + "items": { + "type": "string" + }, + "type": "array" + }, + "x-examples": { + "application/json": "[\n \"cluster-a\",\n \"cluster-b\"\n]" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Cluster has been updated." + }, + "403": { + "description": "Don't have admin permission or policies are read-only." + }, + "404": { + "description": "Cluster doesn't exist." + }, + "412": { + "description": "Peer cluster doesn't exist." + }, + "500": { + "description": "Internal server error." + } + }, + "summary": "Update peer-cluster-list for a cluster.", + "tags": [ + "clusters" + ] + } + }, + "/namespaces/grantPermissionsOnTopics": { + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_grantPermissionsOnTopics", + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "tenant/namespace/topic doesn't exit" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Grant new permissions to a role on multi-topics.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/revokePermissionsOnTopics": { + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_revokePermissionsOnTopics", + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "tenant/namespace/topic doesn't exit" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Revoke new permissions to a role on multi-topics.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{cluster}/antiAffinity/{group}": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getAntiAffinityNamespaces", + "parameters": [ + { + "in": "path", + "name": "cluster", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "group", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "tenant", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "412": { + "description": "Cluster not exist/Anti-affinity group can't be empty." + } + }, + "summary": "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", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{property}/{namespace}/persistence/bookieAffinity": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_deleteBookieAffinityGroup", + "parameters": [ + { + "in": "path", + "name": "property", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Delete the bookie-affinity-group from namespace-local policy.", + "tags": [ + "namespaces" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getBookieAffinityGroup", + "parameters": [ + { + "in": "path", + "name": "property", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/BookieAffinityGroupDataImpl" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Get the bookie-affinity-group from namespace-local policy.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getTenantNamespaces", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant doesn't exist" + } + }, + "summary": "Get the list of all the namespaces for a certain tenant.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_deleteNamespace", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "force", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + }, + "405": { + "description": "Broker doesn't allow forced deletion of namespaces" + }, + "409": { + "description": "Namespace is not empty" + } + }, + "summary": "Delete a namespace and all the topics under it.", + "tags": [ + "namespaces" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getPolicies", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/Policies" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + } + }, + "summary": "Get the dump all the policies specified for a namespace.", + "tags": [ + "namespaces" + ] + }, + "put": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_createNamespace", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Policies for the namespace", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/Policies" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster doesn't exist" + }, + "409": { + "description": "Namespace already exists" + }, + "412": { + "description": "Namespace name is not valid" + } + }, + "summary": "Creates a new namespace with the specified policies", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/allowedClusters": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getNamespaceAllowedClusters", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + }, + "412": { + "description": "Namespace is not global" + } + }, + "summary": "Get the allowed clusters for a namespace.", + "tags": [ + "namespaces" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_setNamespaceAllowedClusters", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "List of allowed clusters", + "in": "body", + "name": "body", + "required": true, + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "400": { + "description": "The list of allowed clusters should include all replication clusters." + }, + "403": { + "description": "The requester does not have admin permissions." + }, + "404": { + "description": "The specified tenant, cluster, or namespace does not exist." + }, + "409": { + "description": "A peer-cluster cannot be part of an allowed-cluster." + }, + "412": { + "description": "The namespace is not global or the provided cluster IDs are invalid." + } + }, + "summary": "Set the allowed clusters for a namespace.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/antiAffinity": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_removeNamespaceAntiAffinityGroup", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove anti-affinity group of a namespace.", + "tags": [ + "namespaces" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getNamespaceAntiAffinityGroup", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "type": "string" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + } + }, + "summary": "Get anti-affinity group of a namespace.", + "tags": [ + "namespaces" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_setNamespaceAntiAffinityGroup", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Anti-affinity group for the specified namespace", + "in": "body", + "name": "body", + "required": true, + "schema": { + "type": "string" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + }, + "412": { + "description": "Invalid antiAffinityGroup" + } + }, + "summary": "Set anti-affinity group for a namespace", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/autoSubscriptionCreation": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_removeAutoSubscriptionCreation", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + } + }, + "summary": "Remove override of broker's allowAutoSubscriptionCreation in a namespace", + "tags": [ + "namespaces" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getAutoSubscriptionCreation", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/AutoSubscriptionCreationOverrideImpl" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or namespace doesn't exist" + } + }, + "summary": "Get autoSubscriptionCreation info in a namespace", + "tags": [ + "namespaces" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_setAutoSubscriptionCreation", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Settings for automatic subscription creation", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/AutoSubscriptionCreationOverride" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "400": { + "description": "Invalid autoSubscriptionCreation override" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + } + }, + "summary": "Override broker's allowAutoSubscriptionCreation setting for a namespace", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/autoTopicCreation": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_removeAutoTopicCreation", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + } + }, + "summary": "Remove override of broker's allowAutoTopicCreation in a namespace", + "tags": [ + "namespaces" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getAutoTopicCreation", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/AutoTopicCreationOverrideImpl" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or namespace doesn't exist" + } + }, + "summary": "Get autoTopicCreation info in a namespace", + "tags": [ + "namespaces" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_setAutoTopicCreation", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Settings for automatic topic creation", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AutoTopicCreationOverride" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "400": { + "description": "Invalid autoTopicCreation override" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + }, + "406": { + "description": "The number of partitions should be less than or equal to maxNumPartitionsPerPartitionedTopic" + } + }, + "summary": "Override broker's allowAutoTopicCreation setting for a namespace", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/backlogQuota": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_removeBacklogQuota", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "enum": [ + "destination_storage", + "message_age" + ], + "in": "query", + "name": "backlogQuotaType", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove a backlog quota policy from a namespace.", + "tags": [ + "namespaces" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_setBacklogQuota", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "enum": [ + "destination_storage", + "message_age" + ], + "in": "query", + "name": "backlogQuotaType", + "required": false, + "type": "string" + }, + { + "description": "Backlog quota for all topics of the specified namespace", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/BacklogQuota" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "Specified backlog quota exceeds retention quota. Increase retention quota and retry request" + } + }, + "summary": " Set a backlog quota for all the topics on a namespace.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/backlogQuotaMap": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getBacklogQuotaMap", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "additionalProperties": { + "$ref": "#/definitions/BacklogQuotaImpl" + }, + "type": "object" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + } + }, + "summary": "Get backlog quota map on a namespace.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/bundles": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getBundlesData", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/BundlesDataImpl" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + }, + "412": { + "description": "Namespace is not setup to split in bundles" + } + }, + "summary": "Get the bundles split data.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/clearBacklog": { + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_clearNamespaceBacklog", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin or operate permission on the namespace" + }, + "404": { + "description": "Namespace does not exist" + } + }, + "summary": "Clear backlog for all topics on a namespace.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/clearBacklog/{subscription}": { + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_clearNamespaceBacklogForSubscription", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "subscription", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin or operate permission on the namespace" + }, + "404": { + "description": "Namespace does not exist" + } + }, + "summary": "Clear backlog for a given subscription on all topics on a namespace.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/compactionThreshold": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "The backlog size is compared to the threshold periodically. A threshold of 0 disabled automatic compaction", + "operationId": "Namespaces_deleteCompactionThreshold", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace doesn't exist" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Delete maximum number of uncompacted bytes in a topic before compaction is triggered.", + "tags": [ + "namespaces" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "The backlog size is compared to the threshold periodically. A threshold of 0 disabled automatic compaction", + "operationId": "Namespaces_getCompactionThreshold", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int64", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace doesn't exist" + } + }, + "summary": "Maximum number of uncompacted bytes in topics before compaction is triggered.", + "tags": [ + "namespaces" + ] + }, + "put": { + "consumes": [ + "application/json" + ], + "description": "The backlog size is compared to the threshold periodically. A threshold of 0 disabled automatic compaction", + "operationId": "Namespaces_setCompactionThreshold", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Maximum number of uncompacted bytes in a topic of the specified namespace", + "in": "body", + "name": "body", + "required": true, + "schema": { + "format": "int64", + "type": "integer" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace doesn't exist" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "compactionThreshold value is not valid" + } + }, + "summary": "Set maximum number of uncompacted bytes in a topic before compaction is triggered.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/deduplication": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_removeDeduplication", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + } + }, + "summary": "Remove broker side deduplication for all topics in a namespace", + "tags": [ + "namespaces" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getDeduplication", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "type": "boolean" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + } + }, + "summary": "Get broker side deduplication for all topics in a namespace", + "tags": [ + "namespaces" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_modifyDeduplication", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Flag for disabling or enabling broker side deduplication for all topics in the specified namespace", + "in": "body", + "name": "body", + "required": true, + "schema": { + "type": "boolean" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + } + }, + "summary": "Enable or disable broker side deduplication for all topics in a namespace", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/deduplicationSnapshotInterval": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getDeduplicationSnapshotInterval", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int32", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + } + }, + "summary": "Get deduplicationSnapshotInterval config on a namespace.", + "tags": [ + "namespaces" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_setDeduplicationSnapshotInterval", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Interval to take deduplication snapshot per topic", + "in": "body", + "name": "body", + "required": true, + "schema": { + "format": "int32", + "type": "integer" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + } + }, + "summary": "Set deduplicationSnapshotInterval config on a namespace.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/delayedDelivery": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_removeDelayedDeliveryPolicies", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + } + }, + "summary": "Delete delayed delivery messages config on a namespace.", + "tags": [ + "namespaces" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getDelayedDeliveryPolicies", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/DelayedDeliveryPolicies" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Get delayed delivery messages config on a namespace.", + "tags": [ + "namespaces" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_setDelayedDeliveryPolicies", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Delayed delivery policies for the specified namespace", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/DelayedDeliveryPolicies" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + } + }, + "summary": "Set delayed delivery messages config on a namespace.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/dispatchRate": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_deleteDispatchRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + } + }, + "summary": "Delete dispatch-rate throttling for all topics of the namespace", + "tags": [ + "namespaces" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getDispatchRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/DispatchRate" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + } + }, + "summary": "Get dispatch-rate configured for the namespace, null means dispatch-rate not configured, -1 means msg-dispatch-rate or byte-dispatch-rate not configured in dispatch-rate yet", + "tags": [ + "namespaces" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_setDispatchRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Dispatch rate for all topics of the specified namespace", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/DispatchRateImpl" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + } + }, + "summary": "Set dispatch-rate throttling for all topics of the namespace", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/dispatcherPauseOnAckStatePersistent": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_removeDispatcherPauseOnAckStatePersistent", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove dispatcher pause on ack state persistent configuration for specified namespace.", + "tags": [ + "namespaces" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getDispatcherPauseOnAckStatePersistent", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "type": "boolean" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + } + }, + "summary": "Get dispatcher pause on ack state persistent config on a namespace.", + "tags": [ + "namespaces" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_setDispatcherPauseOnAckStatePersistent", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Set dispatcher pause on ack state persistent configuration for specified namespace.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/encryptionRequired": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getEncryptionRequired", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "type": "boolean" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or namespace doesn't exist" + } + }, + "summary": "Get message encryption required status in a namespace", + "tags": [ + "namespaces" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_modifyEncryptionRequired", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Flag defining if message encryption is required", + "in": "body", + "name": "body", + "required": true, + "schema": { + "type": "boolean" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Message encryption is required or not for all topics in a namespace", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/entryFilters": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_removeNamespaceEntryFilters", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + }, + "412": { + "description": "Invalid TTL" + } + }, + "summary": "Remove entry filters for namespace", + "tags": [ + "namespaces" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getEntryFiltersPerTopic", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/EntryFilters" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + } + }, + "summary": "Get maxConsumersPerSubscription config on a namespace.", + "tags": [ + "namespaces" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_setEntryFiltersPerTopic", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "entry filters", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/EntryFilters" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "400": { + "description": "Specified entry filters are not valid" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + } + }, + "summary": "Set entry filters for namespace", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/inactiveTopicPolicies": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_removeInactiveTopicPolicies", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove inactive topic policies from a namespace.", + "tags": [ + "namespaces" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getInactiveTopicPolicies", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/InactiveTopicPolicies" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Get inactive topic policies config on a namespace.", + "tags": [ + "namespaces" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_setInactiveTopicPolicies", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Inactive topic policies for the specified namespace", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/InactiveTopicPolicies" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + } + }, + "summary": "Set inactive topic policies config on a namespace.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/isAllowAutoUpdateSchema": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getIsAllowAutoUpdateSchema", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "type": "boolean" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace doesn't exist" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "The flag of whether allow auto update schema", + "tags": [ + "namespaces" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_setIsAllowAutoUpdateSchema", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Flag of whether to allow auto update schema", + "in": "body", + "name": "body", + "required": true, + "schema": { + "type": "boolean" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace doesn't exist" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Update flag of whether allow auto update schema", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/maxConsumersPerSubscription": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_removeMaxConsumersPerSubscription", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "maxConsumersPerSubscription value is not valid" + } + }, + "summary": " Set maxConsumersPerSubscription configuration on a namespace.", + "tags": [ + "namespaces" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getMaxConsumersPerSubscription", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int32", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + } + }, + "summary": "Get maxConsumersPerSubscription config on a namespace.", + "tags": [ + "namespaces" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_setMaxConsumersPerSubscription", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Number of maximum consumers per subscription", + "in": "body", + "name": "body", + "required": true, + "schema": { + "format": "int32", + "type": "integer" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "maxConsumersPerSubscription value is not valid" + } + }, + "summary": " Set maxConsumersPerSubscription configuration on a namespace.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/maxConsumersPerTopic": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_removeMaxConsumersPerTopic", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove maxConsumersPerTopic configuration on a namespace.", + "tags": [ + "namespaces" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getMaxConsumersPerTopic", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int32", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + } + }, + "summary": "Get maxConsumersPerTopic config on a namespace.", + "tags": [ + "namespaces" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_setMaxConsumersPerTopic", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Number of maximum consumers per topic", + "in": "body", + "name": "body", + "required": true, + "schema": { + "format": "int32", + "type": "integer" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "maxConsumersPerTopic value is not valid" + } + }, + "summary": " Set maxConsumersPerTopic configuration on a namespace.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/maxProducersPerTopic": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_removeMaxProducersPerTopic", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove maxProducersPerTopic configuration on a namespace.", + "tags": [ + "namespaces" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getMaxProducersPerTopic", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int32", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + } + }, + "summary": "Get maxProducersPerTopic config on a namespace.", + "tags": [ + "namespaces" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_setMaxProducersPerTopic", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Number of maximum producers per topic", + "in": "body", + "name": "body", + "required": true, + "schema": { + "format": "int32", + "type": "integer" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "maxProducersPerTopic value is not valid" + } + }, + "summary": " Set maxProducersPerTopic configuration on a namespace.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/maxSubscriptionsPerTopic": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_removeMaxSubscriptionsPerTopic", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove maxSubscriptionsPerTopic configuration on a namespace.", + "tags": [ + "namespaces" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getMaxSubscriptionsPerTopic", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int32", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + } + }, + "summary": "Get maxSubscriptionsPerTopic config on a namespace.", + "tags": [ + "namespaces" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_setMaxSubscriptionsPerTopic", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Number of maximum subscriptions per topic", + "in": "body", + "name": "body", + "required": true, + "schema": { + "format": "int32", + "type": "integer" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "maxUnackedMessagesPerSubscription value is not valid" + } + }, + "summary": " Set maxSubscriptionsPerTopic configuration on a namespace.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/maxTopicsPerNamespace": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_removeMaxTopicsPerNamespace", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or namespace doesn't exist" + } + }, + "summary": "Remove maxTopicsPerNamespace config on a namespace.", + "tags": [ + "namespaces" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getMaxTopicsPerNamespace", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int32", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or namespace does not exist" + } + }, + "summary": "Get maxTopicsPerNamespace config on a namespace.", + "tags": [ + "namespaces" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_setMaxTopicsPerNamespace", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Number of maximum topics for specific namespace", + "in": "body", + "name": "body", + "required": true, + "schema": { + "format": "int32", + "type": "integer" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or namespace doesn't exist" + } + }, + "summary": "Set maxTopicsPerNamespace config on a namespace.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/maxUnackedMessagesPerConsumer": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_removeMaxUnackedmessagesPerConsumer", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + } + }, + "summary": "Remove maxUnackedMessagesPerConsumer config on a namespace.", + "tags": [ + "namespaces" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getMaxUnackedMessagesPerConsumer", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int32", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + } + }, + "summary": "Get maxUnackedMessagesPerConsumer config on a namespace.", + "tags": [ + "namespaces" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_setMaxUnackedMessagesPerConsumer", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Number of maximum unacked messages per consumer", + "in": "body", + "name": "body", + "required": true, + "schema": { + "format": "int32", + "type": "integer" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "maxUnackedMessagesPerConsumer value is not valid" + } + }, + "summary": " Set maxConsumersPerTopic configuration on a namespace.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/maxUnackedMessagesPerSubscription": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_removeMaxUnackedmessagesPerSubscription", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + } + }, + "summary": "Remove maxUnackedMessagesPerSubscription config on a namespace.", + "tags": [ + "namespaces" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getMaxUnackedmessagesPerSubscription", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int32", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + } + }, + "summary": "Get maxUnackedMessagesPerSubscription config on a namespace.", + "tags": [ + "namespaces" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_setMaxUnackedMessagesPerSubscription", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Number of maximum unacked messages per subscription", + "in": "body", + "name": "body", + "required": true, + "schema": { + "format": "int32", + "type": "integer" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "maxUnackedMessagesPerSubscription value is not valid" + } + }, + "summary": " Set maxUnackedMessagesPerSubscription configuration on a namespace.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/messageTTL": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_removeNamespaceMessageTTL", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + }, + "412": { + "description": "Invalid TTL" + } + }, + "summary": "Remove message TTL in seconds for namespace", + "tags": [ + "namespaces" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getNamespaceMessageTTL", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int32", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + } + }, + "summary": "Get the message TTL for the namespace", + "tags": [ + "namespaces" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_setNamespaceMessageTTL", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "TTL in seconds for the specified namespace", + "in": "body", + "name": "body", + "required": true, + "schema": { + "format": "int32", + "type": "integer" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + }, + "412": { + "description": "Invalid TTL" + } + }, + "summary": "Set message TTL in seconds for namespace", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/offloadDeletionLagMs": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_clearOffloadDeletionLag", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace doesn't exist" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Clear the namespace configured offload deletion lag. The topics in the namespace will fallback to using the default configured deletion lag for the broker", + "tags": [ + "namespaces" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "A negative value denotes that deletion has been completely disabled. 'null' denotes that the topics in the namespace will fall back to the broker default for deletion lag.", + "operationId": "Namespaces_getOffloadDeletionLag", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int64", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace doesn't exist" + } + }, + "summary": "Number of milliseconds to wait before deleting a ledger segment which has been offloaded from the Pulsar cluster's local storage (i.e. BookKeeper)", + "tags": [ + "namespaces" + ] + }, + "put": { + "consumes": [ + "application/json" + ], + "description": "A negative value disables the deletion completely.", + "operationId": "Namespaces_setOffloadDeletionLag", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "New number of milliseconds to wait before deleting a ledger segment which has been offloaded", + "in": "body", + "name": "body", + "required": true, + "schema": { + "format": "int64", + "type": "integer" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace doesn't exist" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "offloadDeletionLagMs value is not valid" + } + }, + "summary": "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)", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/offloadPolicies": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getOffloadPolicies", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/OffloadPolicies" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + } + }, + "summary": "Get offload configuration on a namespace.", + "tags": [ + "namespaces" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_setOffloadPolicies", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Offload policies for the specified namespace", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/OffloadPoliciesImpl" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "OffloadPolicies is empty or driver is not supported or bucket is not valid" + } + }, + "summary": "Set offload configuration on a namespace.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/offloadThreshold": { + "get": { + "consumes": [ + "application/json" + ], + "description": "A negative value disables automatic offloading", + "operationId": "Namespaces_getOffloadThreshold", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int64", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace doesn't exist" + } + }, + "summary": "Maximum number of bytes stored on the pulsar cluster for a topic, before the broker will start offloading to longterm storage", + "tags": [ + "namespaces" + ] + }, + "put": { + "consumes": [ + "application/json" + ], + "description": "-1 will revert to using the cluster default. A negative value disables automatic offloading. ", + "operationId": "Namespaces_setOffloadThreshold", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Maximum number of bytes stored on the pulsar cluster for a topic of the specified namespace", + "in": "body", + "name": "body", + "required": true, + "schema": { + "format": "int64", + "type": "integer" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace doesn't exist" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "offloadThreshold value is not valid" + } + }, + "summary": "Set maximum number of bytes stored on the pulsar cluster for a topic, before the broker will start offloading to longterm storage", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/offloadThresholdInSeconds": { + "get": { + "consumes": [ + "application/json" + ], + "description": "A negative value disables automatic offloading", + "operationId": "Namespaces_getOffloadThresholdInSeconds", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int64", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace doesn't exist" + } + }, + "summary": "Maximum number of bytes stored on the pulsar cluster for a topic, before the broker will start offloading to longterm storage", + "tags": [ + "namespaces" + ] + }, + "put": { + "consumes": [ + "application/json" + ], + "description": "A negative value disables automatic offloading", + "operationId": "Namespaces_setOffloadThresholdInSeconds", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace doesn't exist" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "offloadThresholdInSeconds value is not valid" + } + }, + "summary": "Set maximum number of seconds stored on the pulsar cluster for a topic, before the broker will start offloading to longterm storage", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/permissions": { + "get": { + "consumes": [ + "application/json" + ], + "description": "Returns a nested map structure which Swagger does not fully support for display. Structure: Map>. Please refer to this structure for details.", + "operationId": "Namespaces_getPermissions", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "additionalProperties": { + "enum": [ + "produce", + "consume", + "functions", + "sources", + "sinks", + "packages" + ], + "type": "string" + }, + "type": "object" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + }, + "409": { + "description": "Namespace is not empty" + } + }, + "summary": "Retrieve the permissions for a namespace.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/permissions/subscription": { + "get": { + "consumes": [ + "application/json" + ], + "description": "Returns a nested map structure which Swagger does not fully support for display. Structure: Map>. Please refer to this structure for details.", + "operationId": "Namespaces_getPermissionOnSubscription", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + }, + "409": { + "description": "Namespace is not empty" + } + }, + "summary": "Retrieve the permissions for a subscription.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/permissions/{role}": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_revokePermissionsOnNamespace", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "role", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + } + }, + "summary": "Revoke all permissions to a role on a namespace.", + "tags": [ + "namespaces" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_grantPermissionOnNamespace", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "role", + "required": true, + "type": "string" + }, + { + "description": "List of permissions for the specified role", + "in": "body", + "name": "body", + "required": false, + "schema": { + "items": { + "enum": [ + "produce", + "consume", + "functions", + "sources", + "sinks", + "packages" + ], + "type": "string" + }, + "type": "array" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + }, + "409": { + "description": "Concurrent modification" + }, + "501": { + "description": "Authorization is not enabled" + } + }, + "summary": "Grant a new permission to a role on a namespace.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/persistence": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_deletePersistence", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + } + }, + "summary": "Delete the persistence configuration for all topics on a namespace", + "tags": [ + "namespaces" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getPersistence", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/PersistencePolicies" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Get the persistence configuration for a namespace.", + "tags": [ + "namespaces" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_setPersistence", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Persistence policies for the specified namespace", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PersistencePolicies" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "400": { + "description": "Invalid persistence policies" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Set the persistence configuration for all the topics on a namespace.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/persistence/bookieAffinity": { + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_setBookieAffinityGroup", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Bookie affinity group for the specified namespace", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/BookieAffinityGroupData" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Set the bookie-affinity-group to namespace-persistent policy.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/properties": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_clearProperties", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or namespace doesn't exist" + } + }, + "summary": "Clear properties on a given namespace.", + "tags": [ + "namespaces" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getProperties", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or namespace doesn't exist" + } + }, + "summary": "Get key value pair properties for a given namespace.", + "tags": [ + "namespaces" + ] + }, + "put": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_setProperties", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Key value pair properties for the namespace", + "in": "body", + "name": "body", + "required": true, + "schema": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or namespace doesn't exist" + } + }, + "summary": "Put key value pairs property on a namespace.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/property/{key}": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_removeProperty", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "key", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or namespace doesn't exist" + } + }, + "summary": "Remove property value for a given key on a namespace.", + "tags": [ + "namespaces" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getProperty", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "key", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "type": "string" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or namespace doesn't exist" + } + }, + "summary": "Get property value for a given key on a namespace.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/property/{key}/{value}": { + "put": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_setProperty", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "key", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "value", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or namespace doesn't exist" + } + }, + "summary": "Put a key value pair property on a namespace.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/removeOffloadPolicies": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_removeOffloadPolicies", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "OffloadPolicies is empty or driver is not supported or bucket is not valid" + } + }, + "summary": " Set offload configuration on a namespace.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/replication": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getNamespaceReplicationClusters", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + }, + "412": { + "description": "Namespace is not global" + } + }, + "summary": "Get the replication clusters for a namespace.", + "tags": [ + "namespaces" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_setNamespaceReplicationClusters", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "List of replication clusters", + "in": "body", + "name": "body", + "required": true, + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + }, + "409": { + "description": "Peer-cluster can't be part of replication-cluster" + }, + "412": { + "description": "Namespace is not global or invalid cluster ids" + } + }, + "summary": "Set the replication clusters for a namespace.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/replicatorDispatchRate": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_removeReplicatorDispatchRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + } + }, + "summary": "Remove replicator dispatch-rate throttling for all topics of the namespace", + "tags": [ + "namespaces" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getReplicatorDispatchRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/DispatchRateImpl" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + } + }, + "summary": "Get replicator dispatch-rate configured for the namespace, null means replicator dispatch-rate not configured, -1 means msg-dispatch-rate or byte-dispatch-rate not configured in dispatch-rate yet", + "tags": [ + "namespaces" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_setReplicatorDispatchRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Replicator dispatch rate for all topics of the specified namespace", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/DispatchRateImpl" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + } + }, + "summary": "Set replicator dispatch-rate throttling for all topics of the namespace", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/resourcegroup": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_removeNamespaceResourceGroup", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + }, + "412": { + "description": "Invalid resourcegroup" + } + }, + "summary": "Delete resourcegroup for a namespace", + "tags": [ + "namespaces" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getNamespaceResourceGroup", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "type": "string" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + } + }, + "summary": "Get the resource group attached to the namespace", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/resourcegroup/{resourcegroup}": { + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_setNamespaceResourceGroup", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "resourcegroup", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + }, + "412": { + "description": "Invalid resourcegroup" + } + }, + "summary": "Set resourcegroup for a namespace", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/retention": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_removeRetention", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Retention policies for the specified namespace", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/RetentionPolicies" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "Retention Quota must exceed backlog quota" + } + }, + "summary": " Remove retention configuration on a namespace.", + "tags": [ + "namespaces" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getRetention", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/RetentionPolicies" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + } + }, + "summary": "Get retention config on a namespace.", + "tags": [ + "namespaces" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_setRetention", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Retention policies for the specified namespace", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/RetentionPolicies" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "Retention Quota must exceed backlog quota" + } + }, + "summary": " Set retention configuration on a namespace.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/scanOffloadedLedgers": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_scanOffloadedLedgers", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successful get of offloaded ledger data" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace doesn't exist" + } + }, + "summary": "Trigger the scan of offloaded Ledgers on the LedgerOffloader for the given namespace", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/schemaAutoUpdateCompatibilityStrategy": { + "get": { + "consumes": [ + "application/json" + ], + "description": "The value AutoUpdateDisabled prevents producers from updating the schema. If set to AutoUpdateDisabled, schemas must be updated through the REST api", + "operationId": "Namespaces_getSchemaAutoUpdateCompatibilityStrategy", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "enum": [ + "AutoUpdateDisabled", + "Backward", + "Forward", + "Full", + "AlwaysCompatible", + "BackwardTransitive", + "ForwardTransitive", + "FullTransitive" + ], + "type": "string" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace doesn't exist" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "The strategy used to check the compatibility of new schemas, provided by producers, before automatically updating the schema", + "tags": [ + "namespaces" + ] + }, + "put": { + "consumes": [ + "application/json" + ], + "description": "The value AutoUpdateDisabled prevents producers from updating the schema. If set to AutoUpdateDisabled, schemas must be updated through the REST api", + "operationId": "Namespaces_setSchemaAutoUpdateCompatibilityStrategy", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Strategy used to check the compatibility of new schemas", + "in": "body", + "name": "body", + "required": false, + "schema": { + "type": "string" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace doesn't exist" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Update the strategy used to check the compatibility of new schemas, provided by producers, before automatically updating the schema", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/schemaCompatibilityStrategy": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getSchemaCompatibilityStrategy", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "enum": [ + "UNDEFINED", + "ALWAYS_INCOMPATIBLE", + "ALWAYS_COMPATIBLE", + "BACKWARD", + "FORWARD", + "FULL", + "BACKWARD_TRANSITIVE", + "FORWARD_TRANSITIVE", + "FULL_TRANSITIVE" + ], + "type": "string" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace doesn't exist" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "The strategy of the namespace schema compatibility ", + "tags": [ + "namespaces" + ] + }, + "put": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_setSchemaCompatibilityStrategy", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Strategy used to check the compatibility of new schema", + "in": "body", + "name": "body", + "required": false, + "schema": { + "type": "string" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace doesn't exist" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Update the strategy used to check the compatibility of new schema", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/schemaValidationEnforced": { + "get": { + "consumes": [ + "application/json" + ], + "description": "If the flag is set to true, when a producer without a schema attempts to produce to a topic with schema in this namespace, the producer will be failed to connect. PLEASE be carefully on using this, since non-java clients don't support schema.if you enable this setting, it will cause non-java clients failed to produce.", + "operationId": "Namespaces_getSchemaValidtionEnforced", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "type": "boolean" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenants or Namespace doesn't exist" + } + }, + "summary": "Get schema validation enforced flag for namespace.", + "tags": [ + "namespaces" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "If the flag is set to true, when a producer without a schema attempts to produce to a topic with schema in this namespace, the producer will be failed to connect. PLEASE be carefully on using this, since non-java clients don't support schema.if you enable this setting, it will cause non-java clients failed to produce.", + "operationId": "Namespaces_setSchemaValidationEnforced", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Flag of whether validation is enforced on the specified namespace", + "in": "body", + "name": "body", + "required": true, + "schema": { + "type": "boolean" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or Namespace doesn't exist" + }, + "412": { + "description": "schemaValidationEnforced value is not valid" + } + }, + "summary": "Set schema validation enforced flag on namespace.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/subscribeRate": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_deleteSubscribeRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + } + }, + "summary": "Delete subscribe-rate throttling for all topics of the namespace", + "tags": [ + "namespaces" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getSubscribeRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/SubscribeRate" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + } + }, + "summary": "Get subscribe-rate configured for the namespace", + "tags": [ + "namespaces" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_setSubscribeRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Subscribe rate for all topics of the specified namespace", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/SubscribeRate" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + } + }, + "summary": "Set subscribe-rate throttling for all topics of the namespace", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/subscriptionAuthMode": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getSubscriptionAuthMode", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "enum": [ + "None", + "Prefix" + ], + "type": "string" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or namespace doesn't exist" + } + }, + "summary": "Get subscription auth mode in a namespace", + "tags": [ + "namespaces" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_setSubscriptionAuthMode", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Subscription auth mode for all topics of the specified namespace", + "in": "body", + "name": "body", + "required": false, + "schema": { + "type": "string" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": " Set a subscription auth mode for all the topics on a namespace.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/subscriptionDispatchRate": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_deleteSubscriptionDispatchRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + } + }, + "summary": "Delete Subscription dispatch-rate throttling for all topics of the namespace", + "tags": [ + "namespaces" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getSubscriptionDispatchRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/DispatchRate" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + } + }, + "summary": "Get subscription dispatch-rate configured for the namespace, null means subscription dispatch-rate not configured, -1 means msg-dispatch-rate or byte-dispatch-rate not configured in dispatch-rate yet", + "tags": [ + "namespaces" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_setSubscriptionDispatchRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Subscription dispatch rate for all topics of the specified namespace", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/DispatchRateImpl" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + } + }, + "summary": "Set Subscription dispatch-rate throttling for all topics of the namespace", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/subscriptionExpirationTime": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_removeSubscriptionExpirationTime", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + } + }, + "summary": "Remove subscription expiration time for namespace", + "tags": [ + "namespaces" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getSubscriptionExpirationTime", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int32", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + } + }, + "summary": "Get the subscription expiration time for the namespace", + "tags": [ + "namespaces" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_setSubscriptionExpirationTime", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Expiration time in minutes for the specified namespace", + "in": "body", + "name": "body", + "required": true, + "schema": { + "format": "int32", + "type": "integer" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + }, + "412": { + "description": "Invalid expiration time" + } + }, + "summary": "Set subscription expiration time in minutes for namespace", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/subscriptionTypesEnabled": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_removeSubscriptionTypesEnabled", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or Namespace does not exist" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": " Remove subscription types enabled on a namespace.", + "tags": [ + "namespaces" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getSubscriptionTypesEnabled", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "enum": [ + "Exclusive", + "Shared", + "Failover", + "Key_Shared" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace doesn't exist" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "The set of whether allow subscription types", + "tags": [ + "namespaces" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_setSubscriptionTypesEnabled", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Set of whether allow subscription types", + "in": "body", + "name": "body", + "required": true, + "schema": { + "items": { + "enum": [ + "Exclusive", + "Shared", + "Failover", + "Key_Shared" + ], + "type": "string" + }, + "type": "array" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace doesn't exist" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Update set of whether allow share sub type", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/topics": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getTopics", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "default": "PERSISTENT", + "enum": [ + "PERSISTENT", + "NON_PERSISTENT", + "ALL" + ], + "in": "query", + "name": "mode", + "required": false, + "type": "string" + }, + { + "description": "Include system topic", + "in": "query", + "name": "includeSystemTopic", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "403": { + "description": "Don't have admin or operate permission on the namespace" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + } + }, + "summary": "Get the list of all the topics under a certain namespace.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/unload": { + "put": { + "consumes": [ + "application/json" + ], + "description": "Unload an active namespace from the current broker serving it. Performing this operation will let the brokerremoves all producers, consumers, and connections using this namespace, and close all topics (includingtheir persistent store). During that operation, the namespace is marked as tentatively unavailable until thebroker completes the unloading action. This operation requires strictly super user privileges, since it wouldresult in non-persistent message loss and unexpected connection closure to the clients.", + "operationId": "Namespaces_unloadNamespace", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or namespace doesn't exist" + }, + "412": { + "description": "Namespace is already unloaded or Namespace has bundles activated" + } + }, + "summary": "Unload namespace", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/unsubscribe/{subscription}": { + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_unsubscribeNamespace", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "subscription", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin or operate permission on the namespacen" + }, + "404": { + "description": "Namespace does not exist" + } + }, + "summary": "Unsubscribes the given subscription on all topics on a namespace.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/{bundle}": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_deleteNamespaceBundle", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "bundle", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "force", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + }, + "409": { + "description": "Namespace bundle is not empty" + } + }, + "summary": "Delete a namespace bundle and all the topics under it.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/{bundle}/clearBacklog": { + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_clearNamespaceBundleBacklog", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "bundle", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace" + }, + "403": { + "description": "Don't have admin or operate permission on the namespace" + }, + "404": { + "description": "Namespace does not exist" + } + }, + "summary": "Clear backlog for all topics on a namespace bundle.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/{bundle}/clearBacklog/{subscription}": { + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_clearNamespaceBundleBacklogForSubscription", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "subscription", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "bundle", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace" + }, + "403": { + "description": "Don't have admin or operate permission on the namespace" + }, + "404": { + "description": "Namespace does not exist" + } + }, + "summary": "Clear backlog for a given subscription on all topics on a namespace bundle.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/{bundle}/split": { + "put": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_splitNamespaceBundle", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "bundle", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "unload", + "required": false, + "type": "boolean" + }, + { + "in": "query", + "name": "splitAlgorithmName", + "required": false, + "type": "string" + }, + { + "description": "splitBoundaries", + "in": "body", + "name": "body", + "required": false, + "schema": { + "items": { + "format": "int64", + "type": "integer" + }, + "type": "array" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace doesn't exist" + } + }, + "summary": "Split a namespace bundle", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/{bundle}/topicHashPositions": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getTopicHashPositions", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "bundle", + "required": true, + "type": "string" + }, + { + "collectionFormat": "multi", + "in": "query", + "items": { + "type": "string" + }, + "name": "topics", + "required": false, + "type": "array" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/TopicHashPositions" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + } + }, + "summary": "Get hash positions for topics", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/{bundle}/unload": { + "put": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_unloadNamespaceBundle", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "bundle", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "in": "query", + "name": "destinationBroker", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace doesn't exist" + } + }, + "summary": "Unload a namespace bundle", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/{bundle}/unsubscribe/{subscription}": { + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_unsubscribeNamespaceBundle", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "subscription", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "bundle", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin or operate permission on the namespace" + }, + "404": { + "description": "Namespace does not exist" + } + }, + "summary": "Unsubscribes the given subscription on all topics on a namespace bundle.", + "tags": [ + "namespaces" + ] + } + }, + "/non-persistent/{tenant}/{namespace}": { + "get": { + "description": "", + "operationId": "NonPersistentTopics_getList", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify the bundle name", + "in": "query", + "name": "bundle", + "required": false, + "type": "string" + }, + { + "description": "Include system topic", + "in": "query", + "name": "includeSystemTopic", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "401": { + "description": "Don't have permission to manage resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "The tenant/namespace does not exist" + }, + "412": { + "description": "Namespace name is not valid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Get the list of non-persistent topics under a namespace.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/partitioned": { + "get": { + "description": "", + "operationId": "PersistentTopics_getPartitionedTopicList", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Include system topic", + "in": "query", + "name": "includeSystemTopic", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin or operate permission on the namespace" + }, + "404": { + "description": "tenant/namespace/topic doesn't exit" + }, + "412": { + "description": "Namespace name is not valid" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Get the list of partitioned topics under a namespace.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{bundle}": { + "get": { + "description": "", + "operationId": "NonPersistentTopics_getListFromBundle", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Bundle range of a topic", + "in": "path", + "name": "bundle", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "401": { + "description": "Don't have permission to manage resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace doesn't exist" + }, + "412": { + "description": "Namespace name is not valid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Get the list of non-persistent topics under a namespace bundle.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}": { + "delete": { + "description": "The topic cannot be deleted if delete is not forcefully and there's any active subscription or producer connected to the it. Force delete ignores connected clients and deletes topic by explicitly closing them.", + "operationId": "PersistentTopics_deleteTopic", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Stop all producer/consumer/replicator and delete topic forcefully", + "in": "query", + "name": "force", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic does not exist" + }, + "412": { + "description": "Topic has active producers/subscriptions" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Delete a topic.", + "tags": [ + "non-persistent topic" + ] + }, + "put": { + "description": "This is the only REST endpoint from which non-partitioned topics could be created.", + "operationId": "PersistentTopics_createNonPartitionedTopic", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "Key value pair properties for the topic metadata", + "in": "body", + "name": "body", + "required": false, + "schema": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or namespace doesn't exist" + }, + "409": { + "description": "Partitioned topic already exist" + }, + "412": { + "description": "Failed Reason : Name is invalid or Namespace does not have any clusters configured" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Create a non-partitioned topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/all_subscription/expireMessages/{expireTimeInSeconds}": { + "post": { + "description": "", + "operationId": "PersistentTopics_expireMessagesForAllSubscriptions", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": 0, + "description": "Expires beyond the specified number of seconds", + "format": "int32", + "in": "path", + "name": "expireTimeInSeconds", + "required": true, + "type": "integer" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic or subscription does not exist" + }, + "405": { + "description": "Expiry messages on a non-persistent topic is not allowed" + }, + "412": { + "description": "Can't find owner for topic" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Expiry messages on all subscriptions of topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/autoSubscriptionCreation": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeAutoSubscriptionCreation", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Topic does not exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove autoSubscriptionCreation ina a topic.", + "tags": [ + "non-persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getAutoSubscriptionCreation", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/AutoSubscriptionCreationOverrideImpl" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Topic does not exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Get autoSubscriptionCreation info in a topic", + "tags": [ + "non-persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setAutoSubscriptionCreation", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "Settings for automatic subscription creation", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/AutoSubscriptionCreationOverrideImpl" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Override namespace's allowAutoSubscriptionCreation setting for a topic", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/backlog": { + "get": { + "description": "", + "operationId": "PersistentTopics_getBacklog", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/PersistentOfflineTopicStats" + } + }, + "404": { + "description": "Namespace does not exist" + }, + "412": { + "description": "Topic name is not valid" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Get estimated backlog for offline topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/backlogQuota": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeBacklogQuota", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "enum": [ + "destination_storage", + "message_age" + ], + "in": "query", + "name": "backlogQuotaType", + "required": false, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove a backlog quota policy from a topic.", + "tags": [ + "non-persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setBacklogQuota", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "enum": [ + "destination_storage", + "message_age" + ], + "in": "query", + "name": "backlogQuotaType", + "required": false, + "type": "string" + }, + { + "description": "backlog quota policies for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/BacklogQuotaImpl" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "Specified backlog quota exceeds retention quota. Increase retention quota and retry request" + } + }, + "summary": "Set a backlog quota for a topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/backlogQuotaMap": { + "get": { + "description": "", + "operationId": "PersistentTopics_getBacklogQuotaMap", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "additionalProperties": { + "$ref": "#/definitions/BacklogQuota" + }, + "type": "object" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Topic policy or namespace does not exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + } + }, + "summary": "Get backlog quota map on a topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/backlogSize": { + "put": { + "description": "", + "operationId": "PersistentTopics_getBacklogSizeByMessageId", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int64", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic does not exist" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Calculate backlog size by a message ID (in bytes).", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/compaction": { + "get": { + "description": "", + "operationId": "PersistentTopics_compactionStatus", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/LongRunningProcessStatus" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic does not exist, or compaction hasn't run" + }, + "405": { + "description": "Operation is not allowed on the persistent topic" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Get the status of a compaction operation for a topic.", + "tags": [ + "non-persistent topic" + ] + }, + "put": { + "description": "", + "operationId": "PersistentTopics_compact", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic does not exist" + }, + "405": { + "description": "Operation is not allowed on the persistent topic" + }, + "409": { + "description": "Compaction already running" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Trigger a compaction operation on a topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/compactionThreshold": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeCompactionThreshold", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove compaction threshold configuration for specified topic.", + "tags": [ + "non-persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getCompactionThreshold", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int64", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Get compaction threshold configuration for specified topic.", + "tags": [ + "non-persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setCompactionThreshold", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "description": "Dispatch rate for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "format": "int64", + "type": "integer" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Set compaction threshold configuration for specified topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/createMissedPartitions": { + "post": { + "description": "", + "operationId": "PersistentTopics_createMissedPartitions", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant does not exist" + }, + "409": { + "description": "Partitioned topic does not exist" + }, + "412": { + "description": "Partitioned topic name is invalid" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Create missed partitions of an existing partitioned topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/deduplicationEnabled": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeDeduplication", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove deduplication configuration for specified topic.", + "tags": [ + "non-persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getDeduplication", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "type": "boolean" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + } + }, + "summary": "Get deduplication configuration of a topic.", + "tags": [ + "non-persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setDeduplication", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "DeduplicationEnabled policies for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "type": "boolean" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + } + }, + "summary": "Set deduplication enabled on a topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/deduplicationSnapshotInterval": { + "delete": { + "description": "", + "operationId": "PersistentTopics_deleteDeduplicationSnapshotInterval", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + } + }, + "summary": "Delete deduplicationSnapshotInterval config on a topic.", + "tags": [ + "non-persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getDeduplicationSnapshotInterval", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int32", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Get deduplicationSnapshotInterval config on a topic.", + "tags": [ + "non-persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setDeduplicationSnapshotInterval", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "Interval to take deduplication snapshot for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "format": "int32", + "type": "integer" + } + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + } + }, + "summary": "Set deduplicationSnapshotInterval config on a topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/delayedDelivery": { + "delete": { + "description": "", + "operationId": "PersistentTopics_deleteDelayedDeliveryPolicies", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + } + }, + "summary": "Set delayed delivery messages config on a topic.", + "tags": [ + "non-persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getDelayedDeliveryPolicies", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/DelayedDeliveryPolicies" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Get delayed delivery messages config on a topic.", + "tags": [ + "non-persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setDelayedDeliveryPolicies", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "Delayed delivery policies for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/DelayedDeliveryPolicies" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + } + }, + "summary": "Set delayed delivery messages config on a topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/dispatchRate": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeDispatchRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove message dispatch rate configuration for specified topic.", + "tags": [ + "non-persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getDispatchRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/DispatchRateImpl" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Get dispatch rate configuration for specified topic.", + "tags": [ + "non-persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setDispatchRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "description": "Dispatch rate for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/DispatchRateImpl" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Set message dispatch rate configuration for specified topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/dispatcherPauseOnAckStatePersistent": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeDispatcherPauseOnAckStatePersistent", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove dispatcher pause on ack state persistent configuration for specified topic.", + "tags": [ + "non-persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getDispatcherPauseOnAckStatePersistent", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int32", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Get dispatcher pause on ack state persistent config on a topic.", + "tags": [ + "non-persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setDispatcherPauseOnAckStatePersistent", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Set dispatcher pause on ack state persistent configuration for specified topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/entryFilters": { + "delete": { + "description": "", + "operationId": "NonPersistentTopics_removeEntryFilters", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected thiscall to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove entry filters for specified topic.", + "tags": [ + "non-persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "NonPersistentTopics_getEntryFilters", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/EntryFilters" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenants or Namespace doesn't exist" + } + }, + "summary": "Get entry filters for a topic.", + "tags": [ + "non-persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "NonPersistentTopics_setEntryFilters", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "Enable sub types for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/EntryFilters" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Set entry filters for specified topic", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/examinemessage": { + "get": { + "description": "", + "operationId": "PersistentTopics_examineMessage", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": "latest", + "description": "Relative start position to examine message.It can be 'latest' or 'earliest'", + "enum": [ + "latest", + "earliest" + ], + "in": "query", + "name": "initialPosition", + "required": false, + "type": "string" + }, + { + "default": 1, + "description": "The position of messages (default 1)", + "format": "int64", + "in": "query", + "name": "messagePosition", + "required": false, + "type": "integer" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successfully retrieved the message. The response is a binary byte stream containing the message data. Clients need to parse this binary stream based on the message metadata provided in the response headers." + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic, the message position does not exist" + }, + "405": { + "description": "If given partitioned topic" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Examine a specific message on a topic by position relative to the earliest or the latest message.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/inactiveTopicPolicies": { + "delete": { + "description": "", + "operationId": "PersistentTopics_deleteInactiveTopicPolicies", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + } + }, + "summary": "Delete inactive topic policies on a topic.", + "tags": [ + "non-persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getInactiveTopicPolicies", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/InactiveTopicPolicies" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Get inactive topic policies on a topic.", + "tags": [ + "non-persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setInactiveTopicPolicies", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "description": "inactive topic policies for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/InactiveTopicPolicies" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + } + }, + "summary": "Set inactive topic policies on a topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/internal-info": { + "get": { + "description": "", + "operationId": "PersistentTopics_getManagedLedgerInfo", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/PartitionedManagedLedgerInfo" + } + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic does not exist" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Get the stored topic metadata.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/internalStats": { + "get": { + "description": "", + "operationId": "NonPersistentTopics_getInternalStats", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "metadata", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/PersistentTopicInternalStats" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to manage resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "The tenant/namespace/topic does not exist" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Get the internal stats for the topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/lastMessageId": { + "get": { + "description": "", + "operationId": "PersistentTopics_getLastMessageId", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/MessageIdAdv" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic does not exist" + }, + "405": { + "description": "Operation is not allowed on the persistent topic" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Return the last commit message id of topic", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/ledger/{ledgerId}/entry/{entryId}": { + "get": { + "description": "", + "operationId": "PersistentTopics_getMessageById", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "The ledger id", + "format": "int64", + "in": "path", + "name": "ledgerId", + "required": true, + "type": "integer" + }, + { + "description": "The entry id", + "format": "int64", + "in": "path", + "name": "entryId", + "required": true, + "type": "integer" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successfully retrieved the message. The response is a binary byte stream containing the message data. Clients need to parse this binary stream based on the message metadata provided in the response headers." + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic, subscription or the message position does not exist" + }, + "405": { + "description": "Skipping messages on a non-persistent topic is not allowed" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Get message by its messageId.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/maxConsumers": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeMaxConsumers", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove maxConsumers config for specified topic.", + "tags": [ + "non-persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getMaxConsumers", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int32", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Get maxConsumers config for specified topic.", + "tags": [ + "non-persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setMaxConsumers", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "The max consumers of the topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "format": "int32", + "type": "integer" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "Invalid value of maxConsumers" + } + }, + "summary": "Set maxConsumers config for specified topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/maxConsumersPerSubscription": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeMaxConsumersPerSubscription", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove max consumers per subscription configuration for specified topic.", + "tags": [ + "non-persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getMaxConsumersPerSubscription", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int32", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Get max consumers per subscription configuration for specified topic.", + "tags": [ + "non-persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setMaxConsumersPerSubscription", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "Dispatch rate for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "format": "int32", + "type": "integer" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Set max consumers per subscription configuration for specified topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/maxMessageSize": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeMaxMessageSize", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove maxMessageSize config for specified topic.", + "tags": [ + "non-persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getMaxMessageSize", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int32", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Get maxMessageSize config for specified topic.", + "tags": [ + "non-persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setMaxMessageSize", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "The max message size of the topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "format": "int32", + "type": "integer" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "Invalid value of maxConsumers" + } + }, + "summary": "Set maxMessageSize config for specified topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/maxProducers": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeMaxProducers", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove maxProducers config for specified topic.", + "tags": [ + "non-persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getMaxProducers", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int32", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Get maxProducers config for specified topic.", + "tags": [ + "non-persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setMaxProducers", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "description": "The max producers of the topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "format": "int32", + "type": "integer" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "Invalid value of maxProducers" + } + }, + "summary": "Set maxProducers config for specified topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/maxSubscriptionsPerTopic": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeMaxSubscriptionsPerTopic", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove maxSubscriptionsPerTopic config for specified topic.", + "tags": [ + "non-persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getMaxSubscriptionsPerTopic", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int32", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Get maxSubscriptionsPerTopic config for specified topic.", + "tags": [ + "non-persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setMaxSubscriptionsPerTopic", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "The max subscriptions of the topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "format": "int32", + "type": "integer" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "Invalid value of maxSubscriptionsPerTopic" + } + }, + "summary": "Set maxSubscriptionsPerTopic config for specified topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/maxUnackedMessagesOnConsumer": { + "delete": { + "description": "", + "operationId": "PersistentTopics_deleteMaxUnackedMessagesOnConsumer", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + } + }, + "summary": "Delete max unacked messages per consumer config on a topic.", + "tags": [ + "non-persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getMaxUnackedMessagesOnConsumer", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int32", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Get max unacked messages per consumer config on a topic.", + "tags": [ + "non-persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setMaxUnackedMessagesOnConsumer", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "Max unacked messages on consumer policies for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "format": "int32", + "type": "integer" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + } + }, + "summary": "Set max unacked messages per consumer config on a topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/maxUnackedMessagesOnSubscription": { + "delete": { + "description": "", + "operationId": "PersistentTopics_deleteMaxUnackedMessagesOnSubscription", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + } + }, + "summary": "Delete max unacked messages per subscription config on a topic.", + "tags": [ + "non-persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getMaxUnackedMessagesOnSubscription", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int32", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Get max unacked messages per subscription config on a topic.", + "tags": [ + "non-persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setMaxUnackedMessagesOnSubscription", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "Max unacked messages on subscription policies for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "format": "int32", + "type": "integer" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + } + }, + "summary": "Set max unacked messages per subscription config on a topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/messageTTL": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeMessageTTL", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Not authenticate to perform the request or policy is read only" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, enable the topic level policy and retry" + }, + "412": { + "description": "Invalid message TTL value" + } + }, + "summary": "Remove message TTL in seconds for a topic", + "tags": [ + "non-persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getMessageTTL", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int32", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, enable the topic level policy and retry" + } + }, + "summary": "Get message TTL in seconds for a topic", + "tags": [ + "non-persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setMessageTTL", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "TTL in seconds for the specified topic", + "format": "int32", + "in": "query", + "name": "messageTTL", + "required": true, + "type": "integer" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Not authenticate to perform the request or policy is read only" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, enable the topic level policy and retry" + }, + "412": { + "description": "Invalid message TTL value" + } + }, + "summary": "Set message TTL in seconds for a topic", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/messageid/{timestamp}": { + "get": { + "description": "", + "operationId": "PersistentTopics_getMessageIdByTimestamp", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "Specify the timestamp", + "format": "int64", + "in": "path", + "name": "timestamp", + "required": true, + "type": "integer" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/MessageIdAdv" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic does not exist" + }, + "405": { + "description": "Topic is not non-partitioned and persistent" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Get message ID published at or just after this absolute timestamp (in ms).", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/offload": { + "get": { + "description": "", + "operationId": "PersistentTopics_offloadStatus", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/OffloadProcessStatus" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic does not exist" + }, + "405": { + "description": "Operation is not allowed on the persistent topic" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Offload a prefix of a topic to long term storage", + "tags": [ + "non-persistent topic" + ] + }, + "put": { + "description": "", + "operationId": "PersistentTopics_triggerOffload", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "400": { + "description": "Message ID is null" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic does not exist" + }, + "405": { + "description": "Operation is not allowed on the persistent topic" + }, + "409": { + "description": "Offload already running" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Offload a prefix of a topic to long term storage", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/offloadPolicies": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeOffloadPolicies", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + } + }, + "summary": "Delete offload policies on a topic.", + "tags": [ + "non-persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getOffloadPolicies", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/OffloadPoliciesImpl" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Get offload policies on a topic.", + "tags": [ + "non-persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setOffloadPolicies", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "description": "Offload policies for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/OffloadPoliciesImpl" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + } + }, + "summary": "Set offload policies on a topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/partitioned-internalStats": { + "get": { + "description": "", + "operationId": "PersistentTopics_getPartitionedStatsInternal", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/PartitionedTopicInternalStats" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic does not exist" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Get the stats-internal for the partitioned topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/partitioned-stats": { + "get": { + "description": "", + "operationId": "NonPersistentTopics_getPartitionedStats", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": true, + "description": "Get per partition stats", + "in": "query", + "name": "perPartition", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "If return precise backlog or imprecise backlog", + "in": "query", + "name": "getPreciseBacklog", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "If return backlog size for each subscription, require locking on ledger so be careful not to use when there's heavy traffic.", + "in": "query", + "name": "subscriptionBacklogSize", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "If return the earliest time in backlog", + "in": "query", + "name": "getEarliestTimeInBacklog", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "If exclude the publishers", + "in": "query", + "name": "excludePublishers", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "If exclude the consumers", + "in": "query", + "name": "excludeConsumers", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/NonPersistentPartitionedTopicStatsImpl" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic does not exist" + }, + "412": { + "description": "Partitioned topic name is invalid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Get the stats for the partitioned topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/partitions": { + "delete": { + "description": "It will also delete all the partitions of the topic if it exists.", + "operationId": "PersistentTopics_deletePartitionedTopic", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Stop all producer/consumer/replicator and delete topic forcefully", + "in": "query", + "name": "force", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Partitioned topic does not exist" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "Partitioned topic name is invalid" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Delete a partitioned topic.", + "tags": [ + "non-persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "NonPersistentTopics_getPartitionedMetadata", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Is check configuration required to automatically create topic", + "in": "query", + "name": "checkAllowAutoCreation", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/PartitionedTopicMetadata" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to manage resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "The tenant/namespace/topic does not exist" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate cluster configuration" + } + }, + "summary": "Get partitioned topic metadata.", + "tags": [ + "non-persistent topic" + ] + }, + "post": { + "description": "It increments partitions of existing partitioned-topic", + "operationId": "PersistentTopics_updatePartitionedTopic", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "updateLocalTopicOnly", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "force", + "required": false, + "type": "boolean" + }, + { + "description": "The number of partitions for the topic", + "in": "body", + "name": "body", + "required": true, + "schema": { + "default": 0, + "format": "int32", + "type": "integer" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Update topic partition successful." + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Unauthenticated" + }, + "403": { + "description": "Forbidden/Unauthorized" + }, + "404": { + "description": "Topic does not exist" + }, + "412": { + "description": "Partitioned topic name is invalid" + }, + "422": { + "description": "The number of partitions should be more than 0 and less than or equal to maxNumPartitionsPerPartitionedTopic and number of new partitions must be greater than existing number of partitions" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Increment partitions of an existing partitioned topic.", + "tags": [ + "non-persistent topic" + ] + }, + "put": { + "description": "It needs to be called before creating a producer on a partitioned topic.", + "operationId": "NonPersistentTopics_createPartitionedTopic", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "The number of partitions for the topic", + "in": "body", + "name": "body", + "required": true, + "schema": { + "default": 0, + "format": "int32", + "type": "integer" + } + }, + { + "default": false, + "in": "query", + "name": "createLocalTopicOnly", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to manage resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "The tenant/namespace does not exist" + }, + "406": { + "description": "The number of partitions should be more than 0 and less than or equal to maxNumPartitionsPerPartitionedTopic" + }, + "409": { + "description": "Partitioned topic already exists" + }, + "412": { + "description": "Failed Reason : Name is invalid or Namespace does not have any clusters configured" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Create a partitioned topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/permissions": { + "get": { + "description": "Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at thenamespace level combined (union) with any eventual specific permission set on the topic.Returns a nested map structure which Swagger does not fully support for display. Structure: Map>. Please refer to this structure for details.", + "operationId": "PersistentTopics_getPermissionsOnTopic", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "additionalProperties": { + "enum": [ + "produce", + "consume", + "functions", + "sources", + "sinks", + "packages" + ], + "type": "string" + }, + "type": "object" + } + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "tenant/namespace/topic doesn't exit" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Get permissions on a topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/permissions/{role}": { + "delete": { + "description": "Revoke permissions to a role on a single topic. If the permission was not set at the topiclevel, but rather at the namespace level, this operation will return an error (HTTP status code 412).", + "operationId": "PersistentTopics_revokePermissionsOnTopic", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "Client role to which grant permissions", + "in": "path", + "name": "role", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "tenant/namespace/topic doesn't exit" + }, + "412": { + "description": "Permissions are not set at the topic level" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Revoke permissions on a topic.", + "tags": [ + "non-persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_grantPermissionsOnTopic", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "Client role to which grant permissions", + "in": "path", + "name": "role", + "required": true, + "type": "string" + }, + { + "description": "Actions to be granted (produce,functions,consume)", + "in": "body", + "name": "body", + "required": false, + "schema": { + "items": { + "enum": [ + "produce", + "consume", + "functions", + "sources", + "sinks", + "packages" + ], + "type": "string" + }, + "type": "array" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "tenant/namespace/topic doesn't exit" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Grant a new permission to a role on a single topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/persistence": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removePersistence", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove configuration of persistence policies for specified topic.", + "tags": [ + "non-persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getPersistence", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/PersistencePolicies" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Get configuration of persistence policies for specified topic.", + "tags": [ + "non-persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setPersistence", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "description": "Bookkeeper persistence policies for specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/PersistencePolicies" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "400": { + "description": "Invalid persistence policies" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Set configuration of persistence policies for specified topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/properties": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeProperties", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "key", + "required": false, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Partitioned topic does not exist" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "Partitioned topic name is invalid" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Remove the key in properties on the given topic.", + "tags": [ + "non-persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getProperties", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic does not exist" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "Topic name is invalid" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Get topic properties.", + "tags": [ + "non-persistent topic" + ] + }, + "put": { + "description": "", + "operationId": "PersistentTopics_updateProperties", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "Key value pair properties for the topic metadata", + "in": "body", + "name": "body", + "required": false, + "schema": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic or subscription does not exist" + }, + "405": { + "description": "Method Not Allowed" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Update the properties on the given topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/publishRate": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removePublishRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove message publish rate configuration for specified topic.", + "tags": [ + "non-persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getPublishRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/PublishRate" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Get publish rate configuration for specified topic.", + "tags": [ + "non-persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setPublishRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "Dispatch rate for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/PublishRate" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Set message publish rate configuration for specified topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/replication": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeReplicationClusters", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove the replication clusters from a topic.", + "tags": [ + "non-persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getReplicationClusters", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, enable the topic level policy and retry" + } + }, + "summary": "Get the replication clusters for a topic", + "tags": [ + "non-persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setReplicationClusters", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "List of replication clusters", + "in": "body", + "name": "body", + "required": true, + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "Topic is not global or invalid cluster ids" + } + }, + "summary": "Set the replication clusters for a topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/replicatorDispatchRate": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeReplicatorDispatchRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove replicatorDispatchRate config for specified topic.", + "tags": [ + "non-persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getReplicatorDispatchRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/DispatchRate" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Get replicatorDispatchRate config for specified topic.", + "tags": [ + "non-persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setReplicatorDispatchRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "Replicator dispatch rate of the topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/DispatchRateImpl" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "Invalid value of replicatorDispatchRate" + } + }, + "summary": "Set replicatorDispatchRate config for specified topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/retention": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeRetention", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "Retention Quota must exceed backlog quota" + } + }, + "summary": "Remove retention configuration for specified topic.", + "tags": [ + "non-persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getRetention", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/RetentionPolicies" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Get retention configuration for specified topic.", + "tags": [ + "non-persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setRetention", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "description": "Retention policies for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/RetentionPolicies" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "Retention Quota must exceed backlog quota" + } + }, + "summary": "Set retention configuration for specified topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/schemaCompatibilityStrategy": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeSchemaCompatibilityStrategy", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "Strategy used to check the compatibility of new schema", + "in": "body", + "name": "body", + "required": false, + "schema": { + "type": "string" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Operation not allowed on persistent topic" + } + }, + "summary": "Remove schema compatibility strategy on a topic", + "tags": [ + "non-persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getSchemaCompatibilityStrategy", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the cluster", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "enum": [ + "UNDEFINED", + "ALWAYS_INCOMPATIBLE", + "ALWAYS_COMPATIBLE", + "BACKWARD", + "FORWARD", + "FULL", + "BACKWARD_TRANSITIVE", + "FORWARD_TRANSITIVE", + "FULL_TRANSITIVE" + ], + "type": "string" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Operation not allowed on persistent topic" + } + }, + "summary": "Get schema compatibility strategy on a topic", + "tags": [ + "non-persistent topic" + ] + }, + "put": { + "description": "", + "operationId": "PersistentTopics_setSchemaCompatibilityStrategy", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "Strategy used to check the compatibility of new schema", + "in": "body", + "name": "body", + "required": false, + "schema": { + "type": "string" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Operation not allowed on persistent topic" + } + }, + "summary": "Set schema compatibility strategy on a topic", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/schemaValidationEnforced": { + "get": { + "description": "", + "operationId": "PersistentTopics_getSchemaValidationEnforced", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "type": "boolean" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenants or Namespace doesn't exist" + } + }, + "summary": "Get schema validation enforced flag for topic.", + "tags": [ + "non-persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setSchemaValidationEnforced", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "in": "body", + "name": "body", + "required": true, + "schema": { + "type": "boolean" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or Namespace doesn't exist" + }, + "412": { + "description": "schemaValidationEnforced value is not valid" + } + }, + "summary": "Set schema validation enforced flag on topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/shadowTopics": { + "delete": { + "description": "", + "operationId": "PersistentTopics_deleteShadowTopics", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Delete shadow topics for a topic", + "tags": [ + "non-persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getShadowTopics", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, enable the topic level policy and retry" + } + }, + "summary": "Get the shadow topic list for a topic", + "tags": [ + "non-persistent topic" + ] + }, + "put": { + "description": "", + "operationId": "PersistentTopics_setShadowTopics", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "List of shadow topics", + "in": "body", + "name": "body", + "required": true, + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Set shadow topic list for a topic", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/stats": { + "get": { + "description": "", + "operationId": "PersistentTopics_getStats", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "If return precise backlog or imprecise backlog", + "in": "query", + "name": "getPreciseBacklog", + "required": false, + "type": "boolean" + }, + { + "default": true, + "description": "If return backlog size for each subscription, require locking on ledger so be careful not to use when there's heavy traffic.", + "in": "query", + "name": "subscriptionBacklogSize", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "If return time of the earliest message in backlog", + "in": "query", + "name": "getEarliestTimeInBacklog", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "If exclude the publishers", + "in": "query", + "name": "excludePublishers", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "If exclude the consumers", + "in": "query", + "name": "excludeConsumers", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/PersistentTopicStats" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic does not exist" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Get the stats for the topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/subscribeRate": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeSubscribeRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "Subscribe rate for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/SubscribeRate" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove subscribe rate configuration for specified topic.", + "tags": [ + "non-persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getSubscribeRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/SubscribeRate" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Get subscribe rate configuration for specified topic.", + "tags": [ + "non-persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setSubscribeRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "Subscribe rate for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/SubscribeRate" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Set subscribe rate configuration for specified topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}": { + "delete": { + "description": "The subscription cannot be deleted if delete is not forcefully and there are any active consumers attached to it. Force delete ignores connected consumers and deletes subscription by explicitly closing them.", + "operationId": "PersistentTopics_deleteSubscription", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "Subscription to be deleted", + "in": "path", + "name": "subName", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Disconnect and close all consumers and delete subscription forcefully", + "in": "query", + "name": "force", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic or subscription does not exist" + }, + "412": { + "description": "Subscription has active consumers" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Delete a subscription.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/analyzeBacklog": { + "post": { + "description": "", + "operationId": "PersistentTopics_analyzeSubscriptionBacklog", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "Subscription", + "in": "path", + "name": "subName", + "required": true, + "type": "string" + }, + { + "description": "messageId to start the analysis", + "in": "body", + "name": "position", + "required": false, + "schema": { + "$ref": "#/definitions/ResetCursorData" + } + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic or subscription does not exist" + }, + "405": { + "description": "Method Not Allowed" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Analyse a subscription, by scanning all the unprocessed messages", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/expireMessages": { + "post": { + "description": "", + "operationId": "PersistentTopics_expireTopicMessages", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "Subscription to be Expiry messages on", + "in": "path", + "name": "subName", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "messageId to reset back to (ledgerId:entryId)", + "in": "body", + "name": "messageId", + "required": false, + "schema": { + "$ref": "#/definitions/ResetCursorData" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic or subscription does not exist" + }, + "405": { + "description": "Expiry messages on a non-persistent topic is not allowed" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Expiry messages on a topic subscription.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/expireMessages/{expireTimeInSeconds}": { + "post": { + "description": "", + "operationId": "PersistentTopics_expireTopicMessages", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "Subscription to be Expiry messages on", + "in": "path", + "name": "subName", + "required": true, + "type": "string" + }, + { + "default": 0, + "description": "Expires beyond the specified number of seconds", + "format": "int32", + "in": "path", + "name": "expireTimeInSeconds", + "required": true, + "type": "integer" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic or subscription does not exist" + }, + "405": { + "description": "Expiry messages on a non-persistent topic is not allowed" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Expiry messages on a topic subscription.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/position/{messagePosition}": { + "get": { + "description": "", + "operationId": "PersistentTopics_peekNthMessage", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "Subscribed message expired", + "in": "path", + "name": "subName", + "required": true, + "type": "string" + }, + { + "default": 1, + "description": "The number of messages (default 1)", + "format": "int32", + "in": "path", + "name": "messagePosition", + "required": true, + "type": "integer" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successfully retrieved the message. The response is a binary byte stream containing the message data. Clients need to parse this binary stream based on the message metadata provided in the response headers." + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic, subscription or the message position does not exist" + }, + "405": { + "description": "Skipping messages on a non-persistent topic is not allowed" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Peek nth message on a topic subscription.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/properties": { + "get": { + "description": "", + "operationId": "PersistentTopics_getSubscriptionProperties", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "Subscription", + "in": "path", + "name": "subName", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic or subscription does not exist" + }, + "405": { + "description": "Method Not Allowed" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Return all the properties on the given subscription", + "tags": [ + "non-persistent topic" + ] + }, + "put": { + "description": "", + "operationId": "PersistentTopics_updateSubscriptionProperties", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "Subscription to update", + "in": "path", + "name": "subName", + "required": true, + "type": "string" + }, + { + "description": "The new properties", + "in": "body", + "name": "body", + "required": false, + "schema": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + } + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic or subscription does not exist" + }, + "405": { + "description": "Method Not Allowed" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Replace all the properties on the given subscription", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/replicatedSubscriptionStatus": { + "get": { + "description": "", + "operationId": "PersistentTopics_getReplicatedSubscriptionStatus", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "Name of subscription", + "in": "path", + "name": "subName", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "additionalProperties": { + "type": "boolean" + }, + "type": "object" + } + }, + "401": { + "description": "Don't have permission to administrate resources" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "412": { + "description": "Can't find owner for topic" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Get replicated subscription status on a topic.", + "tags": [ + "non-persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setReplicatedSubscriptionStatus", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "Name of subscription", + "in": "path", + "name": "subName", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "Whether to enable replicated subscription", + "in": "body", + "name": "body", + "required": true, + "schema": { + "type": "boolean" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant or subscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Topic or subscription does not exist" + }, + "405": { + "description": "Operation not allowed on this topic" + }, + "412": { + "description": "Can't find owner for topic" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Enable or disable a replicated subscription on a topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/resetcursor": { + "post": { + "description": "It fence cursor and disconnects all active consumers before resetting cursor.", + "operationId": "PersistentTopics_resetCursorOnPosition", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "Subscription to reset position on", + "in": "path", + "name": "subName", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "messageId to reset back to (ledgerId:entryId)", + "in": "body", + "name": "messageId", + "required": false, + "schema": { + "$ref": "#/definitions/ResetCursorData" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic or subscription does not exist" + }, + "405": { + "description": "Not supported for partitioned topics" + }, + "412": { + "description": "Unable to find position for position specified" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Reset subscription to message position closest to given position.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/resetcursor/{timestamp}": { + "post": { + "description": "It fence cursor and disconnects all active consumers before resetting cursor.", + "operationId": "PersistentTopics_resetCursor", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "Subscription to reset position on", + "in": "path", + "name": "subName", + "required": true, + "type": "string" + }, + { + "description": "the timestamp to reset back", + "format": "int64", + "in": "path", + "name": "timestamp", + "required": true, + "type": "integer" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic or subscription does not exist" + }, + "405": { + "description": "Method Not Allowed" + }, + "412": { + "description": "Failed to reset cursor on subscription or Unable to find position for timestamp specified" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Reset subscription to message position closest to absolute timestamp (in ms).", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/skip/{numMessages}": { + "post": { + "description": "", + "operationId": "PersistentTopics_skipMessages", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "Name of subscription", + "in": "path", + "name": "subName", + "required": true, + "type": "string" + }, + { + "default": 0, + "description": "The number of messages to skip", + "format": "int32", + "in": "path", + "name": "numMessages", + "required": true, + "type": "integer" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic or subscription does not exist" + }, + "405": { + "description": "Skipping messages on a partitioned topic is not allowed" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Skipping messages on a topic subscription.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/skip_all": { + "post": { + "description": "Completely clears the backlog on the subscription.", + "operationId": "PersistentTopics_skipAllMessages", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "Name of subscription", + "in": "path", + "name": "subName", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic or subscription does not exist" + }, + "405": { + "description": "Operation not allowed on non-persistent topic" + }, + "412": { + "description": "Can't find owner for topic" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Skip all messages on a topic subscription.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/subscription/{subscriptionName}": { + "put": { + "description": "Creates a subscription on the topic at the specified message id", + "operationId": "PersistentTopics_createSubscription", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "Name of subscription to be created", + "in": "path", + "name": "subscriptionName", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "messageId where to create the subscription. It can be 'latest', 'earliest' or (ledgerId:entryId)", + "in": "body", + "name": "messageId", + "required": false, + "schema": { + "$ref": "#/definitions/ResetCursorData" + } + }, + { + "description": "Is replicated required to perform this operation", + "in": "query", + "name": "replicated", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "400": { + "description": "Create subscription on non persistent topic is not supported" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic or subscription does not exist" + }, + "405": { + "description": "Not supported for partitioned topics" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Create a subscription on the topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/subscriptionDispatchRate": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeSubscriptionDispatchRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove subscription message dispatch rate configuration for specified topic.", + "tags": [ + "non-persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getSubscriptionDispatchRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/DispatchRate" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Get subscription message dispatch rate configuration for specified topic.", + "tags": [ + "non-persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setSubscriptionDispatchRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "description": "Subscription message dispatch rate for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/DispatchRateImpl" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Set subscription message dispatch rate configuration for specified topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/subscriptionTypesEnabled": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeSubscriptionTypesEnabled", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove subscription types enabled for specified topic.", + "tags": [ + "non-persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getSubscriptionTypesEnabled", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "enum": [ + "Exclusive", + "Shared", + "Failover", + "Key_Shared" + ], + "type": "string" + }, + "type": "array" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Get is enable sub type fors specified topic.", + "tags": [ + "non-persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setSubscriptionTypesEnabled", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "Enable sub types for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "items": { + "enum": [ + "Exclusive", + "Shared", + "Failover", + "Key_Shared" + ], + "type": "string" + }, + "type": "array" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Set is enable sub types for specified topic", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/subscriptions": { + "get": { + "description": "", + "operationId": "PersistentTopics_getSubscriptions", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic does not exist" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Get the list of persistent subscriptions for a given topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/terminate": { + "post": { + "description": "", + "operationId": "PersistentTopics_terminate", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation terminated successfully. The response includes the 'lastMessageId', which is the identifier of the last message processed.", + "schema": { + "$ref": "#/definitions/MessageIdAdv" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic does not exist" + }, + "405": { + "description": "Termination of a partitioned topic is not allowed" + }, + "406": { + "description": "Need to provide a persistent topic name" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "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", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/terminate/partitions": { + "post": { + "description": "", + "operationId": "PersistentTopics_terminatePartitionedTopic", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic does not exist" + }, + "405": { + "description": "Termination of a non-partitioned topic is not allowed" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "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", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/trim": { + "post": { + "description": "", + "operationId": "PersistentTopics_trimTopic", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic does not exist" + }, + "405": { + "description": "Operation is not allowed on the persistent topic" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": " Trim a topic", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/truncate": { + "delete": { + "description": "NonPersistentTopic does not support truncate.", + "operationId": "NonPersistentTopics_truncateTopic", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "412": { + "description": "NonPersistentTopic does not support truncate." + } + }, + "summary": "Truncate a topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/unload": { + "put": { + "description": "", + "operationId": "NonPersistentTopics_unloadTopic", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "This operation requires super-user access" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "The tenant/namespace/topic does not exist" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Unload a topic", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/{subName}/dispatchRate": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeSubscriptionLevelDispatchRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "subName", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove message dispatch rate configuration for specified subscription.", + "tags": [ + "non-persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getSubscriptionLevelDispatchRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "subName", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/DispatchRate" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Get message dispatch rate configuration for specified subscription.", + "tags": [ + "non-persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setSubscriptionLevelDispatchRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "subName", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "description": "Subscription message dispatch rate for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/DispatchRateImpl" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Set message dispatch rate configuration for specified subscription.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}": { + "get": { + "description": "", + "operationId": "PersistentTopics_getList", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify the bundle name", + "in": "query", + "name": "bundle", + "required": false, + "type": "string" + }, + { + "description": "Include system topic", + "in": "query", + "name": "includeSystemTopic", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin or operate permission on the namespace" + }, + "404": { + "description": "tenant/namespace/topic doesn't exit" + }, + "412": { + "description": "Namespace name is not valid" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Get the list of topics under a namespace.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/partitioned": { + "get": { + "description": "", + "operationId": "PersistentTopics_getPartitionedTopicList", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Include system topic", + "in": "query", + "name": "includeSystemTopic", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin or operate permission on the namespace" + }, + "404": { + "description": "tenant/namespace/topic doesn't exit" + }, + "412": { + "description": "Namespace name is not valid" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Get the list of partitioned topics under a namespace.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}": { + "delete": { + "description": "The topic cannot be deleted if delete is not forcefully and there's any active subscription or producer connected to the it. Force delete ignores connected clients and deletes topic by explicitly closing them.", + "operationId": "PersistentTopics_deleteTopic", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Stop all producer/consumer/replicator and delete topic forcefully", + "in": "query", + "name": "force", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic does not exist" + }, + "412": { + "description": "Topic has active producers/subscriptions" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Delete a topic.", + "tags": [ + "persistent topic" + ] + }, + "put": { + "description": "This is the only REST endpoint from which non-partitioned topics could be created.", + "operationId": "PersistentTopics_createNonPartitionedTopic", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "Key value pair properties for the topic metadata", + "in": "body", + "name": "body", + "required": false, + "schema": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or namespace doesn't exist" + }, + "409": { + "description": "Partitioned topic already exist" + }, + "412": { + "description": "Failed Reason : Name is invalid or Namespace does not have any clusters configured" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Create a non-partitioned topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/all_subscription/expireMessages/{expireTimeInSeconds}": { + "post": { + "description": "", + "operationId": "PersistentTopics_expireMessagesForAllSubscriptions", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": 0, + "description": "Expires beyond the specified number of seconds", + "format": "int32", + "in": "path", + "name": "expireTimeInSeconds", + "required": true, + "type": "integer" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic or subscription does not exist" + }, + "405": { + "description": "Expiry messages on a non-persistent topic is not allowed" + }, + "412": { + "description": "Can't find owner for topic" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Expiry messages on all subscriptions of topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/autoSubscriptionCreation": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeAutoSubscriptionCreation", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Topic does not exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove autoSubscriptionCreation ina a topic.", + "tags": [ + "persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getAutoSubscriptionCreation", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/AutoSubscriptionCreationOverrideImpl" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Topic does not exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Get autoSubscriptionCreation info in a topic", + "tags": [ + "persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setAutoSubscriptionCreation", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "Settings for automatic subscription creation", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/AutoSubscriptionCreationOverrideImpl" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Override namespace's allowAutoSubscriptionCreation setting for a topic", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/backlog": { + "get": { + "description": "", + "operationId": "PersistentTopics_getBacklog", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/PersistentOfflineTopicStats" + } + }, + "404": { + "description": "Namespace does not exist" + }, + "412": { + "description": "Topic name is not valid" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Get estimated backlog for offline topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/backlogQuota": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeBacklogQuota", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "enum": [ + "destination_storage", + "message_age" + ], + "in": "query", + "name": "backlogQuotaType", + "required": false, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove a backlog quota policy from a topic.", + "tags": [ + "persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setBacklogQuota", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "enum": [ + "destination_storage", + "message_age" + ], + "in": "query", + "name": "backlogQuotaType", + "required": false, + "type": "string" + }, + { + "description": "backlog quota policies for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/BacklogQuotaImpl" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "Specified backlog quota exceeds retention quota. Increase retention quota and retry request" + } + }, + "summary": "Set a backlog quota for a topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/backlogQuotaMap": { + "get": { + "description": "", + "operationId": "PersistentTopics_getBacklogQuotaMap", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "additionalProperties": { + "$ref": "#/definitions/BacklogQuota" + }, + "type": "object" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Topic policy or namespace does not exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + } + }, + "summary": "Get backlog quota map on a topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/backlogSize": { + "put": { + "description": "", + "operationId": "PersistentTopics_getBacklogSizeByMessageId", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int64", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic does not exist" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Calculate backlog size by a message ID (in bytes).", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/compaction": { + "get": { + "description": "", + "operationId": "PersistentTopics_compactionStatus", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/LongRunningProcessStatus" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic does not exist, or compaction hasn't run" + }, + "405": { + "description": "Operation is not allowed on the persistent topic" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Get the status of a compaction operation for a topic.", + "tags": [ + "persistent topic" + ] + }, + "put": { + "description": "", + "operationId": "PersistentTopics_compact", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic does not exist" + }, + "405": { + "description": "Operation is not allowed on the persistent topic" + }, + "409": { + "description": "Compaction already running" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Trigger a compaction operation on a topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/compactionThreshold": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeCompactionThreshold", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove compaction threshold configuration for specified topic.", + "tags": [ + "persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getCompactionThreshold", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int64", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Get compaction threshold configuration for specified topic.", + "tags": [ + "persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setCompactionThreshold", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "description": "Dispatch rate for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "format": "int64", + "type": "integer" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Set compaction threshold configuration for specified topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/createMissedPartitions": { + "post": { + "description": "", + "operationId": "PersistentTopics_createMissedPartitions", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant does not exist" + }, + "409": { + "description": "Partitioned topic does not exist" + }, + "412": { + "description": "Partitioned topic name is invalid" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Create missed partitions of an existing partitioned topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/deduplicationEnabled": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeDeduplication", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove deduplication configuration for specified topic.", + "tags": [ + "persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getDeduplication", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "type": "boolean" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + } + }, + "summary": "Get deduplication configuration of a topic.", + "tags": [ + "persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setDeduplication", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "DeduplicationEnabled policies for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "type": "boolean" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + } + }, + "summary": "Set deduplication enabled on a topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/deduplicationSnapshotInterval": { + "delete": { + "description": "", + "operationId": "PersistentTopics_deleteDeduplicationSnapshotInterval", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + } + }, + "summary": "Delete deduplicationSnapshotInterval config on a topic.", + "tags": [ + "persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getDeduplicationSnapshotInterval", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int32", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Get deduplicationSnapshotInterval config on a topic.", + "tags": [ + "persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setDeduplicationSnapshotInterval", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "Interval to take deduplication snapshot for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "format": "int32", + "type": "integer" + } + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + } + }, + "summary": "Set deduplicationSnapshotInterval config on a topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/delayedDelivery": { + "delete": { + "description": "", + "operationId": "PersistentTopics_deleteDelayedDeliveryPolicies", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + } + }, + "summary": "Set delayed delivery messages config on a topic.", + "tags": [ + "persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getDelayedDeliveryPolicies", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/DelayedDeliveryPolicies" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Get delayed delivery messages config on a topic.", + "tags": [ + "persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setDelayedDeliveryPolicies", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "Delayed delivery policies for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/DelayedDeliveryPolicies" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + } + }, + "summary": "Set delayed delivery messages config on a topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/dispatchRate": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeDispatchRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove message dispatch rate configuration for specified topic.", + "tags": [ + "persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getDispatchRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/DispatchRateImpl" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Get dispatch rate configuration for specified topic.", + "tags": [ + "persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setDispatchRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "description": "Dispatch rate for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/DispatchRateImpl" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Set message dispatch rate configuration for specified topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/dispatcherPauseOnAckStatePersistent": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeDispatcherPauseOnAckStatePersistent", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove dispatcher pause on ack state persistent configuration for specified topic.", + "tags": [ + "persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getDispatcherPauseOnAckStatePersistent", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int32", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Get dispatcher pause on ack state persistent config on a topic.", + "tags": [ + "persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setDispatcherPauseOnAckStatePersistent", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Set dispatcher pause on ack state persistent configuration for specified topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/entryFilters": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeEntryFilters", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected thiscall to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove entry filters for specified topic.", + "tags": [ + "persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getEntryFilters", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/EntryFilters" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenants or Namespace doesn't exist" + } + }, + "summary": "Get entry filters for a topic.", + "tags": [ + "persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setEntryFilters", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected thiscall to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "Entry filters for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/EntryFilters" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Set entry filters for specified topic", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/examinemessage": { + "get": { + "description": "", + "operationId": "PersistentTopics_examineMessage", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": "latest", + "description": "Relative start position to examine message.It can be 'latest' or 'earliest'", + "enum": [ + "latest", + "earliest" + ], + "in": "query", + "name": "initialPosition", + "required": false, + "type": "string" + }, + { + "default": 1, + "description": "The position of messages (default 1)", + "format": "int64", + "in": "query", + "name": "messagePosition", + "required": false, + "type": "integer" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successfully retrieved the message. The response is a binary byte stream containing the message data. Clients need to parse this binary stream based on the message metadata provided in the response headers." + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic, the message position does not exist" + }, + "405": { + "description": "If given partitioned topic" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Examine a specific message on a topic by position relative to the earliest or the latest message.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/inactiveTopicPolicies": { + "delete": { + "description": "", + "operationId": "PersistentTopics_deleteInactiveTopicPolicies", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + } + }, + "summary": "Delete inactive topic policies on a topic.", + "tags": [ + "persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getInactiveTopicPolicies", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/InactiveTopicPolicies" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Get inactive topic policies on a topic.", + "tags": [ + "persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setInactiveTopicPolicies", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "description": "inactive topic policies for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/InactiveTopicPolicies" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + } + }, + "summary": "Set inactive topic policies on a topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/internal-info": { + "get": { + "description": "", + "operationId": "PersistentTopics_getManagedLedgerInfo", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/PartitionedManagedLedgerInfo" + } + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic does not exist" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Get the stored topic metadata.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/internalStats": { + "get": { + "description": "", + "operationId": "PersistentTopics_getInternalStats", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "metadata", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/PersistentTopicInternalStats" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic does not exist" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Get the internal stats for the topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/lastMessageId": { + "get": { + "description": "", + "operationId": "PersistentTopics_getLastMessageId", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/MessageIdAdv" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic does not exist" + }, + "405": { + "description": "Operation is not allowed on the persistent topic" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Return the last commit message id of topic", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/ledger/{ledgerId}/entry/{entryId}": { + "get": { + "description": "", + "operationId": "PersistentTopics_getMessageById", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "The ledger id", + "format": "int64", + "in": "path", + "name": "ledgerId", + "required": true, + "type": "integer" + }, + { + "description": "The entry id", + "format": "int64", + "in": "path", + "name": "entryId", + "required": true, + "type": "integer" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successfully retrieved the message. The response is a binary byte stream containing the message data. Clients need to parse this binary stream based on the message metadata provided in the response headers." + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic, subscription or the message position does not exist" + }, + "405": { + "description": "Skipping messages on a non-persistent topic is not allowed" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Get message by its messageId.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/maxConsumers": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeMaxConsumers", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove maxConsumers config for specified topic.", + "tags": [ + "persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getMaxConsumers", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int32", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Get maxConsumers config for specified topic.", + "tags": [ + "persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setMaxConsumers", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "The max consumers of the topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "format": "int32", + "type": "integer" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "Invalid value of maxConsumers" + } + }, + "summary": "Set maxConsumers config for specified topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/maxConsumersPerSubscription": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeMaxConsumersPerSubscription", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove max consumers per subscription configuration for specified topic.", + "tags": [ + "persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getMaxConsumersPerSubscription", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int32", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Get max consumers per subscription configuration for specified topic.", + "tags": [ + "persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setMaxConsumersPerSubscription", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "Dispatch rate for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "format": "int32", + "type": "integer" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Set max consumers per subscription configuration for specified topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/maxMessageSize": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeMaxMessageSize", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove maxMessageSize config for specified topic.", + "tags": [ + "persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getMaxMessageSize", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int32", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Get maxMessageSize config for specified topic.", + "tags": [ + "persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setMaxMessageSize", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "The max message size of the topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "format": "int32", + "type": "integer" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "Invalid value of maxConsumers" + } + }, + "summary": "Set maxMessageSize config for specified topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/maxProducers": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeMaxProducers", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove maxProducers config for specified topic.", + "tags": [ + "persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getMaxProducers", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int32", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Get maxProducers config for specified topic.", + "tags": [ + "persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setMaxProducers", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "description": "The max producers of the topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "format": "int32", + "type": "integer" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "Invalid value of maxProducers" + } + }, + "summary": "Set maxProducers config for specified topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/maxSubscriptionsPerTopic": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeMaxSubscriptionsPerTopic", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove maxSubscriptionsPerTopic config for specified topic.", + "tags": [ + "persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getMaxSubscriptionsPerTopic", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int32", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Get maxSubscriptionsPerTopic config for specified topic.", + "tags": [ + "persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setMaxSubscriptionsPerTopic", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "The max subscriptions of the topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "format": "int32", + "type": "integer" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "Invalid value of maxSubscriptionsPerTopic" + } + }, + "summary": "Set maxSubscriptionsPerTopic config for specified topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/maxUnackedMessagesOnConsumer": { + "delete": { + "description": "", + "operationId": "PersistentTopics_deleteMaxUnackedMessagesOnConsumer", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + } + }, + "summary": "Delete max unacked messages per consumer config on a topic.", + "tags": [ + "persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getMaxUnackedMessagesOnConsumer", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int32", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Get max unacked messages per consumer config on a topic.", + "tags": [ + "persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setMaxUnackedMessagesOnConsumer", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "Max unacked messages on consumer policies for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "format": "int32", + "type": "integer" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + } + }, + "summary": "Set max unacked messages per consumer config on a topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/maxUnackedMessagesOnSubscription": { + "delete": { + "description": "", + "operationId": "PersistentTopics_deleteMaxUnackedMessagesOnSubscription", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + } + }, + "summary": "Delete max unacked messages per subscription config on a topic.", + "tags": [ + "persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getMaxUnackedMessagesOnSubscription", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int32", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Get max unacked messages per subscription config on a topic.", + "tags": [ + "persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setMaxUnackedMessagesOnSubscription", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "Max unacked messages on subscription policies for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "format": "int32", + "type": "integer" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + } + }, + "summary": "Set max unacked messages per subscription config on a topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/messageTTL": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeMessageTTL", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Not authenticate to perform the request or policy is read only" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, enable the topic level policy and retry" + }, + "412": { + "description": "Invalid message TTL value" + } + }, + "summary": "Remove message TTL in seconds for a topic", + "tags": [ + "persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getMessageTTL", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int32", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, enable the topic level policy and retry" + } + }, + "summary": "Get message TTL in seconds for a topic", + "tags": [ + "persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setMessageTTL", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "TTL in seconds for the specified topic", + "format": "int32", + "in": "query", + "name": "messageTTL", + "required": true, + "type": "integer" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Not authenticate to perform the request or policy is read only" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, enable the topic level policy and retry" + }, + "412": { + "description": "Invalid message TTL value" + } + }, + "summary": "Set message TTL in seconds for a topic", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/messageid/{timestamp}": { + "get": { + "description": "", + "operationId": "PersistentTopics_getMessageIdByTimestamp", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "Specify the timestamp", + "format": "int64", + "in": "path", + "name": "timestamp", + "required": true, + "type": "integer" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/MessageIdAdv" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic does not exist" + }, + "405": { + "description": "Topic is not non-partitioned and persistent" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Get message ID published at or just after this absolute timestamp (in ms).", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/offload": { + "get": { + "description": "", + "operationId": "PersistentTopics_offloadStatus", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/OffloadProcessStatus" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic does not exist" + }, + "405": { + "description": "Operation is not allowed on the persistent topic" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Offload a prefix of a topic to long term storage", + "tags": [ + "persistent topic" + ] + }, + "put": { + "description": "", + "operationId": "PersistentTopics_triggerOffload", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "400": { + "description": "Message ID is null" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic does not exist" + }, + "405": { + "description": "Operation is not allowed on the persistent topic" + }, + "409": { + "description": "Offload already running" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Offload a prefix of a topic to long term storage", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/offloadPolicies": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeOffloadPolicies", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + } + }, + "summary": "Delete offload policies on a topic.", + "tags": [ + "persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getOffloadPolicies", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/OffloadPoliciesImpl" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Get offload policies on a topic.", + "tags": [ + "persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setOffloadPolicies", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "description": "Offload policies for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/OffloadPoliciesImpl" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + } + }, + "summary": "Set offload policies on a topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/partitioned-internalStats": { + "get": { + "description": "", + "operationId": "PersistentTopics_getPartitionedStatsInternal", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/PartitionedTopicInternalStats" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic does not exist" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Get the stats-internal for the partitioned topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/partitioned-stats": { + "get": { + "description": "", + "operationId": "PersistentTopics_getPartitionedStats", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": true, + "description": "Get per partition stats", + "in": "query", + "name": "perPartition", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "If return precise backlog or imprecise backlog", + "in": "query", + "name": "getPreciseBacklog", + "required": false, + "type": "boolean" + }, + { + "default": true, + "description": "If return backlog size for each subscription, require locking on ledger so be careful not to use when there's heavy traffic.", + "in": "query", + "name": "subscriptionBacklogSize", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "If return the earliest time in backlog", + "in": "query", + "name": "getEarliestTimeInBacklog", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "If exclude the publishers", + "in": "query", + "name": "excludePublishers", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "If exclude the consumers", + "in": "query", + "name": "excludeConsumers", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/PartitionedTopicStatsImpl" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic does not exist" + }, + "412": { + "description": "Partitioned topic name is invalid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Get the stats for the partitioned topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/partitions": { + "delete": { + "description": "It will also delete all the partitions of the topic if it exists.", + "operationId": "PersistentTopics_deletePartitionedTopic", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Stop all producer/consumer/replicator and delete topic forcefully", + "in": "query", + "name": "force", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Partitioned topic does not exist" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "Partitioned topic name is invalid" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Delete a partitioned topic.", + "tags": [ + "persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getPartitionedMetadata", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Is check configuration required to automatically create topic", + "in": "query", + "name": "checkAllowAutoCreation", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/PartitionedTopicMetadata" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Partitioned topic does not exist" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "Partitioned topic name is invalid" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Get partitioned topic metadata.", + "tags": [ + "persistent topic" + ] + }, + "post": { + "description": "It increments partitions of existing partitioned-topic", + "operationId": "PersistentTopics_updatePartitionedTopic", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "updateLocalTopicOnly", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "force", + "required": false, + "type": "boolean" + }, + { + "description": "The number of partitions for the topic", + "in": "body", + "name": "body", + "required": true, + "schema": { + "default": 0, + "format": "int32", + "type": "integer" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Update topic partition successful." + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Unauthenticated" + }, + "403": { + "description": "Forbidden/Unauthorized" + }, + "404": { + "description": "Topic does not exist" + }, + "412": { + "description": "Partitioned topic name is invalid" + }, + "422": { + "description": "The number of partitions should be more than 0 and less than or equal to maxNumPartitionsPerPartitionedTopic and number of new partitions must be greater than existing number of partitions" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Increment partitions of an existing partitioned topic.", + "tags": [ + "persistent topic" + ] + }, + "put": { + "description": "It needs to be called before creating a producer on a partitioned topic.", + "operationId": "PersistentTopics_createPartitionedTopic", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "The number of partitions for the topic", + "in": "body", + "name": "body", + "required": true, + "schema": { + "default": 0, + "format": "int32", + "type": "integer" + } + }, + { + "default": false, + "in": "query", + "name": "createLocalTopicOnly", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or namespace doesn't exist" + }, + "406": { + "description": "The number of partitions should be more than 0 and less than or equal to maxNumPartitionsPerPartitionedTopic" + }, + "409": { + "description": "Partitioned topic already exist" + }, + "412": { + "description": "Failed Reason : Name is invalid or Namespace does not have any clusters configured" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Create a partitioned topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/permissions": { + "get": { + "description": "Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at thenamespace level combined (union) with any eventual specific permission set on the topic.Returns a nested map structure which Swagger does not fully support for display. Structure: Map>. Please refer to this structure for details.", + "operationId": "PersistentTopics_getPermissionsOnTopic", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "additionalProperties": { + "enum": [ + "produce", + "consume", + "functions", + "sources", + "sinks", + "packages" + ], + "type": "string" + }, + "type": "object" + } + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "tenant/namespace/topic doesn't exit" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Get permissions on a topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/permissions/{role}": { + "delete": { + "description": "Revoke permissions to a role on a single topic. If the permission was not set at the topiclevel, but rather at the namespace level, this operation will return an error (HTTP status code 412).", + "operationId": "PersistentTopics_revokePermissionsOnTopic", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "Client role to which grant permissions", + "in": "path", + "name": "role", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "tenant/namespace/topic doesn't exit" + }, + "412": { + "description": "Permissions are not set at the topic level" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Revoke permissions on a topic.", + "tags": [ + "persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_grantPermissionsOnTopic", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "Client role to which grant permissions", + "in": "path", + "name": "role", + "required": true, + "type": "string" + }, + { + "description": "Actions to be granted (produce,functions,consume)", + "in": "body", + "name": "body", + "required": false, + "schema": { + "items": { + "enum": [ + "produce", + "consume", + "functions", + "sources", + "sinks", + "packages" + ], + "type": "string" + }, + "type": "array" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "tenant/namespace/topic doesn't exit" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Grant a new permission to a role on a single topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/persistence": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removePersistence", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove configuration of persistence policies for specified topic.", + "tags": [ + "persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getPersistence", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/PersistencePolicies" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Get configuration of persistence policies for specified topic.", + "tags": [ + "persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setPersistence", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "description": "Bookkeeper persistence policies for specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/PersistencePolicies" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "400": { + "description": "Invalid persistence policies" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Set configuration of persistence policies for specified topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/properties": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeProperties", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "key", + "required": false, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Partitioned topic does not exist" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "Partitioned topic name is invalid" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Remove the key in properties on the given topic.", + "tags": [ + "persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getProperties", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic does not exist" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "Topic name is invalid" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Get topic properties.", + "tags": [ + "persistent topic" + ] + }, + "put": { + "description": "", + "operationId": "PersistentTopics_updateProperties", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "Key value pair properties for the topic metadata", + "in": "body", + "name": "body", + "required": false, + "schema": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic or subscription does not exist" + }, + "405": { + "description": "Method Not Allowed" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Update the properties on the given topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/publishRate": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removePublishRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove message publish rate configuration for specified topic.", + "tags": [ + "persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getPublishRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/PublishRate" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Get publish rate configuration for specified topic.", + "tags": [ + "persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setPublishRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "Dispatch rate for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/PublishRate" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Set message publish rate configuration for specified topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/replication": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeReplicationClusters", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove the replication clusters from a topic.", + "tags": [ + "persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getReplicationClusters", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, enable the topic level policy and retry" + } + }, + "summary": "Get the replication clusters for a topic", + "tags": [ + "persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setReplicationClusters", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "List of replication clusters", + "in": "body", + "name": "body", + "required": true, + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "Topic is not global or invalid cluster ids" + } + }, + "summary": "Set the replication clusters for a topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/replicatorDispatchRate": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeReplicatorDispatchRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove replicatorDispatchRate config for specified topic.", + "tags": [ + "persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getReplicatorDispatchRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/DispatchRate" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Get replicatorDispatchRate config for specified topic.", + "tags": [ + "persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setReplicatorDispatchRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "Replicator dispatch rate of the topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/DispatchRateImpl" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "Invalid value of replicatorDispatchRate" + } + }, + "summary": "Set replicatorDispatchRate config for specified topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/retention": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeRetention", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "Retention Quota must exceed backlog quota" + } + }, + "summary": "Remove retention configuration for specified topic.", + "tags": [ + "persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getRetention", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/RetentionPolicies" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Get retention configuration for specified topic.", + "tags": [ + "persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setRetention", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "description": "Retention policies for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/RetentionPolicies" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "Retention Quota must exceed backlog quota" + } + }, + "summary": "Set retention configuration for specified topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/schemaCompatibilityStrategy": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeSchemaCompatibilityStrategy", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "Strategy used to check the compatibility of new schema", + "in": "body", + "name": "body", + "required": false, + "schema": { + "type": "string" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Operation not allowed on persistent topic" + } + }, + "summary": "Remove schema compatibility strategy on a topic", + "tags": [ + "persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getSchemaCompatibilityStrategy", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the cluster", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "enum": [ + "UNDEFINED", + "ALWAYS_INCOMPATIBLE", + "ALWAYS_COMPATIBLE", + "BACKWARD", + "FORWARD", + "FULL", + "BACKWARD_TRANSITIVE", + "FORWARD_TRANSITIVE", + "FULL_TRANSITIVE" + ], + "type": "string" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Operation not allowed on persistent topic" + } + }, + "summary": "Get schema compatibility strategy on a topic", + "tags": [ + "persistent topic" + ] + }, + "put": { + "description": "", + "operationId": "PersistentTopics_setSchemaCompatibilityStrategy", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "Strategy used to check the compatibility of new schema", + "in": "body", + "name": "body", + "required": false, + "schema": { + "type": "string" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Operation not allowed on persistent topic" + } + }, + "summary": "Set schema compatibility strategy on a topic", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/schemaValidationEnforced": { + "get": { + "description": "", + "operationId": "PersistentTopics_getSchemaValidationEnforced", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "type": "boolean" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenants or Namespace doesn't exist" + } + }, + "summary": "Get schema validation enforced flag for topic.", + "tags": [ + "persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setSchemaValidationEnforced", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "in": "body", + "name": "body", + "required": true, + "schema": { + "type": "boolean" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or Namespace doesn't exist" + }, + "412": { + "description": "schemaValidationEnforced value is not valid" + } + }, + "summary": "Set schema validation enforced flag on topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/shadowTopics": { + "delete": { + "description": "", + "operationId": "PersistentTopics_deleteShadowTopics", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Delete shadow topics for a topic", + "tags": [ + "persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getShadowTopics", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, enable the topic level policy and retry" + } + }, + "summary": "Get the shadow topic list for a topic", + "tags": [ + "persistent topic" + ] + }, + "put": { + "description": "", + "operationId": "PersistentTopics_setShadowTopics", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "List of shadow topics", + "in": "body", + "name": "body", + "required": true, + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Set shadow topic list for a topic", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/stats": { + "get": { + "description": "", + "operationId": "PersistentTopics_getStats", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "If return precise backlog or imprecise backlog", + "in": "query", + "name": "getPreciseBacklog", + "required": false, + "type": "boolean" + }, + { + "default": true, + "description": "If return backlog size for each subscription, require locking on ledger so be careful not to use when there's heavy traffic.", + "in": "query", + "name": "subscriptionBacklogSize", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "If return time of the earliest message in backlog", + "in": "query", + "name": "getEarliestTimeInBacklog", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "If exclude the publishers", + "in": "query", + "name": "excludePublishers", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "If exclude the consumers", + "in": "query", + "name": "excludeConsumers", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/PersistentTopicStats" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic does not exist" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Get the stats for the topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/subscribeRate": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeSubscribeRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "Subscribe rate for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/SubscribeRate" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove subscribe rate configuration for specified topic.", + "tags": [ + "persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getSubscribeRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/SubscribeRate" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Get subscribe rate configuration for specified topic.", + "tags": [ + "persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setSubscribeRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "Subscribe rate for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/SubscribeRate" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Set subscribe rate configuration for specified topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/subscription/{subName}": { + "delete": { + "description": "The subscription cannot be deleted if delete is not forcefully and there are any active consumers attached to it. Force delete ignores connected consumers and deletes subscription by explicitly closing them.", + "operationId": "PersistentTopics_deleteSubscription", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "Subscription to be deleted", + "in": "path", + "name": "subName", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Disconnect and close all consumers and delete subscription forcefully", + "in": "query", + "name": "force", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic or subscription does not exist" + }, + "412": { + "description": "Subscription has active consumers" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Delete a subscription.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/analyzeBacklog": { + "post": { + "description": "", + "operationId": "PersistentTopics_analyzeSubscriptionBacklog", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "Subscription", + "in": "path", + "name": "subName", + "required": true, + "type": "string" + }, + { + "description": "messageId to start the analysis", + "in": "body", + "name": "position", + "required": false, + "schema": { + "$ref": "#/definitions/ResetCursorData" + } + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic or subscription does not exist" + }, + "405": { + "description": "Method Not Allowed" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Analyse a subscription, by scanning all the unprocessed messages", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/expireMessages": { + "post": { + "description": "", + "operationId": "PersistentTopics_expireTopicMessages", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "Subscription to be Expiry messages on", + "in": "path", + "name": "subName", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "messageId to reset back to (ledgerId:entryId)", + "in": "body", + "name": "messageId", + "required": false, + "schema": { + "$ref": "#/definitions/ResetCursorData" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic or subscription does not exist" + }, + "405": { + "description": "Expiry messages on a non-persistent topic is not allowed" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Expiry messages on a topic subscription.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/expireMessages/{expireTimeInSeconds}": { + "post": { + "description": "", + "operationId": "PersistentTopics_expireTopicMessages", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "Subscription to be Expiry messages on", + "in": "path", + "name": "subName", + "required": true, + "type": "string" + }, + { + "default": 0, + "description": "Expires beyond the specified number of seconds", + "format": "int32", + "in": "path", + "name": "expireTimeInSeconds", + "required": true, + "type": "integer" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic or subscription does not exist" + }, + "405": { + "description": "Expiry messages on a non-persistent topic is not allowed" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Expiry messages on a topic subscription.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/position/{messagePosition}": { + "get": { + "description": "", + "operationId": "PersistentTopics_peekNthMessage", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "Subscribed message expired", + "in": "path", + "name": "subName", + "required": true, + "type": "string" + }, + { + "default": 1, + "description": "The number of messages (default 1)", + "format": "int32", + "in": "path", + "name": "messagePosition", + "required": true, + "type": "integer" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successfully retrieved the message. The response is a binary byte stream containing the message data. Clients need to parse this binary stream based on the message metadata provided in the response headers." + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic, subscription or the message position does not exist" + }, + "405": { + "description": "Skipping messages on a non-persistent topic is not allowed" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Peek nth message on a topic subscription.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/properties": { + "get": { + "description": "", + "operationId": "PersistentTopics_getSubscriptionProperties", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "Subscription", + "in": "path", + "name": "subName", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic or subscription does not exist" + }, + "405": { + "description": "Method Not Allowed" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Return all the properties on the given subscription", + "tags": [ + "persistent topic" + ] + }, + "put": { + "description": "", + "operationId": "PersistentTopics_updateSubscriptionProperties", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "Subscription to update", + "in": "path", + "name": "subName", + "required": true, + "type": "string" + }, + { + "description": "The new properties", + "in": "body", + "name": "body", + "required": false, + "schema": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + } + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic or subscription does not exist" + }, + "405": { + "description": "Method Not Allowed" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Replace all the properties on the given subscription", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/replicatedSubscriptionStatus": { + "get": { + "description": "", + "operationId": "PersistentTopics_getReplicatedSubscriptionStatus", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "Name of subscription", + "in": "path", + "name": "subName", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "additionalProperties": { + "type": "boolean" + }, + "type": "object" + } + }, + "401": { + "description": "Don't have permission to administrate resources" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "412": { + "description": "Can't find owner for topic" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Get replicated subscription status on a topic.", + "tags": [ + "persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setReplicatedSubscriptionStatus", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "Name of subscription", + "in": "path", + "name": "subName", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "Whether to enable replicated subscription", + "in": "body", + "name": "body", + "required": true, + "schema": { + "type": "boolean" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant or subscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Topic or subscription does not exist" + }, + "405": { + "description": "Operation not allowed on this topic" + }, + "412": { + "description": "Can't find owner for topic" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Enable or disable a replicated subscription on a topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/resetcursor": { + "post": { + "description": "It fence cursor and disconnects all active consumers before resetting cursor.", + "operationId": "PersistentTopics_resetCursorOnPosition", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "Subscription to reset position on", + "in": "path", + "name": "subName", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "messageId to reset back to (ledgerId:entryId)", + "in": "body", + "name": "messageId", + "required": false, + "schema": { + "$ref": "#/definitions/ResetCursorData" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic or subscription does not exist" + }, + "405": { + "description": "Not supported for partitioned topics" + }, + "412": { + "description": "Unable to find position for position specified" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Reset subscription to message position closest to given position.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/resetcursor/{timestamp}": { + "post": { + "description": "It fence cursor and disconnects all active consumers before resetting cursor.", + "operationId": "PersistentTopics_resetCursor", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "Subscription to reset position on", + "in": "path", + "name": "subName", + "required": true, + "type": "string" + }, + { + "description": "the timestamp to reset back", + "format": "int64", + "in": "path", + "name": "timestamp", + "required": true, + "type": "integer" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic or subscription does not exist" + }, + "405": { + "description": "Method Not Allowed" + }, + "412": { + "description": "Failed to reset cursor on subscription or Unable to find position for timestamp specified" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Reset subscription to message position closest to absolute timestamp (in ms).", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/skip/{numMessages}": { + "post": { + "description": "", + "operationId": "PersistentTopics_skipMessages", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "Name of subscription", + "in": "path", + "name": "subName", + "required": true, + "type": "string" + }, + { + "default": 0, + "description": "The number of messages to skip", + "format": "int32", + "in": "path", + "name": "numMessages", + "required": true, + "type": "integer" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic or subscription does not exist" + }, + "405": { + "description": "Skipping messages on a partitioned topic is not allowed" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Skipping messages on a topic subscription.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/skip_all": { + "post": { + "description": "Completely clears the backlog on the subscription.", + "operationId": "PersistentTopics_skipAllMessages", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "Name of subscription", + "in": "path", + "name": "subName", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic or subscription does not exist" + }, + "405": { + "description": "Operation not allowed on non-persistent topic" + }, + "412": { + "description": "Can't find owner for topic" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Skip all messages on a topic subscription.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/subscription/{subscriptionName}": { + "put": { + "description": "Creates a subscription on the topic at the specified message id", + "operationId": "PersistentTopics_createSubscription", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "Name of subscription to be created", + "in": "path", + "name": "subscriptionName", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "messageId where to create the subscription. It can be 'latest', 'earliest' or (ledgerId:entryId)", + "in": "body", + "name": "messageId", + "required": false, + "schema": { + "$ref": "#/definitions/ResetCursorData" + } + }, + { + "description": "Is replicated required to perform this operation", + "in": "query", + "name": "replicated", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "400": { + "description": "Create subscription on non persistent topic is not supported" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic or subscription does not exist" + }, + "405": { + "description": "Not supported for partitioned topics" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Create a subscription on the topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/subscriptionDispatchRate": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeSubscriptionDispatchRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove subscription message dispatch rate configuration for specified topic.", + "tags": [ + "persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getSubscriptionDispatchRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/DispatchRate" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Get subscription message dispatch rate configuration for specified topic.", + "tags": [ + "persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setSubscriptionDispatchRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "description": "Subscription message dispatch rate for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/DispatchRateImpl" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Set subscription message dispatch rate configuration for specified topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/subscriptionTypesEnabled": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeSubscriptionTypesEnabled", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove subscription types enabled for specified topic.", + "tags": [ + "persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getSubscriptionTypesEnabled", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "enum": [ + "Exclusive", + "Shared", + "Failover", + "Key_Shared" + ], + "type": "string" + }, + "type": "array" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Get is enable sub type fors specified topic.", + "tags": [ + "persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setSubscriptionTypesEnabled", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "Enable sub types for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "items": { + "enum": [ + "Exclusive", + "Shared", + "Failover", + "Key_Shared" + ], + "type": "string" + }, + "type": "array" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Set is enable sub types for specified topic", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/subscriptions": { + "get": { + "description": "", + "operationId": "PersistentTopics_getSubscriptions", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic does not exist" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Get the list of persistent subscriptions for a given topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/terminate": { + "post": { + "description": "", + "operationId": "PersistentTopics_terminate", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation terminated successfully. The response includes the 'lastMessageId', which is the identifier of the last message processed.", + "schema": { + "$ref": "#/definitions/MessageIdAdv" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic does not exist" + }, + "405": { + "description": "Termination of a partitioned topic is not allowed" + }, + "406": { + "description": "Need to provide a persistent topic name" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "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", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/terminate/partitions": { + "post": { + "description": "", + "operationId": "PersistentTopics_terminatePartitionedTopic", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic does not exist" + }, + "405": { + "description": "Termination of a non-partitioned topic is not allowed" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "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", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/trim": { + "post": { + "description": "", + "operationId": "PersistentTopics_trimTopic", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic does not exist" + }, + "405": { + "description": "Operation is not allowed on the persistent topic" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": " Trim a topic", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/truncate": { + "delete": { + "description": "The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers.", + "operationId": "PersistentTopics_truncateTopic", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic does not exist" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Truncate a topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/unload": { + "put": { + "description": "", + "operationId": "PersistentTopics_unloadTopic", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic does not exist" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "Topic name is not valid or can't find owner for topic" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Unload a topic", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/{subName}/dispatchRate": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeSubscriptionLevelDispatchRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "subName", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove message dispatch rate configuration for specified subscription.", + "tags": [ + "persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getSubscriptionLevelDispatchRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "subName", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/DispatchRate" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Get message dispatch rate configuration for specified subscription.", + "tags": [ + "persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setSubscriptionLevelDispatchRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "subName", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "description": "Subscription message dispatch rate for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/DispatchRateImpl" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Set message dispatch rate configuration for specified subscription.", + "tags": [ + "persistent topic" + ] + } + }, + "/resource-quotas": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "ResourceQuotas_getDefaultResourceQuota", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "403": { + "description": "Don't have admin permission" + } + }, + "summary": "Get the default quota", + "tags": [ + "resource-quotas" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "ResourceQuotas_setDefaultResourceQuota", + "parameters": [ + { + "description": "Default resource quota", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/ResourceQuota" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "403": { + "description": "Don't have admin permission" + } + }, + "summary": "Set the default quota", + "tags": [ + "resource-quotas" + ] + } + }, + "/resource-quotas/{tenant}/{namespace}/{bundle}": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "ResourceQuotas_removeNamespaceBundleResourceQuota", + "parameters": [ + { + "description": "Tenant name", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Namespace name within the specified tenant", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Namespace bundle range", + "in": "path", + "name": "bundle", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace" + }, + "403": { + "description": "Don't have admin permission" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove resource quota for a namespace.", + "tags": [ + "resource-quotas" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "ResourceQuotas_getNamespaceBundleResourceQuota", + "parameters": [ + { + "description": "Tenant name", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Namespace name within the specified tenant", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Namespace bundle range", + "in": "path", + "name": "bundle", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/ResourceQuota" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + } + }, + "summary": "Get resource quota of a namespace bundle.", + "tags": [ + "resource-quotas" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "ResourceQuotas_setNamespaceBundleResourceQuota", + "parameters": [ + { + "description": "Tenant name", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Namespace name within the specified tenant", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Namespace bundle range", + "in": "path", + "name": "bundle", + "required": true, + "type": "string" + }, + { + "description": "Resource quota for the specified namespace", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/ResourceQuota" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace" + }, + "403": { + "description": "Don't have admin permission" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Set resource quota on a namespace.", + "tags": [ + "resource-quotas" + ] + } + }, + "/resourcegroups": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "ResourceGroups_getResourceGroups", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "403": { + "description": "Don't have admin permission" + } + }, + "summary": "Get the list of all the resourcegroups.", + "tags": [ + "resourcegroups" + ] + } + }, + "/resourcegroups/{resourcegroup}": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "ResourceGroups_deleteResourceGroup", + "parameters": [ + { + "in": "path", + "name": "resourcegroup", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "ResourceGroup doesn't exist" + }, + "409": { + "description": "ResourceGroup is in use" + } + }, + "summary": "Delete a resourcegroup.", + "tags": [ + "resourcegroups" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "ResourceGroups_getResourceGroup", + "parameters": [ + { + "in": "path", + "name": "resourcegroup", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/ResourceGroup" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "ResourceGroup doesn't exist" + } + }, + "summary": "Get the rate limiters specified for a resourcegroup.", + "tags": [ + "resourcegroups" + ] + }, + "put": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "ResourceGroups_createOrUpdateResourceGroup", + "parameters": [ + { + "in": "path", + "name": "resourcegroup", + "required": true, + "type": "string" + }, + { + "description": "Rate limiters for the resourcegroup", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/ResourceGroup" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "cluster doesn't exist" + } + }, + "summary": "Creates a new resourcegroup with the specified rate limiters", + "tags": [ + "resourcegroups" + ] + } + }, + "/schemas/{tenant}/{namespace}/{topic}/compatibility": { + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "SchemasResource_testCompatibility", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "A JSON value presenting a schema payload. An example of the expected schema can be found down here.", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/PostSchemaPayload" + }, + "x-examples": { + "application/json": "{\"type\": \"STRING\", \"schema\": \"\", \"properties\": { \"key1\" : \"value1\" + } }" + } + }, + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/IsCompatibilityResponse" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Client is not authorized or Don't have admin permission" + }, + "403": { + "description": "Client is not authenticated" + }, + "404": { + "description": "Tenant or Namespace or Topic doesn't exist" + }, + "412": { + "description": "Failed to find the ownership for the topic" + }, + "500": { + "description": "Internal Server Error" + } + }, + "summary": "test the schema compatibility", + "tags": [ + "schemas" + ] + } + }, + "/schemas/{tenant}/{namespace}/{topic}/metadata": { + "get": { + "description": "", + "operationId": "SchemasResource_getSchemaMetadata", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/GetAllVersionsSchemaResponse" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Client is not authorized or Don't have admin permission" + }, + "403": { + "description": "Client is not authenticated" + }, + "404": { + "description": "Tenant or Namespace or Topic doesn't exist; or Schema is not found for this topic" + }, + "412": { + "description": "Failed to find the ownership for the topic" + }, + "500": { + "description": "Internal Server Error" + } + }, + "summary": "Get the schema metadata of a topic", + "tags": [ + "schemas" + ] + } + }, + "/schemas/{tenant}/{namespace}/{topic}/schema": { + "delete": { + "description": "", + "operationId": "SchemasResource_deleteSchema", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "force", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/DeleteSchemaResponse" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Client is not authorized or Don't have admin permission" + }, + "403": { + "description": "Client is not authenticated" + }, + "404": { + "description": "Tenant or Namespace or Topic doesn't exist" + }, + "412": { + "description": "Failed to find the ownership for the topic" + }, + "500": { + "description": "Internal Server Error" + } + }, + "summary": "Delete all versions schema of a topic", + "tags": [ + "schemas" + ] + }, + "get": { + "description": "", + "operationId": "SchemasResource_getSchema", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/GetSchemaResponse" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Client is not authorized or Don't have admin permission" + }, + "403": { + "description": "Client is not authenticated" + }, + "404": { + "description": "Tenant or Namespace or Topic doesn't exist; or Schema is not found for this topic" + }, + "412": { + "description": "Failed to find the ownership for the topic" + }, + "500": { + "description": "Internal Server Error" + } + }, + "summary": "Get the schema of a topic", + "tags": [ + "schemas" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "SchemasResource_postSchema", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "A JSON value presenting a schema payload. An example of the expected schema can be found down here.", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/PostSchemaPayload" + }, + "x-examples": { + "application/json": "{\"type\": \"STRING\", \"schema\": \"\", \"properties\": { \"key1\" : \"value1\" + } }" + } + }, + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/PostSchemaResponse" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Client is not authorized or Don't have admin permission" + }, + "403": { + "description": "Client is not authenticated" + }, + "404": { + "description": "Tenant or Namespace or Topic doesn't exist" + }, + "409": { + "description": "Incompatible schema" + }, + "412": { + "description": "Failed to find the ownership for the topic" + }, + "422": { + "description": "Invalid schema data" + }, + "500": { + "description": "Internal Server Error" + } + }, + "summary": "Update the schema of a topic", + "tags": [ + "schemas" + ] + } + }, + "/schemas/{tenant}/{namespace}/{topic}/schema/{version}": { + "get": { + "description": "", + "operationId": "SchemasResource_getSchema", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/GetSchemaResponse" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Client is not authorized or Don't have admin permission" + }, + "403": { + "description": "Client is not authenticated" + }, + "404": { + "description": "Tenant or Namespace or Topic doesn't exist; or Schema is not found for this topic" + }, + "412": { + "description": "Failed to find the ownership for the topic" + }, + "500": { + "description": "Internal Server Error" + } + }, + "summary": "Get the schema of a topic at a given version", + "tags": [ + "schemas" + ] + } + }, + "/schemas/{tenant}/{namespace}/{topic}/schemas": { + "get": { + "description": "", + "operationId": "SchemasResource_getAllSchemas", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/GetAllVersionsSchemaResponse" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Client is not authorized or Don't have admin permission" + }, + "403": { + "description": "Client is not authenticated" + }, + "404": { + "description": "Tenant or Namespace or Topic doesn't exist; or Schema is not found for this topic" + }, + "412": { + "description": "Failed to find the ownership for the topic" + }, + "500": { + "description": "Internal Server Error" + } + }, + "summary": "Get the all schemas of a topic", + "tags": [ + "schemas" + ] + } + }, + "/schemas/{tenant}/{namespace}/{topic}/version": { + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "SchemasResource_getVersionBySchema", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "A JSON value presenting a schema payload. An example of the expected schema can be found down here.", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/PostSchemaPayload" + }, + "x-examples": { + "application/json": "{\"type\": \"STRING\", \"schema\": \"\", \"properties\": { \"key1\" : \"value1\" + } }" + } + }, + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/LongSchemaVersion" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Client is not authorized or Don't have admin permission" + }, + "403": { + "description": "Client is not authenticated" + }, + "404": { + "description": "Tenant or Namespace or Topic doesn't exist" + }, + "412": { + "description": "Failed to find the ownership for the topic" + }, + "422": { + "description": "Invalid schema data" + }, + "500": { + "description": "Internal Server Error" + } + }, + "summary": "get the version of the schema", + "tags": [ + "schemas" + ] + } + }, + "/tenants": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "TenantsBase_getTenants", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "403": { + "description": "The requester doesn't have admin permissions" + }, + "404": { + "description": "Tenant doesn't exist" + } + }, + "summary": "Get the list of existing tenants.", + "tags": [ + "tenants" + ] + } + }, + "/tenants/{tenant}": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "TenantsBase_deleteTenant", + "parameters": [ + { + "description": "The tenant name", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "force", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "The requester doesn't have admin permissions" + }, + "404": { + "description": "Tenant does not exist" + }, + "405": { + "description": "Broker doesn't allow forced deletion of tenants" + }, + "409": { + "description": "The tenant still has active namespaces" + } + }, + "summary": "Delete a tenant and all namespaces and topics under it.", + "tags": [ + "tenants" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "TenantsBase_getTenantAdmin", + "parameters": [ + { + "description": "The tenant name", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/TenantInfo" + } + }, + "403": { + "description": "The requester doesn't have admin permissions" + }, + "404": { + "description": "Tenant does not exist" + } + }, + "summary": "Get the admin configuration for a given tenant.", + "tags": [ + "tenants" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "This operation requires Pulsar super-user privileges.", + "operationId": "TenantsBase_updateTenant", + "parameters": [ + { + "description": "The tenant name", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "TenantInfo", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/TenantInfo" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "The requester doesn't have admin permissions" + }, + "404": { + "description": "Tenant does not exist" + }, + "409": { + "description": "Tenant already exists" + }, + "412": { + "description": "Clusters do not exist" + } + }, + "summary": "Update the admins for a tenant.", + "tags": [ + "tenants" + ] + }, + "put": { + "consumes": [ + "application/json" + ], + "description": "This operation requires Pulsar super-user privileges.", + "operationId": "TenantsBase_createTenant", + "parameters": [ + { + "description": "The tenant name", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "TenantInfo", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/TenantInfo" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "The requester doesn't have admin permissions" + }, + "409": { + "description": "Tenant already exists" + }, + "412": { + "description": "Clusters do not exist" + } + }, + "summary": "Create a new tenant.", + "tags": [ + "tenants" + ] + } + }, + "/worker-stats/functionsmetrics": { + "get": { + "description": "Requested should be executed by Monitoring agent on each worker to fetch the metrics", + "operationId": "WorkerStats_getStats", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "$ref": "#/definitions/WorkerFunctionInstanceStats" + }, + "type": "array" + } + }, + "401": { + "description": "Don't have admin permission" + }, + "503": { + "description": "Worker service is not running" + } + }, + "summary": "Get metrics for all functions owned by worker" + } + }, + "/worker-stats/metrics": { + "get": { + "description": "Request should be executed by Monitoring agent on each worker to fetch the worker-metrics", + "operationId": "WorkerStats_getMetrics", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "$ref": "#/definitions/Metrics" + }, + "type": "array" + } + }, + "401": { + "description": "Don't have admin permission" + }, + "503": { + "description": "Worker service is not running" + } + }, + "summary": "Gets the metrics for Monitoring" + } + }, + "/worker/assignments": { + "get": { + "description": "Returns a nested map structure which Swagger does not fully support for display.Structure: Map>. Please refer to this structure for details.", + "operationId": "Worker_getAssignments", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "additionalProperties": { + "type": "object" + }, + "type": "object" + } + }, + "403": { + "description": "The requester doesn't have admin permissions" + }, + "503": { + "description": "Worker service is not running" + } + }, + "summary": "Fetches information about which Pulsar Functions are assigned to which Pulsar clusters" + } + }, + "/worker/cluster": { + "get": { + "description": "", + "operationId": "Worker_getCluster", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "$ref": "#/definitions/WorkerInfo" + }, + "type": "array" + } + }, + "403": { + "description": "The requester doesn't have admin permissions" + }, + "503": { + "description": "Worker service is not running" + } + }, + "summary": "Fetches information about the Pulsar cluster running Pulsar Functions" + } + }, + "/worker/cluster/leader": { + "get": { + "description": "", + "operationId": "Worker_getClusterLeader", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/WorkerInfo" + } + }, + "403": { + "description": "The requester doesn't have admin permissions" + }, + "503": { + "description": "Worker service is not running" + } + }, + "summary": "Fetches info about the leader node of the Pulsar cluster running Pulsar Functions" + } + }, + "/worker/cluster/leader/ready": { + "get": { + "description": "", + "operationId": "Worker_isLeaderReady", + "responses": { + "200": { + "description": "successful operation", + "schema": { + "type": "boolean" + } + }, + "503": { + "description": "Worker service is not running" + } + }, + "summary": "Checks if this node is the leader and is ready to service requests" + } + }, + "/worker/connectors": { + "get": { + "description": "", + "operationId": "Worker_getConnectorsList", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "$ref": "#/definitions/ConnectorDefinition" + }, + "type": "array" + } + }, + "400": { + "description": "Invalid request" + }, + "403": { + "description": "The requester doesn't have admin permissions" + }, + "408": { + "description": "Request timeout" + } + }, + "summary": "Fetches a list of supported Pulsar IO connectors currently running in cluster mode" + } + }, + "/worker/drain": { + "get": { + "description": "", + "operationId": "Worker_getDrainStatus", + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/LongRunningProcessStatus" + } + }, + "403": { + "description": "The requester doesn't have admin permissions" + }, + "503": { + "description": "Worker service is not ready" + } + }, + "summary": "Get the status of any ongoing drain operation at this worker" + }, + "put": { + "description": "", + "operationId": "Worker_drain", + "responses": { + "204": { + "description": "Operation successful" + }, + "400": { + "description": "Invalid request" + }, + "403": { + "description": "The requester doesn't have admin permissions" + }, + "408": { + "description": "Request timeout" + }, + "409": { + "description": "Drain already in progress" + }, + "503": { + "description": "Worker service is not ready" + } + }, + "summary": "Drains this worker, i.e., moves its work-assignments to other workers" + } + }, + "/worker/leader/drain": { + "get": { + "description": "", + "operationId": "Worker_getDrainStatusFromLeader", + "parameters": [ + { + "in": "query", + "name": "workerId", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/LongRunningProcessStatus" + } + }, + "403": { + "description": "The requester doesn't have admin permissions" + }, + "503": { + "description": "Worker service is not ready" + } + }, + "summary": "Get the status of any ongoing drain operation at the specified worker" + }, + "put": { + "description": "", + "operationId": "Worker_drainAtLeader", + "parameters": [ + { + "in": "query", + "name": "workerId", + "required": false, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "400": { + "description": "Invalid request" + }, + "403": { + "description": "The requester doesn't have admin permissions" + }, + "408": { + "description": "Request timeout" + }, + "409": { + "description": "Drain already in progress" + }, + "503": { + "description": "Worker service is not ready" + } + }, + "summary": "Drains the specified worker, i.e., moves its work-assignments to other workers" + } + }, + "/worker/rebalance": { + "put": { + "description": "", + "operationId": "Worker_rebalance", + "responses": { + "204": { + "description": "Operation successful" + }, + "400": { + "description": "Invalid request" + }, + "403": { + "description": "The requester doesn't have admin permissions" + }, + "408": { + "description": "Request timeout" + } + }, + "summary": "Triggers a rebalance of functions to workers" + } + } + }, + "schemes": [ + "http", + "https" + ], + "swagger": "2.0", + "tags": [ + { + "name": "bookies" + }, + { + "name": "broker-stats" + }, + { + "name": "brokers" + }, + { + "name": "clusters" + }, + { + "name": "namespaces" + }, + { + "name": "non-persistent topic" + }, + { + "name": "persistent topic" + }, + { + "name": "resource-quotas" + }, + { + "name": "resourcegroups" + }, + { + "name": "schemas" + }, + { + "name": "tenants" + } + ] +} diff --git a/static/swagger/4.0.0/swaggerfunctions.json b/static/swagger/4.0.0/swaggerfunctions.json new file mode 100644 index 000000000000..9e40f88b1870 --- /dev/null +++ b/static/swagger/4.0.0/swaggerfunctions.json @@ -0,0 +1,2047 @@ +{ + "basePath": "/admin/v3", + "definitions": { + "AuthenticationDataSource": { + "properties": { + "commandData": { + "type": "string" + }, + "httpAuthType": { + "type": "string" + }, + "peerAddress": { + "$ref": "#/definitions/SocketAddress" + }, + "subscription": { + "type": "string" + }, + "tlsCertificates": { + "items": { + "$ref": "#/definitions/Certificate" + }, + "type": "array" + } + }, + "type": "object" + }, + "AuthenticationParameters": { + "properties": { + "clientAuthenticationDataSource": { + "$ref": "#/definitions/AuthenticationDataSource" + }, + "clientRole": { + "type": "string" + }, + "originalPrincipal": { + "type": "string" + } + }, + "type": "object" + }, + "Certificate": { + "properties": { + "encoded": { + "items": { + "format": "byte", + "type": "string" + }, + "type": "array" + }, + "publicKey": { + "$ref": "#/definitions/PublicKey" + }, + "type": { + "type": "string" + } + }, + "type": "object" + }, + "CompletableFuture": { + "properties": { + "cancelled": { + "type": "boolean" + }, + "completedExceptionally": { + "type": "boolean" + }, + "done": { + "type": "boolean" + }, + "numberOfDependents": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "CompletableFutureClusterData": { + "properties": { + "cancelled": { + "type": "boolean" + }, + "completedExceptionally": { + "type": "boolean" + }, + "done": { + "type": "boolean" + }, + "numberOfDependents": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "CompletableFutureVoid": { + "properties": { + "cancelled": { + "type": "boolean" + }, + "completedExceptionally": { + "type": "boolean" + }, + "done": { + "type": "boolean" + }, + "numberOfDependents": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "ConnectorDefinition": { + "properties": { + "description": { + "type": "string" + }, + "name": { + "type": "string" + }, + "sinkClass": { + "type": "string" + }, + "sinkConfigClass": { + "type": "string" + }, + "sourceClass": { + "type": "string" + }, + "sourceConfigClass": { + "type": "string" + } + }, + "type": "object" + }, + "ConsumerConfig": { + "properties": { + "consumerProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "cryptoConfig": { + "$ref": "#/definitions/CryptoConfig" + }, + "poolMessages": { + "type": "boolean" + }, + "receiverQueueSize": { + "format": "int32", + "type": "integer" + }, + "regexPattern": { + "type": "boolean" + }, + "schemaProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "schemaType": { + "type": "string" + }, + "serdeClassName": { + "type": "string" + } + }, + "type": "object" + }, + "CryptoConfig": { + "properties": { + "consumerCryptoFailureAction": { + "enum": [ + "FAIL", + "DISCARD", + "CONSUME" + ], + "type": "string" + }, + "cryptoKeyReaderClassName": { + "type": "string" + }, + "cryptoKeyReaderConfig": { + "additionalProperties": { + "type": "object" + }, + "type": "object" + }, + "encryptionKeys": { + "items": { + "type": "string" + }, + "type": "array" + }, + "producerCryptoFailureAction": { + "enum": [ + "FAIL", + "SEND" + ], + "type": "string" + } + }, + "type": "object" + }, + "ExceptionInformation": { + "properties": { + "exceptionString": { + "type": "string" + }, + "timestampMs": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "FunctionConfig": { + "properties": { + "autoAck": { + "type": "boolean" + }, + "batchBuilder": { + "type": "string" + }, + "className": { + "type": "string" + }, + "cleanupSubscription": { + "type": "boolean" + }, + "customRuntimeOptions": { + "type": "string" + }, + "customSchemaInputs": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "customSchemaOutputs": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "customSerdeInputs": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "deadLetterTopic": { + "type": "string" + }, + "exposePulsarAdminClientEnabled": { + "type": "boolean" + }, + "forwardSourceMessageProperty": { + "type": "boolean" + }, + "fqfn": { + "type": "string" + }, + "functionType": { + "type": "string" + }, + "go": { + "type": "string" + }, + "inputSpecs": { + "additionalProperties": { + "$ref": "#/definitions/ConsumerConfig" + }, + "type": "object" + }, + "inputTypeClassName": { + "type": "string" + }, + "inputs": { + "items": { + "type": "string" + }, + "type": "array" + }, + "jar": { + "type": "string" + }, + "logTopic": { + "type": "string" + }, + "maxMessageRetries": { + "format": "int32", + "type": "integer" + }, + "maxPendingAsyncRequests": { + "format": "int32", + "type": "integer" + }, + "name": { + "type": "string" + }, + "namespace": { + "type": "string" + }, + "output": { + "type": "string" + }, + "outputSchemaType": { + "type": "string" + }, + "outputSerdeClassName": { + "type": "string" + }, + "outputTypeClassName": { + "type": "string" + }, + "parallelism": { + "format": "int32", + "type": "integer" + }, + "processingGuarantees": { + "enum": [ + "ATLEAST_ONCE", + "ATMOST_ONCE", + "EFFECTIVELY_ONCE", + "MANUAL" + ], + "type": "string" + }, + "producerConfig": { + "$ref": "#/definitions/ProducerConfig" + }, + "py": { + "type": "string" + }, + "resources": { + "$ref": "#/definitions/Resources" + }, + "retainKeyOrdering": { + "type": "boolean" + }, + "retainOrdering": { + "type": "boolean" + }, + "runtime": { + "enum": [ + "JAVA", + "PYTHON", + "GO" + ], + "type": "string" + }, + "runtimeFlags": { + "type": "string" + }, + "secrets": { + "additionalProperties": { + "type": "object" + }, + "type": "object" + }, + "skipToLatest": { + "type": "boolean" + }, + "subName": { + "type": "string" + }, + "subscriptionPosition": { + "enum": [ + "Latest", + "Earliest" + ], + "type": "string" + }, + "tenant": { + "type": "string" + }, + "timeoutMs": { + "format": "int64", + "type": "integer" + }, + "topicsPattern": { + "type": "string" + }, + "userConfig": { + "additionalProperties": { + "type": "object" + }, + "type": "object" + }, + "windowConfig": { + "$ref": "#/definitions/WindowConfig" + } + }, + "type": "object" + }, + "FunctionDefinition": { + "properties": { + "description": { + "type": "string" + }, + "functionClass": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "type": "object" + }, + "FunctionInstanceStatsData": { + "properties": { + "avgProcessLatency": { + "format": "double", + "type": "number" + }, + "lastInvocation": { + "format": "int64", + "type": "integer" + }, + "oneMin": { + "$ref": "#/definitions/FunctionInstanceStatsDataBase" + }, + "processedSuccessfullyTotal": { + "format": "int64", + "type": "integer" + }, + "receivedTotal": { + "format": "int64", + "type": "integer" + }, + "systemExceptionsTotal": { + "format": "int64", + "type": "integer" + }, + "userExceptionsTotal": { + "format": "int64", + "type": "integer" + }, + "userMetrics": { + "additionalProperties": { + "format": "double", + "type": "number" + }, + "type": "object" + } + }, + "type": "object" + }, + "FunctionInstanceStatsDataBase": { + "properties": { + "avgProcessLatency": { + "format": "double", + "type": "number" + }, + "processedSuccessfullyTotal": { + "format": "int64", + "type": "integer" + }, + "receivedTotal": { + "format": "int64", + "type": "integer" + }, + "systemExceptionsTotal": { + "format": "int64", + "type": "integer" + }, + "userExceptionsTotal": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "FunctionInstanceStatsDataBaseImpl": { + "properties": { + "avgProcessLatency": { + "format": "double", + "type": "number" + }, + "processedSuccessfullyTotal": { + "format": "int64", + "type": "integer" + }, + "receivedTotal": { + "format": "int64", + "type": "integer" + }, + "systemExceptionsTotal": { + "format": "int64", + "type": "integer" + }, + "userExceptionsTotal": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "FunctionInstanceStatsDataImpl": { + "properties": { + "1min": { + "$ref": "#/definitions/FunctionInstanceStatsDataBaseImpl" + }, + "avgProcessLatency": { + "format": "double", + "type": "number" + }, + "lastInvocation": { + "format": "int64", + "type": "integer" + }, + "processedSuccessfullyTotal": { + "format": "int64", + "type": "integer" + }, + "receivedTotal": { + "format": "int64", + "type": "integer" + }, + "systemExceptionsTotal": { + "format": "int64", + "type": "integer" + }, + "userExceptionsTotal": { + "format": "int64", + "type": "integer" + }, + "userMetrics": { + "additionalProperties": { + "format": "double", + "type": "number" + }, + "type": "object" + } + }, + "type": "object" + }, + "FunctionInstanceStatsImpl": { + "properties": { + "instanceId": { + "format": "int32", + "type": "integer" + }, + "metrics": { + "$ref": "#/definitions/FunctionInstanceStatsData" + } + }, + "type": "object" + }, + "FunctionInstanceStatus": { + "properties": { + "instanceId": { + "format": "int32", + "type": "integer" + }, + "status": { + "$ref": "#/definitions/FunctionInstanceStatusData" + } + }, + "type": "object" + }, + "FunctionInstanceStatusData": { + "properties": { + "averageLatency": { + "format": "double", + "type": "number" + }, + "error": { + "type": "string" + }, + "lastInvocationTime": { + "format": "int64", + "type": "integer" + }, + "latestSystemExceptions": { + "items": { + "$ref": "#/definitions/ExceptionInformation" + }, + "type": "array" + }, + "latestUserExceptions": { + "items": { + "$ref": "#/definitions/ExceptionInformation" + }, + "type": "array" + }, + "numReceived": { + "format": "int64", + "type": "integer" + }, + "numRestarts": { + "format": "int64", + "type": "integer" + }, + "numSuccessfullyProcessed": { + "format": "int64", + "type": "integer" + }, + "numSystemExceptions": { + "format": "int64", + "type": "integer" + }, + "numUserExceptions": { + "format": "int64", + "type": "integer" + }, + "running": { + "type": "boolean" + }, + "workerId": { + "type": "string" + } + }, + "type": "object" + }, + "FunctionState": { + "properties": { + "byteValue": { + "items": { + "format": "byte", + "type": "string" + }, + "type": "array" + }, + "key": { + "type": "string" + }, + "numberValue": { + "format": "int64", + "type": "integer" + }, + "stringValue": { + "type": "string" + }, + "version": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "FunctionStatsImpl": { + "properties": { + "1min": { + "$ref": "#/definitions/FunctionInstanceStatsDataBaseImpl" + }, + "avgProcessLatency": { + "format": "double", + "type": "number" + }, + "instances": { + "items": { + "$ref": "#/definitions/FunctionInstanceStatsImpl" + }, + "type": "array" + }, + "lastInvocation": { + "format": "int64", + "type": "integer" + }, + "processedSuccessfullyTotal": { + "format": "int64", + "type": "integer" + }, + "receivedTotal": { + "format": "int64", + "type": "integer" + }, + "systemExceptionsTotal": { + "format": "int64", + "type": "integer" + }, + "userExceptionsTotal": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "FunctionStatus": { + "properties": { + "instances": { + "items": { + "$ref": "#/definitions/FunctionInstanceStatus" + }, + "type": "array" + }, + "numInstances": { + "format": "int32", + "type": "integer" + }, + "numRunning": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "InputStream": { + "type": "object" + }, + "ProducerConfig": { + "properties": { + "batchBuilder": { + "type": "string" + }, + "compressionType": { + "enum": [ + "NONE", + "LZ4", + "ZLIB", + "ZSTD", + "SNAPPY" + ], + "type": "string" + }, + "cryptoConfig": { + "$ref": "#/definitions/CryptoConfig" + }, + "maxPendingMessages": { + "format": "int32", + "type": "integer" + }, + "maxPendingMessagesAcrossPartitions": { + "format": "int32", + "type": "integer" + }, + "useThreadLocalProducers": { + "type": "boolean" + } + }, + "type": "object" + }, + "PublicKey": { + "properties": { + "algorithm": { + "type": "string" + }, + "encoded": { + "items": { + "format": "byte", + "type": "string" + }, + "type": "array" + }, + "format": { + "type": "string" + } + }, + "type": "object" + }, + "Resources": { + "properties": { + "cpu": { + "format": "double", + "type": "number" + }, + "disk": { + "format": "int64", + "type": "integer" + }, + "ram": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "SocketAddress": { + "type": "object" + }, + "UpdateOptions": { + "description": "Options while updating the sink", + "properties": { + "update-auth-data": { + "description": "Whether or not to update the auth data", + "type": "boolean" + } + }, + "type": "object" + }, + "WindowConfig": { + "properties": { + "actualWindowFunctionClassName": { + "type": "string" + }, + "lateDataTopic": { + "type": "string" + }, + "maxLagMs": { + "format": "int64", + "type": "integer" + }, + "processingGuarantees": { + "enum": [ + "ATLEAST_ONCE", + "ATMOST_ONCE" + ], + "type": "string" + }, + "slidingIntervalCount": { + "format": "int32", + "type": "integer" + }, + "slidingIntervalDurationMs": { + "format": "int64", + "type": "integer" + }, + "timestampExtractorClassName": { + "type": "string" + }, + "watermarkEmitIntervalMs": { + "format": "int64", + "type": "integer" + }, + "windowLengthCount": { + "format": "int32", + "type": "integer" + }, + "windowLengthDurationMs": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + } + }, + "info": { + "description": "This provides the REST API for Pulsar Functions operations", + "license": { + "name": "Apache 2.0", + "url": "http://www.apache.org/licenses/LICENSE-2.0.html" + }, + "title": "Pulsar Functions REST API", + "version": "v3" + }, + "paths": { + "/functions/builtins": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "FunctionsBase_getBuiltinFunction", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "$ref": "#/definitions/FunctionDefinition" + }, + "type": "array" + } + }, + "400": { + "description": "Invalid request" + }, + "403": { + "description": "The requester doesn't have admin permissions" + }, + "408": { + "description": "Request timeout" + } + }, + "summary": "Fetches the list of built-in Pulsar functions", + "tags": [ + "functions" + ] + } + }, + "/functions/builtins/reload": { + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "FunctionsBase_reloadBuiltinFunctions", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "401": { + "description": "This operation requires super-user access" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Function worker service is now initializing. Please try again later." + } + }, + "summary": "Reload the built-in Functions", + "tags": [ + "functions" + ] + } + }, + "/functions/connectors": { + "get": { + "consumes": [ + "application/json" + ], + "deprecated": true, + "description": "", + "operationId": "FunctionsBase_getConnectorsList", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "$ref": "#/definitions/ConnectorDefinition" + }, + "type": "array" + } + }, + "400": { + "description": "Invalid request" + }, + "403": { + "description": "The requester doesn't have admin permissions" + }, + "408": { + "description": "Request timeout" + } + }, + "summary": "Fetches a list of supported Pulsar IO connectors currently running in cluster mode", + "tags": [ + "functions" + ] + } + }, + "/functions/{tenant}/{namespace}": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "FunctionsBase_listFunctions", + "parameters": [ + { + "description": "The tenant of a Pulsar Function", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Function", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "type": "string" + } + }, + "400": { + "description": "Invalid request" + }, + "403": { + "description": "The requester doesn't have admin permissions" + } + }, + "summary": "Lists all Pulsar Functions currently deployed in a given namespace", + "tags": [ + "functions" + ] + } + }, + "/functions/{tenant}/{namespace}/{functionName}": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "FunctionsBase_deregisterFunction", + "parameters": [ + { + "description": "The tenant of a Pulsar Function", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Function", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Function", + "in": "path", + "name": "functionName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Pulsar Function was successfully deleted" + }, + "400": { + "description": "Invalid request" + }, + "403": { + "description": "The requester doesn't have admin permissions" + }, + "404": { + "description": "The Pulsar Function doesn't exist" + }, + "408": { + "description": "Request timeout" + } + }, + "summary": "Deletes a Pulsar Function currently running in cluster mode", + "tags": [ + "functions" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "FunctionsBase_getFunctionInfo", + "parameters": [ + { + "description": "The tenant of a Pulsar Function", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Function", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Function", + "in": "path", + "name": "functionName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/FunctionConfig" + } + }, + "400": { + "description": "Invalid request" + }, + "403": { + "description": "The requester doesn't have admin permissions" + }, + "404": { + "description": "The Pulsar Function doesn't exist" + }, + "408": { + "description": "Request timeout" + } + }, + "summary": "Fetches information about a Pulsar Function currently running in cluster mode", + "tags": [ + "functions" + ] + }, + "post": { + "consumes": [ + "multipart/form-data" + ], + "description": "", + "operationId": "FunctionsBase_registerFunction", + "parameters": [ + { + "description": "The tenant of a Pulsar Function", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Function", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Function", + "in": "path", + "name": "functionName", + "required": true, + "type": "string" + }, + { + "description": "You can submit a function (in any languages that you are familiar with) \nto a Pulsar cluster. Follow the steps below. \n1. Create a JSON object using some of the following parameters.\nA JSON value presenting configuration payload of a Pulsar Function.\n An example of the expected Pulsar Function can be found here.\n- **autoAck**\n Whether or not the framework acknowledges messages automatically.\n- **runtime**\n What is the runtime of the Pulsar Function. Possible Values: [JAVA, PYTHON, GO]\n- **resources**\n The size of the system resources allowed by the Pulsar Function runtime. The resources include: cpu, ram, disk.\n- **className**\n The class name of a Pulsar Function.\n- **customSchemaInputs**\n The map of input topics to Schema class names (specified as a JSON object).\n- **customSerdeInputs**\n The map of input topics to SerDe class names (specified as a JSON object).\n- **deadLetterTopic**\n Messages that are not processed successfully are sent to `deadLetterTopic`.\n- **runtimeFlags**\n Any flags that you want to pass to the runtime. Note that in thread mode, these flags have no impact.\n- **fqfn**\n The Fully Qualified Function Name (FQFN) for the Pulsar Function.\n- **inputSpecs**\n The map of input topics to its consumer configuration, each configuration has schema of {\"schemaType\": \"type-x\", \"serdeClassName\": \"name-x\", \"isRegexPattern\": true, \"receiverQueueSize\": 5}\n- **inputs**\n The input topic or topics (multiple topics can be specified as a comma-separated list) of a Pulsar Function.\n- **jar**\n Path to the JAR file for the Pulsar Function (if the Pulsar Function is written in Java). It also supports URL path [http/https/file (file protocol assumes that file already exists on worker host)] from which worker can download the package.\n- **py**\n Path to the main Python file or Python wheel file for the Pulsar Function (if the Pulsar Function is written in Python).\n- **go**\n Path to the main Go executable binary for the Pulsar Function (if the Pulsar Function is written in Go).\n- **logTopic**\n The topic to which the logs of a Pulsar Function are produced.\n- **maxMessageRetries**\n How many times should we try to process a message before giving up.\n- **output**\n The output topic of a Pulsar Function (If none is specified, no output is written).\n- **outputSerdeClassName**\n The SerDe class to be used for messages output by the Pulsar Function.\n- **parallelism**\n The parallelism factor of a Pulsar Function (i.e. the number of a Pulsar Function instances to run).\n- **processingGuarantees**\n The processing guarantees (that is, delivery semantics) applied to the Pulsar Function. Possible Values: [ATLEAST_ONCE, ATMOST_ONCE, EFFECTIVELY_ONCE]\n- **retainOrdering**\n Function consumes and processes messages in order.\n- **outputSchemaType**\n Represents either a builtin schema type (for example: 'avro', 'json', ect) or the class name for a Schema implementation.- **subName**\n Pulsar source subscription name. User can specify a subscription-name for the input-topic consumer.\n- **windowConfig**\n The window configuration of a Pulsar Function.\n- **timeoutMs**\n The message timeout in milliseconds.\n- **topicsPattern**\n The topic pattern to consume from a list of topics under a namespace that match the pattern. [input] and [topic-pattern] are mutually exclusive. Add SerDe class name for a pattern in customSerdeInputs (supported for java fun only)\n- **userConfig**\n A map of user-defined configurations (specified as a JSON object).\n- **secrets**\n This is a map of secretName(that is how the secret is going to be accessed in the Pulsar Function via context) to an object that encapsulates how the secret is fetched by the underlying secrets provider. The type of an value here can be found by the SecretProviderConfigurator.getSecretObjectType() method. \n- **cleanupSubscription**\n Whether the subscriptions of a Pulsar Function created or used should be deleted when the Pulsar Function is deleted.\n2. Encapsulate the JSON object to a multipart object.", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/FunctionConfig" + }, + "x-examples": { + "text/plain": "Examples\n1. Create a JSON object\n {\n \"inputs\": \"persistent://public/default/input-topic\",\n \"parallelism\": \"4\",\n \"output\": \"persistent://public/default/output-topic\",\n \"log-topic\": \"persistent://public/default/log-topic\",\n \"classname\": \"org.example.test.ExclamationFunction\",\n \"jar\": \"java-function-1.0-SNAPSHOT.jar\"\n }\n2. Encapsulate the JSON object to a multipart object (in Python)\nfrom requests_toolbelt.multipart.encoder import MultipartEncoders\nmp_encoder = MultipartEncoder([('functionConfig',(None, json.dumps(config), 'application/json'))])" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Pulsar Function successfully created" + }, + "400": { + "description": "Invalid request (The Pulsar Function already exists, etc.)" + }, + "403": { + "description": "The requester doesn't have admin permissions" + }, + "408": { + "description": "Request timeout" + } + }, + "summary": "Creates a new Pulsar Function in cluster mode", + "tags": [ + "functions" + ] + }, + "put": { + "consumes": [ + "multipart/form-data" + ], + "description": "", + "operationId": "FunctionsBase_updateFunction", + "parameters": [ + { + "description": "The tenant of a Pulsar Function", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Function", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Function", + "in": "path", + "name": "functionName", + "required": true, + "type": "string" + }, + { + "description": "A JSON value presenting configuration payload of a Pulsar Function. An example of the expected Pulsar Function can be found here.\n- **autoAck**\n Whether or not the framework acknowledges messages automatically.\n- **runtime**\n What is the runtime of the Pulsar Function. Possible Values: [JAVA, PYTHON, GO]\n- **resources**\n The size of the system resources allowed by the Pulsar Function runtime. The resources include: cpu, ram, disk.\n- **className**\n The class name of a Pulsar Function.\n- **customSchemaInputs**\n The map of input topics to Schema class names (specified as a JSON object).\n- **customSerdeInputs**\n The map of input topics to SerDe class names (specified as a JSON object).\n- **deadLetterTopic**\n Messages that are not processed successfully are sent to `deadLetterTopic`.\n- **runtimeFlags**\n Any flags that you want to pass to the runtime. Note that in thread mode, these flags have no impact.\n- **fqfn**\n The Fully Qualified Function Name (FQFN) for the Pulsar Function.\n- **inputSpecs**\n The map of input topics to its consumer configuration, each configuration has schema of {\"schemaType\": \"type-x\", \"serdeClassName\": \"name-x\", \"isRegexPattern\": true, \"receiverQueueSize\": 5}\n- **inputs**\n The input topic or topics (multiple topics can be specified as a comma-separated list) of a Pulsar Function.\n- **jar**\n Path to the JAR file for the Pulsar Function (if the Pulsar Function is written in Java). It also supports URL path [http/https/file (file protocol assumes that file already exists on worker host)] from which worker can download the package.\n- **py**\n Path to the main Python file or Python wheel file for the Pulsar Function (if the Pulsar Function is written in Python).\n- **go**\n Path to the main Go executable binary for the Pulsar Function (if the Pulsar Function is written in Go).\n- **logTopic**\n The topic to which the logs of a Pulsar Function are produced.\n- **maxMessageRetries**\n How many times should we try to process a message before giving up.\n- **output**\n The output topic of a Pulsar Function (If none is specified, no output is written).\n- **outputSerdeClassName**\n The SerDe class to be used for messages output by the Pulsar Function.\n- **parallelism**\n The parallelism factor of a Pulsar Function (i.e. the number of a Pulsar Function instances to run).\n- **processingGuarantees**\n The processing guarantees (that is, delivery semantics) applied to the Pulsar Function. Possible Values: [ATLEAST_ONCE, ATMOST_ONCE, EFFECTIVELY_ONCE]\n- **retainOrdering**\n Function consumes and processes messages in order.\n- **outputSchemaType**\n Represents either a builtin schema type (for example: 'avro', 'json', ect) or the class name for a Schema implementation.- **subName**\n Pulsar source subscription name. User can specify a subscription-name for the input-topic consumer.\n- **windowConfig**\n The window configuration of a Pulsar Function.\n- **timeoutMs**\n The message timeout in milliseconds.\n- **topicsPattern**\n The topic pattern to consume from a list of topics under a namespace that match the pattern. [input] and [topic-pattern] are mutually exclusive. Add SerDe class name for a pattern in customSerdeInputs (supported for java fun only)\n- **userConfig**\n A map of user-defined configurations (specified as a JSON object).\n- **secrets**\n This is a map of secretName(that is how the secret is going to be accessed in the Pulsar Function via context) to an object that encapsulates how the secret is fetched by the underlying secrets provider. The type of an value here can be found by the SecretProviderConfigurator.getSecretObjectType() method. \n- **cleanupSubscription**\n Whether the subscriptions of a Pulsar Function created or used should be deleted when the Pulsar Function is deleted.\n", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/FunctionConfig" + }, + "x-examples": { + "application/json": "{\n \"inputs\": \"persistent://public/default/input-topic\",\n \"parallelism\": 4,\n \"output\": \"persistent://public/default/output-topic\",\n \"log-topic\": \"persistent://public/default/log-topic\",\n \"classname\": \"org.example.test.ExclamationFunction\",\n \"jar\": \"java-function-1.0-SNAPSHOT.jar\"\n}" + } + }, + { + "description": "The update options is for the Pulsar Function that needs to be updated.", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/UpdateOptions" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Pulsar Function successfully updated" + }, + "400": { + "description": "Invalid request (The Pulsar Function doesn't exist, etc.)" + }, + "403": { + "description": "The requester doesn't have admin permissions" + } + }, + "summary": "Updates a Pulsar Function currently running in cluster mode", + "tags": [ + "functions" + ] + } + }, + "/functions/{tenant}/{namespace}/{functionName}/restart": { + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "FunctionsBase_restartFunction", + "parameters": [ + { + "description": "The tenant of a Pulsar Function", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Function", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Function", + "in": "path", + "name": "functionName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "400": { + "description": "Invalid request" + }, + "404": { + "description": "The Pulsar Function does not exist" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Restart all instances of a Pulsar Function", + "tags": [ + "functions" + ] + } + }, + "/functions/{tenant}/{namespace}/{functionName}/start": { + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "FunctionsBase_startFunction", + "parameters": [ + { + "description": "The tenant of a Pulsar Function", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Function", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Function", + "in": "path", + "name": "functionName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "400": { + "description": "Invalid request" + }, + "404": { + "description": "The Pulsar Function does not exist" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Start all instances of a Pulsar Function", + "tags": [ + "functions" + ] + } + }, + "/functions/{tenant}/{namespace}/{functionName}/state/{key}": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "FunctionsBase_getFunctionState", + "parameters": [ + { + "description": "The tenant of a Pulsar Function", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Function", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Function", + "in": "path", + "name": "functionName", + "required": true, + "type": "string" + }, + { + "description": "The stats key", + "in": "path", + "name": "key", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/FunctionState" + } + }, + "400": { + "description": "Invalid request" + }, + "403": { + "description": "The requester doesn't have admin permissions" + }, + "404": { + "description": "The key does not exist" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Fetch the current state associated with a Pulsar Function", + "tags": [ + "functions" + ] + }, + "post": { + "consumes": [ + "multipart/form-data" + ], + "description": "", + "operationId": "FunctionsBase_putFunctionState", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "functionName", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "key", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "400": { + "description": "Invalid request" + }, + "403": { + "description": "The requester doesn't have admin permissions" + }, + "404": { + "description": "The Pulsar Function does not exist" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Put the state associated with a Pulsar Function", + "tags": [ + "functions" + ] + } + }, + "/functions/{tenant}/{namespace}/{functionName}/stats": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "FunctionsBase_getFunctionStats", + "parameters": [ + { + "description": "The tenant of a Pulsar Function", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Function", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Function", + "in": "path", + "name": "functionName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/FunctionStatsImpl" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this function" + }, + "400": { + "description": "Invalid request" + }, + "403": { + "description": "The requester doesn't have admin permissions" + }, + "404": { + "description": "The Pulsar Function doesn't exist" + } + }, + "summary": "Displays the stats of a Pulsar Function", + "tags": [ + "functions" + ] + } + }, + "/functions/{tenant}/{namespace}/{functionName}/status": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "FunctionsBase_getFunctionStatus", + "parameters": [ + { + "description": "The tenant of a Pulsar Function", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Function", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Function", + "in": "path", + "name": "functionName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/FunctionStatus" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this function" + }, + "400": { + "description": "Invalid request" + }, + "403": { + "description": "The requester doesn't have admin permissions" + }, + "404": { + "description": "The Pulsar Function doesn't exist" + } + }, + "summary": "Displays the status of a Pulsar Function", + "tags": [ + "functions" + ] + } + }, + "/functions/{tenant}/{namespace}/{functionName}/stop": { + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "FunctionsBase_stopFunction", + "parameters": [ + { + "description": "The tenant of a Pulsar Function", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Function", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Function", + "in": "path", + "name": "functionName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "400": { + "description": "Invalid request" + }, + "404": { + "description": "The Pulsar Function does not exist" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Stop all instances of a Pulsar Function", + "tags": [ + "functions" + ] + } + }, + "/functions/{tenant}/{namespace}/{functionName}/trigger": { + "post": { + "consumes": [ + "multipart/form-data" + ], + "description": "", + "operationId": "FunctionsBase_triggerFunction", + "parameters": [ + { + "description": "The tenant of a Pulsar Function", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Function", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Function", + "in": "path", + "name": "functionName", + "required": true, + "type": "string" + }, + { + "description": "The value with which you want to trigger the Pulsar Function", + "in": "body", + "name": "body", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The path to the file that contains the data with which you'd like to trigger the Pulsar Function", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/InputStream" + } + }, + { + "description": "The specific topic name that the Pulsar Function consumes from which you want to inject the data to", + "in": "body", + "name": "body", + "required": false, + "schema": { + "type": "string" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "type": "string" + } + }, + "400": { + "description": "Invalid request" + }, + "404": { + "description": "The Pulsar Function does not exist" + }, + "408": { + "description": "Request timeout" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Triggers a Pulsar Function with a user-specified value or file data", + "tags": [ + "functions" + ] + } + }, + "/functions/{tenant}/{namespace}/{functionName}/{instanceId}/restart": { + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "FunctionsBase_restartFunction", + "parameters": [ + { + "description": "The tenant of a Pulsar Function", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Function", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Function", + "in": "path", + "name": "functionName", + "required": true, + "type": "string" + }, + { + "description": "The instanceId of a Pulsar Function (if instance-id is not provided, all instances are restarted", + "in": "path", + "name": "instanceId", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this function" + }, + "400": { + "description": "Invalid request" + }, + "404": { + "description": "The Pulsar Function does not exist" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Restart an instance of a Pulsar Function", + "tags": [ + "functions" + ] + } + }, + "/functions/{tenant}/{namespace}/{functionName}/{instanceId}/start": { + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "FunctionsBase_startFunction", + "parameters": [ + { + "description": "The tenant of a Pulsar Function", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Function", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Function", + "in": "path", + "name": "functionName", + "required": true, + "type": "string" + }, + { + "description": "The instanceId of a Pulsar Function (if instance-id is not provided, all instances sre started. ", + "in": "path", + "name": "instanceId", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "400": { + "description": "Invalid request" + }, + "404": { + "description": "The Pulsar Function does not exist" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Start an instance of a Pulsar Function", + "tags": [ + "functions" + ] + } + }, + "/functions/{tenant}/{namespace}/{functionName}/{instanceId}/stats": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "FunctionsBase_getFunctionInstanceStats", + "parameters": [ + { + "description": "The tenant of a Pulsar Function", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Function", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Function", + "in": "path", + "name": "functionName", + "required": true, + "type": "string" + }, + { + "description": "The instanceId of a Pulsar Function (if instance-id is not provided, the stats of all instances is returned", + "in": "path", + "name": "instanceId", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/FunctionInstanceStatsDataImpl" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this function" + }, + "400": { + "description": "Invalid request" + }, + "403": { + "description": "The requester doesn't have admin permissions" + }, + "404": { + "description": "The Pulsar Function doesn't exist" + } + }, + "summary": "Displays the stats of a Pulsar Function instance", + "tags": [ + "functions" + ] + } + }, + "/functions/{tenant}/{namespace}/{functionName}/{instanceId}/status": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "FunctionsBase_getFunctionInstanceStatus", + "parameters": [ + { + "description": "The tenant of a Pulsar Function", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Function", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Function", + "in": "path", + "name": "functionName", + "required": true, + "type": "string" + }, + { + "description": "The instanceId of a Pulsar Function (if instance-id is not provided, the stats of all instances is returned", + "in": "path", + "name": "instanceId", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/FunctionInstanceStatusData" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this function" + }, + "400": { + "description": "Invalid request" + }, + "403": { + "description": "The requester doesn't have admin permissions" + }, + "404": { + "description": "The Pulsar Function doesn't exist" + } + }, + "summary": "Displays the status of a Pulsar Function instance", + "tags": [ + "functions" + ] + } + }, + "/functions/{tenant}/{namespace}/{functionName}/{instanceId}/stop": { + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "FunctionsBase_stopFunction", + "parameters": [ + { + "description": "The tenant of a Pulsar Function", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Function", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Function", + "in": "path", + "name": "functionName", + "required": true, + "type": "string" + }, + { + "description": "The instanceId of a Pulsar Function (if instance-id is not provided, all instances are stopped. ", + "in": "path", + "name": "instanceId", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "400": { + "description": "Invalid request" + }, + "404": { + "description": "The Pulsar Function does not exist" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Stop an instance of a Pulsar Function", + "tags": [ + "functions" + ] + } + } + }, + "schemes": [ + "http", + "https" + ], + "swagger": "2.0", + "tags": [ + { + "name": "functions" + } + ] +} diff --git a/static/swagger/4.0.0/swaggerlookup.json b/static/swagger/4.0.0/swaggerlookup.json new file mode 100644 index 000000000000..224562a78f7f --- /dev/null +++ b/static/swagger/4.0.0/swaggerlookup.json @@ -0,0 +1,319 @@ +{ + "basePath": "/lookup", + "definitions": { + "AuthenticationDataSource": { + "properties": { + "commandData": { + "type": "string" + }, + "httpAuthType": { + "type": "string" + }, + "peerAddress": { + "$ref": "#/definitions/SocketAddress" + }, + "subscription": { + "type": "string" + }, + "tlsCertificates": { + "items": { + "$ref": "#/definitions/Certificate" + }, + "type": "array" + } + }, + "type": "object" + }, + "AuthenticationParameters": { + "properties": { + "clientAuthenticationDataSource": { + "$ref": "#/definitions/AuthenticationDataSource" + }, + "clientRole": { + "type": "string" + }, + "originalPrincipal": { + "type": "string" + } + }, + "type": "object" + }, + "Certificate": { + "properties": { + "encoded": { + "items": { + "format": "byte", + "type": "string" + }, + "type": "array" + }, + "publicKey": { + "$ref": "#/definitions/PublicKey" + }, + "type": { + "type": "string" + } + }, + "type": "object" + }, + "CompletableFuture": { + "properties": { + "cancelled": { + "type": "boolean" + }, + "completedExceptionally": { + "type": "boolean" + }, + "done": { + "type": "boolean" + }, + "numberOfDependents": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "CompletableFutureByteBuf": { + "properties": { + "cancelled": { + "type": "boolean" + }, + "completedExceptionally": { + "type": "boolean" + }, + "done": { + "type": "boolean" + }, + "numberOfDependents": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "CompletableFutureClusterData": { + "properties": { + "cancelled": { + "type": "boolean" + }, + "completedExceptionally": { + "type": "boolean" + }, + "done": { + "type": "boolean" + }, + "numberOfDependents": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "CompletableFutureVoid": { + "properties": { + "cancelled": { + "type": "boolean" + }, + "completedExceptionally": { + "type": "boolean" + }, + "done": { + "type": "boolean" + }, + "numberOfDependents": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "LookupData": { + "properties": { + "brokerUrl": { + "type": "string" + }, + "brokerUrlSsl": { + "type": "string" + }, + "brokerUrlTls": { + "type": "string" + }, + "httpUrl": { + "type": "string" + }, + "httpUrlTls": { + "type": "string" + }, + "nativeUrl": { + "type": "string" + } + }, + "type": "object" + }, + "PublicKey": { + "properties": { + "algorithm": { + "type": "string" + }, + "encoded": { + "items": { + "format": "byte", + "type": "string" + }, + "type": "array" + }, + "format": { + "type": "string" + } + }, + "type": "object" + }, + "SocketAddress": { + "type": "object" + } + }, + "info": { + "description": "This provides the REST API for lookup operations", + "license": { + "name": "Apache 2.0", + "url": "http://www.apache.org/licenses/LICENSE-2.0.html" + }, + "title": "Pulsar Lookup REST API", + "version": "v2" + }, + "paths": { + "/v2/topic/{topic-domain}/{tenant}/{namespace}/{topic}": { + "get": { + "description": "", + "operationId": "TopicLookup_lookupTopicAsync", + "parameters": [ + { + "in": "path", + "name": "topic-domain", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "in": "query", + "name": "listenerName", + "required": false, + "type": "string" + }, + { + "in": "header", + "name": "X-Pulsar-ListenerName", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/LookupData" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + } + }, + "summary": "Get the owner broker of the given topic.", + "tags": [ + "lookup" + ] + } + }, + "/v2/topic/{topic-domain}/{tenant}/{namespace}/{topic}/bundle": { + "get": { + "description": "", + "operationId": "TopicLookup_getNamespaceBundle", + "parameters": [ + { + "in": "path", + "name": "topic-domain", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "type": "string" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "405": { + "description": "Invalid topic domain type" + } + }, + "summary": "Get the namespace bundle which the given topic belongs to.", + "tags": [ + "lookup" + ] + } + } + }, + "schemes": [ + "http", + "https" + ], + "swagger": "2.0", + "tags": [ + { + "name": "lookup" + } + ] +} diff --git a/static/swagger/4.0.0/swaggerpackages.json b/static/swagger/4.0.0/swaggerpackages.json new file mode 100644 index 000000000000..154d67730cf5 --- /dev/null +++ b/static/swagger/4.0.0/swaggerpackages.json @@ -0,0 +1,627 @@ +{ + "basePath": "/admin/v3", + "definitions": { + "AuthenticationDataSource": { + "properties": { + "commandData": { + "type": "string" + }, + "httpAuthType": { + "type": "string" + }, + "peerAddress": { + "$ref": "#/definitions/SocketAddress" + }, + "subscription": { + "type": "string" + }, + "tlsCertificates": { + "items": { + "$ref": "#/definitions/Certificate" + }, + "type": "array" + } + }, + "type": "object" + }, + "AuthenticationParameters": { + "properties": { + "clientAuthenticationDataSource": { + "$ref": "#/definitions/AuthenticationDataSource" + }, + "clientRole": { + "type": "string" + }, + "originalPrincipal": { + "type": "string" + } + }, + "type": "object" + }, + "Certificate": { + "properties": { + "encoded": { + "items": { + "format": "byte", + "type": "string" + }, + "type": "array" + }, + "publicKey": { + "$ref": "#/definitions/PublicKey" + }, + "type": { + "type": "string" + } + }, + "type": "object" + }, + "CompletableFuture": { + "properties": { + "cancelled": { + "type": "boolean" + }, + "completedExceptionally": { + "type": "boolean" + }, + "done": { + "type": "boolean" + }, + "numberOfDependents": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "CompletableFutureClusterData": { + "properties": { + "cancelled": { + "type": "boolean" + }, + "completedExceptionally": { + "type": "boolean" + }, + "done": { + "type": "boolean" + }, + "numberOfDependents": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "CompletableFutureVoid": { + "properties": { + "cancelled": { + "type": "boolean" + }, + "completedExceptionally": { + "type": "boolean" + }, + "done": { + "type": "boolean" + }, + "numberOfDependents": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "PackageMetadata": { + "properties": { + "contact": { + "type": "string" + }, + "createTime": { + "format": "int64", + "type": "integer" + }, + "description": { + "type": "string" + }, + "modificationTime": { + "format": "int64", + "type": "integer" + }, + "properties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + } + }, + "type": "object" + }, + "PublicKey": { + "properties": { + "algorithm": { + "type": "string" + }, + "encoded": { + "items": { + "format": "byte", + "type": "string" + }, + "type": "array" + }, + "format": { + "type": "string" + } + }, + "type": "object" + }, + "SocketAddress": { + "type": "object" + }, + "StreamingOutput": { + "type": "object" + } + }, + "info": { + "description": "This provides the REST API for Pulsar Packages operations", + "license": { + "name": "Apache 2.0", + "url": "http://www.apache.org/licenses/LICENSE-2.0.html" + }, + "title": "Pulsar Packages REST API", + "version": "v3" + }, + "paths": { + "/packages/{type}/{tenant}/{namespace}": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Packages_listPackages", + "parameters": [ + { + "in": "path", + "name": "type", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Return all the specified type package names in the specified namespace.", + "schema": { + "items": { + "$ref": "#/definitions/PackageMetadata" + }, + "type": "array" + } + }, + "412": { + "description": "The package type is illegal." + }, + "500": { + "description": "Internal server error." + }, + "503": { + "description": "Package Management Service is not enabled in the broker." + } + }, + "summary": "Get all the specified type packages in a namespace.", + "tags": [ + "packages" + ] + } + }, + "/packages/{type}/{tenant}/{namespace}/{packageName}": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Packages_listPackageVersion", + "parameters": [ + { + "in": "path", + "name": "type", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "packageName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Return the package versions of the specified package.", + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "404": { + "description": "The specified package is not existent." + }, + "412": { + "description": "The package name is illegal." + }, + "500": { + "description": "Internal server error." + }, + "503": { + "description": "Package Management Service is not enabled in the broker." + } + }, + "summary": "Get all the versions of a package.", + "tags": [ + "packages" + ] + } + }, + "/packages/{type}/{tenant}/{namespace}/{packageName}/{version}": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Packages_delete", + "parameters": [ + { + "in": "path", + "name": "type", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "packageName", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Delete the specified package successfully." + }, + "404": { + "description": "The specified package is not existent." + }, + "412": { + "description": "The package name is illegal." + }, + "500": { + "description": "Internal server error." + }, + "503": { + "description": "Package Management Service is not enabled in the broker." + } + }, + "summary": "Delete a package with the package name.", + "tags": [ + "packages" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Packages_download", + "parameters": [ + { + "in": "path", + "name": "type", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "packageName", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Download the specified package successfully.", + "schema": { + "$ref": "#/definitions/StreamingOutput" + } + }, + "404": { + "description": "The specified package is not existent." + }, + "412": { + "description": "The package name is illegal." + }, + "500": { + "description": "Internal server error." + }, + "503": { + "description": "Package Management Service is not enabled in the broker." + } + }, + "summary": "Download a package with the package name.", + "tags": [ + "packages" + ] + }, + "post": { + "consumes": [ + "multipart/form-data" + ], + "description": "", + "operationId": "Packages_upload", + "parameters": [ + { + "in": "path", + "name": "type", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "packageName", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Upload the specified package successfully." + }, + "412": { + "description": "The package name is illegal." + }, + "500": { + "description": "Internal server error." + }, + "503": { + "description": "Package Management Service is not enabled in the broker." + } + }, + "summary": "Upload a package.", + "tags": [ + "packages" + ] + } + }, + "/packages/{type}/{tenant}/{namespace}/{packageName}/{version}/metadata": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Packages_getMeta", + "parameters": [ + { + "in": "path", + "name": "type", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "packageName", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Return the metadata of the specified package.", + "schema": { + "$ref": "#/definitions/PackageMetadata" + } + }, + "404": { + "description": "The specified package is not existent." + }, + "412": { + "description": "The package name is illegal." + }, + "500": { + "description": "Internal server error." + }, + "503": { + "description": "Package Management Service is not enabled in the broker." + } + }, + "summary": "Get the metadata of a package.", + "tags": [ + "packages" + ] + }, + "put": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Packages_updateMeta", + "parameters": [ + { + "in": "path", + "name": "type", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "packageName", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Update the metadata of the specified package successfully." + }, + "404": { + "description": "The specified package is not existent." + }, + "412": { + "description": "The package name is illegal." + }, + "500": { + "description": "Internal server error." + }, + "503": { + "description": "Package Management Service is not enabled in the broker." + } + }, + "summary": "Update the metadata of a package.", + "tags": [ + "packages" + ] + } + } + }, + "schemes": [ + "http", + "https" + ], + "swagger": "2.0", + "tags": [ + { + "name": "packages" + } + ] +} diff --git a/static/swagger/4.0.0/swaggersink.json b/static/swagger/4.0.0/swaggersink.json new file mode 100644 index 000000000000..d73048d61938 --- /dev/null +++ b/static/swagger/4.0.0/swaggersink.json @@ -0,0 +1,1449 @@ +{ + "basePath": "/admin/v3", + "definitions": { + "AuthenticationDataSource": { + "properties": { + "commandData": { + "type": "string" + }, + "httpAuthType": { + "type": "string" + }, + "peerAddress": { + "$ref": "#/definitions/SocketAddress" + }, + "subscription": { + "type": "string" + }, + "tlsCertificates": { + "items": { + "$ref": "#/definitions/Certificate" + }, + "type": "array" + } + }, + "type": "object" + }, + "AuthenticationParameters": { + "properties": { + "clientAuthenticationDataSource": { + "$ref": "#/definitions/AuthenticationDataSource" + }, + "clientRole": { + "type": "string" + }, + "originalPrincipal": { + "type": "string" + } + }, + "type": "object" + }, + "Certificate": { + "properties": { + "encoded": { + "items": { + "format": "byte", + "type": "string" + }, + "type": "array" + }, + "publicKey": { + "$ref": "#/definitions/PublicKey" + }, + "type": { + "type": "string" + } + }, + "type": "object" + }, + "CompletableFuture": { + "properties": { + "cancelled": { + "type": "boolean" + }, + "completedExceptionally": { + "type": "boolean" + }, + "done": { + "type": "boolean" + }, + "numberOfDependents": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "CompletableFutureClusterData": { + "properties": { + "cancelled": { + "type": "boolean" + }, + "completedExceptionally": { + "type": "boolean" + }, + "done": { + "type": "boolean" + }, + "numberOfDependents": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "CompletableFutureVoid": { + "properties": { + "cancelled": { + "type": "boolean" + }, + "completedExceptionally": { + "type": "boolean" + }, + "done": { + "type": "boolean" + }, + "numberOfDependents": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "ConfigFieldDefinition": { + "properties": { + "attributes": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "fieldName": { + "type": "string" + }, + "typeName": { + "type": "string" + } + }, + "type": "object" + }, + "ConnectorDefinition": { + "properties": { + "description": { + "type": "string" + }, + "name": { + "type": "string" + }, + "sinkClass": { + "type": "string" + }, + "sinkConfigClass": { + "type": "string" + }, + "sourceClass": { + "type": "string" + }, + "sourceConfigClass": { + "type": "string" + } + }, + "type": "object" + }, + "ConsumerConfig": { + "properties": { + "consumerProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "cryptoConfig": { + "$ref": "#/definitions/CryptoConfig" + }, + "poolMessages": { + "type": "boolean" + }, + "receiverQueueSize": { + "format": "int32", + "type": "integer" + }, + "regexPattern": { + "type": "boolean" + }, + "schemaProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "schemaType": { + "type": "string" + }, + "serdeClassName": { + "type": "string" + } + }, + "type": "object" + }, + "CryptoConfig": { + "properties": { + "consumerCryptoFailureAction": { + "enum": [ + "FAIL", + "DISCARD", + "CONSUME" + ], + "type": "string" + }, + "cryptoKeyReaderClassName": { + "type": "string" + }, + "cryptoKeyReaderConfig": { + "additionalProperties": { + "type": "object" + }, + "type": "object" + }, + "encryptionKeys": { + "items": { + "type": "string" + }, + "type": "array" + }, + "producerCryptoFailureAction": { + "enum": [ + "FAIL", + "SEND" + ], + "type": "string" + } + }, + "type": "object" + }, + "ExceptionInformation": { + "properties": { + "exceptionString": { + "type": "string" + }, + "timestampMs": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "PublicKey": { + "properties": { + "algorithm": { + "type": "string" + }, + "encoded": { + "items": { + "format": "byte", + "type": "string" + }, + "type": "array" + }, + "format": { + "type": "string" + } + }, + "type": "object" + }, + "Resources": { + "properties": { + "cpu": { + "format": "double", + "type": "number" + }, + "disk": { + "format": "int64", + "type": "integer" + }, + "ram": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "SinkConfig": { + "properties": { + "archive": { + "type": "string" + }, + "autoAck": { + "type": "boolean" + }, + "className": { + "type": "string" + }, + "cleanupSubscription": { + "type": "boolean" + }, + "configs": { + "additionalProperties": { + "type": "object" + }, + "type": "object" + }, + "customRuntimeOptions": { + "type": "string" + }, + "deadLetterTopic": { + "type": "string" + }, + "inputSpecs": { + "additionalProperties": { + "$ref": "#/definitions/ConsumerConfig" + }, + "type": "object" + }, + "inputs": { + "items": { + "type": "string" + }, + "type": "array" + }, + "logTopic": { + "type": "string" + }, + "maxMessageRetries": { + "format": "int32", + "type": "integer" + }, + "name": { + "type": "string" + }, + "namespace": { + "type": "string" + }, + "negativeAckRedeliveryDelayMs": { + "format": "int64", + "type": "integer" + }, + "parallelism": { + "format": "int32", + "type": "integer" + }, + "processingGuarantees": { + "enum": [ + "ATLEAST_ONCE", + "ATMOST_ONCE", + "EFFECTIVELY_ONCE", + "MANUAL" + ], + "type": "string" + }, + "resources": { + "$ref": "#/definitions/Resources" + }, + "retainKeyOrdering": { + "type": "boolean" + }, + "retainOrdering": { + "type": "boolean" + }, + "runtimeFlags": { + "type": "string" + }, + "secrets": { + "additionalProperties": { + "type": "object" + }, + "type": "object" + }, + "sinkType": { + "type": "string" + }, + "sourceSubscriptionName": { + "type": "string" + }, + "sourceSubscriptionPosition": { + "enum": [ + "Latest", + "Earliest" + ], + "type": "string" + }, + "tenant": { + "type": "string" + }, + "timeoutMs": { + "format": "int64", + "type": "integer" + }, + "topicToSchemaProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "topicToSchemaType": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "topicToSerdeClassName": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "topicsPattern": { + "type": "string" + }, + "transformFunction": { + "type": "string" + }, + "transformFunctionClassName": { + "type": "string" + }, + "transformFunctionConfig": { + "type": "string" + } + }, + "type": "object" + }, + "SinkInstanceStatus": { + "properties": { + "instanceId": { + "format": "int32", + "type": "integer" + }, + "status": { + "$ref": "#/definitions/SinkInstanceStatusData" + } + }, + "type": "object" + }, + "SinkInstanceStatusData": { + "properties": { + "error": { + "type": "string" + }, + "lastReceivedTime": { + "format": "int64", + "type": "integer" + }, + "latestSinkExceptions": { + "items": { + "$ref": "#/definitions/ExceptionInformation" + }, + "type": "array" + }, + "latestSystemExceptions": { + "items": { + "$ref": "#/definitions/ExceptionInformation" + }, + "type": "array" + }, + "numReadFromPulsar": { + "format": "int64", + "type": "integer" + }, + "numRestarts": { + "format": "int64", + "type": "integer" + }, + "numSinkExceptions": { + "format": "int64", + "type": "integer" + }, + "numSystemExceptions": { + "format": "int64", + "type": "integer" + }, + "numWrittenToSink": { + "format": "int64", + "type": "integer" + }, + "running": { + "type": "boolean" + }, + "workerId": { + "type": "string" + } + }, + "type": "object" + }, + "SinkStatus": { + "properties": { + "instances": { + "items": { + "$ref": "#/definitions/SinkInstanceStatus" + }, + "type": "array" + }, + "numInstances": { + "format": "int32", + "type": "integer" + }, + "numRunning": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "SocketAddress": { + "type": "object" + }, + "UpdateOptions": { + "description": "Options while updating the sink", + "properties": { + "update-auth-data": { + "description": "Whether or not to update the auth data", + "type": "boolean" + } + }, + "type": "object" + } + }, + "info": { + "description": "This provides the REST API for Pulsar Sink operations", + "license": { + "name": "Apache 2.0", + "url": "http://www.apache.org/licenses/LICENSE-2.0.html" + }, + "title": "Pulsar Sink REST API", + "version": "v3" + }, + "paths": { + "/sinks/builtinsinks": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "SinksBase_getSinkList", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Get builtin sinks successfully.", + "schema": { + "items": { + "$ref": "#/definitions/ConnectorDefinition" + }, + "type": "array" + } + } + }, + "summary": "Fetches the list of built-in Pulsar IO sinks", + "tags": [ + "sinks" + ] + } + }, + "/sinks/builtinsinks/{name}/configdefinition": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "SinksBase_getSinkConfigDefinition", + "parameters": [ + { + "description": "The name of the builtin sink", + "in": "path", + "name": "name", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "$ref": "#/definitions/ConfigFieldDefinition" + }, + "type": "array" + } + }, + "403": { + "description": "The requester doesn't have admin permissions" + }, + "404": { + "description": "builtin sink does not exist" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Function worker service is now initializing. Please try again later." + } + }, + "summary": "Fetches information about config fields associated with the specified builtin sink", + "tags": [ + "sinks" + ] + } + }, + "/sinks/reloadBuiltInSinks": { + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "SinksBase_reloadSinks", + "produces": [ + "application/json" + ], + "responses": { + "401": { + "description": "This operation requires super-user access" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Function worker service is now initializing. Please try again later." + } + }, + "summary": "Reload the built-in connectors, including Sources and Sinks", + "tags": [ + "sinks" + ] + } + }, + "/sinks/{tenant}/{namespace}": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "SinksBase_listSinks", + "parameters": [ + { + "description": "The tenant of a Pulsar Sink", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Sink", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "type": "string" + } + }, + "400": { + "description": "Invalid list request" + }, + "401": { + "description": "The client is not authorized to perform this operation" + }, + "500": { + "description": "Internal server error (failed to authorize, etc.)" + }, + "503": { + "description": "Function worker service is now initializing. Please try again later." + } + }, + "summary": "Lists all Pulsar Sinks currently deployed in a given namespace", + "tags": [ + "sinks" + ] + } + }, + "/sinks/{tenant}/{namespace}/{sinkName}": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "SinksBase_deregisterSink", + "parameters": [ + { + "description": "The tenant of a Pulsar Sink", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Sink", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Sink", + "in": "path", + "name": "sinkName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Pulsar Sink was successfully deleted" + }, + "400": { + "description": "Invalid deregister request" + }, + "401": { + "description": "Client is not authorized to perform operation" + }, + "404": { + "description": "The Pulsar Sink does not exist" + }, + "408": { + "description": "Got InterruptedException while deregistering the Pulsar Sink" + }, + "500": { + "description": "Internal server error (failed to authorize, failed to deregister, etc.)" + }, + "503": { + "description": "Function worker service is now initializing. Please try again later." + } + }, + "summary": "Deletes a Pulsar Sink currently running in cluster mode", + "tags": [ + "sinks" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "SinksBase_getSinkInfo", + "parameters": [ + { + "description": "The tenant of a Pulsar Sink", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Sink", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Sink", + "in": "path", + "name": "sinkName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/SinkConfig" + } + }, + "400": { + "description": "Invalid request" + }, + "404": { + "description": "The Pulsar Sink does not exist" + }, + "503": { + "description": "Function worker service is now initializing. Please try again later." + } + }, + "summary": "Fetches information about a Pulsar Sink currently running in cluster mode", + "tags": [ + "sinks" + ] + }, + "post": { + "consumes": [ + "multipart/form-data" + ], + "description": "", + "operationId": "SinksBase_registerSink", + "parameters": [ + { + "description": "The tenant of a Pulsar Sink", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Sink", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Sink", + "in": "path", + "name": "sinkName", + "required": true, + "type": "string" + }, + { + "description": "You can submit a sink (in any languages that you are familiar with) to a Pulsar cluster. Follow the steps below.\n1. Create a JSON object using some of the following parameters.\nA JSON value presenting config payload of a Pulsar Sink. All available configuration options are:\n- **classname**\n The class name of a Pulsar Sink if archive is file-url-path (file://)\n- **sourceSubscriptionName**\n Pulsar source subscription name if user wants a specific\n subscription-name for input-topic consumer\n- **inputs**\n The input topic or topics of a Pulsar Sink (specified as a JSON array)\n- **topicsPattern**\n TopicsPattern to consume from list of topics under a namespace that match the pattern. [input] and [topicsPattern] are mutually exclusive. Add SerDe class name for a pattern in customSerdeInputs (supported for java fun only)- **topicToSerdeClassName**\n The map of input topics to SerDe class names (specified as a JSON object)\n- **topicToSchemaType**\n The map of input topics to Schema types or class names (specified as a JSON object)\n- **inputSpecs**\n The map of input topics to its consumer configuration, each configuration has schema of {\"schemaType\": \"type-x\", \"serdeClassName\": \"name-x\", \"isRegexPattern\": true, \"receiverQueueSize\": 5}\n- **configs**\n The map of configs (specified as a JSON object)\n- **secrets**\n a map of secretName(aka how the secret is going to be \n accessed in the function via context) to an object that \n encapsulates how the secret is fetched by the underlying \n secrets provider. The type of an value here can be found by the \n SecretProviderConfigurator.getSecretObjectType() method. (specified as a JSON object)\n- **parallelism**\n The parallelism factor of a Pulsar Sink (i.e. the number of a Pulsar Sink instances to run \n- **processingGuarantees**\n The processing guarantees (aka delivery semantics) applied to the Pulsar Sink. Possible Values: \"ATLEAST_ONCE\", \"ATMOST_ONCE\", \"EFFECTIVELY_ONCE\"\n- **retainOrdering**\n Boolean denotes whether the Pulsar Sink consumes and processes messages in order\n- **resources**\n {\"cpu\": 1, \"ram\": 2, \"disk\": 3} The CPU (in cores), RAM (in bytes) and disk (in bytes) that needs to be allocated per Pulsar Sink instance (applicable only to Docker runtime)\n- **autoAck**\n Boolean denotes whether or not the framework will automatically acknowledge messages\n- **timeoutMs**\n Long denotes the message timeout in milliseconds\n- **cleanupSubscription**\n Boolean denotes whether the subscriptions the functions created/used should be deleted when the functions is deleted\n- **runtimeFlags**\n Any flags that you want to pass to the runtime as a single string\n2. Encapsulate the JSON object to a multipart object.", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/SinkConfig" + }, + "x-examples": { + "text/plain": "Example\n1. Create a JSON object.\n {\n \"classname\": \"org.example.MySinkTest\",\n \"inputs\": [\"persistent://public/default/sink-input\"],\n \"processingGuarantees\": \"EFFECTIVELY_ONCE\",\n \"parallelism\": \"10\"\n }\n2. Encapsulate the JSON object to a multipart object (in Python).\nfrom requests_toolbelt.multipart.encoder import MultipartEncoder\nmp_encoder = MultipartEncoder( [('sinkConfig',(None, json.dumps(config), 'application/json'))])" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Pulsar Sink successfully created" + }, + "400": { + "description": "Invalid request (The Pulsar Sink already exists, etc.)" + }, + "401": { + "description": "Client is not authorized to perform operation" + }, + "500": { + "description": "Internal server error (failed to authorize, failed to get tenant data, failed to process package, etc.)" + }, + "503": { + "description": "Function worker service is now initializing. Please try again later." + } + }, + "summary": "Creates a new Pulsar Sink in cluster mode", + "tags": [ + "sinks" + ] + }, + "put": { + "consumes": [ + "multipart/form-data" + ], + "description": "", + "operationId": "SinksBase_updateSink", + "parameters": [ + { + "description": "The tenant of a Pulsar Sink", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Sink", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Sink", + "in": "path", + "name": "sinkName", + "required": true, + "type": "string" + }, + { + "description": "A JSON value presenting config payload of a Pulsar Sink. All available configuration options are:\n- **classname**\n The class name of a Pulsar Sink if archive is file-url-path (file://)\n- **sourceSubscriptionName**\n Pulsar source subscription name if user wants a specific\n subscription-name for input-topic consumer\n- **inputs**\n The input topic or topics of a Pulsar Sink (specified as a JSON array)\n- **topicsPattern**\n TopicsPattern to consume from list of topics under a namespace that match the pattern. [input] and [topicsPattern] are mutually exclusive. Add SerDe class name for a pattern in customSerdeInputs (supported for java fun only)- **topicToSerdeClassName**\n The map of input topics to SerDe class names (specified as a JSON object)\n- **topicToSchemaType**\n The map of input topics to Schema types or class names (specified as a JSON object)\n- **inputSpecs**\n The map of input topics to its consumer configuration, each configuration has schema of {\"schemaType\": \"type-x\", \"serdeClassName\": \"name-x\", \"isRegexPattern\": true, \"receiverQueueSize\": 5}\n- **configs**\n The map of configs (specified as a JSON object)\n- **secrets**\n a map of secretName(aka how the secret is going to be \n accessed in the function via context) to an object that \n encapsulates how the secret is fetched by the underlying \n secrets provider. The type of an value here can be found by the \n SecretProviderConfigurator.getSecretObjectType() method. (specified as a JSON object)\n- **parallelism**\n The parallelism factor of a Pulsar Sink (i.e. the number of a Pulsar Sink instances to run \n- **processingGuarantees**\n The processing guarantees (aka delivery semantics) applied to the Pulsar Sink. Possible Values: \"ATLEAST_ONCE\", \"ATMOST_ONCE\", \"EFFECTIVELY_ONCE\"\n- **retainOrdering**\n Boolean denotes whether the Pulsar Sink consumes and processes messages in order\n- **resources**\n {\"cpu\": 1, \"ram\": 2, \"disk\": 3} The CPU (in cores), RAM (in bytes) and disk (in bytes) that needs to be allocated per Pulsar Sink instance (applicable only to Docker runtime)\n- **autoAck**\n Boolean denotes whether or not the framework will automatically acknowledge messages\n- **timeoutMs**\n Long denotes the message timeout in milliseconds\n- **cleanupSubscription**\n Boolean denotes whether the subscriptions the functions created/used should be deleted when the functions is deleted\n- **runtimeFlags**\n Any flags that you want to pass to the runtime as a single string\n", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/SinkConfig" + }, + "x-examples": { + "application/json": "{\n\"classname\": \"org.example.SinkStressTest\",\n\"inputs\": [\"persistent://public/default/sink-input\"],\n\"processingGuarantees\": \"EFFECTIVELY_ONCE\",\n\"parallelism\": 5\n}" + } + }, + { + "description": "Update options for the Pulsar Sink", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/UpdateOptions" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Pulsar Sink successfully updated" + }, + "400": { + "description": "Invalid request (The Pulsar Sink doesn't exist, update contains no change, etc.)" + }, + "401": { + "description": "Client is not authorized to perform operation" + }, + "404": { + "description": "The Pulsar Sink doesn't exist" + }, + "500": { + "description": "Internal server error (failed to authorize, failed to process package, etc.)" + }, + "503": { + "description": "Function worker service is now initializing. Please try again later." + } + }, + "summary": "Updates a Pulsar Sink currently running in cluster mode", + "tags": [ + "sinks" + ] + } + }, + "/sinks/{tenant}/{namespace}/{sinkName}/restart": { + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "SinksBase_restartSink", + "parameters": [ + { + "description": "The tenant of a Pulsar Sink", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Sink", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Sink", + "in": "path", + "name": "sinkName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "400": { + "description": "Invalid restart request" + }, + "401": { + "description": "The client is not authorized to perform this operation" + }, + "404": { + "description": "The Pulsar Sink does not exist" + }, + "500": { + "description": "Internal server error (failed to restart the Pulsar Sink, failed to authorize, etc.)" + }, + "503": { + "description": "Function worker service is now initializing. Please try again later." + } + }, + "summary": "Restart all instances of a Pulsar Sink", + "tags": [ + "sinks" + ] + } + }, + "/sinks/{tenant}/{namespace}/{sinkName}/start": { + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "SinksBase_startSink", + "parameters": [ + { + "description": "The tenant of a Pulsar Sink", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Sink", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Sink", + "in": "path", + "name": "sinkName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "400": { + "description": "Invalid start request" + }, + "401": { + "description": "The client is not authorized to perform this operation" + }, + "404": { + "description": "The Pulsar Sink does not exist" + }, + "500": { + "description": "Internal server error (failed to start the Pulsar Sink, failed to authorize, etc.)" + }, + "503": { + "description": "Function worker service is now initializing. Please try again later." + } + }, + "summary": "Start all instances of a Pulsar Sink", + "tags": [ + "sinks" + ] + } + }, + "/sinks/{tenant}/{namespace}/{sinkName}/status": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "SinksBase_getSinkStatus", + "parameters": [ + { + "description": "The tenant of a Pulsar Sink", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Sink", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Sink", + "in": "path", + "name": "sinkName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/SinkStatus" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this sink" + }, + "400": { + "description": "Invalid get status request" + }, + "401": { + "description": "The client is not authorized to perform this operation" + }, + "404": { + "description": "The Pulsar Sink does not exist" + }, + "503": { + "description": "Function worker service is now initializing. Please try again later." + } + }, + "summary": "Displays the status of a Pulsar Sink running in cluster mode", + "tags": [ + "sinks" + ] + } + }, + "/sinks/{tenant}/{namespace}/{sinkName}/stop": { + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "SinksBase_stopSink", + "parameters": [ + { + "description": "The tenant of a Pulsar Sink", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Sink", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Sink", + "in": "path", + "name": "sinkName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "400": { + "description": "Invalid stop request" + }, + "401": { + "description": "The client is not authorized to perform this operation" + }, + "404": { + "description": "The Pulsar Sink does not exist" + }, + "500": { + "description": "Internal server error (failed to stop the Pulsar Sink, failed to authorize, etc.)" + }, + "503": { + "description": "Function worker service is now initializing. Please try again later." + } + }, + "summary": "Stop all instances of a Pulsar Sink", + "tags": [ + "sinks" + ] + } + }, + "/sinks/{tenant}/{namespace}/{sinkName}/{instanceId}/restart": { + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "SinksBase_restartSink", + "parameters": [ + { + "description": "The tenant of a Pulsar Sink", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Sink", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Sink", + "in": "path", + "name": "sinkName", + "required": true, + "type": "string" + }, + { + "description": "The instanceId of a Pulsar Sink", + "in": "path", + "name": "instanceId", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this sink" + }, + "400": { + "description": "Invalid restart request" + }, + "401": { + "description": "The client is not authorized to perform this operation" + }, + "404": { + "description": "The Pulsar Sink does not exist" + }, + "500": { + "description": "Internal server error (failed to restart the instance of a Pulsar Sink, failed to authorize, etc.)" + }, + "503": { + "description": "Function worker service is now initializing. Please try again later." + } + }, + "summary": "Restart an instance of a Pulsar Sink", + "tags": [ + "sinks" + ] + } + }, + "/sinks/{tenant}/{namespace}/{sinkName}/{instanceId}/start": { + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "SinksBase_startSink", + "parameters": [ + { + "description": "The tenant of a Pulsar Sink", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Sink", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Sink", + "in": "path", + "name": "sinkName", + "required": true, + "type": "string" + }, + { + "description": "The instanceId of a Pulsar Sink", + "in": "path", + "name": "instanceId", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "400": { + "description": "Invalid start request" + }, + "401": { + "description": "The client is not authorized to perform this operation" + }, + "404": { + "description": "The Pulsar Sink does not exist" + }, + "500": { + "description": "Internal server error (failed to start the Pulsar Sink, failed to authorize, etc.)" + }, + "503": { + "description": "Function worker service is now initializing. Please try again later." + } + }, + "summary": "Start an instance of a Pulsar Sink", + "tags": [ + "sinks" + ] + } + }, + "/sinks/{tenant}/{namespace}/{sinkName}/{instanceId}/status": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "SinksBase_getSinkInstanceStatus", + "parameters": [ + { + "description": "The tenant of a Pulsar Sink", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Sink", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Sink", + "in": "path", + "name": "sinkName", + "required": true, + "type": "string" + }, + { + "description": "The instanceId of a Pulsar Sink", + "in": "path", + "name": "instanceId", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/SinkInstanceStatusData" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this sink" + }, + "400": { + "description": "The Pulsar Sink instance does not exist" + }, + "404": { + "description": "The Pulsar Sink does not exist" + }, + "500": { + "description": "Internal Server Error (got exception while getting status, etc.)" + }, + "503": { + "description": "Function worker service is now initializing. Please try again later." + } + }, + "summary": "Displays the status of a Pulsar Sink instance", + "tags": [ + "sinks" + ] + } + }, + "/sinks/{tenant}/{namespace}/{sinkName}/{instanceId}/stop": { + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "SinksBase_stopSink", + "parameters": [ + { + "description": "The tenant of a Pulsar Sink", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Sink", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Sink", + "in": "path", + "name": "sinkName", + "required": true, + "type": "string" + }, + { + "description": "The instanceId of a Pulsar Sink", + "in": "path", + "name": "instanceId", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "400": { + "description": "Invalid stop request" + }, + "401": { + "description": "The client is not authorized to perform this operation" + }, + "404": { + "description": "The Pulsar Sink instance does not exist" + }, + "500": { + "description": "Internal server error (failed to stop the Pulsar Sink, failed to authorize, etc.)" + }, + "503": { + "description": "Function worker service is now initializing. Please try again later." + } + }, + "summary": "Stop an instance of a Pulsar Sink", + "tags": [ + "sinks" + ] + } + } + }, + "schemes": [ + "http", + "https" + ], + "swagger": "2.0", + "tags": [ + { + "name": "sinks" + } + ] +} diff --git a/static/swagger/4.0.0/swaggersource.json b/static/swagger/4.0.0/swaggersource.json new file mode 100644 index 000000000000..188aaeb805a9 --- /dev/null +++ b/static/swagger/4.0.0/swaggersource.json @@ -0,0 +1,1404 @@ +{ + "basePath": "/admin/v3", + "definitions": { + "AuthenticationDataSource": { + "properties": { + "commandData": { + "type": "string" + }, + "httpAuthType": { + "type": "string" + }, + "peerAddress": { + "$ref": "#/definitions/SocketAddress" + }, + "subscription": { + "type": "string" + }, + "tlsCertificates": { + "items": { + "$ref": "#/definitions/Certificate" + }, + "type": "array" + } + }, + "type": "object" + }, + "AuthenticationParameters": { + "properties": { + "clientAuthenticationDataSource": { + "$ref": "#/definitions/AuthenticationDataSource" + }, + "clientRole": { + "type": "string" + }, + "originalPrincipal": { + "type": "string" + } + }, + "type": "object" + }, + "BatchSourceConfig": { + "properties": { + "discoveryTriggererClassName": { + "type": "string" + }, + "discoveryTriggererConfig": { + "additionalProperties": { + "type": "object" + }, + "type": "object" + } + }, + "type": "object" + }, + "Certificate": { + "properties": { + "encoded": { + "items": { + "format": "byte", + "type": "string" + }, + "type": "array" + }, + "publicKey": { + "$ref": "#/definitions/PublicKey" + }, + "type": { + "type": "string" + } + }, + "type": "object" + }, + "CompletableFuture": { + "properties": { + "cancelled": { + "type": "boolean" + }, + "completedExceptionally": { + "type": "boolean" + }, + "done": { + "type": "boolean" + }, + "numberOfDependents": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "CompletableFutureClusterData": { + "properties": { + "cancelled": { + "type": "boolean" + }, + "completedExceptionally": { + "type": "boolean" + }, + "done": { + "type": "boolean" + }, + "numberOfDependents": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "CompletableFutureVoid": { + "properties": { + "cancelled": { + "type": "boolean" + }, + "completedExceptionally": { + "type": "boolean" + }, + "done": { + "type": "boolean" + }, + "numberOfDependents": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "ConfigFieldDefinition": { + "properties": { + "attributes": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "fieldName": { + "type": "string" + }, + "typeName": { + "type": "string" + } + }, + "type": "object" + }, + "ConnectorDefinition": { + "properties": { + "description": { + "type": "string" + }, + "name": { + "type": "string" + }, + "sinkClass": { + "type": "string" + }, + "sinkConfigClass": { + "type": "string" + }, + "sourceClass": { + "type": "string" + }, + "sourceConfigClass": { + "type": "string" + } + }, + "type": "object" + }, + "CryptoConfig": { + "properties": { + "consumerCryptoFailureAction": { + "enum": [ + "FAIL", + "DISCARD", + "CONSUME" + ], + "type": "string" + }, + "cryptoKeyReaderClassName": { + "type": "string" + }, + "cryptoKeyReaderConfig": { + "additionalProperties": { + "type": "object" + }, + "type": "object" + }, + "encryptionKeys": { + "items": { + "type": "string" + }, + "type": "array" + }, + "producerCryptoFailureAction": { + "enum": [ + "FAIL", + "SEND" + ], + "type": "string" + } + }, + "type": "object" + }, + "ExceptionInformation": { + "properties": { + "exceptionString": { + "type": "string" + }, + "timestampMs": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "ProducerConfig": { + "properties": { + "batchBuilder": { + "type": "string" + }, + "compressionType": { + "enum": [ + "NONE", + "LZ4", + "ZLIB", + "ZSTD", + "SNAPPY" + ], + "type": "string" + }, + "cryptoConfig": { + "$ref": "#/definitions/CryptoConfig" + }, + "maxPendingMessages": { + "format": "int32", + "type": "integer" + }, + "maxPendingMessagesAcrossPartitions": { + "format": "int32", + "type": "integer" + }, + "useThreadLocalProducers": { + "type": "boolean" + } + }, + "type": "object" + }, + "PublicKey": { + "properties": { + "algorithm": { + "type": "string" + }, + "encoded": { + "items": { + "format": "byte", + "type": "string" + }, + "type": "array" + }, + "format": { + "type": "string" + } + }, + "type": "object" + }, + "Resources": { + "properties": { + "cpu": { + "format": "double", + "type": "number" + }, + "disk": { + "format": "int64", + "type": "integer" + }, + "ram": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "SocketAddress": { + "type": "object" + }, + "SourceConfig": { + "properties": { + "archive": { + "type": "string" + }, + "batchBuilder": { + "type": "string" + }, + "batchSourceConfig": { + "$ref": "#/definitions/BatchSourceConfig" + }, + "className": { + "type": "string" + }, + "configs": { + "additionalProperties": { + "type": "object" + }, + "type": "object" + }, + "customRuntimeOptions": { + "type": "string" + }, + "logTopic": { + "type": "string" + }, + "name": { + "type": "string" + }, + "namespace": { + "type": "string" + }, + "parallelism": { + "format": "int32", + "type": "integer" + }, + "processingGuarantees": { + "enum": [ + "ATLEAST_ONCE", + "ATMOST_ONCE", + "EFFECTIVELY_ONCE", + "MANUAL" + ], + "type": "string" + }, + "producerConfig": { + "$ref": "#/definitions/ProducerConfig" + }, + "resources": { + "$ref": "#/definitions/Resources" + }, + "runtimeFlags": { + "type": "string" + }, + "schemaType": { + "type": "string" + }, + "secrets": { + "additionalProperties": { + "type": "object" + }, + "type": "object" + }, + "serdeClassName": { + "type": "string" + }, + "sourceType": { + "type": "string" + }, + "tenant": { + "type": "string" + }, + "topicName": { + "type": "string" + } + }, + "type": "object" + }, + "SourceInstanceStatus": { + "properties": { + "instanceId": { + "format": "int32", + "type": "integer" + }, + "status": { + "$ref": "#/definitions/SourceInstanceStatusData" + } + }, + "type": "object" + }, + "SourceInstanceStatusData": { + "properties": { + "error": { + "type": "string" + }, + "lastReceivedTime": { + "format": "int64", + "type": "integer" + }, + "latestSourceExceptions": { + "items": { + "$ref": "#/definitions/ExceptionInformation" + }, + "type": "array" + }, + "latestSystemExceptions": { + "items": { + "$ref": "#/definitions/ExceptionInformation" + }, + "type": "array" + }, + "numReceivedFromSource": { + "format": "int64", + "type": "integer" + }, + "numRestarts": { + "format": "int64", + "type": "integer" + }, + "numSourceExceptions": { + "format": "int64", + "type": "integer" + }, + "numSystemExceptions": { + "format": "int64", + "type": "integer" + }, + "numWritten": { + "format": "int64", + "type": "integer" + }, + "running": { + "type": "boolean" + }, + "workerId": { + "type": "string" + } + }, + "type": "object" + }, + "SourceStatus": { + "properties": { + "instances": { + "items": { + "$ref": "#/definitions/SourceInstanceStatus" + }, + "type": "array" + }, + "numInstances": { + "format": "int32", + "type": "integer" + }, + "numRunning": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "UpdateOptions": { + "description": "Options while updating the sink", + "properties": { + "update-auth-data": { + "description": "Whether or not to update the auth data", + "type": "boolean" + } + }, + "type": "object" + } + }, + "info": { + "description": "This provides the REST API for Pulsar Source operations", + "license": { + "name": "Apache 2.0", + "url": "http://www.apache.org/licenses/LICENSE-2.0.html" + }, + "title": "Pulsar Source REST API", + "version": "v3" + }, + "paths": { + "/sources/builtinsources": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "SourcesBase_getSourceList", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "$ref": "#/definitions/ConnectorDefinition" + }, + "type": "array" + } + }, + "400": { + "description": "Invalid request" + }, + "403": { + "description": "The requester doesn't have admin permissions" + }, + "408": { + "description": "Request timeout" + }, + "503": { + "description": "Function worker service is now initializing. Please try again later." + } + }, + "summary": "Fetches the list of built-in Pulsar IO sources", + "tags": [ + "sources" + ] + } + }, + "/sources/builtinsources/{name}/configdefinition": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "SourcesBase_getSourceConfigDefinition", + "parameters": [ + { + "description": "The name of the builtin source", + "in": "path", + "name": "name", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "$ref": "#/definitions/ConfigFieldDefinition" + }, + "type": "array" + } + }, + "403": { + "description": "The requester doesn't have admin permissions" + }, + "404": { + "description": "builtin source does not exist" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Function worker service is now initializing. Please try again later." + } + }, + "summary": "Fetches information about config fields associated with the specified builtin source", + "tags": [ + "sources" + ] + } + }, + "/sources/reloadBuiltInSources": { + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "SourcesBase_reloadSources", + "produces": [ + "application/json" + ], + "responses": { + "401": { + "description": "This operation requires super-user access" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Function worker service is now initializing. Please try again later." + } + }, + "summary": "Reload the built-in connectors, including Sources and Sinks", + "tags": [ + "sources" + ] + } + }, + "/sources/{tenant}/{namespace}": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "SourcesBase_listSources", + "parameters": [ + { + "description": "The tenant of a Pulsar Source", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Source", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "400": { + "description": "Invalid request" + }, + "401": { + "description": "Client is not authorized to perform operation" + }, + "500": { + "description": "Internal Server Error" + }, + "503": { + "description": "Function worker service is now initializing. Please try again later." + } + }, + "summary": "Lists all Pulsar Sources currently deployed in a given namespace", + "tags": [ + "sources" + ] + } + }, + "/sources/{tenant}/{namespace}/{sourceName}": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "SourcesBase_deregisterSource", + "parameters": [ + { + "description": "The tenant of a Pulsar Source", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Source", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Source", + "in": "path", + "name": "sourceName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The function was successfully deleted" + }, + "400": { + "description": "Invalid request" + }, + "401": { + "description": "Client is not authorized to perform operation" + }, + "404": { + "description": "Not Found(The Pulsar Source doesn't exist)" + }, + "408": { + "description": "Request timeout" + }, + "500": { + "description": "Internal Server Error" + }, + "503": { + "description": "Function worker service is now initializing. Please try again later." + } + }, + "summary": "Deletes a Pulsar Source currently running in cluster mode", + "tags": [ + "sources" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "SourcesBase_getSourceInfo", + "parameters": [ + { + "description": "The tenant of a Pulsar Source", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Source", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Source", + "in": "path", + "name": "sourceName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/SourceConfig" + } + }, + "400": { + "description": "Invalid request" + }, + "404": { + "description": "Not Found(The Pulsar Source doesn't exist)" + }, + "503": { + "description": "Function worker service is now initializing. Please try again later." + } + }, + "summary": "Fetches information about a Pulsar Source currently running in cluster mode", + "tags": [ + "sources" + ] + }, + "post": { + "consumes": [ + "multipart/form-data" + ], + "description": "", + "operationId": "SourcesBase_registerSource", + "parameters": [ + { + "description": "The tenant of a Pulsar Source", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Source", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Source", + "in": "path", + "name": "sourceName", + "required": true, + "type": "string" + }, + { + "description": "You can submit a source (in any languages that you are familiar with) to a Pulsar cluster. Follow the steps below.\n1. Create a JSON object using some of the following parameters.\nA JSON value presenting configuration payload of a Pulsar Source. An example of the expected functions can be found here.\n- **classname**\n The class name of a Pulsar Source if archive is file-url-path (file://).\n- **topicName**\n The Pulsar topic to which data is sent.\n- **serdeClassName**\n The SerDe classname for the Pulsar Source.\n- **schemaType**\n The schema type (either a builtin schema like 'avro', 'json', etc.. or custom Schema class name to be used to encode messages emitted from the Pulsar Source\n- **configs**\n Source config key/values\n- **secrets**\n This is a map of secretName(that is how the secret is going to be accessed in the function via context) to an object that encapsulates how the secret is fetched by the underlying secrets provider. The type of an value here can be found by the SecretProviderConfigurator.getSecretObjectType() method. \n- **parallelism**\n The parallelism factor of a Pulsar Source (i.e. the number of a Pulsar Source instances to run).\n- **processingGuarantees**\n The processing guarantees (aka delivery semantics) applied to the Pulsar Source. Possible Values: [ATLEAST_ONCE, ATMOST_ONCE, EFFECTIVELY_ONCE]\n- **resources**\n The size of the system resources allowed by the Pulsar Source runtime. The resources include: cpu, ram, disk.\n- **archive**\n The path to the NAR archive for the Pulsar Source. It also supports url-path [http/https/file (file protocol assumes that file already exists on worker host)] from which worker can download the package.\n- **runtimeFlags**\n Any flags that you want to pass to the runtime.\n2. Encapsulate the JSON object to a multipart object.", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/SourceConfig" + }, + "x-examples": { + "text/plain": "Example\n1. Create a JSON object.\n{\n \"tenant\": \"public\",\n \"namespace\": \"default\",\n \"name\": \"pulsar-io-mysql\",\n \"className\": \"TestSourceMysql\",\n \"topicName\": \"pulsar-io-mysql\",\n \"parallelism\": \"1\",\n \"archive\": \"/connectors/pulsar-io-mysql-0.0.1.nar\",\n \"schemaType\": \"avro\"\n}\n2. Encapsulate the JSON object to a multipart object (in Python).\nfrom requests_toolbelt.multipart.encoder import MultipartEncoder\nmp_encoder = MultipartEncoder([('sourceConfig', (None, json.dumps(config), 'application/json'))])" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Pulsar Function successfully created" + }, + "400": { + "description": "Invalid request (Function already exists or Tenant, Namespace or Name is not provided, etc.)" + }, + "401": { + "description": "Client is not authorized to perform operation" + }, + "500": { + "description": "Internal Server Error" + }, + "503": { + "description": "Function worker service is now initializing. Please try again later." + } + }, + "summary": "Creates a new Pulsar Source in cluster mode", + "tags": [ + "sources" + ] + }, + "put": { + "consumes": [ + "multipart/form-data" + ], + "description": "", + "operationId": "SourcesBase_updateSource", + "parameters": [ + { + "description": "The tenant of a Pulsar Source", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Source", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Source", + "in": "path", + "name": "sourceName", + "required": true, + "type": "string" + }, + { + "description": "A JSON value presenting configuration payload of a Pulsar Source. An example of the expected functions can be found here.\n- **classname**\n The class name of a Pulsar Source if archive is file-url-path (file://).\n- **topicName**\n The Pulsar topic to which data is sent.\n- **serdeClassName**\n The SerDe classname for the Pulsar Source.\n- **schemaType**\n The schema type (either a builtin schema like 'avro', 'json', etc.. or custom Schema class name to be used to encode messages emitted from the Pulsar Source\n- **configs**\n Pulsar Source config key/values\n- **secrets**\n This is a map of secretName(that is how the secret is going to be accessed in the function via context) to an object that encapsulates how the secret is fetched by the underlying secrets provider. The type of an value here can be found by the SecretProviderConfigurator.getSecretObjectType() method.\n- **parallelism**\n The parallelism factor of a Pulsar Source (i.e. the number of a Pulsar Source instances to run).\n- **processingGuarantees**\n The processing guarantees (aka delivery semantics) applied to the Pulsar Source. Possible Values: [ATLEAST_ONCE, ATMOST_ONCE, EFFECTIVELY_ONCE]\n- **resources**\n The size of the system resources allowed by the Pulsar Source runtime. The resources include: cpu, ram, disk.\n- **archive**\n The path to the NAR archive for the Pulsar Source. It also supports url-path [http/https/file (file protocol assumes that file already exists on worker host)] from which worker can download the package.\n- **runtimeFlags**\n Any flags that you want to pass to the runtime.\n", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/SourceConfig" + }, + "x-examples": { + "application/json": "{\n \"tenant\": \"public\",\n \"namespace\": \"default\",\n \"name\": \"pulsar-io-mysql\",\n \"className\": \"TestSourceMysql\",\n \"topicName\": \"pulsar-io-mysql\",\n \"parallelism\": 1,\n \"archive\": \"/connectors/pulsar-io-mysql-0.0.1.nar\",\n \"schemaType\": \"avro\"\n}" + } + }, + { + "description": "Update options for Pulsar Source", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/UpdateOptions" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Pulsar Function successfully updated" + }, + "400": { + "description": "Invalid request (Function already exists or Tenant, Namespace or Name is not provided, etc.)" + }, + "401": { + "description": "Client is not authorized to perform operation" + }, + "403": { + "description": "The requester doesn't have admin permissions" + }, + "404": { + "description": "Not Found(The Pulsar Source doesn't exist)" + }, + "500": { + "description": "Internal Server Error" + }, + "503": { + "description": "Function worker service is now initializing. Please try again later." + } + }, + "summary": "Updates a Pulsar Source currently running in cluster mode", + "tags": [ + "sources" + ] + } + }, + "/sources/{tenant}/{namespace}/{sourceName}/restart": { + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "SourcesBase_restartSource", + "parameters": [ + { + "description": "The tenant of a Pulsar Source", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Source", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Source", + "in": "path", + "name": "sourceName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "400": { + "description": "Invalid request" + }, + "401": { + "description": "Client is not authorized to perform operation" + }, + "404": { + "description": "Not Found(The Pulsar Source doesn't exist)" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Function worker service is now initializing. Please try again later." + } + }, + "summary": "Restart all instances of a Pulsar Source", + "tags": [ + "sources" + ] + } + }, + "/sources/{tenant}/{namespace}/{sourceName}/start": { + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "SourcesBase_startSource", + "parameters": [ + { + "description": "The tenant of a Pulsar Source", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Source", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Source", + "in": "path", + "name": "sourceName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "400": { + "description": "Invalid request" + }, + "401": { + "description": "Client is not authorized to perform operation" + }, + "404": { + "description": "Not Found(The Pulsar Source doesn't exist)" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Function worker service is now initializing. Please try again later." + } + }, + "summary": "Start all instances of a Pulsar Source", + "tags": [ + "sources" + ] + } + }, + "/sources/{tenant}/{namespace}/{sourceName}/status": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "SourcesBase_getSourceStatus", + "parameters": [ + { + "description": "The tenant of a Pulsar Source", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Source", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Source", + "in": "path", + "name": "sourceName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/SourceStatus" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this source" + }, + "500": { + "description": "Internal Server Error" + }, + "503": { + "description": "Function worker service is now initializing. Please try again later." + } + }, + "summary": "Displays the status of a Pulsar Source running in cluster mode", + "tags": [ + "sources" + ] + } + }, + "/sources/{tenant}/{namespace}/{sourceName}/stop": { + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "SourcesBase_stopSource", + "parameters": [ + { + "description": "The tenant of a Pulsar Source", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Source", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Source", + "in": "path", + "name": "sourceName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "400": { + "description": "Invalid request" + }, + "401": { + "description": "Client is not authorized to perform operation" + }, + "404": { + "description": "Not Found(The Pulsar Source doesn't exist)" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Function worker service is now initializing. Please try again later." + } + }, + "summary": "Stop all instances of a Pulsar Source", + "tags": [ + "sources" + ] + } + }, + "/sources/{tenant}/{namespace}/{sourceName}/{instanceId}/restart": { + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "SourcesBase_restartSource", + "parameters": [ + { + "description": "The tenant of a Pulsar Source", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Source", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Source", + "in": "path", + "name": "sourceName", + "required": true, + "type": "string" + }, + { + "description": "The instanceId of a Pulsar Source (if instance-id is not provided, the stats of all instances is returned).", + "in": "path", + "name": "instanceId", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this source" + }, + "400": { + "description": "Invalid request" + }, + "401": { + "description": "Client is not authorized to perform operation" + }, + "404": { + "description": "Not Found(The Pulsar Source doesn't exist)" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Function worker service is now initializing. Please try again later." + } + }, + "summary": "Restart an instance of a Pulsar Source", + "tags": [ + "sources" + ] + } + }, + "/sources/{tenant}/{namespace}/{sourceName}/{instanceId}/start": { + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "SourcesBase_startSource", + "parameters": [ + { + "description": "The tenant of a Pulsar Source", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Source", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Source", + "in": "path", + "name": "sourceName", + "required": true, + "type": "string" + }, + { + "description": "The instanceId of a Pulsar Source (if instance-id is not provided, the stats of all instances is returned).", + "in": "path", + "name": "instanceId", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "400": { + "description": "Invalid request" + }, + "401": { + "description": "Client is not authorized to perform operation" + }, + "404": { + "description": "Not Found(The Pulsar Source doesn't exist)" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Function worker service is now initializing. Please try again later." + } + }, + "summary": "Start an instance of a Pulsar Source", + "tags": [ + "sources" + ] + } + }, + "/sources/{tenant}/{namespace}/{sourceName}/{instanceId}/status": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "SourcesBase_getSourceInstanceStatus", + "parameters": [ + { + "description": "The tenant of a Pulsar Source", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Source", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Source", + "in": "path", + "name": "sourceName", + "required": true, + "type": "string" + }, + { + "description": "The instanceId of a Pulsar Source (if instance-id is not provided, the stats of all instances is returned).", + "in": "path", + "name": "instanceId", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/SourceInstanceStatusData" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this source" + }, + "500": { + "description": "Internal Server Error" + }, + "503": { + "description": "Function worker service is now initializing. Please try again later." + } + }, + "summary": "Displays the status of a Pulsar Source instance", + "tags": [ + "sources" + ] + } + }, + "/sources/{tenant}/{namespace}/{sourceName}/{instanceId}/stop": { + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "SourcesBase_stopSource", + "parameters": [ + { + "description": "The tenant of a Pulsar Source", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Source", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Source", + "in": "path", + "name": "sourceName", + "required": true, + "type": "string" + }, + { + "description": "The instanceId of a Pulsar Source (if instance-id is not provided, the stats of all instances is returned).", + "in": "path", + "name": "instanceId", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "400": { + "description": "Invalid request" + }, + "401": { + "description": "Client is not authorized to perform operation" + }, + "404": { + "description": "Not Found(The Pulsar Source doesn't exist)" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Function worker service is now initializing. Please try again later." + } + }, + "summary": "Stop instance of a Pulsar Source", + "tags": [ + "sources" + ] + } + } + }, + "schemes": [ + "http", + "https" + ], + "swagger": "2.0", + "tags": [ + { + "name": "sources" + } + ] +} diff --git a/static/swagger/4.0.0/swaggertransactions.json b/static/swagger/4.0.0/swaggertransactions.json new file mode 100644 index 000000000000..5f830b49690a --- /dev/null +++ b/static/swagger/4.0.0/swaggertransactions.json @@ -0,0 +1,1537 @@ +{ + "basePath": "/admin/v3", + "definitions": { + "AuthenticationDataSource": { + "properties": { + "commandData": { + "type": "string" + }, + "httpAuthType": { + "type": "string" + }, + "peerAddress": { + "$ref": "#/definitions/SocketAddress" + }, + "subscription": { + "type": "string" + }, + "tlsCertificates": { + "items": { + "$ref": "#/definitions/Certificate" + }, + "type": "array" + } + }, + "type": "object" + }, + "AuthenticationParameters": { + "properties": { + "clientAuthenticationDataSource": { + "$ref": "#/definitions/AuthenticationDataSource" + }, + "clientRole": { + "type": "string" + }, + "originalPrincipal": { + "type": "string" + } + }, + "type": "object" + }, + "Certificate": { + "properties": { + "encoded": { + "items": { + "format": "byte", + "type": "string" + }, + "type": "array" + }, + "publicKey": { + "$ref": "#/definitions/PublicKey" + }, + "type": { + "type": "string" + } + }, + "type": "object" + }, + "CompletableFuture": { + "properties": { + "cancelled": { + "type": "boolean" + }, + "completedExceptionally": { + "type": "boolean" + }, + "done": { + "type": "boolean" + }, + "numberOfDependents": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "CompletableFutureClusterData": { + "properties": { + "cancelled": { + "type": "boolean" + }, + "completedExceptionally": { + "type": "boolean" + }, + "done": { + "type": "boolean" + }, + "numberOfDependents": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "CompletableFutureVoid": { + "properties": { + "cancelled": { + "type": "boolean" + }, + "completedExceptionally": { + "type": "boolean" + }, + "done": { + "type": "boolean" + }, + "numberOfDependents": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "CursorStats": { + "properties": { + "active": { + "type": "boolean" + }, + "cursorLedger": { + "format": "int64", + "type": "integer" + }, + "cursorLedgerLastEntry": { + "format": "int64", + "type": "integer" + }, + "individuallyDeletedMessages": { + "type": "string" + }, + "lastLedgerSwitchTimestamp": { + "type": "string" + }, + "markDeletePosition": { + "type": "string" + }, + "messagesConsumedCounter": { + "format": "int64", + "type": "integer" + }, + "numberOfEntriesSinceFirstNotAckedMessage": { + "format": "int64", + "type": "integer" + }, + "pendingReadOps": { + "format": "int32", + "type": "integer" + }, + "properties": { + "additionalProperties": { + "format": "int64", + "type": "integer" + }, + "type": "object" + }, + "readPosition": { + "type": "string" + }, + "state": { + "type": "string" + }, + "subscriptionHavePendingRead": { + "type": "boolean" + }, + "subscriptionHavePendingReplayRead": { + "type": "boolean" + }, + "totalNonContiguousDeletedMessagesRange": { + "format": "int32", + "type": "integer" + }, + "waitingReadOp": { + "type": "boolean" + } + }, + "type": "object" + }, + "LedgerInfo": { + "properties": { + "entries": { + "format": "int64", + "type": "integer" + }, + "ledgerId": { + "format": "int64", + "type": "integer" + }, + "metadata": { + "type": "string" + }, + "offloaded": { + "type": "boolean" + }, + "size": { + "format": "int64", + "type": "integer" + }, + "underReplicated": { + "type": "boolean" + } + }, + "type": "object" + }, + "ManagedLedgerInternalStats": { + "properties": { + "currentLedgerEntries": { + "format": "int64", + "type": "integer" + }, + "currentLedgerSize": { + "format": "int64", + "type": "integer" + }, + "cursors": { + "additionalProperties": { + "$ref": "#/definitions/CursorStats" + }, + "type": "object" + }, + "entriesAddedCounter": { + "format": "int64", + "type": "integer" + }, + "lastConfirmedEntry": { + "type": "string" + }, + "lastLedgerCreatedTimestamp": { + "type": "string" + }, + "lastLedgerCreationFailureTimestamp": { + "type": "string" + }, + "ledgers": { + "items": { + "$ref": "#/definitions/LedgerInfo" + }, + "type": "array" + }, + "numberOfEntries": { + "format": "int64", + "type": "integer" + }, + "pendingAddEntriesCount": { + "format": "int32", + "type": "integer" + }, + "state": { + "type": "string" + }, + "totalSize": { + "format": "int64", + "type": "integer" + }, + "waitingCursorsCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "PositionInPendingAckStats": { + "properties": { + "state": { + "enum": [ + "PendingAck", + "MarkDelete", + "NotInPendingAck", + "PendingAckNotReady", + "InvalidPosition" + ], + "type": "string" + } + }, + "type": "object" + }, + "PublicKey": { + "properties": { + "algorithm": { + "type": "string" + }, + "encoded": { + "items": { + "format": "byte", + "type": "string" + }, + "type": "array" + }, + "format": { + "type": "string" + } + }, + "type": "object" + }, + "SegmentStats": { + "properties": { + "lastTxnID": { + "type": "string" + }, + "persistentPosition": { + "type": "string" + } + }, + "type": "object" + }, + "SegmentsStats": { + "properties": { + "currentSegmentCapacity": { + "format": "int64", + "type": "integer" + }, + "lastTookSnapshotSegmentTimestamp": { + "format": "int64", + "type": "integer" + }, + "segmentStats": { + "items": { + "$ref": "#/definitions/SegmentStats" + }, + "type": "array" + }, + "segmentsSize": { + "format": "int64", + "type": "integer" + }, + "unsealedAbortTxnIDSize": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "SnapshotSystemTopicInternalStats": { + "properties": { + "managedLedgerInternalStats": { + "$ref": "#/definitions/ManagedLedgerInternalStats" + }, + "managedLedgerName": { + "type": "string" + } + }, + "type": "object" + }, + "SocketAddress": { + "type": "object" + }, + "TransactionBufferInternalStats": { + "properties": { + "segmentIndexInternalStats": { + "$ref": "#/definitions/SnapshotSystemTopicInternalStats" + }, + "segmentInternalStats": { + "$ref": "#/definitions/SnapshotSystemTopicInternalStats" + }, + "singleSnapshotSystemTopicInternalStats": { + "$ref": "#/definitions/SnapshotSystemTopicInternalStats" + }, + "snapshotType": { + "type": "string" + } + }, + "type": "object" + }, + "TransactionBufferStats": { + "properties": { + "lastSnapshotTimestamps": { + "format": "int64", + "type": "integer" + }, + "lowWaterMarks": { + "additionalProperties": { + "format": "int64", + "type": "integer" + }, + "type": "object" + }, + "maxReadPosition": { + "type": "string" + }, + "ongoingTxnSize": { + "format": "int64", + "type": "integer" + }, + "recoverEndTime": { + "format": "int64", + "type": "integer" + }, + "recoverStartTime": { + "format": "int64", + "type": "integer" + }, + "segmentsStats": { + "$ref": "#/definitions/SegmentsStats" + }, + "snapshotType": { + "type": "string" + }, + "state": { + "type": "string" + }, + "totalAbortedTransactions": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "TransactionCoordinatorInfo": { + "properties": { + "brokerServiceUrl": { + "type": "string" + }, + "id": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "TransactionCoordinatorInternalStats": { + "properties": { + "transactionLogStats": { + "$ref": "#/definitions/TransactionLogStats" + } + }, + "type": "object" + }, + "TransactionCoordinatorStats": { + "properties": { + "leastSigBits": { + "format": "int64", + "type": "integer" + }, + "lowWaterMark": { + "format": "int64", + "type": "integer" + }, + "ongoingTxnSize": { + "format": "int64", + "type": "integer" + }, + "recoverEndTime": { + "format": "int64", + "type": "integer" + }, + "recoverStartTime": { + "format": "int64", + "type": "integer" + }, + "state": { + "type": "string" + } + }, + "type": "object" + }, + "TransactionInBufferStats": { + "properties": { + "aborted": { + "type": "boolean" + }, + "startPosition": { + "type": "string" + } + }, + "type": "object" + }, + "TransactionInPendingAckStats": { + "properties": { + "cumulativeAckPosition": { + "type": "string" + } + }, + "type": "object" + }, + "TransactionLogStats": { + "properties": { + "managedLedgerInternalStats": { + "$ref": "#/definitions/ManagedLedgerInternalStats" + }, + "managedLedgerName": { + "type": "string" + } + }, + "type": "object" + }, + "TransactionMetadata": { + "properties": { + "ackedPartitions": { + "additionalProperties": { + "additionalProperties": { + "$ref": "#/definitions/TransactionInPendingAckStats" + }, + "type": "object" + }, + "type": "object" + }, + "openTimestamp": { + "format": "int64", + "type": "integer" + }, + "owner": { + "type": "string" + }, + "producedPartitions": { + "additionalProperties": { + "$ref": "#/definitions/TransactionInBufferStats" + }, + "type": "object" + }, + "status": { + "type": "string" + }, + "timeoutAt": { + "format": "int64", + "type": "integer" + }, + "txnId": { + "type": "string" + } + }, + "type": "object" + }, + "TransactionPendingAckInternalStats": { + "properties": { + "pendingAckLogStats": { + "$ref": "#/definitions/TransactionLogStats" + } + }, + "type": "object" + }, + "TransactionPendingAckStats": { + "properties": { + "lowWaterMarks": { + "additionalProperties": { + "format": "int64", + "type": "integer" + }, + "type": "object" + }, + "ongoingTxnSize": { + "format": "int64", + "type": "integer" + }, + "recoverEndTime": { + "format": "int64", + "type": "integer" + }, + "recoverStartTime": { + "format": "int64", + "type": "integer" + }, + "state": { + "type": "string" + } + }, + "type": "object" + } + }, + "info": { + "description": "This provides the REST API for Pulsar Transactions operations", + "license": { + "name": "Apache 2.0", + "url": "http://www.apache.org/licenses/LICENSE-2.0.html" + }, + "title": "Pulsar Transactions REST API", + "version": "v3" + }, + "paths": { + "/transactions/abortTransaction/{mostSigBits}/{leastSigBits}": { + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Transactions_abortTransaction", + "parameters": [ + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "in": "path", + "name": "mostSigBits", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "leastSigBits", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Topic is not owned by this broker!" + }, + "400": { + "description": "Topic is not a persistent topic!" + }, + "401": { + "description": "This operation requires super-user access" + }, + "404": { + "description": "Tenant or cluster or namespace or topic or coordinator or transaction doesn't exist" + }, + "409": { + "description": "Concurrent modification" + }, + "503": { + "description": "This Broker is not configured with transactionCoordinatorEnabled=true." + } + }, + "summary": "Abort transaction", + "tags": [ + "transactions" + ] + } + }, + "/transactions/coordinatorInternalStats/{coordinatorId}": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Transactions_getCoordinatorInternalStats", + "parameters": [ + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "in": "path", + "name": "coordinatorId", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "metadata", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/TransactionCoordinatorInternalStats" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Transaction coordinator not found" + }, + "405": { + "description": "Broker don't use MLTransactionMetadataStore!" + }, + "409": { + "description": "Concurrent modification" + }, + "503": { + "description": "This Broker is not configured with transactionCoordinatorEnabled=true." + } + }, + "summary": "Get coordinator internal stats.", + "tags": [ + "transactions" + ] + } + }, + "/transactions/coordinatorStats": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Transactions_getCoordinatorStats", + "parameters": [ + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "format": "int32", + "in": "query", + "name": "coordinatorId", + "required": false, + "type": "integer" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/TransactionCoordinatorStats" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Transaction coordinator not found" + }, + "409": { + "description": "Concurrent modification" + }, + "503": { + "description": "This Broker is not configured with transactionCoordinatorEnabled=true." + } + }, + "summary": "Get transaction coordinator stats.", + "tags": [ + "transactions" + ] + } + }, + "/transactions/coordinators": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Transactions_listCoordinators", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "$ref": "#/definitions/TransactionCoordinatorInfo" + }, + "type": "array" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "503": { + "description": "This Broker is not configured with transactionCoordinatorEnabled=true." + } + }, + "summary": "List transaction coordinators.", + "tags": [ + "transactions" + ] + } + }, + "/transactions/pendingAckInternalStats/{tenant}/{namespace}/{topic}/{subName}": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Transactions_getPendingAckInternalStats", + "parameters": [ + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "subName", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "metadata", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/TransactionPendingAckInternalStats" + } + }, + "307": { + "description": "Topic is not owned by this broker!" + }, + "400": { + "description": "Topic is not a persistent topic!" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic or subscription name doesn't exist" + }, + "405": { + "description": "Pending ack handle don't use managedLedger!" + }, + "409": { + "description": "Concurrent modification" + }, + "503": { + "description": "This Broker is not configured with transactionCoordinatorEnabled=true." + } + }, + "summary": "Get transaction pending ack internal stats.", + "tags": [ + "transactions" + ] + } + }, + "/transactions/pendingAckStats/{tenant}/{namespace}/{topic}/{subName}": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Transactions_getPendingAckStats", + "parameters": [ + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "subName", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "lowWaterMarks", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/TransactionPendingAckStats" + } + }, + "307": { + "description": "Topic is not owned by this broker!" + }, + "400": { + "description": "Topic is not a persistent topic!" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic or subName doesn't exist" + }, + "409": { + "description": "Concurrent modification" + }, + "503": { + "description": "This Broker is not configured with transactionCoordinatorEnabled=true." + } + }, + "summary": "Get transaction pending ack stats in topic.", + "tags": [ + "transactions" + ] + } + }, + "/transactions/positionStatsInPendingAck/{tenant}/{namespace}/{topic}/{subName}/{ledgerId}/{entryId}": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Transactions_getPositionStatsInPendingAck", + "parameters": [ + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "subName", + "required": true, + "type": "string" + }, + { + "format": "int64", + "in": "path", + "name": "ledgerId", + "required": true, + "type": "integer" + }, + { + "format": "int64", + "in": "path", + "name": "entryId", + "required": true, + "type": "integer" + }, + { + "format": "int32", + "in": "query", + "name": "batchIndex", + "required": false, + "type": "integer" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/PositionInPendingAckStats" + } + }, + "307": { + "description": "Topic is not owned by this broker!" + }, + "400": { + "description": "Topic is not a persistent topic!" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic or subscription name doesn't exist" + }, + "405": { + "description": "Pending ack handle don't use managedLedger!" + }, + "409": { + "description": "Concurrent modification" + }, + "503": { + "description": "This Broker is not configured with transactionCoordinatorEnabled=true." + } + }, + "summary": "Get position stats in pending ack.", + "tags": [ + "transactions" + ] + } + }, + "/transactions/slowTransactions/{timeout}": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Transactions_getSlowTransactions", + "parameters": [ + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "in": "path", + "name": "timeout", + "required": true, + "type": "string" + }, + { + "format": "int32", + "in": "query", + "name": "coordinatorId", + "required": false, + "type": "integer" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "additionalProperties": { + "$ref": "#/definitions/TransactionMetadata" + }, + "type": "object" + } + }, + "307": { + "description": "Topic don't owner by this broker!" + }, + "400": { + "description": "Topic is not a persistent topic!" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic or coordinator or transaction doesn't exist" + }, + "409": { + "description": "Concurrent modification" + }, + "503": { + "description": "This Broker is not configured with transactionCoordinatorEnabled=true." + } + }, + "summary": "Get slow transactions.", + "tags": [ + "transactions" + ] + } + }, + "/transactions/transactionBufferInternalStats/{tenant}/{namespace}/{topic}": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Transactions_getTransactionBufferInternalStats", + "parameters": [ + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "metadata", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/TransactionBufferInternalStats" + } + }, + "307": { + "description": "Topic is not owned by this broker!" + }, + "400": { + "description": "Topic is not a persistent topic!" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + }, + "405": { + "description": "Transaction buffer don't use managedLedger!" + }, + "409": { + "description": "Concurrent modification" + }, + "503": { + "description": "This Broker is not enable transaction" + } + }, + "summary": "Get transaction buffer internal stats.", + "tags": [ + "transactions" + ] + } + }, + "/transactions/transactionBufferStats/{tenant}/{namespace}/{topic}": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Transactions_getTransactionBufferStats", + "parameters": [ + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "lowWaterMarks", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "segmentStats", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/TransactionBufferStats" + } + }, + "307": { + "description": "Topic is not owned by this broker!" + }, + "400": { + "description": "Topic is not a persistent topic!" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + }, + "409": { + "description": "Concurrent modification" + }, + "503": { + "description": "This Broker is not configured with transactionCoordinatorEnabled=true." + } + }, + "summary": "Get transaction buffer stats in topic.", + "tags": [ + "transactions" + ] + } + }, + "/transactions/transactionCoordinator/replicas": { + "post": { + "consumes": [ + "application/json" + ], + "operationId": "Transactions_scaleTransactionCoordinators", + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "401": { + "description": "This operation requires super-user access" + }, + "406": { + "description": "The number of replicas should be more than the current number of transaction coordinator replicas" + }, + "503": { + "description": "This Broker is not configured with transactionCoordinatorEnabled=true." + } + }, + "tags": [ + "transactions" + ] + } + }, + "/transactions/transactionInBufferStats/{tenant}/{namespace}/{topic}/{mostSigBits}/{leastSigBits}": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Transactions_getTransactionInBufferStats", + "parameters": [ + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "mostSigBits", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "leastSigBits", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/TransactionInBufferStats" + } + }, + "307": { + "description": "Topic is not owned by this broker!" + }, + "400": { + "description": "Topic is not a persistent topic!" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + }, + "409": { + "description": "Concurrent modification" + }, + "503": { + "description": "This Broker is not configured with transactionCoordinatorEnabled=true." + } + }, + "summary": "Get transaction state in transaction buffer.", + "tags": [ + "transactions" + ] + } + }, + "/transactions/transactionInPendingAckStats/{tenant}/{namespace}/{topic}/{subName}/{mostSigBits}/{leastSigBits}": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Transactions_getTransactionInPendingAckStats", + "parameters": [ + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "mostSigBits", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "leastSigBits", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "subName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/TransactionInPendingAckStats" + } + }, + "307": { + "description": "Topic is not owned by this broker!" + }, + "400": { + "description": "Topic is not a persistent topic!" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + }, + "409": { + "description": "Concurrent modification" + }, + "503": { + "description": "This Broker is not configured with transactionCoordinatorEnabled=true." + } + }, + "summary": "Get transaction state in pending ack.", + "tags": [ + "transactions" + ] + } + }, + "/transactions/transactionMetadata/{mostSigBits}/{leastSigBits}": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Transactions_getTransactionMetadata", + "parameters": [ + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "in": "path", + "name": "mostSigBits", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "leastSigBits", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/TransactionMetadata" + } + }, + "307": { + "description": "Topic is not owned by this broker!" + }, + "400": { + "description": "Topic is not a persistent topic!" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic or coordinator or transaction doesn't exist" + }, + "409": { + "description": "Concurrent modification" + }, + "503": { + "description": "This Broker is not configured with transactionCoordinatorEnabled=true." + } + }, + "summary": "Get transaction metadata", + "tags": [ + "transactions" + ] + } + } + }, + "schemes": [ + "http", + "https" + ], + "swagger": "2.0", + "tags": [ + { + "name": "transactions" + } + ] +} diff --git a/static/swagger/4.0.0/v2/swagger.json b/static/swagger/4.0.0/v2/swagger.json new file mode 100644 index 000000000000..68eae463bd6a --- /dev/null +++ b/static/swagger/4.0.0/v2/swagger.json @@ -0,0 +1,36143 @@ +{ + "basePath": "/admin/v2", + "definitions": { + "AllocatorStats": { + "properties": { + "directArenas": { + "items": { + "$ref": "#/definitions/PoolArenaStats" + }, + "type": "array" + }, + "heapArenas": { + "items": { + "$ref": "#/definitions/PoolArenaStats" + }, + "type": "array" + }, + "normalCacheSize": { + "format": "int32", + "type": "integer" + }, + "numDirectArenas": { + "format": "int32", + "type": "integer" + }, + "numHeapArenas": { + "format": "int32", + "type": "integer" + }, + "numThreadLocalCaches": { + "format": "int32", + "type": "integer" + }, + "smallCacheSize": { + "format": "int32", + "type": "integer" + }, + "usedDirectMemory": { + "format": "int64", + "type": "integer" + }, + "usedHeapMemory": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "AuthPolicies": { + "properties": { + "namespaceAuthentication": { + "additionalProperties": { + "items": { + "enum": [ + "produce", + "consume", + "functions", + "sources", + "sinks", + "packages" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "type": "object" + }, + "subscriptionAuthentication": { + "additionalProperties": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "type": "object" + }, + "topicAuthentication": { + "additionalProperties": { + "additionalProperties": { + "items": { + "enum": [ + "produce", + "consume", + "functions", + "sources", + "sinks", + "packages" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "type": "object" + }, + "type": "object" + } + }, + "type": "object" + }, + "AuthenticationDataSource": { + "properties": { + "commandData": { + "type": "string" + }, + "httpAuthType": { + "type": "string" + }, + "peerAddress": { + "$ref": "#/definitions/SocketAddress" + }, + "subscription": { + "type": "string" + }, + "tlsCertificates": { + "items": { + "$ref": "#/definitions/Certificate" + }, + "type": "array" + } + }, + "type": "object" + }, + "AuthenticationParameters": { + "properties": { + "clientAuthenticationDataSource": { + "$ref": "#/definitions/AuthenticationDataSource" + }, + "clientRole": { + "type": "string" + }, + "originalPrincipal": { + "type": "string" + } + }, + "type": "object" + }, + "AutoFailoverPolicyData": { + "properties": { + "parameters": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "policyType": { + "enum": [ + "min_available" + ], + "type": "string" + } + }, + "type": "object" + }, + "AutoSubscriptionCreationOverride": { + "properties": { + "allowAutoSubscriptionCreation": { + "type": "boolean" + } + }, + "type": "object" + }, + "AutoSubscriptionCreationOverrideImpl": { + "properties": { + "allowAutoSubscriptionCreation": { + "type": "boolean" + } + }, + "type": "object" + }, + "AutoTopicCreationOverride": { + "properties": { + "allowAutoTopicCreation": { + "type": "boolean" + }, + "defaultNumPartitions": { + "format": "int32", + "type": "integer" + }, + "topicType": { + "type": "string" + } + }, + "type": "object" + }, + "AutoTopicCreationOverrideImpl": { + "properties": { + "allowAutoTopicCreation": { + "type": "boolean" + }, + "defaultNumPartitions": { + "format": "int32", + "type": "integer" + }, + "topicType": { + "type": "string" + } + }, + "type": "object" + }, + "BacklogQuota": { + "properties": { + "limit": { + "format": "int64", + "type": "integer" + }, + "limitSize": { + "format": "int64", + "type": "integer" + }, + "limitTime": { + "format": "int32", + "type": "integer" + }, + "policy": { + "enum": [ + "producer_request_hold", + "producer_exception", + "consumer_backlog_eviction" + ], + "type": "string" + } + }, + "type": "object" + }, + "BacklogQuotaImpl": { + "properties": { + "limit": { + "format": "int64", + "type": "integer" + }, + "limitSize": { + "format": "int64", + "type": "integer" + }, + "limitTime": { + "format": "int32", + "type": "integer" + }, + "policy": { + "enum": [ + "producer_request_hold", + "producer_exception", + "consumer_backlog_eviction" + ], + "type": "string" + } + }, + "type": "object" + }, + "BitSet": { + "properties": { + "empty": { + "type": "boolean" + } + }, + "type": "object" + }, + "BookieAffinityGroupData": { + "properties": { + "bookkeeperAffinityGroupPrimary": { + "type": "string" + }, + "bookkeeperAffinityGroupSecondary": { + "type": "string" + } + }, + "type": "object" + }, + "BookieAffinityGroupDataImpl": { + "properties": { + "bookkeeperAffinityGroupPrimary": { + "type": "string" + }, + "bookkeeperAffinityGroupSecondary": { + "type": "string" + } + }, + "type": "object" + }, + "BookieInfo": { + "properties": { + "hostname": { + "type": "string" + }, + "rack": { + "type": "string" + } + }, + "type": "object" + }, + "BookiesClusterInfo": { + "properties": { + "bookies": { + "items": { + "$ref": "#/definitions/RawBookieInfo" + }, + "type": "array" + } + }, + "type": "object" + }, + "BrokerInfo": { + "properties": { + "brokerId": { + "type": "string" + }, + "serviceUrl": { + "type": "string" + } + }, + "type": "object" + }, + "BrokerNamespaceIsolationData": { + "description": "The namespace isolation data for a given broker", + "properties": { + "brokerName": { + "description": "The broker name", + "example": "broker1:8080", + "type": "string" + }, + "namespaceRegex": { + "description": "The namespace-isolation policies attached to this broker", + "items": { + "type": "string" + }, + "type": "array" + }, + "policyName": { + "description": "Policy name", + "example": "my-policy", + "type": "string" + }, + "primary": { + "type": "boolean" + } + }, + "type": "object" + }, + "BundlesData": { + "properties": { + "boundaries": { + "items": { + "type": "string" + }, + "type": "array" + }, + "numBundles": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "BundlesDataImpl": { + "properties": { + "boundaries": { + "items": { + "type": "string" + }, + "type": "array" + }, + "numBundles": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "Certificate": { + "properties": { + "encoded": { + "items": { + "format": "byte", + "type": "string" + }, + "type": "array" + }, + "publicKey": { + "$ref": "#/definitions/PublicKey" + }, + "type": { + "type": "string" + } + }, + "type": "object" + }, + "ClusterData": { + "description": "The configuration data for a cluster", + "properties": { + "authenticationParameters": { + "description": "Authentication parameters when client would like to connect to cluster.", + "type": "string" + }, + "authenticationPlugin": { + "description": "Authentication plugin when client would like to connect to cluster.", + "example": "org.apache.pulsar.client.impl.auth.AuthenticationToken", + "type": "string" + }, + "brokerClientCertificateFilePath": { + "description": "TLS certificate file for internal client, used by the internal client to authenticate with Pulsar brokers", + "type": "string" + }, + "brokerClientKeyFilePath": { + "description": "TLS private key file for internal client, used by the internal client to authenticate with Pulsar brokers", + "type": "string" + }, + "brokerClientSslFactoryPlugin": { + "description": "SSL Factory plugin used by internal client to generate the SSL Context and Engine", + "type": "string" + }, + "brokerClientSslFactoryPluginParams": { + "description": "Parameters used by the internal client's SSL factory plugin to generate the SSL Context and Engine", + "type": "string" + }, + "brokerClientTlsEnabled": { + "description": "Enable TLS when talking with other brokers in the same cluster (admin operation) or different clusters (replication)", + "type": "boolean" + }, + "brokerClientTlsEnabledWithKeyStore": { + "description": "Whether internal client use KeyStore type to authenticate with other Pulsar brokers", + "type": "boolean" + }, + "brokerClientTlsKeyStore": { + "description": "TLS KeyStore path for internal client, used by the internal client to authenticate with Pulsar brokers", + "type": "string" + }, + "brokerClientTlsKeyStorePassword": { + "description": "TLS KeyStore password for internal client, used by the internal client to authenticate with Pulsar brokers", + "type": "string" + }, + "brokerClientTlsKeyStoreType": { + "description": "TLS KeyStore type configuration for internal client: JKS, PKCS12, used by the internal client to authenticate with Pulsar brokers", + "type": "string" + }, + "brokerClientTlsTrustStore": { + "description": "TLS TrustStore path for internal client used by the internal client to authenticate with Pulsar brokers", + "type": "string" + }, + "brokerClientTlsTrustStorePassword": { + "description": "TLS TrustStore password for internal client used by the internal client to authenticate with Pulsar brokers", + "type": "string" + }, + "brokerClientTlsTrustStoreType": { + "description": "TLS TrustStore type configuration for internal client: JKS, PKCS12 used by the internal client to authenticate with Pulsar brokers", + "example": "JKS", + "type": "string" + }, + "brokerClientTrustCertsFilePath": { + "description": "Path for the trusted TLS certificate file for outgoing connection to a server (broker)", + "type": "string" + }, + "brokerServiceUrl": { + "description": "The broker service url (for produce and consume operations)", + "example": "pulsar://pulsar.example.com:6650", + "type": "string" + }, + "brokerServiceUrlTls": { + "description": "The secured broker service url (for produce and consume operations)", + "example": "pulsar+ssl://pulsar.example.com:6651", + "type": "string" + }, + "listenerName": { + "description": "listenerName when client would like to connect to cluster", + "type": "string" + }, + "peerClusterNames": { + "description": "A set of peer cluster names", + "items": { + "type": "string" + }, + "type": "array" + }, + "proxyProtocol": { + "description": "protocol to decide type of proxy routing eg: SNI-routing", + "enum": [ + "SNI" + ], + "example": "SNI", + "type": "string" + }, + "proxyServiceUrl": { + "description": "Proxy-service url when client would like to connect to broker via proxy.", + "example": "pulsar+ssl://ats-proxy.example.com:4443 or pulsar://ats-proxy.example.com:4080", + "type": "string" + }, + "serviceUrl": { + "description": "The HTTP rest service URL (for admin operations)", + "example": "http://pulsar.example.com:8080", + "type": "string" + }, + "serviceUrlTls": { + "description": "The HTTPS rest service URL (for admin operations)", + "example": "https://pulsar.example.com:8443", + "type": "string" + }, + "tlsAllowInsecureConnection": { + "description": "Allow TLS connections to servers whose certificate cannot be verified to have been signed by a trusted certificate authority.", + "type": "boolean" + } + }, + "type": "object" + }, + "ClusterUrl": { + "properties": { + "brokerServiceUrl": { + "type": "string" + }, + "brokerServiceUrlTls": { + "type": "string" + }, + "empty": { + "type": "boolean" + }, + "serviceUrl": { + "type": "string" + }, + "serviceUrlTls": { + "type": "string" + } + }, + "type": "object" + }, + "CompactionStats": { + "properties": { + "lastCompactionDurationTimeInMills": { + "format": "int64", + "type": "integer" + }, + "lastCompactionFailedTimestamp": { + "format": "int64", + "type": "integer" + }, + "lastCompactionRemovedEventCount": { + "format": "int64", + "type": "integer" + }, + "lastCompactionSucceedTimestamp": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "CompactionStatsImpl": { + "properties": { + "lastCompactionDurationTimeInMills": { + "format": "int64", + "type": "integer" + }, + "lastCompactionFailedTimestamp": { + "format": "int64", + "type": "integer" + }, + "lastCompactionRemovedEventCount": { + "format": "int64", + "type": "integer" + }, + "lastCompactionSucceedTimestamp": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "CompletableFuture": { + "properties": { + "cancelled": { + "type": "boolean" + }, + "completedExceptionally": { + "type": "boolean" + }, + "done": { + "type": "boolean" + }, + "numberOfDependents": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "CompletableFutureClusterData": { + "properties": { + "cancelled": { + "type": "boolean" + }, + "completedExceptionally": { + "type": "boolean" + }, + "done": { + "type": "boolean" + }, + "numberOfDependents": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "CompletableFutureListSchemaAndMetadata": { + "properties": { + "cancelled": { + "type": "boolean" + }, + "completedExceptionally": { + "type": "boolean" + }, + "done": { + "type": "boolean" + }, + "numberOfDependents": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "CompletableFutureLong": { + "properties": { + "cancelled": { + "type": "boolean" + }, + "completedExceptionally": { + "type": "boolean" + }, + "done": { + "type": "boolean" + }, + "numberOfDependents": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "CompletableFuturePairBooleanSchemaCompatibilityStrategy": { + "properties": { + "cancelled": { + "type": "boolean" + }, + "completedExceptionally": { + "type": "boolean" + }, + "done": { + "type": "boolean" + }, + "numberOfDependents": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "CompletableFuturePartitionedTopicMetadata": { + "properties": { + "cancelled": { + "type": "boolean" + }, + "completedExceptionally": { + "type": "boolean" + }, + "done": { + "type": "boolean" + }, + "numberOfDependents": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "CompletableFutureResourceQuota": { + "properties": { + "cancelled": { + "type": "boolean" + }, + "completedExceptionally": { + "type": "boolean" + }, + "done": { + "type": "boolean" + }, + "numberOfDependents": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "CompletableFutureSchemaAndMetadata": { + "properties": { + "cancelled": { + "type": "boolean" + }, + "completedExceptionally": { + "type": "boolean" + }, + "done": { + "type": "boolean" + }, + "numberOfDependents": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "CompletableFutureSchemaMetadata": { + "properties": { + "cancelled": { + "type": "boolean" + }, + "completedExceptionally": { + "type": "boolean" + }, + "done": { + "type": "boolean" + }, + "numberOfDependents": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "CompletableFutureSchemaVersion": { + "properties": { + "cancelled": { + "type": "boolean" + }, + "completedExceptionally": { + "type": "boolean" + }, + "done": { + "type": "boolean" + }, + "numberOfDependents": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "CompletableFutureVoid": { + "properties": { + "cancelled": { + "type": "boolean" + }, + "completedExceptionally": { + "type": "boolean" + }, + "done": { + "type": "boolean" + }, + "numberOfDependents": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "ConnectorDefinition": { + "properties": { + "description": { + "type": "string" + }, + "name": { + "type": "string" + }, + "sinkClass": { + "type": "string" + }, + "sinkConfigClass": { + "type": "string" + }, + "sourceClass": { + "type": "string" + }, + "sourceConfigClass": { + "type": "string" + } + }, + "type": "object" + }, + "ConsumerStats": { + "properties": { + "address": { + "type": "string" + }, + "appId": { + "type": "string" + }, + "availablePermits": { + "format": "int32", + "type": "integer" + }, + "avgMessagesPerEntry": { + "format": "int32", + "type": "integer" + }, + "blockedConsumerOnUnackedMsgs": { + "type": "boolean" + }, + "bytesOutCounter": { + "format": "int64", + "type": "integer" + }, + "chunkedMessageRate": { + "format": "double", + "type": "number" + }, + "clientVersion": { + "type": "string" + }, + "connectedSince": { + "type": "string" + }, + "consumerName": { + "type": "string" + }, + "drainingHashes": { + "items": { + "$ref": "#/definitions/DrainingHash" + }, + "type": "array" + }, + "drainingHashesClearedTotal": { + "format": "int64", + "type": "integer" + }, + "drainingHashesCount": { + "format": "int32", + "type": "integer" + }, + "drainingHashesUnackedMessages": { + "format": "int32", + "type": "integer" + }, + "keyHashRangeArrays": { + "items": { + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + }, + "type": "array" + }, + "keyHashRanges": { + "items": { + "type": "string" + }, + "type": "array" + }, + "lastAckedTimestamp": { + "format": "int64", + "type": "integer" + }, + "lastConsumedFlowTimestamp": { + "format": "int64", + "type": "integer" + }, + "lastConsumedTimestamp": { + "format": "int64", + "type": "integer" + }, + "messageAckRate": { + "format": "double", + "type": "number" + }, + "metadata": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "msgOutCounter": { + "format": "int64", + "type": "integer" + }, + "msgRateOut": { + "format": "double", + "type": "number" + }, + "msgRateRedeliver": { + "format": "double", + "type": "number" + }, + "msgThroughputOut": { + "format": "double", + "type": "number" + }, + "readPositionWhenJoining": { + "type": "string" + }, + "unackedMessages": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "CursorDetails": { + "properties": { + "cursorBacklog": { + "format": "int64", + "type": "integer" + }, + "cursorLedgerId": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "CursorInfo": { + "properties": { + "creationDate": { + "type": "string" + }, + "cursorsLedgerId": { + "format": "int64", + "type": "integer" + }, + "individualDeletedMessages": { + "items": { + "$ref": "#/definitions/MessageRangeInfo" + }, + "type": "array" + }, + "markDelete": { + "$ref": "#/definitions/PositionInfo" + }, + "modificationDate": { + "type": "string" + }, + "properties": { + "additionalProperties": { + "format": "int64", + "type": "integer" + }, + "type": "object" + }, + "version": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "CursorStats": { + "properties": { + "active": { + "type": "boolean" + }, + "cursorLedger": { + "format": "int64", + "type": "integer" + }, + "cursorLedgerLastEntry": { + "format": "int64", + "type": "integer" + }, + "individuallyDeletedMessages": { + "type": "string" + }, + "lastLedgerSwitchTimestamp": { + "type": "string" + }, + "markDeletePosition": { + "type": "string" + }, + "messagesConsumedCounter": { + "format": "int64", + "type": "integer" + }, + "numberOfEntriesSinceFirstNotAckedMessage": { + "format": "int64", + "type": "integer" + }, + "pendingReadOps": { + "format": "int32", + "type": "integer" + }, + "properties": { + "additionalProperties": { + "format": "int64", + "type": "integer" + }, + "type": "object" + }, + "readPosition": { + "type": "string" + }, + "state": { + "type": "string" + }, + "subscriptionHavePendingRead": { + "type": "boolean" + }, + "subscriptionHavePendingReplayRead": { + "type": "boolean" + }, + "totalNonContiguousDeletedMessagesRange": { + "format": "int32", + "type": "integer" + }, + "waitingReadOp": { + "type": "boolean" + } + }, + "type": "object" + }, + "DelayedDeliveryPolicies": { + "properties": { + "active": { + "type": "boolean" + }, + "maxDeliveryDelayInMillis": { + "format": "int64", + "type": "integer" + }, + "tickTime": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "DeleteSchemaResponse": { + "properties": { + "version": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "DispatchRate": { + "properties": { + "dispatchThrottlingRateInByte": { + "format": "int64", + "type": "integer" + }, + "dispatchThrottlingRateInMsg": { + "format": "int32", + "type": "integer" + }, + "ratePeriodInSecond": { + "format": "int32", + "type": "integer" + }, + "relativeToPublishRate": { + "type": "boolean" + } + }, + "type": "object" + }, + "DispatchRateImpl": { + "properties": { + "dispatchThrottlingRateInByte": { + "format": "int64", + "type": "integer" + }, + "dispatchThrottlingRateInMsg": { + "format": "int32", + "type": "integer" + }, + "ratePeriodInSecond": { + "format": "int32", + "type": "integer" + }, + "relativeToPublishRate": { + "type": "boolean" + } + }, + "type": "object" + }, + "DrainingHash": { + "properties": { + "blockedAttempts": { + "format": "int32", + "type": "integer" + }, + "hash": { + "format": "int32", + "type": "integer" + }, + "unackMsgs": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "EntryFilters": { + "properties": { + "entryFilterNames": { + "type": "string" + } + }, + "type": "object" + }, + "FailureDomain": { + "description": "The data of a failure domain configuration in a cluster", + "properties": { + "brokers": { + "description": "The collection of brokers in the same failure domain", + "example": "[ 'broker-1', 'broker-2' ]", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "FunctionInstanceStatsData": { + "properties": { + "avgProcessLatency": { + "format": "double", + "type": "number" + }, + "lastInvocation": { + "format": "int64", + "type": "integer" + }, + "oneMin": { + "$ref": "#/definitions/FunctionInstanceStatsDataBase" + }, + "processedSuccessfullyTotal": { + "format": "int64", + "type": "integer" + }, + "receivedTotal": { + "format": "int64", + "type": "integer" + }, + "systemExceptionsTotal": { + "format": "int64", + "type": "integer" + }, + "userExceptionsTotal": { + "format": "int64", + "type": "integer" + }, + "userMetrics": { + "additionalProperties": { + "format": "double", + "type": "number" + }, + "type": "object" + } + }, + "type": "object" + }, + "FunctionInstanceStatsDataBase": { + "properties": { + "avgProcessLatency": { + "format": "double", + "type": "number" + }, + "processedSuccessfullyTotal": { + "format": "int64", + "type": "integer" + }, + "receivedTotal": { + "format": "int64", + "type": "integer" + }, + "systemExceptionsTotal": { + "format": "int64", + "type": "integer" + }, + "userExceptionsTotal": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "Functions": { + "properties": { + "listOfConnectors": { + "items": { + "$ref": "#/definitions/ConnectorDefinition" + }, + "type": "array" + } + }, + "type": "object" + }, + "FunctionsV2": { + "properties": { + "listOfConnectors": { + "items": { + "$ref": "#/definitions/ConnectorDefinition" + }, + "type": "array" + } + }, + "type": "object" + }, + "FunctionsV2WorkerService": { + "properties": { + "listOfConnectors": { + "items": { + "$ref": "#/definitions/ConnectorDefinition" + }, + "type": "array" + } + }, + "type": "object" + }, + "FunctionsWorkerService": { + "properties": { + "listOfConnectors": { + "items": { + "$ref": "#/definitions/ConnectorDefinition" + }, + "type": "array" + } + }, + "type": "object" + }, + "GetAllVersionsSchemaResponse": { + "properties": { + "getSchemaResponses": { + "items": { + "$ref": "#/definitions/GetSchemaResponse" + }, + "type": "array" + } + }, + "type": "object" + }, + "GetSchemaResponse": { + "properties": { + "data": { + "type": "string" + }, + "properties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "timestamp": { + "format": "int64", + "type": "integer" + }, + "type": { + "enum": [ + "NONE", + "STRING", + "JSON", + "PROTOBUF", + "AVRO", + "BOOLEAN", + "INT8", + "INT16", + "INT32", + "INT64", + "FLOAT", + "DOUBLE", + "DATE", + "TIME", + "TIMESTAMP", + "KEY_VALUE", + "INSTANT", + "LOCAL_DATE", + "LOCAL_TIME", + "LOCAL_DATE_TIME", + "PROTOBUF_NATIVE", + "BYTES", + "AUTO", + "AUTO_CONSUME", + "AUTO_PUBLISH" + ], + "type": "string" + }, + "version": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "InactiveTopicPolicies": { + "properties": { + "deleteWhileInactive": { + "type": "boolean" + }, + "inactiveTopicDeleteMode": { + "enum": [ + "delete_when_no_subscriptions", + "delete_when_subscriptions_caught_up" + ], + "type": "string" + }, + "maxInactiveDurationSeconds": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "InternalConfigurationData": { + "properties": { + "bookkeeperMetadataServiceUri": { + "type": "string" + }, + "configurationMetadataStoreUrl": { + "type": "string" + }, + "configurationStoreServers": { + "type": "string" + }, + "ledgersRootPath": { + "type": "string" + }, + "metadataStoreUrl": { + "type": "string" + }, + "stateStorageServiceUrl": { + "type": "string" + }, + "zookeeperServers": { + "type": "string" + } + }, + "type": "object" + }, + "IsCompatibilityResponse": { + "properties": { + "compatibility": { + "type": "boolean" + }, + "schemaCompatibilityStrategy": { + "type": "string" + } + }, + "type": "object" + }, + "KubernetesContainerFactory": { + "properties": { + "changeConfigMap": { + "type": "string" + }, + "changeConfigMapNamespace": { + "type": "string" + }, + "configAdminCLI": { + "type": "string" + }, + "cpuOverCommitRatio": { + "format": "double", + "type": "number" + }, + "customLabels": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "expectedMetricsCollectionInterval": { + "format": "int32", + "type": "integer" + }, + "extraFunctionDependenciesDir": { + "type": "string" + }, + "functionDockerImages": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "functionInstanceClassPath": { + "type": "string" + }, + "gracePeriodSeconds": { + "format": "int32", + "type": "integer" + }, + "grpcPort": { + "format": "int32", + "type": "integer" + }, + "imagePullPolicy": { + "type": "string" + }, + "installUserCodeDependencies": { + "type": "boolean" + }, + "jobName": { + "type": "string" + }, + "jobNamespace": { + "type": "string" + }, + "k8Uri": { + "type": "string" + }, + "kubernetesFunctionAuthProviderConfig": { + "additionalProperties": { + "type": "object" + }, + "type": "object" + }, + "memoryOverCommitRatio": { + "format": "double", + "type": "number" + }, + "metricsPort": { + "format": "int32", + "type": "integer" + }, + "narExtractionDirectory": { + "type": "string" + }, + "percentMemoryPadding": { + "format": "int32", + "type": "integer" + }, + "pulsarAdminUrl": { + "type": "string" + }, + "pulsarDockerImageName": { + "type": "string" + }, + "pulsarRootDir": { + "type": "string" + }, + "pulsarServiceUrl": { + "type": "string" + }, + "pythonDependencyRepository": { + "type": "string" + }, + "pythonExtraDependencyRepository": { + "type": "string" + }, + "submittingInsidePod": { + "type": "boolean" + } + }, + "type": "object" + }, + "LedgerDetails": { + "properties": { + "entries": { + "format": "int64", + "type": "integer" + }, + "ledgerId": { + "format": "int64", + "type": "integer" + }, + "size": { + "format": "int64", + "type": "integer" + }, + "timestamp": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "LedgerInfo": { + "properties": { + "entries": { + "format": "int64", + "type": "integer" + }, + "ledgerId": { + "format": "int64", + "type": "integer" + }, + "metadata": { + "type": "string" + }, + "offloaded": { + "type": "boolean" + }, + "size": { + "format": "int64", + "type": "integer" + }, + "underReplicated": { + "type": "boolean" + } + }, + "type": "object" + }, + "LoadReport": { + "properties": { + "allocatedBandwidthIn": { + "format": "double", + "type": "number" + }, + "allocatedBandwidthOut": { + "format": "double", + "type": "number" + }, + "allocatedCPU": { + "format": "double", + "type": "number" + }, + "allocatedMemory": { + "format": "double", + "type": "number" + }, + "allocatedMsgRateIn": { + "format": "double", + "type": "number" + }, + "allocatedMsgRateOut": { + "format": "double", + "type": "number" + }, + "bandwidthIn": { + "$ref": "#/definitions/ResourceUsage" + }, + "bandwidthOut": { + "$ref": "#/definitions/ResourceUsage" + }, + "brokerVersionString": { + "type": "string" + }, + "bundleGains": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "bundleLosses": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "bundleStats": { + "additionalProperties": { + "$ref": "#/definitions/NamespaceBundleStats" + }, + "type": "object" + }, + "cpu": { + "$ref": "#/definitions/ResourceUsage" + }, + "directMemory": { + "$ref": "#/definitions/ResourceUsage" + }, + "lastUpdate": { + "format": "int64", + "type": "integer" + }, + "loadManagerClassName": { + "type": "string" + }, + "loadReportType": { + "type": "string" + }, + "memory": { + "$ref": "#/definitions/ResourceUsage" + }, + "msgRateIn": { + "format": "double", + "type": "number" + }, + "msgRateOut": { + "format": "double", + "type": "number" + }, + "msgThroughputIn": { + "format": "double", + "type": "number" + }, + "msgThroughputOut": { + "format": "double", + "type": "number" + }, + "name": { + "type": "string" + }, + "nonPersistentTopicsEnabled": { + "type": "boolean" + }, + "numBundles": { + "format": "int32", + "type": "integer" + }, + "numConsumers": { + "format": "int32", + "type": "integer" + }, + "numProducers": { + "format": "int32", + "type": "integer" + }, + "numTopics": { + "format": "int64", + "type": "integer" + }, + "overLoaded": { + "type": "boolean" + }, + "persistentTopicsEnabled": { + "type": "boolean" + }, + "preAllocatedBandwidthIn": { + "format": "double", + "type": "number" + }, + "preAllocatedBandwidthOut": { + "format": "double", + "type": "number" + }, + "preAllocatedCPU": { + "format": "double", + "type": "number" + }, + "preAllocatedMemory": { + "format": "double", + "type": "number" + }, + "preAllocatedMsgRateIn": { + "format": "double", + "type": "number" + }, + "preAllocatedMsgRateOut": { + "format": "double", + "type": "number" + }, + "protocols": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "pulsarServiceUrl": { + "type": "string" + }, + "pulsarServiceUrlTls": { + "type": "string" + }, + "startTimestamp": { + "format": "int64", + "type": "integer" + }, + "systemResourceUsage": { + "$ref": "#/definitions/SystemResourceUsage" + }, + "timestamp": { + "format": "int64", + "type": "integer" + }, + "underLoaded": { + "type": "boolean" + }, + "webServiceUrl": { + "type": "string" + }, + "webServiceUrlTls": { + "type": "string" + } + }, + "type": "object" + }, + "LongRunningProcessStatus": { + "properties": { + "lastError": { + "type": "string" + }, + "status": { + "enum": [ + "NOT_RUN", + "RUNNING", + "SUCCESS", + "ERROR" + ], + "type": "string" + } + }, + "type": "object" + }, + "LongSchemaVersion": { + "properties": { + "version": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "ManagedLedgerInfo": { + "properties": { + "creationDate": { + "type": "string" + }, + "cursors": { + "additionalProperties": { + "$ref": "#/definitions/CursorInfo" + }, + "type": "object" + }, + "ledgers": { + "items": { + "$ref": "#/definitions/LedgerInfo" + }, + "type": "array" + }, + "modificationDate": { + "type": "string" + }, + "properties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "terminatedPosition": { + "$ref": "#/definitions/PositionInfo" + }, + "version": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "MemoryLimit": { + "properties": { + "absoluteValue": { + "format": "int64", + "type": "integer" + }, + "percentOfMaxDirectMemory": { + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "MessageId": { + "type": "object" + }, + "MessageIdAdv": { + "properties": { + "ackSet": { + "$ref": "#/definitions/BitSet" + }, + "batchIndex": { + "format": "int32", + "type": "integer" + }, + "batchSize": { + "format": "int32", + "type": "integer" + }, + "entryId": { + "format": "int64", + "type": "integer" + }, + "firstChunkMessageId": { + "$ref": "#/definitions/MessageIdAdv" + }, + "ledgerId": { + "format": "int64", + "type": "integer" + }, + "partitionIndex": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "MessageRangeInfo": { + "properties": { + "from": { + "$ref": "#/definitions/PositionInfo" + }, + "to": { + "$ref": "#/definitions/PositionInfo" + } + }, + "type": "object" + }, + "Metrics": { + "properties": { + "dimensions": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "metrics": { + "additionalProperties": { + "type": "object" + }, + "type": "object" + } + }, + "type": "object" + }, + "NamespaceBundleStats": { + "properties": { + "cacheSize": { + "format": "int64", + "type": "integer" + }, + "consumerCount": { + "format": "int32", + "type": "integer" + }, + "msgRateIn": { + "format": "double", + "type": "number" + }, + "msgRateOut": { + "format": "double", + "type": "number" + }, + "msgThroughputIn": { + "format": "double", + "type": "number" + }, + "msgThroughputOut": { + "format": "double", + "type": "number" + }, + "producerCount": { + "format": "int32", + "type": "integer" + }, + "topics": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "NamespaceIsolationData": { + "description": "The data of namespace isolation configuration", + "properties": { + "auto_failover_policy": { + "$ref": "#/definitions/AutoFailoverPolicyData", + "description": "The data of auto-failover policy configuration", + "example": "{ \"policy_type\": \"min_available\" \"parameters\": { \"\": \"\" }}" + }, + "namespaces": { + "description": "The list of namespaces to apply this namespace isolation data", + "items": { + "type": "string" + }, + "type": "array" + }, + "primary": { + "description": "The list of primary brokers for serving the list of namespaces in this isolation policy", + "items": { + "type": "string" + }, + "type": "array" + }, + "secondary": { + "description": "The list of secondary brokers for serving the list of namespaces in this isolation policy", + "items": { + "type": "string" + }, + "type": "array" + }, + "unload_scope": { + "description": "The type of unload to perform while applying the new isolation policy.", + "enum": [ + "all_matching", + "none", + "changed" + ], + "example": "'changed' (default) for unloading only the namespaces whose placement is actually changing. 'all_matching' for unloading all matching namespaces. 'none' for not unloading any namespaces.", + "type": "string" + } + }, + "type": "object" + }, + "NamespaceOwnershipStatus": { + "properties": { + "broker_assignment": { + "enum": [ + "primary", + "secondary", + "shared" + ], + "type": "string" + }, + "is_active": { + "type": "boolean" + }, + "is_controlled": { + "type": "boolean" + } + }, + "type": "object" + }, + "NonPersistentPartitionedTopicStatsImpl": { + "properties": { + "abortedTxnCount": { + "format": "int64", + "type": "integer" + }, + "averageMsgSize": { + "format": "double", + "type": "number" + }, + "backlogQuotaLimitSize": { + "format": "int64", + "type": "integer" + }, + "backlogQuotaLimitTime": { + "format": "int64", + "type": "integer" + }, + "backlogSize": { + "format": "int64", + "type": "integer" + }, + "bytesInCounter": { + "format": "int64", + "type": "integer" + }, + "bytesOutCounter": { + "format": "int64", + "type": "integer" + }, + "bytesOutInternalCounter": { + "format": "int64", + "type": "integer" + }, + "committedTxnCount": { + "format": "int64", + "type": "integer" + }, + "compaction": { + "$ref": "#/definitions/CompactionStatsImpl" + }, + "deduplicationStatus": { + "type": "string" + }, + "delayedMessageIndexSizeInBytes": { + "format": "int64", + "type": "integer" + }, + "earliestMsgPublishTimeInBacklogs": { + "format": "int64", + "type": "integer" + }, + "lastOffloadFailureTimeStamp": { + "format": "int64", + "type": "integer" + }, + "lastOffloadLedgerId": { + "format": "int64", + "type": "integer" + }, + "lastOffloadSuccessTimeStamp": { + "format": "int64", + "type": "integer" + }, + "metadata": { + "$ref": "#/definitions/PartitionedTopicMetadata" + }, + "msgChunkPublished": { + "type": "boolean" + }, + "msgDropRate": { + "format": "double", + "type": "number" + }, + "msgInCounter": { + "format": "int64", + "type": "integer" + }, + "msgOutCounter": { + "format": "int64", + "type": "integer" + }, + "msgRateIn": { + "format": "double", + "type": "number" + }, + "msgRateOut": { + "format": "double", + "type": "number" + }, + "msgThroughputIn": { + "format": "double", + "type": "number" + }, + "msgThroughputOut": { + "format": "double", + "type": "number" + }, + "nonContiguousDeletedMessagesRanges": { + "format": "int32", + "type": "integer" + }, + "nonContiguousDeletedMessagesRangesSerializedSize": { + "format": "int32", + "type": "integer" + }, + "offloadedStorageSize": { + "format": "int64", + "type": "integer" + }, + "oldestBacklogMessageAgeSeconds": { + "format": "int64", + "type": "integer" + }, + "oldestBacklogMessageSubscriptionName": { + "type": "string" + }, + "ongoingTxnCount": { + "format": "int64", + "type": "integer" + }, + "ownerBroker": { + "type": "string" + }, + "partitions": { + "additionalProperties": { + "$ref": "#/definitions/NonPersistentTopicStatsImpl" + }, + "type": "object" + }, + "publishRateLimitedTimes": { + "format": "int64", + "type": "integer" + }, + "publishers": { + "items": { + "$ref": "#/definitions/NonPersistentPublisherStats" + }, + "readOnly": true, + "type": "array" + }, + "replication": { + "additionalProperties": { + "$ref": "#/definitions/NonPersistentReplicatorStats" + }, + "readOnly": true, + "type": "object" + }, + "storageSize": { + "format": "int64", + "type": "integer" + }, + "subscriptions": { + "additionalProperties": { + "$ref": "#/definitions/NonPersistentSubscriptionStats" + }, + "readOnly": true, + "type": "object" + }, + "systemTopicBytesInCounter": { + "format": "int64", + "type": "integer" + }, + "topicEpoch": { + "format": "int64", + "type": "integer" + }, + "waitingPublishers": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "NonPersistentPublisherStats": { + "properties": { + "accessMode": { + "enum": [ + "Shared", + "Exclusive", + "ExclusiveWithFencing", + "WaitForExclusive" + ], + "type": "string" + }, + "address": { + "type": "string" + }, + "averageMsgSize": { + "format": "double", + "type": "number" + }, + "chunkedMessageRate": { + "format": "double", + "type": "number" + }, + "clientVersion": { + "type": "string" + }, + "connectedSince": { + "type": "string" + }, + "metadata": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "msgDropRate": { + "format": "double", + "type": "number" + }, + "msgRateIn": { + "format": "double", + "type": "number" + }, + "msgThroughputIn": { + "format": "double", + "type": "number" + }, + "producerId": { + "format": "int64", + "type": "integer" + }, + "producerName": { + "type": "string" + }, + "supportsPartialProducer": { + "type": "boolean" + } + }, + "type": "object" + }, + "NonPersistentReplicatorStats": { + "properties": { + "bytesInCount": { + "format": "int64", + "type": "integer" + }, + "bytesOutCount": { + "format": "int64", + "type": "integer" + }, + "connected": { + "type": "boolean" + }, + "inboundConnectedSince": { + "type": "string" + }, + "inboundConnection": { + "type": "string" + }, + "msgDropCount": { + "format": "int64", + "type": "integer" + }, + "msgDropRate": { + "format": "double", + "type": "number" + }, + "msgExpiredCount": { + "format": "int64", + "type": "integer" + }, + "msgInCount": { + "format": "int64", + "type": "integer" + }, + "msgOutCount": { + "format": "int64", + "type": "integer" + }, + "msgRateExpired": { + "format": "double", + "type": "number" + }, + "msgRateIn": { + "format": "double", + "type": "number" + }, + "msgRateOut": { + "format": "double", + "type": "number" + }, + "msgThroughputIn": { + "format": "double", + "type": "number" + }, + "msgThroughputOut": { + "format": "double", + "type": "number" + }, + "outboundConnectedSince": { + "type": "string" + }, + "outboundConnection": { + "type": "string" + }, + "replicationBacklog": { + "format": "int64", + "type": "integer" + }, + "replicationDelayInSeconds": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "NonPersistentSubscriptionStats": { + "properties": { + "activeConsumerName": { + "type": "string" + }, + "allowOutOfOrderDelivery": { + "type": "boolean" + }, + "backlogSize": { + "format": "int64", + "type": "integer" + }, + "blockedSubscriptionOnUnackedMsgs": { + "type": "boolean" + }, + "bytesOutCounter": { + "format": "int64", + "type": "integer" + }, + "chunkedMessageRate": { + "format": "double", + "type": "number" + }, + "consumers": { + "items": { + "$ref": "#/definitions/ConsumerStats" + }, + "type": "array" + }, + "consumersAfterMarkDeletePosition": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "delayedMessageIndexSizeInBytes": { + "format": "int64", + "type": "integer" + }, + "drainingHashesClearedTotal": { + "format": "int64", + "type": "integer" + }, + "drainingHashesCount": { + "format": "int32", + "type": "integer" + }, + "drainingHashesUnackedMessages": { + "format": "int32", + "type": "integer" + }, + "durable": { + "type": "boolean" + }, + "earliestMsgPublishTimeInBacklog": { + "format": "int64", + "type": "integer" + }, + "filterAcceptedMsgCount": { + "format": "int64", + "type": "integer" + }, + "filterProcessedMsgCount": { + "format": "int64", + "type": "integer" + }, + "filterRejectedMsgCount": { + "format": "int64", + "type": "integer" + }, + "filterRescheduledMsgCount": { + "format": "int64", + "type": "integer" + }, + "keySharedMode": { + "type": "string" + }, + "lastAckedTimestamp": { + "format": "int64", + "type": "integer" + }, + "lastConsumedFlowTimestamp": { + "format": "int64", + "type": "integer" + }, + "lastConsumedTimestamp": { + "format": "int64", + "type": "integer" + }, + "lastExpireTimestamp": { + "format": "int64", + "type": "integer" + }, + "lastMarkDeleteAdvancedTimestamp": { + "format": "int64", + "type": "integer" + }, + "messageAckRate": { + "format": "double", + "type": "number" + }, + "msgBacklog": { + "format": "int64", + "type": "integer" + }, + "msgBacklogNoDelayed": { + "format": "int64", + "type": "integer" + }, + "msgDelayed": { + "format": "int64", + "type": "integer" + }, + "msgDropRate": { + "format": "double", + "type": "number" + }, + "msgInReplay": { + "format": "int64", + "type": "integer" + }, + "msgOutCounter": { + "format": "int64", + "type": "integer" + }, + "msgRateExpired": { + "format": "double", + "type": "number" + }, + "msgRateOut": { + "format": "double", + "type": "number" + }, + "msgRateRedeliver": { + "format": "double", + "type": "number" + }, + "msgThroughputOut": { + "format": "double", + "type": "number" + }, + "nonContiguousDeletedMessagesRanges": { + "format": "int32", + "type": "integer" + }, + "nonContiguousDeletedMessagesRangesSerializedSize": { + "format": "int32", + "type": "integer" + }, + "replicated": { + "type": "boolean" + }, + "subscriptionProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "totalMsgExpired": { + "format": "int64", + "type": "integer" + }, + "type": { + "type": "string" + }, + "unackedMessages": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "NonPersistentTopicStatsImpl": { + "properties": { + "abortedTxnCount": { + "format": "int64", + "type": "integer" + }, + "averageMsgSize": { + "format": "double", + "type": "number" + }, + "backlogQuotaLimitSize": { + "format": "int64", + "type": "integer" + }, + "backlogQuotaLimitTime": { + "format": "int64", + "type": "integer" + }, + "backlogSize": { + "format": "int64", + "type": "integer" + }, + "bytesInCounter": { + "format": "int64", + "type": "integer" + }, + "bytesOutCounter": { + "format": "int64", + "type": "integer" + }, + "bytesOutInternalCounter": { + "format": "int64", + "type": "integer" + }, + "committedTxnCount": { + "format": "int64", + "type": "integer" + }, + "compaction": { + "$ref": "#/definitions/CompactionStatsImpl" + }, + "deduplicationStatus": { + "type": "string" + }, + "delayedMessageIndexSizeInBytes": { + "format": "int64", + "type": "integer" + }, + "earliestMsgPublishTimeInBacklogs": { + "format": "int64", + "type": "integer" + }, + "lastOffloadFailureTimeStamp": { + "format": "int64", + "type": "integer" + }, + "lastOffloadLedgerId": { + "format": "int64", + "type": "integer" + }, + "lastOffloadSuccessTimeStamp": { + "format": "int64", + "type": "integer" + }, + "msgChunkPublished": { + "type": "boolean" + }, + "msgDropRate": { + "format": "double", + "type": "number" + }, + "msgInCounter": { + "format": "int64", + "type": "integer" + }, + "msgOutCounter": { + "format": "int64", + "type": "integer" + }, + "msgRateIn": { + "format": "double", + "type": "number" + }, + "msgRateOut": { + "format": "double", + "type": "number" + }, + "msgThroughputIn": { + "format": "double", + "type": "number" + }, + "msgThroughputOut": { + "format": "double", + "type": "number" + }, + "nonContiguousDeletedMessagesRanges": { + "format": "int32", + "type": "integer" + }, + "nonContiguousDeletedMessagesRangesSerializedSize": { + "format": "int32", + "type": "integer" + }, + "offloadedStorageSize": { + "format": "int64", + "type": "integer" + }, + "oldestBacklogMessageAgeSeconds": { + "format": "int64", + "type": "integer" + }, + "oldestBacklogMessageSubscriptionName": { + "type": "string" + }, + "ongoingTxnCount": { + "format": "int64", + "type": "integer" + }, + "ownerBroker": { + "type": "string" + }, + "publishRateLimitedTimes": { + "format": "int64", + "type": "integer" + }, + "publishers": { + "items": { + "$ref": "#/definitions/NonPersistentPublisherStats" + }, + "readOnly": true, + "type": "array" + }, + "replication": { + "additionalProperties": { + "$ref": "#/definitions/NonPersistentReplicatorStats" + }, + "readOnly": true, + "type": "object" + }, + "storageSize": { + "format": "int64", + "type": "integer" + }, + "subscriptions": { + "additionalProperties": { + "$ref": "#/definitions/NonPersistentSubscriptionStats" + }, + "readOnly": true, + "type": "object" + }, + "systemTopicBytesInCounter": { + "format": "int64", + "type": "integer" + }, + "topicEpoch": { + "format": "int64", + "type": "integer" + }, + "waitingPublishers": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "OffloadPolicies": { + "properties": { + "fileSystemProfilePath": { + "type": "string" + }, + "fileSystemURI": { + "type": "string" + }, + "gcsManagedLedgerOffloadBucket": { + "type": "string" + }, + "gcsManagedLedgerOffloadMaxBlockSizeInBytes": { + "format": "int32", + "type": "integer" + }, + "gcsManagedLedgerOffloadReadBufferSizeInBytes": { + "format": "int32", + "type": "integer" + }, + "gcsManagedLedgerOffloadRegion": { + "type": "string" + }, + "gcsManagedLedgerOffloadServiceAccountKeyFile": { + "type": "string" + }, + "managedLedgerOffloadBucket": { + "type": "string" + }, + "managedLedgerOffloadDeletionLagInMillis": { + "format": "int64", + "type": "integer" + }, + "managedLedgerOffloadDriver": { + "type": "string" + }, + "managedLedgerOffloadMaxBlockSizeInBytes": { + "format": "int32", + "type": "integer" + }, + "managedLedgerOffloadMaxThreads": { + "format": "int32", + "type": "integer" + }, + "managedLedgerOffloadPrefetchRounds": { + "format": "int32", + "type": "integer" + }, + "managedLedgerOffloadReadBufferSizeInBytes": { + "format": "int32", + "type": "integer" + }, + "managedLedgerOffloadRegion": { + "type": "string" + }, + "managedLedgerOffloadServiceEndpoint": { + "type": "string" + }, + "managedLedgerOffloadThresholdInBytes": { + "format": "int64", + "type": "integer" + }, + "managedLedgerOffloadThresholdInSeconds": { + "format": "int64", + "type": "integer" + }, + "managedLedgerOffloadedReadPriority": { + "enum": [ + "BOOKKEEPER_FIRST", + "TIERED_STORAGE_FIRST" + ], + "type": "string" + }, + "offloadersDirectory": { + "type": "string" + }, + "s3ManagedLedgerOffloadBucket": { + "type": "string" + }, + "s3ManagedLedgerOffloadCredentialId": { + "type": "string" + }, + "s3ManagedLedgerOffloadCredentialSecret": { + "type": "string" + }, + "s3ManagedLedgerOffloadMaxBlockSizeInBytes": { + "format": "int32", + "type": "integer" + }, + "s3ManagedLedgerOffloadReadBufferSizeInBytes": { + "format": "int32", + "type": "integer" + }, + "s3ManagedLedgerOffloadRegion": { + "type": "string" + }, + "s3ManagedLedgerOffloadRole": { + "type": "string" + }, + "s3ManagedLedgerOffloadRoleSessionName": { + "type": "string" + }, + "s3ManagedLedgerOffloadServiceEndpoint": { + "type": "string" + } + }, + "type": "object" + }, + "OffloadPoliciesImpl": { + "properties": { + "fileSystemDriver": { + "type": "boolean" + }, + "fileSystemProfilePath": { + "type": "string" + }, + "fileSystemURI": { + "type": "string" + }, + "gcsDriver": { + "type": "boolean" + }, + "gcsManagedLedgerOffloadBucket": { + "type": "string" + }, + "gcsManagedLedgerOffloadMaxBlockSizeInBytes": { + "format": "int32", + "type": "integer" + }, + "gcsManagedLedgerOffloadReadBufferSizeInBytes": { + "format": "int32", + "type": "integer" + }, + "gcsManagedLedgerOffloadRegion": { + "type": "string" + }, + "gcsManagedLedgerOffloadServiceAccountKeyFile": { + "type": "string" + }, + "managedLedgerExtraConfigurations": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "managedLedgerOffloadBucket": { + "type": "string" + }, + "managedLedgerOffloadDeletionLagInMillis": { + "format": "int64", + "type": "integer" + }, + "managedLedgerOffloadDriver": { + "type": "string" + }, + "managedLedgerOffloadMaxBlockSizeInBytes": { + "format": "int32", + "type": "integer" + }, + "managedLedgerOffloadMaxThreads": { + "format": "int32", + "type": "integer" + }, + "managedLedgerOffloadPrefetchRounds": { + "format": "int32", + "type": "integer" + }, + "managedLedgerOffloadReadBufferSizeInBytes": { + "format": "int32", + "type": "integer" + }, + "managedLedgerOffloadRegion": { + "type": "string" + }, + "managedLedgerOffloadServiceEndpoint": { + "type": "string" + }, + "managedLedgerOffloadThresholdInBytes": { + "format": "int64", + "type": "integer" + }, + "managedLedgerOffloadThresholdInSeconds": { + "format": "int64", + "type": "integer" + }, + "managedLedgerOffloadedReadPriority": { + "enum": [ + "BOOKKEEPER_FIRST", + "TIERED_STORAGE_FIRST" + ], + "type": "string" + }, + "offloadersDirectory": { + "type": "string" + }, + "s3Driver": { + "type": "boolean" + }, + "s3ManagedLedgerOffloadBucket": { + "type": "string" + }, + "s3ManagedLedgerOffloadCredentialId": { + "type": "string" + }, + "s3ManagedLedgerOffloadCredentialSecret": { + "type": "string" + }, + "s3ManagedLedgerOffloadMaxBlockSizeInBytes": { + "format": "int32", + "type": "integer" + }, + "s3ManagedLedgerOffloadReadBufferSizeInBytes": { + "format": "int32", + "type": "integer" + }, + "s3ManagedLedgerOffloadRegion": { + "type": "string" + }, + "s3ManagedLedgerOffloadRole": { + "type": "string" + }, + "s3ManagedLedgerOffloadRoleSessionName": { + "type": "string" + }, + "s3ManagedLedgerOffloadServiceEndpoint": { + "type": "string" + } + }, + "type": "object" + }, + "OffloadProcessStatus": { + "properties": { + "firstUnoffloadedMessage": { + "$ref": "#/definitions/MessageId" + }, + "lastError": { + "type": "string" + }, + "status": { + "enum": [ + "NOT_RUN", + "RUNNING", + "SUCCESS", + "ERROR" + ], + "type": "string" + } + }, + "type": "object" + }, + "OutputStream": { + "type": "object" + }, + "PartitionedManagedLedgerInfo": { + "properties": { + "creationDate": { + "type": "string" + }, + "cursors": { + "additionalProperties": { + "$ref": "#/definitions/CursorInfo" + }, + "type": "object" + }, + "ledgers": { + "items": { + "$ref": "#/definitions/LedgerInfo" + }, + "type": "array" + }, + "modificationDate": { + "type": "string" + }, + "partitions": { + "additionalProperties": { + "$ref": "#/definitions/ManagedLedgerInfo" + }, + "type": "object" + }, + "properties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "terminatedPosition": { + "$ref": "#/definitions/PositionInfo" + }, + "version": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "PartitionedTopicInternalStats": { + "properties": { + "metadata": { + "$ref": "#/definitions/PartitionedTopicMetadata" + }, + "partitions": { + "additionalProperties": { + "$ref": "#/definitions/PersistentTopicInternalStats" + }, + "type": "object" + } + }, + "type": "object" + }, + "PartitionedTopicMetadata": { + "properties": { + "deleted": { + "type": "boolean" + }, + "partitions": { + "format": "int32", + "type": "integer" + }, + "properties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + } + }, + "type": "object" + }, + "PartitionedTopicStatsImpl": { + "properties": { + "abortedTxnCount": { + "format": "int64", + "type": "integer" + }, + "averageMsgSize": { + "format": "double", + "type": "number" + }, + "backlogQuotaLimitSize": { + "format": "int64", + "type": "integer" + }, + "backlogQuotaLimitTime": { + "format": "int64", + "type": "integer" + }, + "backlogSize": { + "format": "int64", + "type": "integer" + }, + "bytesInCounter": { + "format": "int64", + "type": "integer" + }, + "bytesOutCounter": { + "format": "int64", + "type": "integer" + }, + "bytesOutInternalCounter": { + "format": "int64", + "type": "integer" + }, + "committedTxnCount": { + "format": "int64", + "type": "integer" + }, + "compaction": { + "$ref": "#/definitions/CompactionStatsImpl" + }, + "deduplicationStatus": { + "type": "string" + }, + "delayedMessageIndexSizeInBytes": { + "format": "int64", + "type": "integer" + }, + "earliestMsgPublishTimeInBacklogs": { + "format": "int64", + "type": "integer" + }, + "lastOffloadFailureTimeStamp": { + "format": "int64", + "type": "integer" + }, + "lastOffloadLedgerId": { + "format": "int64", + "type": "integer" + }, + "lastOffloadSuccessTimeStamp": { + "format": "int64", + "type": "integer" + }, + "metadata": { + "$ref": "#/definitions/PartitionedTopicMetadata" + }, + "msgChunkPublished": { + "type": "boolean" + }, + "msgInCounter": { + "format": "int64", + "type": "integer" + }, + "msgOutCounter": { + "format": "int64", + "type": "integer" + }, + "msgRateIn": { + "format": "double", + "type": "number" + }, + "msgRateOut": { + "format": "double", + "type": "number" + }, + "msgThroughputIn": { + "format": "double", + "type": "number" + }, + "msgThroughputOut": { + "format": "double", + "type": "number" + }, + "nonContiguousDeletedMessagesRanges": { + "format": "int32", + "type": "integer" + }, + "nonContiguousDeletedMessagesRangesSerializedSize": { + "format": "int32", + "type": "integer" + }, + "offloadedStorageSize": { + "format": "int64", + "type": "integer" + }, + "oldestBacklogMessageAgeSeconds": { + "format": "int64", + "type": "integer" + }, + "oldestBacklogMessageSubscriptionName": { + "type": "string" + }, + "ongoingTxnCount": { + "format": "int64", + "type": "integer" + }, + "ownerBroker": { + "type": "string" + }, + "partitions": { + "additionalProperties": { + "$ref": "#/definitions/TopicStats" + }, + "type": "object" + }, + "publishRateLimitedTimes": { + "format": "int64", + "type": "integer" + }, + "publishers": { + "items": { + "$ref": "#/definitions/PublisherStats" + }, + "type": "array" + }, + "replication": { + "additionalProperties": { + "$ref": "#/definitions/ReplicatorStats" + }, + "type": "object" + }, + "storageSize": { + "format": "int64", + "type": "integer" + }, + "subscriptions": { + "additionalProperties": { + "$ref": "#/definitions/SubscriptionStats" + }, + "type": "object" + }, + "systemTopicBytesInCounter": { + "format": "int64", + "type": "integer" + }, + "topicEpoch": { + "format": "int64", + "type": "integer" + }, + "waitingPublishers": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "PendingBookieOpsStats": { + "properties": { + "cursorLedgerCloseOp": { + "format": "int64", + "type": "integer" + }, + "cursorLedgerCreateOp": { + "format": "int64", + "type": "integer" + }, + "cursorLedgerDeleteOp": { + "format": "int64", + "type": "integer" + }, + "cursorLedgerOpenOp": { + "format": "int64", + "type": "integer" + }, + "dataLedgerCloseOp": { + "format": "int64", + "type": "integer" + }, + "dataLedgerCreateOp": { + "format": "int64", + "type": "integer" + }, + "dataLedgerDeleteOp": { + "format": "int64", + "type": "integer" + }, + "dataLedgerOpenOp": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "PersistencePolicies": { + "properties": { + "bookkeeperAckQuorum": { + "format": "int32", + "type": "integer" + }, + "bookkeeperEnsemble": { + "format": "int32", + "type": "integer" + }, + "bookkeeperWriteQuorum": { + "format": "int32", + "type": "integer" + }, + "managedLedgerMaxMarkDeleteRate": { + "format": "double", + "type": "number" + }, + "managedLedgerStorageClassName": { + "type": "string" + } + }, + "type": "object" + }, + "PersistentOfflineTopicStats": { + "properties": { + "brokerName": { + "type": "string" + }, + "cursorDetails": { + "additionalProperties": { + "$ref": "#/definitions/CursorDetails" + }, + "type": "object" + }, + "dataLedgerDetails": { + "items": { + "$ref": "#/definitions/LedgerDetails" + }, + "type": "array" + }, + "messageBacklog": { + "format": "int64", + "type": "integer" + }, + "statGeneratedAt": { + "format": "date-time", + "type": "string" + }, + "storageSize": { + "format": "int64", + "type": "integer" + }, + "topicName": { + "type": "string" + }, + "totalMessages": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "PersistentTopicInternalStats": { + "properties": { + "compactedLedger": { + "$ref": "#/definitions/LedgerInfo" + }, + "currentLedgerEntries": { + "format": "int64", + "type": "integer" + }, + "currentLedgerSize": { + "format": "int64", + "type": "integer" + }, + "cursors": { + "additionalProperties": { + "$ref": "#/definitions/CursorStats" + }, + "type": "object" + }, + "entriesAddedCounter": { + "format": "int64", + "type": "integer" + }, + "lastConfirmedEntry": { + "type": "string" + }, + "lastLedgerCreatedTimestamp": { + "type": "string" + }, + "lastLedgerCreationFailureTimestamp": { + "type": "string" + }, + "ledgers": { + "items": { + "$ref": "#/definitions/LedgerInfo" + }, + "type": "array" + }, + "numberOfEntries": { + "format": "int64", + "type": "integer" + }, + "pendingAddEntriesCount": { + "format": "int32", + "type": "integer" + }, + "schemaLedgers": { + "items": { + "$ref": "#/definitions/LedgerInfo" + }, + "type": "array" + }, + "state": { + "type": "string" + }, + "totalSize": { + "format": "int64", + "type": "integer" + }, + "waitingCursorsCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "PersistentTopicStats": { + "properties": { + "averageMsgSize": { + "format": "double", + "type": "number" + }, + "backlogQuotaLimitSize": { + "format": "int64", + "type": "integer" + }, + "backlogQuotaLimitTime": { + "format": "int64", + "type": "integer" + }, + "backlogSize": { + "format": "int64", + "type": "integer" + }, + "bytesInCounter": { + "format": "int64", + "type": "integer" + }, + "bytesOutCounter": { + "format": "int64", + "type": "integer" + }, + "compaction": { + "$ref": "#/definitions/CompactionStats" + }, + "deduplicationStatus": { + "type": "string" + }, + "delayedMessageIndexSizeInBytes": { + "format": "int64", + "type": "integer" + }, + "earliestMsgPublishTimeInBacklogs": { + "format": "int64", + "type": "integer" + }, + "msgChunkPublished": { + "type": "boolean" + }, + "msgInCounter": { + "format": "int64", + "type": "integer" + }, + "msgOutCounter": { + "format": "int64", + "type": "integer" + }, + "msgRateIn": { + "format": "double", + "type": "number" + }, + "msgRateOut": { + "format": "double", + "type": "number" + }, + "msgThroughputIn": { + "format": "double", + "type": "number" + }, + "msgThroughputOut": { + "format": "double", + "type": "number" + }, + "nonContiguousDeletedMessagesRanges": { + "format": "int32", + "type": "integer" + }, + "nonContiguousDeletedMessagesRangesSerializedSize": { + "format": "int32", + "type": "integer" + }, + "offloadedStorageSize": { + "format": "int64", + "type": "integer" + }, + "oldestBacklogMessageAgeSeconds": { + "format": "int64", + "type": "integer" + }, + "oldestBacklogMessageSubscriptionName": { + "type": "string" + }, + "ownerBroker": { + "type": "string" + }, + "publishers": { + "items": { + "$ref": "#/definitions/PublisherStats" + }, + "type": "array" + }, + "replication": { + "additionalProperties": { + "$ref": "#/definitions/ReplicatorStats" + }, + "type": "object" + }, + "storageSize": { + "format": "int64", + "type": "integer" + }, + "subscriptions": { + "additionalProperties": { + "$ref": "#/definitions/SubscriptionStats" + }, + "type": "object" + }, + "topicEpoch": { + "format": "int64", + "type": "integer" + }, + "waitingPublishers": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "Policies": { + "properties": { + "allowed_clusters": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "auth_policies": { + "$ref": "#/definitions/AuthPolicies" + }, + "autoSubscriptionCreationOverride": { + "$ref": "#/definitions/AutoSubscriptionCreationOverride" + }, + "autoTopicCreationOverride": { + "$ref": "#/definitions/AutoTopicCreationOverride" + }, + "backlog_quota_map": { + "additionalProperties": { + "$ref": "#/definitions/BacklogQuota" + }, + "type": "object" + }, + "bundles": { + "$ref": "#/definitions/BundlesData" + }, + "clusterDispatchRate": { + "additionalProperties": { + "$ref": "#/definitions/DispatchRateImpl" + }, + "type": "object" + }, + "clusterSubscribeRate": { + "additionalProperties": { + "$ref": "#/definitions/SubscribeRate" + }, + "type": "object" + }, + "compaction_threshold": { + "format": "int64", + "type": "integer" + }, + "deduplicationEnabled": { + "type": "boolean" + }, + "deduplicationSnapshotIntervalSeconds": { + "format": "int32", + "type": "integer" + }, + "delayed_delivery_policies": { + "$ref": "#/definitions/DelayedDeliveryPolicies" + }, + "deleted": { + "type": "boolean" + }, + "dispatcherPauseOnAckStatePersistentEnabled": { + "type": "boolean" + }, + "encryption_required": { + "type": "boolean" + }, + "entryFilters": { + "$ref": "#/definitions/EntryFilters" + }, + "inactive_topic_policies": { + "$ref": "#/definitions/InactiveTopicPolicies" + }, + "is_allow_auto_update_schema": { + "type": "boolean" + }, + "latency_stats_sample_rate": { + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "type": "object" + }, + "max_consumers_per_subscription": { + "format": "int32", + "type": "integer" + }, + "max_consumers_per_topic": { + "format": "int32", + "type": "integer" + }, + "max_producers_per_topic": { + "format": "int32", + "type": "integer" + }, + "max_subscriptions_per_topic": { + "format": "int32", + "type": "integer" + }, + "max_topics_per_namespace": { + "format": "int32", + "type": "integer" + }, + "max_unacked_messages_per_consumer": { + "format": "int32", + "type": "integer" + }, + "max_unacked_messages_per_subscription": { + "format": "int32", + "type": "integer" + }, + "message_ttl_in_seconds": { + "format": "int32", + "type": "integer" + }, + "migrated": { + "type": "boolean" + }, + "offload_deletion_lag_ms": { + "format": "int64", + "type": "integer" + }, + "offload_policies": { + "$ref": "#/definitions/OffloadPolicies" + }, + "offload_threshold": { + "format": "int64", + "type": "integer" + }, + "offload_threshold_in_seconds": { + "format": "int64", + "type": "integer" + }, + "persistence": { + "$ref": "#/definitions/PersistencePolicies" + }, + "properties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "publishMaxMessageRate": { + "additionalProperties": { + "$ref": "#/definitions/PublishRate" + }, + "type": "object" + }, + "replication_clusters": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "replicatorDispatchRate": { + "additionalProperties": { + "$ref": "#/definitions/DispatchRateImpl" + }, + "type": "object" + }, + "resource_group_name": { + "type": "string" + }, + "retention_policies": { + "$ref": "#/definitions/RetentionPolicies" + }, + "schema_auto_update_compatibility_strategy": { + "enum": [ + "AutoUpdateDisabled", + "Backward", + "Forward", + "Full", + "AlwaysCompatible", + "BackwardTransitive", + "ForwardTransitive", + "FullTransitive" + ], + "type": "string" + }, + "schema_compatibility_strategy": { + "enum": [ + "UNDEFINED", + "ALWAYS_INCOMPATIBLE", + "ALWAYS_COMPATIBLE", + "BACKWARD", + "FORWARD", + "FULL", + "BACKWARD_TRANSITIVE", + "FORWARD_TRANSITIVE", + "FULL_TRANSITIVE" + ], + "type": "string" + }, + "schema_validation_enforced": { + "type": "boolean" + }, + "subscriptionDispatchRate": { + "additionalProperties": { + "$ref": "#/definitions/DispatchRateImpl" + }, + "type": "object" + }, + "subscription_auth_mode": { + "enum": [ + "None", + "Prefix" + ], + "type": "string" + }, + "subscription_expiration_time_minutes": { + "format": "int32", + "type": "integer" + }, + "subscription_types_enabled": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "topicDispatchRate": { + "additionalProperties": { + "$ref": "#/definitions/DispatchRateImpl" + }, + "type": "object" + } + }, + "type": "object" + }, + "PoolArenaStats": { + "properties": { + "chunkLists": { + "items": { + "$ref": "#/definitions/PoolChunkListStats" + }, + "type": "array" + }, + "numActiveAllocations": { + "format": "int64", + "type": "integer" + }, + "numActiveHugeAllocations": { + "format": "int64", + "type": "integer" + }, + "numActiveNormalAllocations": { + "format": "int64", + "type": "integer" + }, + "numActiveSmallAllocations": { + "format": "int64", + "type": "integer" + }, + "numAllocations": { + "format": "int64", + "type": "integer" + }, + "numChunkLists": { + "format": "int32", + "type": "integer" + }, + "numDeallocations": { + "format": "int64", + "type": "integer" + }, + "numHugeAllocations": { + "format": "int64", + "type": "integer" + }, + "numHugeDeallocations": { + "format": "int64", + "type": "integer" + }, + "numNormalAllocations": { + "format": "int64", + "type": "integer" + }, + "numNormalDeallocations": { + "format": "int64", + "type": "integer" + }, + "numSmallAllocations": { + "format": "int64", + "type": "integer" + }, + "numSmallDeallocations": { + "format": "int64", + "type": "integer" + }, + "numSmallSubpages": { + "format": "int32", + "type": "integer" + }, + "smallSubpages": { + "items": { + "$ref": "#/definitions/PoolSubpageStats" + }, + "type": "array" + } + }, + "type": "object" + }, + "PoolChunkListStats": { + "properties": { + "chunks": { + "items": { + "$ref": "#/definitions/PoolChunkStats" + }, + "type": "array" + }, + "maxUsage": { + "format": "int32", + "type": "integer" + }, + "minUsage": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "PoolChunkStats": { + "properties": { + "chunkSize": { + "format": "int32", + "type": "integer" + }, + "freeBytes": { + "format": "int32", + "type": "integer" + }, + "usage": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "PoolSubpageStats": { + "properties": { + "elementSize": { + "format": "int32", + "type": "integer" + }, + "maxNumElements": { + "format": "int32", + "type": "integer" + }, + "numAvailable": { + "format": "int32", + "type": "integer" + }, + "pageSize": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "PositionInfo": { + "properties": { + "entryId": { + "format": "int64", + "type": "integer" + }, + "ledgerId": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "PostSchemaPayload": { + "properties": { + "properties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "schema": { + "type": "string" + }, + "type": { + "type": "string" + } + }, + "type": "object" + }, + "PostSchemaResponse": { + "properties": { + "version": { + "$ref": "#/definitions/SchemaVersion" + } + }, + "type": "object" + }, + "ProcessContainerFactory": { + "properties": { + "extraFunctionDependenciesDir": { + "type": "string" + }, + "javaInstanceJarLocation": { + "type": "string" + }, + "logDirectory": { + "type": "string" + }, + "pythonInstanceLocation": { + "type": "string" + } + }, + "type": "object" + }, + "PublicKey": { + "properties": { + "algorithm": { + "type": "string" + }, + "encoded": { + "items": { + "format": "byte", + "type": "string" + }, + "type": "array" + }, + "format": { + "type": "string" + } + }, + "type": "object" + }, + "PublishRate": { + "properties": { + "publishThrottlingRateInByte": { + "format": "int64", + "type": "integer" + }, + "publishThrottlingRateInMsg": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "PublisherStats": { + "properties": { + "accessMode": { + "enum": [ + "Shared", + "Exclusive", + "ExclusiveWithFencing", + "WaitForExclusive" + ], + "type": "string" + }, + "address": { + "type": "string" + }, + "averageMsgSize": { + "format": "double", + "type": "number" + }, + "chunkedMessageRate": { + "format": "double", + "type": "number" + }, + "clientVersion": { + "type": "string" + }, + "connectedSince": { + "type": "string" + }, + "metadata": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "msgRateIn": { + "format": "double", + "type": "number" + }, + "msgThroughputIn": { + "format": "double", + "type": "number" + }, + "producerId": { + "format": "int64", + "type": "integer" + }, + "producerName": { + "type": "string" + }, + "supportsPartialProducer": { + "type": "boolean" + } + }, + "type": "object" + }, + "RawBookieInfo": { + "properties": { + "bookieId": { + "type": "string" + } + }, + "type": "object" + }, + "ReplicatorStats": { + "properties": { + "bytesInCount": { + "format": "int64", + "type": "integer" + }, + "bytesOutCount": { + "format": "int64", + "type": "integer" + }, + "connected": { + "type": "boolean" + }, + "inboundConnectedSince": { + "type": "string" + }, + "inboundConnection": { + "type": "string" + }, + "msgExpiredCount": { + "format": "int64", + "type": "integer" + }, + "msgInCount": { + "format": "int64", + "type": "integer" + }, + "msgOutCount": { + "format": "int64", + "type": "integer" + }, + "msgRateExpired": { + "format": "double", + "type": "number" + }, + "msgRateIn": { + "format": "double", + "type": "number" + }, + "msgRateOut": { + "format": "double", + "type": "number" + }, + "msgThroughputIn": { + "format": "double", + "type": "number" + }, + "msgThroughputOut": { + "format": "double", + "type": "number" + }, + "outboundConnectedSince": { + "type": "string" + }, + "outboundConnection": { + "type": "string" + }, + "replicationBacklog": { + "format": "int64", + "type": "integer" + }, + "replicationDelayInSeconds": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "ResetCursorData": { + "properties": { + "batchIndex": { + "format": "int32", + "type": "integer" + }, + "entryId": { + "format": "int64", + "type": "integer" + }, + "excluded": { + "type": "boolean" + }, + "ledgerId": { + "format": "int64", + "type": "integer" + }, + "partitionIndex": { + "format": "int32", + "type": "integer" + }, + "properties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + } + }, + "type": "object" + }, + "ResourceDescription": { + "properties": { + "resourceUsage": { + "additionalProperties": { + "$ref": "#/definitions/ResourceUsage" + }, + "type": "object" + }, + "usagePct": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "ResourceGroup": { + "properties": { + "dispatchRateInBytes": { + "format": "int64", + "type": "integer" + }, + "dispatchRateInMsgs": { + "format": "int32", + "type": "integer" + }, + "publishRateInBytes": { + "format": "int64", + "type": "integer" + }, + "publishRateInMsgs": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "ResourceQuota": { + "properties": { + "bandwidthIn": { + "format": "double", + "type": "number" + }, + "bandwidthOut": { + "format": "double", + "type": "number" + }, + "dynamic": { + "type": "boolean" + }, + "memory": { + "format": "double", + "type": "number" + }, + "msgRateIn": { + "format": "double", + "type": "number" + }, + "msgRateOut": { + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "ResourceUnit": { + "properties": { + "availableResource": { + "$ref": "#/definitions/ResourceDescription" + }, + "resourceId": { + "type": "string" + } + }, + "type": "object" + }, + "ResourceUsage": { + "properties": { + "limit": { + "format": "double", + "type": "number" + }, + "usage": { + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "Resources": { + "properties": { + "cpu": { + "format": "double", + "type": "number" + }, + "disk": { + "format": "int64", + "type": "integer" + }, + "ram": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "RetentionPolicies": { + "properties": { + "retentionSizeInMB": { + "format": "int64", + "type": "integer" + }, + "retentionTimeInMinutes": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "SchemaVersion": { + "type": "object" + }, + "Sinks": { + "properties": { + "listOfConnectors": { + "items": { + "$ref": "#/definitions/ConnectorDefinition" + }, + "type": "array" + }, + "sinkList": { + "items": { + "$ref": "#/definitions/ConnectorDefinition" + }, + "type": "array" + } + }, + "type": "object" + }, + "SinksWorkerService": { + "properties": { + "listOfConnectors": { + "items": { + "$ref": "#/definitions/ConnectorDefinition" + }, + "type": "array" + }, + "sinkList": { + "items": { + "$ref": "#/definitions/ConnectorDefinition" + }, + "type": "array" + } + }, + "type": "object" + }, + "SocketAddress": { + "type": "object" + }, + "Sources": { + "properties": { + "listOfConnectors": { + "items": { + "$ref": "#/definitions/ConnectorDefinition" + }, + "type": "array" + }, + "sourceList": { + "items": { + "$ref": "#/definitions/ConnectorDefinition" + }, + "type": "array" + } + }, + "type": "object" + }, + "SourcesWorkerService": { + "properties": { + "listOfConnectors": { + "items": { + "$ref": "#/definitions/ConnectorDefinition" + }, + "type": "array" + }, + "sourceList": { + "items": { + "$ref": "#/definitions/ConnectorDefinition" + }, + "type": "array" + } + }, + "type": "object" + }, + "SubscribeRate": { + "properties": { + "ratePeriodInSecond": { + "format": "int32", + "type": "integer" + }, + "subscribeThrottlingRatePerConsumer": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "SubscriptionStats": { + "properties": { + "activeConsumerName": { + "type": "string" + }, + "allowOutOfOrderDelivery": { + "type": "boolean" + }, + "backlogSize": { + "format": "int64", + "type": "integer" + }, + "blockedSubscriptionOnUnackedMsgs": { + "type": "boolean" + }, + "bytesOutCounter": { + "format": "int64", + "type": "integer" + }, + "chunkedMessageRate": { + "format": "double", + "type": "number" + }, + "consumers": { + "items": { + "$ref": "#/definitions/ConsumerStats" + }, + "type": "array" + }, + "consumersAfterMarkDeletePosition": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "delayedMessageIndexSizeInBytes": { + "format": "int64", + "type": "integer" + }, + "drainingHashesClearedTotal": { + "format": "int64", + "type": "integer" + }, + "drainingHashesCount": { + "format": "int32", + "type": "integer" + }, + "drainingHashesUnackedMessages": { + "format": "int32", + "type": "integer" + }, + "durable": { + "type": "boolean" + }, + "earliestMsgPublishTimeInBacklog": { + "format": "int64", + "type": "integer" + }, + "filterAcceptedMsgCount": { + "format": "int64", + "type": "integer" + }, + "filterProcessedMsgCount": { + "format": "int64", + "type": "integer" + }, + "filterRejectedMsgCount": { + "format": "int64", + "type": "integer" + }, + "filterRescheduledMsgCount": { + "format": "int64", + "type": "integer" + }, + "keySharedMode": { + "type": "string" + }, + "lastAckedTimestamp": { + "format": "int64", + "type": "integer" + }, + "lastConsumedFlowTimestamp": { + "format": "int64", + "type": "integer" + }, + "lastConsumedTimestamp": { + "format": "int64", + "type": "integer" + }, + "lastExpireTimestamp": { + "format": "int64", + "type": "integer" + }, + "lastMarkDeleteAdvancedTimestamp": { + "format": "int64", + "type": "integer" + }, + "messageAckRate": { + "format": "double", + "type": "number" + }, + "msgBacklog": { + "format": "int64", + "type": "integer" + }, + "msgBacklogNoDelayed": { + "format": "int64", + "type": "integer" + }, + "msgDelayed": { + "format": "int64", + "type": "integer" + }, + "msgInReplay": { + "format": "int64", + "type": "integer" + }, + "msgOutCounter": { + "format": "int64", + "type": "integer" + }, + "msgRateExpired": { + "format": "double", + "type": "number" + }, + "msgRateOut": { + "format": "double", + "type": "number" + }, + "msgRateRedeliver": { + "format": "double", + "type": "number" + }, + "msgThroughputOut": { + "format": "double", + "type": "number" + }, + "nonContiguousDeletedMessagesRanges": { + "format": "int32", + "type": "integer" + }, + "nonContiguousDeletedMessagesRangesSerializedSize": { + "format": "int32", + "type": "integer" + }, + "replicated": { + "type": "boolean" + }, + "subscriptionProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "totalMsgExpired": { + "format": "int64", + "type": "integer" + }, + "type": { + "type": "string" + }, + "unackedMessages": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "SystemResourceUsage": { + "properties": { + "bandwidthIn": { + "$ref": "#/definitions/ResourceUsage" + }, + "bandwidthOut": { + "$ref": "#/definitions/ResourceUsage" + }, + "cpu": { + "$ref": "#/definitions/ResourceUsage" + }, + "directMemory": { + "$ref": "#/definitions/ResourceUsage" + }, + "memory": { + "$ref": "#/definitions/ResourceUsage" + } + }, + "type": "object" + }, + "TenantInfo": { + "description": "Information of adminRoles and allowedClusters for tenant", + "properties": { + "adminRoles": { + "description": "Comma separated list of auth principal allowed to administrate the tenant.", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "allowedClusters": { + "description": "Comma separated allowed clusters.", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "ThreadContainerFactory": { + "properties": { + "pulsarClientMemoryLimit": { + "$ref": "#/definitions/MemoryLimit" + }, + "threadGroupName": { + "type": "string" + } + }, + "type": "object" + }, + "TopicHashPositions": { + "properties": { + "bundle": { + "type": "string" + }, + "namespace": { + "type": "string" + }, + "topicHashPositions": { + "additionalProperties": { + "format": "int64", + "type": "integer" + }, + "type": "object" + } + }, + "type": "object" + }, + "TopicStats": { + "properties": { + "averageMsgSize": { + "format": "double", + "type": "number" + }, + "backlogQuotaLimitSize": { + "format": "int64", + "type": "integer" + }, + "backlogQuotaLimitTime": { + "format": "int64", + "type": "integer" + }, + "backlogSize": { + "format": "int64", + "type": "integer" + }, + "bytesInCounter": { + "format": "int64", + "type": "integer" + }, + "bytesOutCounter": { + "format": "int64", + "type": "integer" + }, + "compaction": { + "$ref": "#/definitions/CompactionStats" + }, + "deduplicationStatus": { + "type": "string" + }, + "delayedMessageIndexSizeInBytes": { + "format": "int64", + "type": "integer" + }, + "earliestMsgPublishTimeInBacklogs": { + "format": "int64", + "type": "integer" + }, + "msgChunkPublished": { + "type": "boolean" + }, + "msgInCounter": { + "format": "int64", + "type": "integer" + }, + "msgOutCounter": { + "format": "int64", + "type": "integer" + }, + "msgRateIn": { + "format": "double", + "type": "number" + }, + "msgRateOut": { + "format": "double", + "type": "number" + }, + "msgThroughputIn": { + "format": "double", + "type": "number" + }, + "msgThroughputOut": { + "format": "double", + "type": "number" + }, + "nonContiguousDeletedMessagesRanges": { + "format": "int32", + "type": "integer" + }, + "nonContiguousDeletedMessagesRangesSerializedSize": { + "format": "int32", + "type": "integer" + }, + "offloadedStorageSize": { + "format": "int64", + "type": "integer" + }, + "oldestBacklogMessageAgeSeconds": { + "format": "int64", + "type": "integer" + }, + "oldestBacklogMessageSubscriptionName": { + "type": "string" + }, + "ownerBroker": { + "type": "string" + }, + "publishers": { + "items": { + "$ref": "#/definitions/PublisherStats" + }, + "type": "array" + }, + "replication": { + "additionalProperties": { + "$ref": "#/definitions/ReplicatorStats" + }, + "type": "object" + }, + "storageSize": { + "format": "int64", + "type": "integer" + }, + "subscriptions": { + "additionalProperties": { + "$ref": "#/definitions/SubscriptionStats" + }, + "type": "object" + }, + "topicEpoch": { + "format": "int64", + "type": "integer" + }, + "waitingPublishers": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "WorkerConfig": { + "properties": { + "additionalEnabledConnectorUrlPatterns": { + "items": { + "type": "string" + }, + "type": "array" + }, + "additionalEnabledFunctionsUrlPatterns": { + "items": { + "type": "string" + }, + "type": "array" + }, + "additionalJavaRuntimeArguments": { + "items": { + "type": "string" + }, + "type": "array" + }, + "assignmentWriteMaxRetries": { + "format": "int32", + "type": "integer" + }, + "authenticateMetricsEndpoint": { + "type": "boolean" + }, + "authenticationEnabled": { + "type": "boolean" + }, + "authenticationProviders": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "authorizationEnabled": { + "type": "boolean" + }, + "authorizationProvider": { + "type": "string" + }, + "bookkeeperClientAuthenticationParameters": { + "type": "string" + }, + "bookkeeperClientAuthenticationParametersName": { + "type": "string" + }, + "bookkeeperClientAuthenticationPlugin": { + "type": "string" + }, + "brokerClientAuthenticationEnabled": { + "type": "boolean" + }, + "brokerClientAuthenticationParameters": { + "type": "string" + }, + "brokerClientAuthenticationPlugin": { + "type": "string" + }, + "brokerClientTrustCertsFilePath": { + "type": "string" + }, + "clientAuthenticationParameters": { + "type": "string" + }, + "clientAuthenticationPlugin": { + "type": "string" + }, + "clusterCoordinationTopic": { + "type": "string" + }, + "clusterCoordinationTopicName": { + "type": "string" + }, + "configurationMetadataStoreUrl": { + "type": "string" + }, + "configurationStoreServers": { + "type": "string" + }, + "connectorsDirectory": { + "type": "string" + }, + "downloadDirectory": { + "type": "string" + }, + "enableClassloadingOfBuiltinFiles": { + "type": "boolean" + }, + "enableClassloadingOfExternalFiles": { + "type": "boolean" + }, + "enableReferencingConnectorDirectoryFiles": { + "type": "boolean" + }, + "enableReferencingFunctionsDirectoryFiles": { + "type": "boolean" + }, + "exposeAdminClientEnabled": { + "type": "boolean" + }, + "failureCheckFreqMs": { + "format": "int64", + "type": "integer" + }, + "forwardSourceMessageProperty": { + "type": "boolean" + }, + "functionAssignmentTopic": { + "type": "string" + }, + "functionAssignmentTopicName": { + "type": "string" + }, + "functionAuthProviderClassName": { + "type": "string" + }, + "functionInstanceMaxResources": { + "$ref": "#/definitions/Resources" + }, + "functionInstanceMinResources": { + "$ref": "#/definitions/Resources" + }, + "functionInstanceResourceChangeInLockStep": { + "type": "boolean" + }, + "functionInstanceResourceGranularities": { + "$ref": "#/definitions/Resources" + }, + "functionMetadataTopic": { + "type": "string" + }, + "functionMetadataTopicName": { + "type": "string" + }, + "functionRuntimeFactoryClassName": { + "type": "string" + }, + "functionRuntimeFactoryConfigs": { + "additionalProperties": { + "type": "object" + }, + "type": "object" + }, + "functionWebServiceUrl": { + "type": "string" + }, + "functionsDirectory": { + "type": "string" + }, + "functionsWorkerEnablePackageManagement": { + "type": "boolean" + }, + "functionsWorkerServiceCustomConfigs": { + "additionalProperties": { + "type": "object" + }, + "type": "object" + }, + "functionsWorkerServiceNarPackage": { + "type": "string" + }, + "httpRequestsLimitEnabled": { + "type": "boolean" + }, + "httpRequestsMaxPerSecond": { + "format": "double", + "type": "number" + }, + "httpServerAcceptQueueSize": { + "format": "int32", + "type": "integer" + }, + "httpServerThreadPoolQueueSize": { + "format": "int32", + "type": "integer" + }, + "ignoreUnknownConfigFields": { + "type": "boolean" + }, + "includeStandardPrometheusMetrics": { + "type": "boolean" + }, + "initialBrokerReconnectMaxRetries": { + "format": "int32", + "type": "integer" + }, + "initializedDlogMetadata": { + "type": "boolean" + }, + "instanceLivenessCheckFreqMs": { + "format": "int64", + "type": "integer" + }, + "jvmGCMetricsLoggerClassName": { + "type": "string" + }, + "kinitCommand": { + "type": "string" + }, + "kubernetesContainerFactory": { + "$ref": "#/definitions/KubernetesContainerFactory" + }, + "maxConcurrentHttpRequests": { + "format": "int32", + "type": "integer" + }, + "maxHttpServerConnections": { + "format": "int32", + "type": "integer" + }, + "maxPendingAsyncRequests": { + "format": "int32", + "type": "integer" + }, + "metadataStoreAllowReadOnlyOperations": { + "type": "boolean" + }, + "metadataStoreCacheExpirySeconds": { + "format": "int32", + "type": "integer" + }, + "metadataStoreOperationTimeoutSeconds": { + "format": "int32", + "type": "integer" + }, + "metadataStoreSessionTimeoutMillis": { + "format": "int64", + "type": "integer" + }, + "narExtractionDirectory": { + "type": "string" + }, + "numFunctionPackageReplicas": { + "format": "int32", + "type": "integer" + }, + "numHttpServerThreads": { + "format": "int32", + "type": "integer" + }, + "processContainerFactory": { + "$ref": "#/definitions/ProcessContainerFactory" + }, + "properties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "proxyRoles": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "pulsarFunctionsCluster": { + "type": "string" + }, + "pulsarFunctionsNamespace": { + "type": "string" + }, + "pulsarServiceUrl": { + "type": "string" + }, + "pulsarWebServiceUrl": { + "type": "string" + }, + "rebalanceCheckFreqSec": { + "format": "int64", + "type": "integer" + }, + "rescheduleTimeoutMs": { + "format": "int64", + "type": "integer" + }, + "runtimeCustomizerClassName": { + "type": "string" + }, + "runtimeCustomizerConfig": { + "additionalProperties": { + "type": "object" + }, + "type": "object" + }, + "saslJaasClientAllowedIds": { + "type": "string" + }, + "saslJaasServerRoleTokenSignerSecretPath": { + "type": "string" + }, + "saslJaasServerSectionName": { + "type": "string" + }, + "schedulerClassName": { + "type": "string" + }, + "secretsProviderConfiguratorClassName": { + "type": "string" + }, + "secretsProviderConfiguratorConfig": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "stateStorageProviderImplementation": { + "type": "string" + }, + "stateStorageServiceUrl": { + "type": "string" + }, + "superUserRoles": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "threadContainerFactory": { + "$ref": "#/definitions/ThreadContainerFactory" + }, + "tlsAllowInsecureConnection": { + "type": "boolean" + }, + "tlsCertRefreshCheckDurationSec": { + "format": "int64", + "type": "integer" + }, + "tlsCertificateFilePath": { + "type": "string" + }, + "tlsEnableHostnameVerification": { + "type": "boolean" + }, + "tlsEnabled": { + "type": "boolean" + }, + "tlsEnabledWithKeyStore": { + "type": "boolean" + }, + "tlsKeyFilePath": { + "type": "string" + }, + "tlsKeyStore": { + "type": "string" + }, + "tlsKeyStorePassword": { + "type": "string" + }, + "tlsKeyStoreType": { + "type": "string" + }, + "tlsProvider": { + "type": "string" + }, + "tlsRequireTrustedClientCertOnConnect": { + "type": "boolean" + }, + "tlsTrustCertsFilePath": { + "type": "string" + }, + "tlsTrustChainBytes": { + "items": { + "format": "byte", + "type": "string" + }, + "type": "array" + }, + "tlsTrustStore": { + "type": "string" + }, + "tlsTrustStorePassword": { + "type": "string" + }, + "tlsTrustStoreType": { + "type": "string" + }, + "topicCompactionFrequencySec": { + "format": "int64", + "type": "integer" + }, + "uploadBuiltinSinksSources": { + "type": "boolean" + }, + "useCompactedMetadataTopic": { + "type": "boolean" + }, + "useTls": { + "type": "boolean" + }, + "validateConnectorConfig": { + "type": "boolean" + }, + "webServiceHaProxyProtocolEnabled": { + "type": "boolean" + }, + "webServiceLogDetailedAddresses": { + "type": "boolean" + }, + "webServiceTlsCiphers": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "webServiceTlsProtocols": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "webServiceTrustXForwardedFor": { + "type": "boolean" + }, + "workerHostname": { + "type": "string" + }, + "workerId": { + "type": "string" + }, + "workerListProbeIntervalSec": { + "format": "int32", + "type": "integer" + }, + "workerPort": { + "format": "int32", + "type": "integer" + }, + "workerPortTls": { + "format": "int32", + "type": "integer" + }, + "workerWebAddress": { + "type": "string" + }, + "workerWebAddressTls": { + "type": "string" + }, + "zooKeeperAllowReadOnlyOperations": { + "type": "boolean" + }, + "zooKeeperCacheExpirySeconds": { + "format": "int32", + "type": "integer" + }, + "zooKeeperOperationTimeoutSeconds": { + "format": "int32", + "type": "integer" + }, + "zooKeeperSessionTimeoutMillis": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "WorkerFunctionInstanceStats": { + "properties": { + "metrics": { + "$ref": "#/definitions/FunctionInstanceStatsData" + }, + "name": { + "type": "string" + } + }, + "type": "object" + }, + "WorkerInfo": { + "properties": { + "port": { + "format": "int32", + "type": "integer" + }, + "workerHostname": { + "type": "string" + }, + "workerId": { + "type": "string" + } + }, + "type": "object" + }, + "WorkerService": { + "properties": { + "functions": { + "$ref": "#/definitions/FunctionsWorkerService" + }, + "functionsV2": { + "$ref": "#/definitions/FunctionsV2WorkerService" + }, + "initialized": { + "type": "boolean" + }, + "sinks": { + "$ref": "#/definitions/SinksWorkerService" + }, + "sources": { + "$ref": "#/definitions/SourcesWorkerService" + }, + "workerConfig": { + "$ref": "#/definitions/WorkerConfig" + }, + "workers": { + "$ref": "#/definitions/WorkersWorkerService" + } + }, + "type": "object" + }, + "Workers": { + "type": "object" + }, + "WorkersWorkerService": { + "type": "object" + } + }, + "info": { + "description": "This provides the REST API for admin operations", + "license": { + "name": "Apache 2.0", + "url": "http://www.apache.org/licenses/LICENSE-2.0.html" + }, + "title": "Pulsar Admin REST API", + "version": "v2" + }, + "paths": { + "/bookies/all": { + "get": { + "description": "", + "operationId": "Bookies_getAllBookies", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/BookiesClusterInfo" + } + }, + "403": { + "description": "Don't have admin permission" + } + }, + "summary": "Gets raw information for all the bookies in the cluster", + "tags": [ + "bookies" + ] + } + }, + "/bookies/racks-info": { + "get": { + "description": "", + "operationId": "Bookies_getBookiesRackInfo", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "additionalProperties": { + "additionalProperties": { + "$ref": "#/definitions/BookieInfo" + }, + "type": "object" + }, + "type": "object" + } + }, + "403": { + "description": "Don't have admin permission" + } + }, + "summary": "Gets the rack placement information for all the bookies in the cluster", + "tags": [ + "bookies" + ] + } + }, + "/bookies/racks-info/{bookie}": { + "delete": { + "description": "", + "operationId": "Bookies_deleteBookieRackInfo", + "parameters": [ + { + "in": "path", + "name": "bookie", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + } + }, + "summary": "Removed the rack placement information for a specific bookie in the cluster", + "tags": [ + "bookies" + ] + }, + "get": { + "description": "", + "operationId": "Bookies_getBookieRackInfo", + "parameters": [ + { + "in": "path", + "name": "bookie", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/BookieInfo" + } + }, + "403": { + "description": "Don't have admin permission" + } + }, + "summary": "Gets the rack placement information for a specific bookie in the cluster", + "tags": [ + "bookies" + ] + }, + "post": { + "description": "", + "operationId": "Bookies_updateBookieRackInfo", + "parameters": [ + { + "description": "The bookie address", + "in": "path", + "name": "bookie", + "required": true, + "type": "string" + }, + { + "description": "The group", + "in": "query", + "name": "group", + "required": true, + "type": "string" + }, + { + "description": "The bookie info", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/BookieInfo" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + } + }, + "summary": "Updates the rack placement information for a specific bookie in the cluster (note. bookie address format:`address:port`)", + "tags": [ + "bookies" + ] + } + }, + "/broker-stats/allocator-stats/{allocator}": { + "get": { + "description": "", + "operationId": "BrokerStatsBase_getAllocatorStats", + "parameters": [ + { + "in": "path", + "name": "allocator", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/AllocatorStats" + } + }, + "403": { + "description": "Don't have admin permission" + } + }, + "summary": "Get the stats for the Netty allocator. Available allocators are 'default' and 'ml-cache'", + "tags": [ + "broker-stats" + ] + } + }, + "/broker-stats/bookieops": { + "get": { + "description": "Returns a nested map structure which Swagger does not fully support for display. Structure: Map>. Please refer to this structure for details.", + "operationId": "BrokerStatsBase_getPendingBookieOpsStats", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "additionalProperties": { + "$ref": "#/definitions/PendingBookieOpsStats" + }, + "type": "object" + } + }, + "403": { + "description": "Don't have admin permission" + } + }, + "summary": "Get pending bookie client op stats by namespace", + "tags": [ + "broker-stats" + ] + } + }, + "/broker-stats/broker-resource-availability/{tenant}/{namespace}": { + "get": { + "description": "This API gives the current broker availability in percent, each resource percentage usage is calculated and thensum of all of the resource usage percent is called broker-resource-availability

THIS API IS ONLY FOR USE BY TESTING FOR CONFIRMING NAMESPACE ALLOCATION ALGORITHM", + "operationId": "BrokerStats_getBrokerResourceAvailability", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Returns broker resource availability as Map>.Since `ResourceUnit` is an interface, its specific content is not determinable via class reflection. Refer to the source code or interface tests for detailed type definitions.", + "schema": { + "additionalProperties": { + "$ref": "#/definitions/ResourceUnit" + }, + "type": "object" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "409": { + "description": "Load-manager doesn't support operation" + } + }, + "summary": "Broker availability report", + "tags": [ + "broker-stats" + ] + } + }, + "/broker-stats/load-report": { + "get": { + "description": "consists of topics stats & systemResourceUsage", + "operationId": "BrokerStatsBase_getLoadReport", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/LoadReport" + } + }, + "403": { + "description": "Don't have admin permission" + } + }, + "summary": "Get Load for this broker", + "tags": [ + "broker-stats" + ] + } + }, + "/broker-stats/mbeans": { + "get": { + "description": "", + "operationId": "BrokerStatsBase_getMBeans", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "$ref": "#/definitions/Metrics" + }, + "type": "array" + } + }, + "403": { + "description": "Don't have admin permission" + } + }, + "summary": "Get all the mbean details of this broker JVM", + "tags": [ + "broker-stats" + ] + } + }, + "/broker-stats/metrics": { + "get": { + "description": "Requested should be executed by Monitoring agent on each broker to fetch the metrics", + "operationId": "BrokerStatsBase_getMetrics", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "$ref": "#/definitions/Metrics" + }, + "type": "array" + } + }, + "403": { + "description": "Don't have admin permission" + } + }, + "summary": "Gets the metrics for Monitoring", + "tags": [ + "broker-stats" + ] + } + }, + "/broker-stats/topics": { + "get": { + "description": "", + "operationId": "BrokerStats_getTopics2", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/OutputStream" + } + }, + "403": { + "description": "Don't have admin permission" + } + }, + "summary": "Get all the topic stats by namespace", + "tags": [ + "broker-stats" + ] + } + }, + "/brokers": { + "get": { + "description": "", + "operationId": "BrokersBase_getActiveBrokers", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "401": { + "description": "Authentication required" + }, + "403": { + "description": "This operation requires super-user access" + } + }, + "summary": "Get the list of active brokers (broker ids) in the local cluster.If authorization is not enabled", + "tags": [ + "brokers" + ] + } + }, + "/brokers/backlog-quota-check": { + "get": { + "description": "", + "operationId": "BrokersBase_backlogQuotaCheck", + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Everything is OK" + }, + "403": { + "description": "Don't have admin permission" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "An REST endpoint to trigger backlogQuotaCheck", + "tags": [ + "brokers" + ] + } + }, + "/brokers/configuration": { + "get": { + "description": "", + "operationId": "BrokersBase_getDynamicConfigurationName", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "403": { + "description": "You don't have admin permission to get configuration" + } + }, + "summary": "Get all updatable dynamic configurations's name", + "tags": [ + "brokers" + ] + } + }, + "/brokers/configuration/runtime": { + "get": { + "description": "", + "operationId": "BrokersBase_getRuntimeConfiguration", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + } + }, + "403": { + "description": "Don't have admin permission" + } + }, + "summary": "Get all runtime configurations. This operation requires Pulsar super-user privileges.", + "tags": [ + "brokers" + ] + } + }, + "/brokers/configuration/values": { + "get": { + "description": "", + "operationId": "BrokersBase_getAllDynamicConfigurations", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + } + }, + "403": { + "description": "You don't have admin permission to view configuration" + }, + "404": { + "description": "Configuration not found" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Get value of all dynamic configurations' value overridden on local config", + "tags": [ + "brokers" + ] + } + }, + "/brokers/configuration/{configName}": { + "delete": { + "description": "", + "operationId": "BrokersBase_deleteDynamicConfiguration", + "parameters": [ + { + "in": "path", + "name": "configName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Service configuration delete successfully" + }, + "403": { + "description": "You don't have admin permission to update service-configuration" + }, + "412": { + "description": "Invalid dynamic-config value" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Delete dynamic ServiceConfiguration into metadata only. This operation requires Pulsar super-user privileges.", + "tags": [ + "brokers" + ] + } + }, + "/brokers/configuration/{configName}/{configValue}": { + "post": { + "description": "", + "operationId": "BrokersBase_updateDynamicConfiguration", + "parameters": [ + { + "in": "path", + "name": "configName", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "configValue", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Service configuration updated successfully" + }, + "403": { + "description": "You don't have admin permission to update service-configuration" + }, + "404": { + "description": "Configuration not found" + }, + "412": { + "description": "Invalid dynamic-config value" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Update dynamic serviceconfiguration into zk only. This operation requires Pulsar super-user privileges.", + "tags": [ + "brokers" + ] + } + }, + "/brokers/health": { + "get": { + "description": "", + "operationId": "BrokersBase_healthCheck", + "parameters": [ + { + "description": "Topic Version", + "enum": [ + "V1", + "V2" + ], + "in": "query", + "name": "topicVersion", + "required": false, + "type": "string" + }, + { + "in": "query", + "name": "brokerId", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Everything is OK" + }, + "307": { + "description": "Current broker is not the target broker" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Cluster doesn't exist" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Run a healthCheck against the broker", + "tags": [ + "brokers" + ] + } + }, + "/brokers/internal-configuration": { + "get": { + "description": "", + "operationId": "BrokersBase_getInternalConfigurationData", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/InternalConfigurationData" + } + }, + "403": { + "description": "Don't have admin permission" + } + }, + "summary": "Get the internal configuration data", + "tags": [ + "brokers" + ] + } + }, + "/brokers/leaderBroker": { + "get": { + "description": "", + "operationId": "BrokersBase_getLeaderBroker", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/BrokerInfo" + } + }, + "401": { + "description": "Authentication required" + }, + "403": { + "description": "This operation requires super-user access" + }, + "404": { + "description": "Leader broker not found" + } + }, + "summary": "Get the information of the leader broker.", + "tags": [ + "brokers" + ] + } + }, + "/brokers/ready": { + "get": { + "description": "", + "operationId": "BrokersBase_isReady", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Broker is ready" + }, + "500": { + "description": "Broker is not ready" + } + }, + "summary": "Check if the broker is fully initialized", + "tags": [ + "brokers" + ] + } + }, + "/brokers/shutdown": { + "post": { + "description": "", + "operationId": "BrokersBase_shutDownBrokerGracefully", + "parameters": [ + { + "description": "if the value absent(value=0) means no concurrent limitation.", + "format": "int32", + "in": "query", + "name": "maxConcurrentUnloadPerSec", + "required": false, + "type": "integer" + }, + { + "default": true, + "in": "query", + "name": "forcedTerminateTopic", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Execute shutdown command successfully" + }, + "403": { + "description": "You don't have admin permission to update service-configuration" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Shutdown broker gracefully.", + "tags": [ + "brokers" + ] + } + }, + "/brokers/version": { + "get": { + "description": "", + "operationId": "BrokersBase_version", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Pulsar version", + "schema": { + "type": "string" + } + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Get version of current broker", + "tags": [ + "brokers" + ] + } + }, + "/brokers/{clusterName}/{brokerId}/ownedNamespaces": { + "get": { + "description": "", + "operationId": "BrokersBase_getOwnedNamespaces", + "parameters": [ + { + "in": "path", + "name": "clusterName", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "brokerId", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "additionalProperties": { + "$ref": "#/definitions/NamespaceOwnershipStatus" + }, + "type": "object" + } + }, + "307": { + "description": "Current broker doesn't serve the cluster" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Cluster doesn't exist" + } + }, + "summary": "Get the list of namespaces served by the specific broker id", + "tags": [ + "brokers" + ] + } + }, + "/brokers/{cluster}": { + "get": { + "description": "", + "operationId": "BrokersBase_getActiveBrokers", + "parameters": [ + { + "in": "path", + "name": "cluster", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "307": { + "description": "Current broker doesn't serve this cluster" + }, + "401": { + "description": "Authentication required" + }, + "403": { + "description": "This operation requires super-user access" + }, + "404": { + "description": "Cluster does not exist: cluster={clustername}" + } + }, + "summary": "Get the list of active brokers (broker ids) in the cluster.If authorization is not enabled, any cluster name is valid.", + "tags": [ + "brokers" + ] + } + }, + "/clusters": { + "get": { + "description": "", + "operationId": "ClustersBase_getClusters", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Return a list of clusters.", + "schema": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "500": { + "description": "Internal server error." + } + }, + "summary": "Get the list of all the Pulsar clusters.", + "tags": [ + "clusters" + ] + } + }, + "/clusters/{cluster}": { + "delete": { + "description": "This operation requires Pulsar superuser privileges.", + "operationId": "ClustersBase_deleteCluster", + "parameters": [ + { + "description": "The cluster name", + "in": "path", + "name": "cluster", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Cluster has been deleted." + }, + "403": { + "description": "Don't have admin permission or policies are read-only." + }, + "404": { + "description": "Cluster doesn't exist." + }, + "412": { + "description": "Cluster is not empty." + }, + "500": { + "description": "Internal server error." + } + }, + "summary": "Delete an existing cluster.", + "tags": [ + "clusters" + ] + }, + "get": { + "description": "This operation requires Pulsar superuser privileges.", + "operationId": "ClustersBase_getCluster", + "parameters": [ + { + "description": "The cluster name", + "in": "path", + "name": "cluster", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Return the cluster data.", + "schema": { + "$ref": "#/definitions/ClusterData" + } + }, + "403": { + "description": "Don't have admin permission." + }, + "404": { + "description": "Cluster doesn't exist." + }, + "500": { + "description": "Internal server error." + } + }, + "summary": "Get the configuration for the specified cluster.", + "tags": [ + "clusters" + ] + }, + "post": { + "description": "This operation requires Pulsar superuser privileges.", + "operationId": "ClustersBase_updateCluster", + "parameters": [ + { + "description": "The cluster name", + "in": "path", + "name": "cluster", + "required": true, + "type": "string" + }, + { + "description": "The cluster data", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterData" + }, + "x-examples": { + "application/json": "{\n \"serviceUrl\": \"http://pulsar.example.com:8080\",\n \"brokerServiceUrl\": \"pulsar://pulsar.example.com:6651\"\n}" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Cluster has been updated." + }, + "400": { + "description": "Bad request parameter." + }, + "403": { + "description": "Don't have admin permission or policies are read-only." + }, + "404": { + "description": "Cluster doesn't exist." + }, + "500": { + "description": "Internal server error." + } + }, + "summary": "Update the configuration for a cluster.", + "tags": [ + "clusters" + ] + }, + "put": { + "description": "This operation requires Pulsar superuser privileges, and the name cannot contain the '/' characters.", + "operationId": "ClustersBase_createCluster", + "parameters": [ + { + "description": "The cluster name", + "in": "path", + "name": "cluster", + "required": true, + "type": "string" + }, + { + "description": "The cluster data", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterData" + }, + "x-examples": { + "application/json": "{\n \"serviceUrl\": \"http://pulsar.example.com:8080\",\n \"brokerServiceUrl\": \"pulsar://pulsar.example.com:6651\",\n}" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Cluster has been created." + }, + "400": { + "description": "Bad request parameter." + }, + "403": { + "description": "You don't have admin permission to create the cluster." + }, + "409": { + "description": "Cluster already exists." + }, + "412": { + "description": "Cluster name is not valid." + }, + "500": { + "description": "Internal server error." + } + }, + "summary": "Create a new cluster.", + "tags": [ + "clusters" + ] + } + }, + "/clusters/{cluster}/failureDomains": { + "get": { + "description": "This operation requires Pulsar superuser privileges.", + "operationId": "ClustersBase_getFailureDomains", + "parameters": [ + { + "description": "The cluster name", + "in": "path", + "name": "cluster", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "additionalProperties": { + "$ref": "#/definitions/FailureDomain" + }, + "type": "object" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Get the cluster failure domains.", + "tags": [ + "clusters" + ] + } + }, + "/clusters/{cluster}/failureDomains/{domainName}": { + "delete": { + "description": "This operation requires Pulsar superuser privileges.", + "operationId": "ClustersBase_deleteFailureDomain", + "parameters": [ + { + "description": "The cluster name", + "in": "path", + "name": "cluster", + "required": true, + "type": "string" + }, + { + "description": "The failure domain name", + "in": "path", + "name": "domainName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Delete the failure domain of the cluster successfully" + }, + "403": { + "description": "Don't have admin permission or policy is read only" + }, + "404": { + "description": "FailureDomain doesn't exist" + }, + "412": { + "description": "Cluster doesn't exist" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Delete the failure domain of the cluster", + "tags": [ + "clusters" + ] + }, + "get": { + "description": "This operation requires Pulsar superuser privileges.", + "operationId": "ClustersBase_getDomain", + "parameters": [ + { + "description": "The cluster name", + "in": "path", + "name": "cluster", + "required": true, + "type": "string" + }, + { + "description": "The failure domain name", + "in": "path", + "name": "domainName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/FailureDomain" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "FailureDomain doesn't exist" + }, + "412": { + "description": "Cluster doesn't exist" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Get a domain in a cluster", + "tags": [ + "clusters" + ] + }, + "post": { + "description": "This operation requires Pulsar superuser privileges.", + "operationId": "ClustersBase_setFailureDomain", + "parameters": [ + { + "description": "The cluster name", + "in": "path", + "name": "cluster", + "required": true, + "type": "string" + }, + { + "description": "The failure domain name", + "in": "path", + "name": "domainName", + "required": true, + "type": "string" + }, + { + "description": "The configuration data of a failure domain", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FailureDomain" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Set the failure domain of the cluster successfully." + }, + "403": { + "description": "Don't have admin permission." + }, + "404": { + "description": "Failure domain doesn't exist." + }, + "409": { + "description": "Broker already exists in another domain." + }, + "412": { + "description": "Cluster doesn't exist." + }, + "500": { + "description": "Internal server error." + } + }, + "summary": "Set the failure domain of the cluster.", + "tags": [ + "clusters" + ] + } + }, + "/clusters/{cluster}/migrate": { + "get": { + "description": "This operation requires Pulsar superuser privileges.", + "operationId": "ClustersBase_getClusterMigration", + "parameters": [ + { + "description": "The cluster name", + "in": "path", + "name": "cluster", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Return the cluster data.", + "schema": { + "$ref": "#/definitions/ClusterData" + } + }, + "403": { + "description": "Don't have admin permission." + }, + "404": { + "description": "Cluster doesn't exist." + }, + "500": { + "description": "Internal server error." + } + }, + "summary": "Get the cluster migration configuration for the specified cluster.", + "tags": [ + "clusters" + ] + }, + "post": { + "description": "This operation requires Pulsar superuser privileges.", + "operationId": "ClustersBase_updateClusterMigration", + "parameters": [ + { + "description": "The cluster name", + "in": "path", + "name": "cluster", + "required": true, + "type": "string" + }, + { + "description": "Is cluster migrated", + "in": "query", + "name": "migrated", + "required": true, + "type": "boolean" + }, + { + "description": "The cluster url data", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterUrl" + }, + "x-examples": { + "application/json": "{\n \"serviceUrl\": \"http://pulsar.example.com:8080\",\n \"brokerServiceUrl\": \"pulsar://pulsar.example.com:6651\"\n}" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Cluster has been updated." + }, + "400": { + "description": "Cluster url must not be empty." + }, + "403": { + "description": "Don't have admin permission or policies are read-only." + }, + "404": { + "description": "Cluster doesn't exist." + }, + "500": { + "description": "Internal server error." + } + }, + "summary": "Update the configuration for a cluster migration.", + "tags": [ + "clusters" + ] + } + }, + "/clusters/{cluster}/namespaceIsolationPolicies": { + "get": { + "description": "This operation requires Pulsar superuser privileges.", + "operationId": "ClustersBase_getNamespaceIsolationPolicies", + "parameters": [ + { + "description": "The cluster name", + "in": "path", + "name": "cluster", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "additionalProperties": { + "$ref": "#/definitions/NamespaceIsolationData" + }, + "type": "object" + } + }, + "403": { + "description": "Don't have admin permission." + }, + "404": { + "description": "Cluster doesn't exist." + }, + "500": { + "description": "Internal server error." + } + }, + "summary": "Get the namespace isolation policies assigned to the cluster.", + "tags": [ + "clusters" + ] + } + }, + "/clusters/{cluster}/namespaceIsolationPolicies/brokers": { + "get": { + "description": "This operation requires Pulsar superuser privileges.", + "operationId": "ClustersBase_getBrokersWithNamespaceIsolationPolicy", + "parameters": [ + { + "description": "The cluster name", + "in": "path", + "name": "cluster", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "$ref": "#/definitions/BrokerNamespaceIsolationData" + }, + "type": "array", + "uniqueItems": true + } + }, + "403": { + "description": "Don't have admin permission." + }, + "404": { + "description": "Namespace-isolation policies not found." + }, + "412": { + "description": "Cluster doesn't exist." + }, + "500": { + "description": "Internal server error." + } + }, + "summary": "Get list of brokers with namespace-isolation policies attached to them.", + "tags": [ + "clusters" + ] + } + }, + "/clusters/{cluster}/namespaceIsolationPolicies/brokers/{broker}": { + "get": { + "description": "This operation requires Pulsar superuser privileges.", + "operationId": "ClustersBase_getBrokerWithNamespaceIsolationPolicy", + "parameters": [ + { + "description": "The cluster name", + "in": "path", + "name": "cluster", + "required": true, + "type": "string" + }, + { + "description": "The broker name (:)", + "in": "path", + "name": "broker", + "required": true, + "type": "string", + "x-example": "broker1:8080" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/BrokerNamespaceIsolationData" + } + }, + "403": { + "description": "Don't have admin permission." + }, + "404": { + "description": "Namespace-isolation policies/ Broker not found." + }, + "412": { + "description": "Cluster doesn't exist." + }, + "500": { + "description": "Internal server error." + } + }, + "summary": "Get a broker with namespace-isolation policies attached to it.", + "tags": [ + "clusters" + ] + } + }, + "/clusters/{cluster}/namespaceIsolationPolicies/{policyName}": { + "delete": { + "description": "This operation requires Pulsar superuser privileges.", + "operationId": "ClustersBase_deleteNamespaceIsolationPolicy", + "parameters": [ + { + "description": "The cluster name", + "in": "path", + "name": "cluster", + "required": true, + "type": "string" + }, + { + "description": "The namespace isolation policy name", + "in": "path", + "name": "policyName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Delete namespace isolation policy successfully." + }, + "403": { + "description": "Don't have admin permission or policies are read only." + }, + "404": { + "description": "Namespace isolation policy doesn't exist." + }, + "412": { + "description": "Cluster doesn't exist." + }, + "500": { + "description": "Internal server error." + } + }, + "summary": "Delete namespace isolation policy.", + "tags": [ + "clusters" + ] + }, + "get": { + "description": "This operation requires Pulsar superuser privileges.", + "operationId": "ClustersBase_getNamespaceIsolationPolicy", + "parameters": [ + { + "description": "The cluster name", + "in": "path", + "name": "cluster", + "required": true, + "type": "string" + }, + { + "description": "The name of the namespace isolation policy", + "in": "path", + "name": "policyName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/NamespaceIsolationData" + } + }, + "403": { + "description": "Don't have admin permission." + }, + "404": { + "description": "Policy doesn't exist." + }, + "412": { + "description": "Cluster doesn't exist." + }, + "500": { + "description": "Internal server error." + } + }, + "summary": "Get the single namespace isolation policy assigned to the cluster.", + "tags": [ + "clusters" + ] + }, + "post": { + "description": "This operation requires Pulsar superuser privileges.", + "operationId": "ClustersBase_setNamespaceIsolationPolicy", + "parameters": [ + { + "description": "The cluster name", + "in": "path", + "name": "cluster", + "required": true, + "type": "string" + }, + { + "description": "The namespace isolation policy name", + "in": "path", + "name": "policyName", + "required": true, + "type": "string" + }, + { + "description": "The namespace isolation policy data", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NamespaceIsolationData" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Set namespace isolation policy successfully." + }, + "400": { + "description": "Namespace isolation policy data is invalid." + }, + "403": { + "description": "Don't have admin permission or policies are read-only." + }, + "404": { + "description": "Namespace isolation policy doesn't exist." + }, + "412": { + "description": "Cluster doesn't exist." + }, + "500": { + "description": "Internal server error." + } + }, + "summary": "Set namespace isolation policy.", + "tags": [ + "clusters" + ] + } + }, + "/clusters/{cluster}/peers": { + "get": { + "description": "This operation requires Pulsar superuser privileges.", + "operationId": "ClustersBase_getPeerCluster", + "parameters": [ + { + "description": "The cluster name", + "in": "path", + "name": "cluster", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "403": { + "description": "Don't have admin permission." + }, + "404": { + "description": "Cluster doesn't exist." + }, + "500": { + "description": "Internal server error." + } + }, + "summary": "Get the peer-cluster data for the specified cluster.", + "tags": [ + "clusters" + ] + }, + "post": { + "description": "This operation requires Pulsar superuser privileges.", + "operationId": "ClustersBase_setPeerClusterNames", + "parameters": [ + { + "description": "The cluster name", + "in": "path", + "name": "cluster", + "required": true, + "type": "string" + }, + { + "description": "The list of peer cluster names", + "in": "body", + "name": "body", + "required": true, + "schema": { + "items": { + "type": "string" + }, + "type": "array" + }, + "x-examples": { + "application/json": "[\n \"cluster-a\",\n \"cluster-b\"\n]" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Cluster has been updated." + }, + "403": { + "description": "Don't have admin permission or policies are read-only." + }, + "404": { + "description": "Cluster doesn't exist." + }, + "412": { + "description": "Peer cluster doesn't exist." + }, + "500": { + "description": "Internal server error." + } + }, + "summary": "Update peer-cluster-list for a cluster.", + "tags": [ + "clusters" + ] + } + }, + "/namespaces/grantPermissionsOnTopics": { + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_grantPermissionsOnTopics", + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "tenant/namespace/topic doesn't exit" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Grant new permissions to a role on multi-topics.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/revokePermissionsOnTopics": { + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_revokePermissionsOnTopics", + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "tenant/namespace/topic doesn't exit" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Revoke new permissions to a role on multi-topics.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{cluster}/antiAffinity/{group}": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getAntiAffinityNamespaces", + "parameters": [ + { + "in": "path", + "name": "cluster", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "group", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "tenant", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "412": { + "description": "Cluster not exist/Anti-affinity group can't be empty." + } + }, + "summary": "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", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{property}/{namespace}/persistence/bookieAffinity": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_deleteBookieAffinityGroup", + "parameters": [ + { + "in": "path", + "name": "property", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Delete the bookie-affinity-group from namespace-local policy.", + "tags": [ + "namespaces" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getBookieAffinityGroup", + "parameters": [ + { + "in": "path", + "name": "property", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/BookieAffinityGroupDataImpl" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Get the bookie-affinity-group from namespace-local policy.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getTenantNamespaces", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant doesn't exist" + } + }, + "summary": "Get the list of all the namespaces for a certain tenant.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_deleteNamespace", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "force", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + }, + "405": { + "description": "Broker doesn't allow forced deletion of namespaces" + }, + "409": { + "description": "Namespace is not empty" + } + }, + "summary": "Delete a namespace and all the topics under it.", + "tags": [ + "namespaces" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getPolicies", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/Policies" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + } + }, + "summary": "Get the dump all the policies specified for a namespace.", + "tags": [ + "namespaces" + ] + }, + "put": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_createNamespace", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Policies for the namespace", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/Policies" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster doesn't exist" + }, + "409": { + "description": "Namespace already exists" + }, + "412": { + "description": "Namespace name is not valid" + } + }, + "summary": "Creates a new namespace with the specified policies", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/allowedClusters": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getNamespaceAllowedClusters", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + }, + "412": { + "description": "Namespace is not global" + } + }, + "summary": "Get the allowed clusters for a namespace.", + "tags": [ + "namespaces" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_setNamespaceAllowedClusters", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "List of allowed clusters", + "in": "body", + "name": "body", + "required": true, + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "400": { + "description": "The list of allowed clusters should include all replication clusters." + }, + "403": { + "description": "The requester does not have admin permissions." + }, + "404": { + "description": "The specified tenant, cluster, or namespace does not exist." + }, + "409": { + "description": "A peer-cluster cannot be part of an allowed-cluster." + }, + "412": { + "description": "The namespace is not global or the provided cluster IDs are invalid." + } + }, + "summary": "Set the allowed clusters for a namespace.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/antiAffinity": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_removeNamespaceAntiAffinityGroup", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove anti-affinity group of a namespace.", + "tags": [ + "namespaces" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getNamespaceAntiAffinityGroup", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "type": "string" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + } + }, + "summary": "Get anti-affinity group of a namespace.", + "tags": [ + "namespaces" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_setNamespaceAntiAffinityGroup", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Anti-affinity group for the specified namespace", + "in": "body", + "name": "body", + "required": true, + "schema": { + "type": "string" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + }, + "412": { + "description": "Invalid antiAffinityGroup" + } + }, + "summary": "Set anti-affinity group for a namespace", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/autoSubscriptionCreation": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_removeAutoSubscriptionCreation", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + } + }, + "summary": "Remove override of broker's allowAutoSubscriptionCreation in a namespace", + "tags": [ + "namespaces" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getAutoSubscriptionCreation", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/AutoSubscriptionCreationOverrideImpl" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or namespace doesn't exist" + } + }, + "summary": "Get autoSubscriptionCreation info in a namespace", + "tags": [ + "namespaces" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_setAutoSubscriptionCreation", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Settings for automatic subscription creation", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/AutoSubscriptionCreationOverride" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "400": { + "description": "Invalid autoSubscriptionCreation override" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + } + }, + "summary": "Override broker's allowAutoSubscriptionCreation setting for a namespace", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/autoTopicCreation": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_removeAutoTopicCreation", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + } + }, + "summary": "Remove override of broker's allowAutoTopicCreation in a namespace", + "tags": [ + "namespaces" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getAutoTopicCreation", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/AutoTopicCreationOverrideImpl" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or namespace doesn't exist" + } + }, + "summary": "Get autoTopicCreation info in a namespace", + "tags": [ + "namespaces" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_setAutoTopicCreation", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Settings for automatic topic creation", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AutoTopicCreationOverride" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "400": { + "description": "Invalid autoTopicCreation override" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + }, + "406": { + "description": "The number of partitions should be less than or equal to maxNumPartitionsPerPartitionedTopic" + } + }, + "summary": "Override broker's allowAutoTopicCreation setting for a namespace", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/backlogQuota": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_removeBacklogQuota", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "enum": [ + "destination_storage", + "message_age" + ], + "in": "query", + "name": "backlogQuotaType", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove a backlog quota policy from a namespace.", + "tags": [ + "namespaces" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_setBacklogQuota", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "enum": [ + "destination_storage", + "message_age" + ], + "in": "query", + "name": "backlogQuotaType", + "required": false, + "type": "string" + }, + { + "description": "Backlog quota for all topics of the specified namespace", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/BacklogQuota" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "Specified backlog quota exceeds retention quota. Increase retention quota and retry request" + } + }, + "summary": " Set a backlog quota for all the topics on a namespace.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/backlogQuotaMap": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getBacklogQuotaMap", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "additionalProperties": { + "$ref": "#/definitions/BacklogQuotaImpl" + }, + "type": "object" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + } + }, + "summary": "Get backlog quota map on a namespace.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/bundles": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getBundlesData", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/BundlesDataImpl" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + }, + "412": { + "description": "Namespace is not setup to split in bundles" + } + }, + "summary": "Get the bundles split data.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/clearBacklog": { + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_clearNamespaceBacklog", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin or operate permission on the namespace" + }, + "404": { + "description": "Namespace does not exist" + } + }, + "summary": "Clear backlog for all topics on a namespace.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/clearBacklog/{subscription}": { + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_clearNamespaceBacklogForSubscription", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "subscription", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin or operate permission on the namespace" + }, + "404": { + "description": "Namespace does not exist" + } + }, + "summary": "Clear backlog for a given subscription on all topics on a namespace.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/compactionThreshold": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "The backlog size is compared to the threshold periodically. A threshold of 0 disabled automatic compaction", + "operationId": "Namespaces_deleteCompactionThreshold", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace doesn't exist" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Delete maximum number of uncompacted bytes in a topic before compaction is triggered.", + "tags": [ + "namespaces" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "The backlog size is compared to the threshold periodically. A threshold of 0 disabled automatic compaction", + "operationId": "Namespaces_getCompactionThreshold", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int64", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace doesn't exist" + } + }, + "summary": "Maximum number of uncompacted bytes in topics before compaction is triggered.", + "tags": [ + "namespaces" + ] + }, + "put": { + "consumes": [ + "application/json" + ], + "description": "The backlog size is compared to the threshold periodically. A threshold of 0 disabled automatic compaction", + "operationId": "Namespaces_setCompactionThreshold", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Maximum number of uncompacted bytes in a topic of the specified namespace", + "in": "body", + "name": "body", + "required": true, + "schema": { + "format": "int64", + "type": "integer" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace doesn't exist" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "compactionThreshold value is not valid" + } + }, + "summary": "Set maximum number of uncompacted bytes in a topic before compaction is triggered.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/deduplication": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_removeDeduplication", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + } + }, + "summary": "Remove broker side deduplication for all topics in a namespace", + "tags": [ + "namespaces" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getDeduplication", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "type": "boolean" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + } + }, + "summary": "Get broker side deduplication for all topics in a namespace", + "tags": [ + "namespaces" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_modifyDeduplication", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Flag for disabling or enabling broker side deduplication for all topics in the specified namespace", + "in": "body", + "name": "body", + "required": true, + "schema": { + "type": "boolean" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + } + }, + "summary": "Enable or disable broker side deduplication for all topics in a namespace", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/deduplicationSnapshotInterval": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getDeduplicationSnapshotInterval", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int32", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + } + }, + "summary": "Get deduplicationSnapshotInterval config on a namespace.", + "tags": [ + "namespaces" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_setDeduplicationSnapshotInterval", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Interval to take deduplication snapshot per topic", + "in": "body", + "name": "body", + "required": true, + "schema": { + "format": "int32", + "type": "integer" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + } + }, + "summary": "Set deduplicationSnapshotInterval config on a namespace.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/delayedDelivery": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_removeDelayedDeliveryPolicies", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + } + }, + "summary": "Delete delayed delivery messages config on a namespace.", + "tags": [ + "namespaces" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getDelayedDeliveryPolicies", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/DelayedDeliveryPolicies" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Get delayed delivery messages config on a namespace.", + "tags": [ + "namespaces" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_setDelayedDeliveryPolicies", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Delayed delivery policies for the specified namespace", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/DelayedDeliveryPolicies" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + } + }, + "summary": "Set delayed delivery messages config on a namespace.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/dispatchRate": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_deleteDispatchRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + } + }, + "summary": "Delete dispatch-rate throttling for all topics of the namespace", + "tags": [ + "namespaces" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getDispatchRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/DispatchRate" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + } + }, + "summary": "Get dispatch-rate configured for the namespace, null means dispatch-rate not configured, -1 means msg-dispatch-rate or byte-dispatch-rate not configured in dispatch-rate yet", + "tags": [ + "namespaces" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_setDispatchRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Dispatch rate for all topics of the specified namespace", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/DispatchRateImpl" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + } + }, + "summary": "Set dispatch-rate throttling for all topics of the namespace", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/dispatcherPauseOnAckStatePersistent": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_removeDispatcherPauseOnAckStatePersistent", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove dispatcher pause on ack state persistent configuration for specified namespace.", + "tags": [ + "namespaces" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getDispatcherPauseOnAckStatePersistent", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "type": "boolean" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + } + }, + "summary": "Get dispatcher pause on ack state persistent config on a namespace.", + "tags": [ + "namespaces" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_setDispatcherPauseOnAckStatePersistent", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Set dispatcher pause on ack state persistent configuration for specified namespace.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/encryptionRequired": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getEncryptionRequired", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "type": "boolean" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or namespace doesn't exist" + } + }, + "summary": "Get message encryption required status in a namespace", + "tags": [ + "namespaces" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_modifyEncryptionRequired", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Flag defining if message encryption is required", + "in": "body", + "name": "body", + "required": true, + "schema": { + "type": "boolean" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Message encryption is required or not for all topics in a namespace", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/entryFilters": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_removeNamespaceEntryFilters", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + }, + "412": { + "description": "Invalid TTL" + } + }, + "summary": "Remove entry filters for namespace", + "tags": [ + "namespaces" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getEntryFiltersPerTopic", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/EntryFilters" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + } + }, + "summary": "Get maxConsumersPerSubscription config on a namespace.", + "tags": [ + "namespaces" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_setEntryFiltersPerTopic", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "entry filters", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/EntryFilters" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "400": { + "description": "Specified entry filters are not valid" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + } + }, + "summary": "Set entry filters for namespace", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/inactiveTopicPolicies": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_removeInactiveTopicPolicies", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove inactive topic policies from a namespace.", + "tags": [ + "namespaces" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getInactiveTopicPolicies", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/InactiveTopicPolicies" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Get inactive topic policies config on a namespace.", + "tags": [ + "namespaces" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_setInactiveTopicPolicies", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Inactive topic policies for the specified namespace", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/InactiveTopicPolicies" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + } + }, + "summary": "Set inactive topic policies config on a namespace.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/isAllowAutoUpdateSchema": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getIsAllowAutoUpdateSchema", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "type": "boolean" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace doesn't exist" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "The flag of whether allow auto update schema", + "tags": [ + "namespaces" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_setIsAllowAutoUpdateSchema", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Flag of whether to allow auto update schema", + "in": "body", + "name": "body", + "required": true, + "schema": { + "type": "boolean" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace doesn't exist" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Update flag of whether allow auto update schema", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/maxConsumersPerSubscription": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_removeMaxConsumersPerSubscription", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "maxConsumersPerSubscription value is not valid" + } + }, + "summary": " Set maxConsumersPerSubscription configuration on a namespace.", + "tags": [ + "namespaces" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getMaxConsumersPerSubscription", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int32", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + } + }, + "summary": "Get maxConsumersPerSubscription config on a namespace.", + "tags": [ + "namespaces" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_setMaxConsumersPerSubscription", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Number of maximum consumers per subscription", + "in": "body", + "name": "body", + "required": true, + "schema": { + "format": "int32", + "type": "integer" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "maxConsumersPerSubscription value is not valid" + } + }, + "summary": " Set maxConsumersPerSubscription configuration on a namespace.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/maxConsumersPerTopic": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_removeMaxConsumersPerTopic", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove maxConsumersPerTopic configuration on a namespace.", + "tags": [ + "namespaces" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getMaxConsumersPerTopic", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int32", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + } + }, + "summary": "Get maxConsumersPerTopic config on a namespace.", + "tags": [ + "namespaces" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_setMaxConsumersPerTopic", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Number of maximum consumers per topic", + "in": "body", + "name": "body", + "required": true, + "schema": { + "format": "int32", + "type": "integer" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "maxConsumersPerTopic value is not valid" + } + }, + "summary": " Set maxConsumersPerTopic configuration on a namespace.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/maxProducersPerTopic": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_removeMaxProducersPerTopic", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove maxProducersPerTopic configuration on a namespace.", + "tags": [ + "namespaces" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getMaxProducersPerTopic", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int32", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + } + }, + "summary": "Get maxProducersPerTopic config on a namespace.", + "tags": [ + "namespaces" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_setMaxProducersPerTopic", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Number of maximum producers per topic", + "in": "body", + "name": "body", + "required": true, + "schema": { + "format": "int32", + "type": "integer" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "maxProducersPerTopic value is not valid" + } + }, + "summary": " Set maxProducersPerTopic configuration on a namespace.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/maxSubscriptionsPerTopic": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_removeMaxSubscriptionsPerTopic", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove maxSubscriptionsPerTopic configuration on a namespace.", + "tags": [ + "namespaces" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getMaxSubscriptionsPerTopic", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int32", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + } + }, + "summary": "Get maxSubscriptionsPerTopic config on a namespace.", + "tags": [ + "namespaces" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_setMaxSubscriptionsPerTopic", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Number of maximum subscriptions per topic", + "in": "body", + "name": "body", + "required": true, + "schema": { + "format": "int32", + "type": "integer" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "maxUnackedMessagesPerSubscription value is not valid" + } + }, + "summary": " Set maxSubscriptionsPerTopic configuration on a namespace.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/maxTopicsPerNamespace": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_removeMaxTopicsPerNamespace", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or namespace doesn't exist" + } + }, + "summary": "Remove maxTopicsPerNamespace config on a namespace.", + "tags": [ + "namespaces" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getMaxTopicsPerNamespace", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int32", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or namespace does not exist" + } + }, + "summary": "Get maxTopicsPerNamespace config on a namespace.", + "tags": [ + "namespaces" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_setMaxTopicsPerNamespace", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Number of maximum topics for specific namespace", + "in": "body", + "name": "body", + "required": true, + "schema": { + "format": "int32", + "type": "integer" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or namespace doesn't exist" + } + }, + "summary": "Set maxTopicsPerNamespace config on a namespace.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/maxUnackedMessagesPerConsumer": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_removeMaxUnackedmessagesPerConsumer", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + } + }, + "summary": "Remove maxUnackedMessagesPerConsumer config on a namespace.", + "tags": [ + "namespaces" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getMaxUnackedMessagesPerConsumer", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int32", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + } + }, + "summary": "Get maxUnackedMessagesPerConsumer config on a namespace.", + "tags": [ + "namespaces" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_setMaxUnackedMessagesPerConsumer", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Number of maximum unacked messages per consumer", + "in": "body", + "name": "body", + "required": true, + "schema": { + "format": "int32", + "type": "integer" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "maxUnackedMessagesPerConsumer value is not valid" + } + }, + "summary": " Set maxConsumersPerTopic configuration on a namespace.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/maxUnackedMessagesPerSubscription": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_removeMaxUnackedmessagesPerSubscription", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + } + }, + "summary": "Remove maxUnackedMessagesPerSubscription config on a namespace.", + "tags": [ + "namespaces" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getMaxUnackedmessagesPerSubscription", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int32", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + } + }, + "summary": "Get maxUnackedMessagesPerSubscription config on a namespace.", + "tags": [ + "namespaces" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_setMaxUnackedMessagesPerSubscription", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Number of maximum unacked messages per subscription", + "in": "body", + "name": "body", + "required": true, + "schema": { + "format": "int32", + "type": "integer" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "maxUnackedMessagesPerSubscription value is not valid" + } + }, + "summary": " Set maxUnackedMessagesPerSubscription configuration on a namespace.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/messageTTL": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_removeNamespaceMessageTTL", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + }, + "412": { + "description": "Invalid TTL" + } + }, + "summary": "Remove message TTL in seconds for namespace", + "tags": [ + "namespaces" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getNamespaceMessageTTL", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int32", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + } + }, + "summary": "Get the message TTL for the namespace", + "tags": [ + "namespaces" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_setNamespaceMessageTTL", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "TTL in seconds for the specified namespace", + "in": "body", + "name": "body", + "required": true, + "schema": { + "format": "int32", + "type": "integer" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + }, + "412": { + "description": "Invalid TTL" + } + }, + "summary": "Set message TTL in seconds for namespace", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/offloadDeletionLagMs": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_clearOffloadDeletionLag", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace doesn't exist" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Clear the namespace configured offload deletion lag. The topics in the namespace will fallback to using the default configured deletion lag for the broker", + "tags": [ + "namespaces" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "A negative value denotes that deletion has been completely disabled. 'null' denotes that the topics in the namespace will fall back to the broker default for deletion lag.", + "operationId": "Namespaces_getOffloadDeletionLag", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int64", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace doesn't exist" + } + }, + "summary": "Number of milliseconds to wait before deleting a ledger segment which has been offloaded from the Pulsar cluster's local storage (i.e. BookKeeper)", + "tags": [ + "namespaces" + ] + }, + "put": { + "consumes": [ + "application/json" + ], + "description": "A negative value disables the deletion completely.", + "operationId": "Namespaces_setOffloadDeletionLag", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "New number of milliseconds to wait before deleting a ledger segment which has been offloaded", + "in": "body", + "name": "body", + "required": true, + "schema": { + "format": "int64", + "type": "integer" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace doesn't exist" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "offloadDeletionLagMs value is not valid" + } + }, + "summary": "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)", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/offloadPolicies": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getOffloadPolicies", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/OffloadPolicies" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + } + }, + "summary": "Get offload configuration on a namespace.", + "tags": [ + "namespaces" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_setOffloadPolicies", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Offload policies for the specified namespace", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/OffloadPoliciesImpl" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "OffloadPolicies is empty or driver is not supported or bucket is not valid" + } + }, + "summary": "Set offload configuration on a namespace.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/offloadThreshold": { + "get": { + "consumes": [ + "application/json" + ], + "description": "A negative value disables automatic offloading", + "operationId": "Namespaces_getOffloadThreshold", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int64", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace doesn't exist" + } + }, + "summary": "Maximum number of bytes stored on the pulsar cluster for a topic, before the broker will start offloading to longterm storage", + "tags": [ + "namespaces" + ] + }, + "put": { + "consumes": [ + "application/json" + ], + "description": "-1 will revert to using the cluster default. A negative value disables automatic offloading. ", + "operationId": "Namespaces_setOffloadThreshold", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Maximum number of bytes stored on the pulsar cluster for a topic of the specified namespace", + "in": "body", + "name": "body", + "required": true, + "schema": { + "format": "int64", + "type": "integer" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace doesn't exist" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "offloadThreshold value is not valid" + } + }, + "summary": "Set maximum number of bytes stored on the pulsar cluster for a topic, before the broker will start offloading to longterm storage", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/offloadThresholdInSeconds": { + "get": { + "consumes": [ + "application/json" + ], + "description": "A negative value disables automatic offloading", + "operationId": "Namespaces_getOffloadThresholdInSeconds", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int64", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace doesn't exist" + } + }, + "summary": "Maximum number of bytes stored on the pulsar cluster for a topic, before the broker will start offloading to longterm storage", + "tags": [ + "namespaces" + ] + }, + "put": { + "consumes": [ + "application/json" + ], + "description": "A negative value disables automatic offloading", + "operationId": "Namespaces_setOffloadThresholdInSeconds", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace doesn't exist" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "offloadThresholdInSeconds value is not valid" + } + }, + "summary": "Set maximum number of seconds stored on the pulsar cluster for a topic, before the broker will start offloading to longterm storage", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/permissions": { + "get": { + "consumes": [ + "application/json" + ], + "description": "Returns a nested map structure which Swagger does not fully support for display. Structure: Map>. Please refer to this structure for details.", + "operationId": "Namespaces_getPermissions", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "additionalProperties": { + "enum": [ + "produce", + "consume", + "functions", + "sources", + "sinks", + "packages" + ], + "type": "string" + }, + "type": "object" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + }, + "409": { + "description": "Namespace is not empty" + } + }, + "summary": "Retrieve the permissions for a namespace.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/permissions/subscription": { + "get": { + "consumes": [ + "application/json" + ], + "description": "Returns a nested map structure which Swagger does not fully support for display. Structure: Map>. Please refer to this structure for details.", + "operationId": "Namespaces_getPermissionOnSubscription", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + }, + "409": { + "description": "Namespace is not empty" + } + }, + "summary": "Retrieve the permissions for a subscription.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/permissions/{role}": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_revokePermissionsOnNamespace", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "role", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + } + }, + "summary": "Revoke all permissions to a role on a namespace.", + "tags": [ + "namespaces" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_grantPermissionOnNamespace", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "role", + "required": true, + "type": "string" + }, + { + "description": "List of permissions for the specified role", + "in": "body", + "name": "body", + "required": false, + "schema": { + "items": { + "enum": [ + "produce", + "consume", + "functions", + "sources", + "sinks", + "packages" + ], + "type": "string" + }, + "type": "array" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + }, + "409": { + "description": "Concurrent modification" + }, + "501": { + "description": "Authorization is not enabled" + } + }, + "summary": "Grant a new permission to a role on a namespace.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/persistence": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_deletePersistence", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + } + }, + "summary": "Delete the persistence configuration for all topics on a namespace", + "tags": [ + "namespaces" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getPersistence", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/PersistencePolicies" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Get the persistence configuration for a namespace.", + "tags": [ + "namespaces" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_setPersistence", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Persistence policies for the specified namespace", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PersistencePolicies" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "400": { + "description": "Invalid persistence policies" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Set the persistence configuration for all the topics on a namespace.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/persistence/bookieAffinity": { + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_setBookieAffinityGroup", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Bookie affinity group for the specified namespace", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/BookieAffinityGroupData" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Set the bookie-affinity-group to namespace-persistent policy.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/properties": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_clearProperties", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or namespace doesn't exist" + } + }, + "summary": "Clear properties on a given namespace.", + "tags": [ + "namespaces" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getProperties", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or namespace doesn't exist" + } + }, + "summary": "Get key value pair properties for a given namespace.", + "tags": [ + "namespaces" + ] + }, + "put": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_setProperties", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Key value pair properties for the namespace", + "in": "body", + "name": "body", + "required": true, + "schema": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or namespace doesn't exist" + } + }, + "summary": "Put key value pairs property on a namespace.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/property/{key}": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_removeProperty", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "key", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or namespace doesn't exist" + } + }, + "summary": "Remove property value for a given key on a namespace.", + "tags": [ + "namespaces" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getProperty", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "key", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "type": "string" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or namespace doesn't exist" + } + }, + "summary": "Get property value for a given key on a namespace.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/property/{key}/{value}": { + "put": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_setProperty", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "key", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "value", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or namespace doesn't exist" + } + }, + "summary": "Put a key value pair property on a namespace.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/removeOffloadPolicies": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_removeOffloadPolicies", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "OffloadPolicies is empty or driver is not supported or bucket is not valid" + } + }, + "summary": " Set offload configuration on a namespace.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/replication": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getNamespaceReplicationClusters", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + }, + "412": { + "description": "Namespace is not global" + } + }, + "summary": "Get the replication clusters for a namespace.", + "tags": [ + "namespaces" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_setNamespaceReplicationClusters", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "List of replication clusters", + "in": "body", + "name": "body", + "required": true, + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + }, + "409": { + "description": "Peer-cluster can't be part of replication-cluster" + }, + "412": { + "description": "Namespace is not global or invalid cluster ids" + } + }, + "summary": "Set the replication clusters for a namespace.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/replicatorDispatchRate": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_removeReplicatorDispatchRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + } + }, + "summary": "Remove replicator dispatch-rate throttling for all topics of the namespace", + "tags": [ + "namespaces" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getReplicatorDispatchRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/DispatchRateImpl" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + } + }, + "summary": "Get replicator dispatch-rate configured for the namespace, null means replicator dispatch-rate not configured, -1 means msg-dispatch-rate or byte-dispatch-rate not configured in dispatch-rate yet", + "tags": [ + "namespaces" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_setReplicatorDispatchRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Replicator dispatch rate for all topics of the specified namespace", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/DispatchRateImpl" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + } + }, + "summary": "Set replicator dispatch-rate throttling for all topics of the namespace", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/resourcegroup": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_removeNamespaceResourceGroup", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + }, + "412": { + "description": "Invalid resourcegroup" + } + }, + "summary": "Delete resourcegroup for a namespace", + "tags": [ + "namespaces" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getNamespaceResourceGroup", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "type": "string" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + } + }, + "summary": "Get the resource group attached to the namespace", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/resourcegroup/{resourcegroup}": { + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_setNamespaceResourceGroup", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "resourcegroup", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + }, + "412": { + "description": "Invalid resourcegroup" + } + }, + "summary": "Set resourcegroup for a namespace", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/retention": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_removeRetention", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Retention policies for the specified namespace", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/RetentionPolicies" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "Retention Quota must exceed backlog quota" + } + }, + "summary": " Remove retention configuration on a namespace.", + "tags": [ + "namespaces" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getRetention", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/RetentionPolicies" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + } + }, + "summary": "Get retention config on a namespace.", + "tags": [ + "namespaces" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_setRetention", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Retention policies for the specified namespace", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/RetentionPolicies" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "Retention Quota must exceed backlog quota" + } + }, + "summary": " Set retention configuration on a namespace.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/scanOffloadedLedgers": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_scanOffloadedLedgers", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successful get of offloaded ledger data" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace doesn't exist" + } + }, + "summary": "Trigger the scan of offloaded Ledgers on the LedgerOffloader for the given namespace", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/schemaAutoUpdateCompatibilityStrategy": { + "get": { + "consumes": [ + "application/json" + ], + "description": "The value AutoUpdateDisabled prevents producers from updating the schema. If set to AutoUpdateDisabled, schemas must be updated through the REST api", + "operationId": "Namespaces_getSchemaAutoUpdateCompatibilityStrategy", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "enum": [ + "AutoUpdateDisabled", + "Backward", + "Forward", + "Full", + "AlwaysCompatible", + "BackwardTransitive", + "ForwardTransitive", + "FullTransitive" + ], + "type": "string" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace doesn't exist" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "The strategy used to check the compatibility of new schemas, provided by producers, before automatically updating the schema", + "tags": [ + "namespaces" + ] + }, + "put": { + "consumes": [ + "application/json" + ], + "description": "The value AutoUpdateDisabled prevents producers from updating the schema. If set to AutoUpdateDisabled, schemas must be updated through the REST api", + "operationId": "Namespaces_setSchemaAutoUpdateCompatibilityStrategy", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Strategy used to check the compatibility of new schemas", + "in": "body", + "name": "body", + "required": false, + "schema": { + "type": "string" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace doesn't exist" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Update the strategy used to check the compatibility of new schemas, provided by producers, before automatically updating the schema", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/schemaCompatibilityStrategy": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getSchemaCompatibilityStrategy", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "enum": [ + "UNDEFINED", + "ALWAYS_INCOMPATIBLE", + "ALWAYS_COMPATIBLE", + "BACKWARD", + "FORWARD", + "FULL", + "BACKWARD_TRANSITIVE", + "FORWARD_TRANSITIVE", + "FULL_TRANSITIVE" + ], + "type": "string" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace doesn't exist" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "The strategy of the namespace schema compatibility ", + "tags": [ + "namespaces" + ] + }, + "put": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_setSchemaCompatibilityStrategy", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Strategy used to check the compatibility of new schema", + "in": "body", + "name": "body", + "required": false, + "schema": { + "type": "string" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace doesn't exist" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Update the strategy used to check the compatibility of new schema", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/schemaValidationEnforced": { + "get": { + "consumes": [ + "application/json" + ], + "description": "If the flag is set to true, when a producer without a schema attempts to produce to a topic with schema in this namespace, the producer will be failed to connect. PLEASE be carefully on using this, since non-java clients don't support schema.if you enable this setting, it will cause non-java clients failed to produce.", + "operationId": "Namespaces_getSchemaValidtionEnforced", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "type": "boolean" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenants or Namespace doesn't exist" + } + }, + "summary": "Get schema validation enforced flag for namespace.", + "tags": [ + "namespaces" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "If the flag is set to true, when a producer without a schema attempts to produce to a topic with schema in this namespace, the producer will be failed to connect. PLEASE be carefully on using this, since non-java clients don't support schema.if you enable this setting, it will cause non-java clients failed to produce.", + "operationId": "Namespaces_setSchemaValidationEnforced", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Flag of whether validation is enforced on the specified namespace", + "in": "body", + "name": "body", + "required": true, + "schema": { + "type": "boolean" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or Namespace doesn't exist" + }, + "412": { + "description": "schemaValidationEnforced value is not valid" + } + }, + "summary": "Set schema validation enforced flag on namespace.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/subscribeRate": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_deleteSubscribeRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + } + }, + "summary": "Delete subscribe-rate throttling for all topics of the namespace", + "tags": [ + "namespaces" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getSubscribeRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/SubscribeRate" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + } + }, + "summary": "Get subscribe-rate configured for the namespace", + "tags": [ + "namespaces" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_setSubscribeRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Subscribe rate for all topics of the specified namespace", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/SubscribeRate" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + } + }, + "summary": "Set subscribe-rate throttling for all topics of the namespace", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/subscriptionAuthMode": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getSubscriptionAuthMode", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "enum": [ + "None", + "Prefix" + ], + "type": "string" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or namespace doesn't exist" + } + }, + "summary": "Get subscription auth mode in a namespace", + "tags": [ + "namespaces" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_setSubscriptionAuthMode", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Subscription auth mode for all topics of the specified namespace", + "in": "body", + "name": "body", + "required": false, + "schema": { + "type": "string" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": " Set a subscription auth mode for all the topics on a namespace.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/subscriptionDispatchRate": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_deleteSubscriptionDispatchRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + } + }, + "summary": "Delete Subscription dispatch-rate throttling for all topics of the namespace", + "tags": [ + "namespaces" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getSubscriptionDispatchRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/DispatchRate" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + } + }, + "summary": "Get subscription dispatch-rate configured for the namespace, null means subscription dispatch-rate not configured, -1 means msg-dispatch-rate or byte-dispatch-rate not configured in dispatch-rate yet", + "tags": [ + "namespaces" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_setSubscriptionDispatchRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Subscription dispatch rate for all topics of the specified namespace", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/DispatchRateImpl" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + } + }, + "summary": "Set Subscription dispatch-rate throttling for all topics of the namespace", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/subscriptionExpirationTime": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_removeSubscriptionExpirationTime", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + } + }, + "summary": "Remove subscription expiration time for namespace", + "tags": [ + "namespaces" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getSubscriptionExpirationTime", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int32", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + } + }, + "summary": "Get the subscription expiration time for the namespace", + "tags": [ + "namespaces" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_setSubscriptionExpirationTime", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Expiration time in minutes for the specified namespace", + "in": "body", + "name": "body", + "required": true, + "schema": { + "format": "int32", + "type": "integer" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + }, + "412": { + "description": "Invalid expiration time" + } + }, + "summary": "Set subscription expiration time in minutes for namespace", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/subscriptionTypesEnabled": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_removeSubscriptionTypesEnabled", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or Namespace does not exist" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": " Remove subscription types enabled on a namespace.", + "tags": [ + "namespaces" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getSubscriptionTypesEnabled", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "enum": [ + "Exclusive", + "Shared", + "Failover", + "Key_Shared" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace doesn't exist" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "The set of whether allow subscription types", + "tags": [ + "namespaces" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_setSubscriptionTypesEnabled", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Set of whether allow subscription types", + "in": "body", + "name": "body", + "required": true, + "schema": { + "items": { + "enum": [ + "Exclusive", + "Shared", + "Failover", + "Key_Shared" + ], + "type": "string" + }, + "type": "array" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace doesn't exist" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Update set of whether allow share sub type", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/topics": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getTopics", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "default": "PERSISTENT", + "enum": [ + "PERSISTENT", + "NON_PERSISTENT", + "ALL" + ], + "in": "query", + "name": "mode", + "required": false, + "type": "string" + }, + { + "description": "Include system topic", + "in": "query", + "name": "includeSystemTopic", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "403": { + "description": "Don't have admin or operate permission on the namespace" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + } + }, + "summary": "Get the list of all the topics under a certain namespace.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/unload": { + "put": { + "consumes": [ + "application/json" + ], + "description": "Unload an active namespace from the current broker serving it. Performing this operation will let the brokerremoves all producers, consumers, and connections using this namespace, and close all topics (includingtheir persistent store). During that operation, the namespace is marked as tentatively unavailable until thebroker completes the unloading action. This operation requires strictly super user privileges, since it wouldresult in non-persistent message loss and unexpected connection closure to the clients.", + "operationId": "Namespaces_unloadNamespace", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or namespace doesn't exist" + }, + "412": { + "description": "Namespace is already unloaded or Namespace has bundles activated" + } + }, + "summary": "Unload namespace", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/unsubscribe/{subscription}": { + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_unsubscribeNamespace", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "subscription", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin or operate permission on the namespacen" + }, + "404": { + "description": "Namespace does not exist" + } + }, + "summary": "Unsubscribes the given subscription on all topics on a namespace.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/{bundle}": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_deleteNamespaceBundle", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "bundle", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "force", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace doesn't exist" + }, + "409": { + "description": "Namespace bundle is not empty" + } + }, + "summary": "Delete a namespace bundle and all the topics under it.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/{bundle}/clearBacklog": { + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_clearNamespaceBundleBacklog", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "bundle", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace" + }, + "403": { + "description": "Don't have admin or operate permission on the namespace" + }, + "404": { + "description": "Namespace does not exist" + } + }, + "summary": "Clear backlog for all topics on a namespace bundle.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/{bundle}/clearBacklog/{subscription}": { + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_clearNamespaceBundleBacklogForSubscription", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "subscription", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "bundle", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace" + }, + "403": { + "description": "Don't have admin or operate permission on the namespace" + }, + "404": { + "description": "Namespace does not exist" + } + }, + "summary": "Clear backlog for a given subscription on all topics on a namespace bundle.", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/{bundle}/split": { + "put": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_splitNamespaceBundle", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "bundle", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "unload", + "required": false, + "type": "boolean" + }, + { + "in": "query", + "name": "splitAlgorithmName", + "required": false, + "type": "string" + }, + { + "description": "splitBoundaries", + "in": "body", + "name": "body", + "required": false, + "schema": { + "items": { + "format": "int64", + "type": "integer" + }, + "type": "array" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace doesn't exist" + } + }, + "summary": "Split a namespace bundle", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/{bundle}/topicHashPositions": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_getTopicHashPositions", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "bundle", + "required": true, + "type": "string" + }, + { + "collectionFormat": "multi", + "in": "query", + "items": { + "type": "string" + }, + "name": "topics", + "required": false, + "type": "array" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/TopicHashPositions" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + } + }, + "summary": "Get hash positions for topics", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/{bundle}/unload": { + "put": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_unloadNamespaceBundle", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "bundle", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "in": "query", + "name": "destinationBroker", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace doesn't exist" + } + }, + "summary": "Unload a namespace bundle", + "tags": [ + "namespaces" + ] + } + }, + "/namespaces/{tenant}/{namespace}/{bundle}/unsubscribe/{subscription}": { + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Namespaces_unsubscribeNamespaceBundle", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "subscription", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "bundle", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin or operate permission on the namespace" + }, + "404": { + "description": "Namespace does not exist" + } + }, + "summary": "Unsubscribes the given subscription on all topics on a namespace bundle.", + "tags": [ + "namespaces" + ] + } + }, + "/non-persistent/{tenant}/{namespace}": { + "get": { + "description": "", + "operationId": "NonPersistentTopics_getList", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify the bundle name", + "in": "query", + "name": "bundle", + "required": false, + "type": "string" + }, + { + "description": "Include system topic", + "in": "query", + "name": "includeSystemTopic", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "401": { + "description": "Don't have permission to manage resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "The tenant/namespace does not exist" + }, + "412": { + "description": "Namespace name is not valid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Get the list of non-persistent topics under a namespace.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/partitioned": { + "get": { + "description": "", + "operationId": "PersistentTopics_getPartitionedTopicList", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Include system topic", + "in": "query", + "name": "includeSystemTopic", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin or operate permission on the namespace" + }, + "404": { + "description": "tenant/namespace/topic doesn't exit" + }, + "412": { + "description": "Namespace name is not valid" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Get the list of partitioned topics under a namespace.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{bundle}": { + "get": { + "description": "", + "operationId": "NonPersistentTopics_getListFromBundle", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Bundle range of a topic", + "in": "path", + "name": "bundle", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "401": { + "description": "Don't have permission to manage resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace doesn't exist" + }, + "412": { + "description": "Namespace name is not valid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Get the list of non-persistent topics under a namespace bundle.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}": { + "delete": { + "description": "The topic cannot be deleted if delete is not forcefully and there's any active subscription or producer connected to the it. Force delete ignores connected clients and deletes topic by explicitly closing them.", + "operationId": "PersistentTopics_deleteTopic", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Stop all producer/consumer/replicator and delete topic forcefully", + "in": "query", + "name": "force", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic does not exist" + }, + "412": { + "description": "Topic has active producers/subscriptions" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Delete a topic.", + "tags": [ + "non-persistent topic" + ] + }, + "put": { + "description": "This is the only REST endpoint from which non-partitioned topics could be created.", + "operationId": "PersistentTopics_createNonPartitionedTopic", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "Key value pair properties for the topic metadata", + "in": "body", + "name": "body", + "required": false, + "schema": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or namespace doesn't exist" + }, + "409": { + "description": "Partitioned topic already exist" + }, + "412": { + "description": "Failed Reason : Name is invalid or Namespace does not have any clusters configured" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Create a non-partitioned topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/all_subscription/expireMessages/{expireTimeInSeconds}": { + "post": { + "description": "", + "operationId": "PersistentTopics_expireMessagesForAllSubscriptions", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": 0, + "description": "Expires beyond the specified number of seconds", + "format": "int32", + "in": "path", + "name": "expireTimeInSeconds", + "required": true, + "type": "integer" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic or subscription does not exist" + }, + "405": { + "description": "Expiry messages on a non-persistent topic is not allowed" + }, + "412": { + "description": "Can't find owner for topic" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Expiry messages on all subscriptions of topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/autoSubscriptionCreation": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeAutoSubscriptionCreation", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Topic does not exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove autoSubscriptionCreation ina a topic.", + "tags": [ + "non-persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getAutoSubscriptionCreation", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/AutoSubscriptionCreationOverrideImpl" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Topic does not exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Get autoSubscriptionCreation info in a topic", + "tags": [ + "non-persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setAutoSubscriptionCreation", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "Settings for automatic subscription creation", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/AutoSubscriptionCreationOverrideImpl" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Override namespace's allowAutoSubscriptionCreation setting for a topic", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/backlog": { + "get": { + "description": "", + "operationId": "PersistentTopics_getBacklog", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/PersistentOfflineTopicStats" + } + }, + "404": { + "description": "Namespace does not exist" + }, + "412": { + "description": "Topic name is not valid" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Get estimated backlog for offline topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/backlogQuota": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeBacklogQuota", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "enum": [ + "destination_storage", + "message_age" + ], + "in": "query", + "name": "backlogQuotaType", + "required": false, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove a backlog quota policy from a topic.", + "tags": [ + "non-persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setBacklogQuota", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "enum": [ + "destination_storage", + "message_age" + ], + "in": "query", + "name": "backlogQuotaType", + "required": false, + "type": "string" + }, + { + "description": "backlog quota policies for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/BacklogQuotaImpl" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "Specified backlog quota exceeds retention quota. Increase retention quota and retry request" + } + }, + "summary": "Set a backlog quota for a topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/backlogQuotaMap": { + "get": { + "description": "", + "operationId": "PersistentTopics_getBacklogQuotaMap", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "additionalProperties": { + "$ref": "#/definitions/BacklogQuota" + }, + "type": "object" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Topic policy or namespace does not exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + } + }, + "summary": "Get backlog quota map on a topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/backlogSize": { + "put": { + "description": "", + "operationId": "PersistentTopics_getBacklogSizeByMessageId", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int64", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic does not exist" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Calculate backlog size by a message ID (in bytes).", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/compaction": { + "get": { + "description": "", + "operationId": "PersistentTopics_compactionStatus", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/LongRunningProcessStatus" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic does not exist, or compaction hasn't run" + }, + "405": { + "description": "Operation is not allowed on the persistent topic" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Get the status of a compaction operation for a topic.", + "tags": [ + "non-persistent topic" + ] + }, + "put": { + "description": "", + "operationId": "PersistentTopics_compact", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic does not exist" + }, + "405": { + "description": "Operation is not allowed on the persistent topic" + }, + "409": { + "description": "Compaction already running" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Trigger a compaction operation on a topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/compactionThreshold": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeCompactionThreshold", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove compaction threshold configuration for specified topic.", + "tags": [ + "non-persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getCompactionThreshold", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int64", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Get compaction threshold configuration for specified topic.", + "tags": [ + "non-persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setCompactionThreshold", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "description": "Dispatch rate for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "format": "int64", + "type": "integer" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Set compaction threshold configuration for specified topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/createMissedPartitions": { + "post": { + "description": "", + "operationId": "PersistentTopics_createMissedPartitions", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant does not exist" + }, + "409": { + "description": "Partitioned topic does not exist" + }, + "412": { + "description": "Partitioned topic name is invalid" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Create missed partitions of an existing partitioned topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/deduplicationEnabled": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeDeduplication", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove deduplication configuration for specified topic.", + "tags": [ + "non-persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getDeduplication", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "type": "boolean" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + } + }, + "summary": "Get deduplication configuration of a topic.", + "tags": [ + "non-persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setDeduplication", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "DeduplicationEnabled policies for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "type": "boolean" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + } + }, + "summary": "Set deduplication enabled on a topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/deduplicationSnapshotInterval": { + "delete": { + "description": "", + "operationId": "PersistentTopics_deleteDeduplicationSnapshotInterval", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + } + }, + "summary": "Delete deduplicationSnapshotInterval config on a topic.", + "tags": [ + "non-persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getDeduplicationSnapshotInterval", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int32", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Get deduplicationSnapshotInterval config on a topic.", + "tags": [ + "non-persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setDeduplicationSnapshotInterval", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "Interval to take deduplication snapshot for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "format": "int32", + "type": "integer" + } + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + } + }, + "summary": "Set deduplicationSnapshotInterval config on a topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/delayedDelivery": { + "delete": { + "description": "", + "operationId": "PersistentTopics_deleteDelayedDeliveryPolicies", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + } + }, + "summary": "Set delayed delivery messages config on a topic.", + "tags": [ + "non-persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getDelayedDeliveryPolicies", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/DelayedDeliveryPolicies" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Get delayed delivery messages config on a topic.", + "tags": [ + "non-persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setDelayedDeliveryPolicies", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "Delayed delivery policies for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/DelayedDeliveryPolicies" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + } + }, + "summary": "Set delayed delivery messages config on a topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/dispatchRate": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeDispatchRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove message dispatch rate configuration for specified topic.", + "tags": [ + "non-persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getDispatchRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/DispatchRateImpl" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Get dispatch rate configuration for specified topic.", + "tags": [ + "non-persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setDispatchRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "description": "Dispatch rate for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/DispatchRateImpl" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Set message dispatch rate configuration for specified topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/dispatcherPauseOnAckStatePersistent": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeDispatcherPauseOnAckStatePersistent", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove dispatcher pause on ack state persistent configuration for specified topic.", + "tags": [ + "non-persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getDispatcherPauseOnAckStatePersistent", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int32", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Get dispatcher pause on ack state persistent config on a topic.", + "tags": [ + "non-persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setDispatcherPauseOnAckStatePersistent", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Set dispatcher pause on ack state persistent configuration for specified topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/entryFilters": { + "delete": { + "description": "", + "operationId": "NonPersistentTopics_removeEntryFilters", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected thiscall to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove entry filters for specified topic.", + "tags": [ + "non-persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "NonPersistentTopics_getEntryFilters", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/EntryFilters" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenants or Namespace doesn't exist" + } + }, + "summary": "Get entry filters for a topic.", + "tags": [ + "non-persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "NonPersistentTopics_setEntryFilters", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "Enable sub types for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/EntryFilters" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Set entry filters for specified topic", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/examinemessage": { + "get": { + "description": "", + "operationId": "PersistentTopics_examineMessage", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": "latest", + "description": "Relative start position to examine message.It can be 'latest' or 'earliest'", + "enum": [ + "latest", + "earliest" + ], + "in": "query", + "name": "initialPosition", + "required": false, + "type": "string" + }, + { + "default": 1, + "description": "The position of messages (default 1)", + "format": "int64", + "in": "query", + "name": "messagePosition", + "required": false, + "type": "integer" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successfully retrieved the message. The response is a binary byte stream containing the message data. Clients need to parse this binary stream based on the message metadata provided in the response headers." + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic, the message position does not exist" + }, + "405": { + "description": "If given partitioned topic" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Examine a specific message on a topic by position relative to the earliest or the latest message.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/inactiveTopicPolicies": { + "delete": { + "description": "", + "operationId": "PersistentTopics_deleteInactiveTopicPolicies", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + } + }, + "summary": "Delete inactive topic policies on a topic.", + "tags": [ + "non-persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getInactiveTopicPolicies", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/InactiveTopicPolicies" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Get inactive topic policies on a topic.", + "tags": [ + "non-persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setInactiveTopicPolicies", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "description": "inactive topic policies for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/InactiveTopicPolicies" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + } + }, + "summary": "Set inactive topic policies on a topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/internal-info": { + "get": { + "description": "", + "operationId": "PersistentTopics_getManagedLedgerInfo", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/PartitionedManagedLedgerInfo" + } + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic does not exist" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Get the stored topic metadata.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/internalStats": { + "get": { + "description": "", + "operationId": "NonPersistentTopics_getInternalStats", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "metadata", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/PersistentTopicInternalStats" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to manage resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "The tenant/namespace/topic does not exist" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Get the internal stats for the topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/lastMessageId": { + "get": { + "description": "", + "operationId": "PersistentTopics_getLastMessageId", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/MessageIdAdv" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic does not exist" + }, + "405": { + "description": "Operation is not allowed on the persistent topic" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Return the last commit message id of topic", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/ledger/{ledgerId}/entry/{entryId}": { + "get": { + "description": "", + "operationId": "PersistentTopics_getMessageById", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "The ledger id", + "format": "int64", + "in": "path", + "name": "ledgerId", + "required": true, + "type": "integer" + }, + { + "description": "The entry id", + "format": "int64", + "in": "path", + "name": "entryId", + "required": true, + "type": "integer" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successfully retrieved the message. The response is a binary byte stream containing the message data. Clients need to parse this binary stream based on the message metadata provided in the response headers." + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic, subscription or the message position does not exist" + }, + "405": { + "description": "Skipping messages on a non-persistent topic is not allowed" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Get message by its messageId.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/maxConsumers": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeMaxConsumers", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove maxConsumers config for specified topic.", + "tags": [ + "non-persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getMaxConsumers", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int32", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Get maxConsumers config for specified topic.", + "tags": [ + "non-persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setMaxConsumers", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "The max consumers of the topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "format": "int32", + "type": "integer" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "Invalid value of maxConsumers" + } + }, + "summary": "Set maxConsumers config for specified topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/maxConsumersPerSubscription": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeMaxConsumersPerSubscription", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove max consumers per subscription configuration for specified topic.", + "tags": [ + "non-persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getMaxConsumersPerSubscription", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int32", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Get max consumers per subscription configuration for specified topic.", + "tags": [ + "non-persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setMaxConsumersPerSubscription", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "Dispatch rate for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "format": "int32", + "type": "integer" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Set max consumers per subscription configuration for specified topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/maxMessageSize": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeMaxMessageSize", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove maxMessageSize config for specified topic.", + "tags": [ + "non-persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getMaxMessageSize", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int32", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Get maxMessageSize config for specified topic.", + "tags": [ + "non-persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setMaxMessageSize", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "The max message size of the topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "format": "int32", + "type": "integer" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "Invalid value of maxConsumers" + } + }, + "summary": "Set maxMessageSize config for specified topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/maxProducers": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeMaxProducers", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove maxProducers config for specified topic.", + "tags": [ + "non-persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getMaxProducers", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int32", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Get maxProducers config for specified topic.", + "tags": [ + "non-persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setMaxProducers", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "description": "The max producers of the topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "format": "int32", + "type": "integer" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "Invalid value of maxProducers" + } + }, + "summary": "Set maxProducers config for specified topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/maxSubscriptionsPerTopic": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeMaxSubscriptionsPerTopic", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove maxSubscriptionsPerTopic config for specified topic.", + "tags": [ + "non-persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getMaxSubscriptionsPerTopic", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int32", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Get maxSubscriptionsPerTopic config for specified topic.", + "tags": [ + "non-persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setMaxSubscriptionsPerTopic", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "The max subscriptions of the topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "format": "int32", + "type": "integer" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "Invalid value of maxSubscriptionsPerTopic" + } + }, + "summary": "Set maxSubscriptionsPerTopic config for specified topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/maxUnackedMessagesOnConsumer": { + "delete": { + "description": "", + "operationId": "PersistentTopics_deleteMaxUnackedMessagesOnConsumer", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + } + }, + "summary": "Delete max unacked messages per consumer config on a topic.", + "tags": [ + "non-persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getMaxUnackedMessagesOnConsumer", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int32", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Get max unacked messages per consumer config on a topic.", + "tags": [ + "non-persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setMaxUnackedMessagesOnConsumer", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "Max unacked messages on consumer policies for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "format": "int32", + "type": "integer" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + } + }, + "summary": "Set max unacked messages per consumer config on a topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/maxUnackedMessagesOnSubscription": { + "delete": { + "description": "", + "operationId": "PersistentTopics_deleteMaxUnackedMessagesOnSubscription", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + } + }, + "summary": "Delete max unacked messages per subscription config on a topic.", + "tags": [ + "non-persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getMaxUnackedMessagesOnSubscription", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int32", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Get max unacked messages per subscription config on a topic.", + "tags": [ + "non-persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setMaxUnackedMessagesOnSubscription", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "Max unacked messages on subscription policies for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "format": "int32", + "type": "integer" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + } + }, + "summary": "Set max unacked messages per subscription config on a topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/messageTTL": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeMessageTTL", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Not authenticate to perform the request or policy is read only" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, enable the topic level policy and retry" + }, + "412": { + "description": "Invalid message TTL value" + } + }, + "summary": "Remove message TTL in seconds for a topic", + "tags": [ + "non-persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getMessageTTL", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int32", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, enable the topic level policy and retry" + } + }, + "summary": "Get message TTL in seconds for a topic", + "tags": [ + "non-persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setMessageTTL", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "TTL in seconds for the specified topic", + "format": "int32", + "in": "query", + "name": "messageTTL", + "required": true, + "type": "integer" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Not authenticate to perform the request or policy is read only" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, enable the topic level policy and retry" + }, + "412": { + "description": "Invalid message TTL value" + } + }, + "summary": "Set message TTL in seconds for a topic", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/messageid/{timestamp}": { + "get": { + "description": "", + "operationId": "PersistentTopics_getMessageIdByTimestamp", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "Specify the timestamp", + "format": "int64", + "in": "path", + "name": "timestamp", + "required": true, + "type": "integer" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/MessageIdAdv" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic does not exist" + }, + "405": { + "description": "Topic is not non-partitioned and persistent" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Get message ID published at or just after this absolute timestamp (in ms).", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/offload": { + "get": { + "description": "", + "operationId": "PersistentTopics_offloadStatus", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/OffloadProcessStatus" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic does not exist" + }, + "405": { + "description": "Operation is not allowed on the persistent topic" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Offload a prefix of a topic to long term storage", + "tags": [ + "non-persistent topic" + ] + }, + "put": { + "description": "", + "operationId": "PersistentTopics_triggerOffload", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "400": { + "description": "Message ID is null" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic does not exist" + }, + "405": { + "description": "Operation is not allowed on the persistent topic" + }, + "409": { + "description": "Offload already running" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Offload a prefix of a topic to long term storage", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/offloadPolicies": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeOffloadPolicies", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + } + }, + "summary": "Delete offload policies on a topic.", + "tags": [ + "non-persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getOffloadPolicies", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/OffloadPoliciesImpl" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Get offload policies on a topic.", + "tags": [ + "non-persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setOffloadPolicies", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "description": "Offload policies for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/OffloadPoliciesImpl" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + } + }, + "summary": "Set offload policies on a topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/partitioned-internalStats": { + "get": { + "description": "", + "operationId": "PersistentTopics_getPartitionedStatsInternal", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/PartitionedTopicInternalStats" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic does not exist" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Get the stats-internal for the partitioned topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/partitioned-stats": { + "get": { + "description": "", + "operationId": "NonPersistentTopics_getPartitionedStats", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": true, + "description": "Get per partition stats", + "in": "query", + "name": "perPartition", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "If return precise backlog or imprecise backlog", + "in": "query", + "name": "getPreciseBacklog", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "If return backlog size for each subscription, require locking on ledger so be careful not to use when there's heavy traffic.", + "in": "query", + "name": "subscriptionBacklogSize", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "If return the earliest time in backlog", + "in": "query", + "name": "getEarliestTimeInBacklog", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "If exclude the publishers", + "in": "query", + "name": "excludePublishers", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "If exclude the consumers", + "in": "query", + "name": "excludeConsumers", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/NonPersistentPartitionedTopicStatsImpl" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic does not exist" + }, + "412": { + "description": "Partitioned topic name is invalid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Get the stats for the partitioned topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/partitions": { + "delete": { + "description": "It will also delete all the partitions of the topic if it exists.", + "operationId": "PersistentTopics_deletePartitionedTopic", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Stop all producer/consumer/replicator and delete topic forcefully", + "in": "query", + "name": "force", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Partitioned topic does not exist" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "Partitioned topic name is invalid" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Delete a partitioned topic.", + "tags": [ + "non-persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "NonPersistentTopics_getPartitionedMetadata", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Is check configuration required to automatically create topic", + "in": "query", + "name": "checkAllowAutoCreation", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/PartitionedTopicMetadata" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to manage resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "The tenant/namespace/topic does not exist" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate cluster configuration" + } + }, + "summary": "Get partitioned topic metadata.", + "tags": [ + "non-persistent topic" + ] + }, + "post": { + "description": "It increments partitions of existing partitioned-topic", + "operationId": "PersistentTopics_updatePartitionedTopic", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "updateLocalTopicOnly", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "force", + "required": false, + "type": "boolean" + }, + { + "description": "The number of partitions for the topic", + "in": "body", + "name": "body", + "required": true, + "schema": { + "default": 0, + "format": "int32", + "type": "integer" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Update topic partition successful." + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Unauthenticated" + }, + "403": { + "description": "Forbidden/Unauthorized" + }, + "404": { + "description": "Topic does not exist" + }, + "412": { + "description": "Partitioned topic name is invalid" + }, + "422": { + "description": "The number of partitions should be more than 0 and less than or equal to maxNumPartitionsPerPartitionedTopic and number of new partitions must be greater than existing number of partitions" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Increment partitions of an existing partitioned topic.", + "tags": [ + "non-persistent topic" + ] + }, + "put": { + "description": "It needs to be called before creating a producer on a partitioned topic.", + "operationId": "NonPersistentTopics_createPartitionedTopic", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "The number of partitions for the topic", + "in": "body", + "name": "body", + "required": true, + "schema": { + "default": 0, + "format": "int32", + "type": "integer" + } + }, + { + "default": false, + "in": "query", + "name": "createLocalTopicOnly", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to manage resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "The tenant/namespace does not exist" + }, + "406": { + "description": "The number of partitions should be more than 0 and less than or equal to maxNumPartitionsPerPartitionedTopic" + }, + "409": { + "description": "Partitioned topic already exists" + }, + "412": { + "description": "Failed Reason : Name is invalid or Namespace does not have any clusters configured" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Create a partitioned topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/permissions": { + "get": { + "description": "Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at thenamespace level combined (union) with any eventual specific permission set on the topic.Returns a nested map structure which Swagger does not fully support for display. Structure: Map>. Please refer to this structure for details.", + "operationId": "PersistentTopics_getPermissionsOnTopic", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "additionalProperties": { + "enum": [ + "produce", + "consume", + "functions", + "sources", + "sinks", + "packages" + ], + "type": "string" + }, + "type": "object" + } + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "tenant/namespace/topic doesn't exit" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Get permissions on a topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/permissions/{role}": { + "delete": { + "description": "Revoke permissions to a role on a single topic. If the permission was not set at the topiclevel, but rather at the namespace level, this operation will return an error (HTTP status code 412).", + "operationId": "PersistentTopics_revokePermissionsOnTopic", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "Client role to which grant permissions", + "in": "path", + "name": "role", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "tenant/namespace/topic doesn't exit" + }, + "412": { + "description": "Permissions are not set at the topic level" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Revoke permissions on a topic.", + "tags": [ + "non-persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_grantPermissionsOnTopic", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "Client role to which grant permissions", + "in": "path", + "name": "role", + "required": true, + "type": "string" + }, + { + "description": "Actions to be granted (produce,functions,consume)", + "in": "body", + "name": "body", + "required": false, + "schema": { + "items": { + "enum": [ + "produce", + "consume", + "functions", + "sources", + "sinks", + "packages" + ], + "type": "string" + }, + "type": "array" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "tenant/namespace/topic doesn't exit" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Grant a new permission to a role on a single topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/persistence": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removePersistence", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove configuration of persistence policies for specified topic.", + "tags": [ + "non-persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getPersistence", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/PersistencePolicies" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Get configuration of persistence policies for specified topic.", + "tags": [ + "non-persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setPersistence", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "description": "Bookkeeper persistence policies for specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/PersistencePolicies" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "400": { + "description": "Invalid persistence policies" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Set configuration of persistence policies for specified topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/properties": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeProperties", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "key", + "required": false, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Partitioned topic does not exist" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "Partitioned topic name is invalid" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Remove the key in properties on the given topic.", + "tags": [ + "non-persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getProperties", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic does not exist" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "Topic name is invalid" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Get topic properties.", + "tags": [ + "non-persistent topic" + ] + }, + "put": { + "description": "", + "operationId": "PersistentTopics_updateProperties", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "Key value pair properties for the topic metadata", + "in": "body", + "name": "body", + "required": false, + "schema": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic or subscription does not exist" + }, + "405": { + "description": "Method Not Allowed" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Update the properties on the given topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/publishRate": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removePublishRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove message publish rate configuration for specified topic.", + "tags": [ + "non-persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getPublishRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/PublishRate" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Get publish rate configuration for specified topic.", + "tags": [ + "non-persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setPublishRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "Dispatch rate for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/PublishRate" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Set message publish rate configuration for specified topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/replication": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeReplicationClusters", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove the replication clusters from a topic.", + "tags": [ + "non-persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getReplicationClusters", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, enable the topic level policy and retry" + } + }, + "summary": "Get the replication clusters for a topic", + "tags": [ + "non-persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setReplicationClusters", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "List of replication clusters", + "in": "body", + "name": "body", + "required": true, + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "Topic is not global or invalid cluster ids" + } + }, + "summary": "Set the replication clusters for a topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/replicatorDispatchRate": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeReplicatorDispatchRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove replicatorDispatchRate config for specified topic.", + "tags": [ + "non-persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getReplicatorDispatchRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/DispatchRate" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Get replicatorDispatchRate config for specified topic.", + "tags": [ + "non-persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setReplicatorDispatchRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "Replicator dispatch rate of the topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/DispatchRateImpl" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "Invalid value of replicatorDispatchRate" + } + }, + "summary": "Set replicatorDispatchRate config for specified topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/retention": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeRetention", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "Retention Quota must exceed backlog quota" + } + }, + "summary": "Remove retention configuration for specified topic.", + "tags": [ + "non-persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getRetention", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/RetentionPolicies" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Get retention configuration for specified topic.", + "tags": [ + "non-persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setRetention", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "description": "Retention policies for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/RetentionPolicies" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "Retention Quota must exceed backlog quota" + } + }, + "summary": "Set retention configuration for specified topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/schemaCompatibilityStrategy": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeSchemaCompatibilityStrategy", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "Strategy used to check the compatibility of new schema", + "in": "body", + "name": "body", + "required": false, + "schema": { + "type": "string" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Operation not allowed on persistent topic" + } + }, + "summary": "Remove schema compatibility strategy on a topic", + "tags": [ + "non-persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getSchemaCompatibilityStrategy", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the cluster", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "enum": [ + "UNDEFINED", + "ALWAYS_INCOMPATIBLE", + "ALWAYS_COMPATIBLE", + "BACKWARD", + "FORWARD", + "FULL", + "BACKWARD_TRANSITIVE", + "FORWARD_TRANSITIVE", + "FULL_TRANSITIVE" + ], + "type": "string" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Operation not allowed on persistent topic" + } + }, + "summary": "Get schema compatibility strategy on a topic", + "tags": [ + "non-persistent topic" + ] + }, + "put": { + "description": "", + "operationId": "PersistentTopics_setSchemaCompatibilityStrategy", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "Strategy used to check the compatibility of new schema", + "in": "body", + "name": "body", + "required": false, + "schema": { + "type": "string" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Operation not allowed on persistent topic" + } + }, + "summary": "Set schema compatibility strategy on a topic", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/schemaValidationEnforced": { + "get": { + "description": "", + "operationId": "PersistentTopics_getSchemaValidationEnforced", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "type": "boolean" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenants or Namespace doesn't exist" + } + }, + "summary": "Get schema validation enforced flag for topic.", + "tags": [ + "non-persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setSchemaValidationEnforced", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "in": "body", + "name": "body", + "required": true, + "schema": { + "type": "boolean" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or Namespace doesn't exist" + }, + "412": { + "description": "schemaValidationEnforced value is not valid" + } + }, + "summary": "Set schema validation enforced flag on topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/shadowTopics": { + "delete": { + "description": "", + "operationId": "PersistentTopics_deleteShadowTopics", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Delete shadow topics for a topic", + "tags": [ + "non-persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getShadowTopics", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, enable the topic level policy and retry" + } + }, + "summary": "Get the shadow topic list for a topic", + "tags": [ + "non-persistent topic" + ] + }, + "put": { + "description": "", + "operationId": "PersistentTopics_setShadowTopics", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "List of shadow topics", + "in": "body", + "name": "body", + "required": true, + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Set shadow topic list for a topic", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/stats": { + "get": { + "description": "", + "operationId": "PersistentTopics_getStats", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "If return precise backlog or imprecise backlog", + "in": "query", + "name": "getPreciseBacklog", + "required": false, + "type": "boolean" + }, + { + "default": true, + "description": "If return backlog size for each subscription, require locking on ledger so be careful not to use when there's heavy traffic.", + "in": "query", + "name": "subscriptionBacklogSize", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "If return time of the earliest message in backlog", + "in": "query", + "name": "getEarliestTimeInBacklog", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "If exclude the publishers", + "in": "query", + "name": "excludePublishers", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "If exclude the consumers", + "in": "query", + "name": "excludeConsumers", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/PersistentTopicStats" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic does not exist" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Get the stats for the topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/subscribeRate": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeSubscribeRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "Subscribe rate for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/SubscribeRate" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove subscribe rate configuration for specified topic.", + "tags": [ + "non-persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getSubscribeRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/SubscribeRate" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Get subscribe rate configuration for specified topic.", + "tags": [ + "non-persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setSubscribeRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "Subscribe rate for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/SubscribeRate" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Set subscribe rate configuration for specified topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}": { + "delete": { + "description": "The subscription cannot be deleted if delete is not forcefully and there are any active consumers attached to it. Force delete ignores connected consumers and deletes subscription by explicitly closing them.", + "operationId": "PersistentTopics_deleteSubscription", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "Subscription to be deleted", + "in": "path", + "name": "subName", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Disconnect and close all consumers and delete subscription forcefully", + "in": "query", + "name": "force", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic or subscription does not exist" + }, + "412": { + "description": "Subscription has active consumers" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Delete a subscription.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/analyzeBacklog": { + "post": { + "description": "", + "operationId": "PersistentTopics_analyzeSubscriptionBacklog", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "Subscription", + "in": "path", + "name": "subName", + "required": true, + "type": "string" + }, + { + "description": "messageId to start the analysis", + "in": "body", + "name": "position", + "required": false, + "schema": { + "$ref": "#/definitions/ResetCursorData" + } + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic or subscription does not exist" + }, + "405": { + "description": "Method Not Allowed" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Analyse a subscription, by scanning all the unprocessed messages", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/expireMessages": { + "post": { + "description": "", + "operationId": "PersistentTopics_expireTopicMessages", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "Subscription to be Expiry messages on", + "in": "path", + "name": "subName", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "messageId to reset back to (ledgerId:entryId)", + "in": "body", + "name": "messageId", + "required": false, + "schema": { + "$ref": "#/definitions/ResetCursorData" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic or subscription does not exist" + }, + "405": { + "description": "Expiry messages on a non-persistent topic is not allowed" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Expiry messages on a topic subscription.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/expireMessages/{expireTimeInSeconds}": { + "post": { + "description": "", + "operationId": "PersistentTopics_expireTopicMessages", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "Subscription to be Expiry messages on", + "in": "path", + "name": "subName", + "required": true, + "type": "string" + }, + { + "default": 0, + "description": "Expires beyond the specified number of seconds", + "format": "int32", + "in": "path", + "name": "expireTimeInSeconds", + "required": true, + "type": "integer" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic or subscription does not exist" + }, + "405": { + "description": "Expiry messages on a non-persistent topic is not allowed" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Expiry messages on a topic subscription.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/position/{messagePosition}": { + "get": { + "description": "", + "operationId": "PersistentTopics_peekNthMessage", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "Subscribed message expired", + "in": "path", + "name": "subName", + "required": true, + "type": "string" + }, + { + "default": 1, + "description": "The number of messages (default 1)", + "format": "int32", + "in": "path", + "name": "messagePosition", + "required": true, + "type": "integer" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successfully retrieved the message. The response is a binary byte stream containing the message data. Clients need to parse this binary stream based on the message metadata provided in the response headers." + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic, subscription or the message position does not exist" + }, + "405": { + "description": "Skipping messages on a non-persistent topic is not allowed" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Peek nth message on a topic subscription.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/properties": { + "get": { + "description": "", + "operationId": "PersistentTopics_getSubscriptionProperties", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "Subscription", + "in": "path", + "name": "subName", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic or subscription does not exist" + }, + "405": { + "description": "Method Not Allowed" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Return all the properties on the given subscription", + "tags": [ + "non-persistent topic" + ] + }, + "put": { + "description": "", + "operationId": "PersistentTopics_updateSubscriptionProperties", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "Subscription to update", + "in": "path", + "name": "subName", + "required": true, + "type": "string" + }, + { + "description": "The new properties", + "in": "body", + "name": "body", + "required": false, + "schema": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + } + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic or subscription does not exist" + }, + "405": { + "description": "Method Not Allowed" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Replace all the properties on the given subscription", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/replicatedSubscriptionStatus": { + "get": { + "description": "", + "operationId": "PersistentTopics_getReplicatedSubscriptionStatus", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "Name of subscription", + "in": "path", + "name": "subName", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "additionalProperties": { + "type": "boolean" + }, + "type": "object" + } + }, + "401": { + "description": "Don't have permission to administrate resources" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "412": { + "description": "Can't find owner for topic" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Get replicated subscription status on a topic.", + "tags": [ + "non-persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setReplicatedSubscriptionStatus", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "Name of subscription", + "in": "path", + "name": "subName", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "Whether to enable replicated subscription", + "in": "body", + "name": "body", + "required": true, + "schema": { + "type": "boolean" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant or subscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Topic or subscription does not exist" + }, + "405": { + "description": "Operation not allowed on this topic" + }, + "412": { + "description": "Can't find owner for topic" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Enable or disable a replicated subscription on a topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/resetcursor": { + "post": { + "description": "It fence cursor and disconnects all active consumers before resetting cursor.", + "operationId": "PersistentTopics_resetCursorOnPosition", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "Subscription to reset position on", + "in": "path", + "name": "subName", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "messageId to reset back to (ledgerId:entryId)", + "in": "body", + "name": "messageId", + "required": false, + "schema": { + "$ref": "#/definitions/ResetCursorData" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic or subscription does not exist" + }, + "405": { + "description": "Not supported for partitioned topics" + }, + "412": { + "description": "Unable to find position for position specified" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Reset subscription to message position closest to given position.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/resetcursor/{timestamp}": { + "post": { + "description": "It fence cursor and disconnects all active consumers before resetting cursor.", + "operationId": "PersistentTopics_resetCursor", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "Subscription to reset position on", + "in": "path", + "name": "subName", + "required": true, + "type": "string" + }, + { + "description": "the timestamp to reset back", + "format": "int64", + "in": "path", + "name": "timestamp", + "required": true, + "type": "integer" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic or subscription does not exist" + }, + "405": { + "description": "Method Not Allowed" + }, + "412": { + "description": "Failed to reset cursor on subscription or Unable to find position for timestamp specified" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Reset subscription to message position closest to absolute timestamp (in ms).", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/skip/{numMessages}": { + "post": { + "description": "", + "operationId": "PersistentTopics_skipMessages", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "Name of subscription", + "in": "path", + "name": "subName", + "required": true, + "type": "string" + }, + { + "default": 0, + "description": "The number of messages to skip", + "format": "int32", + "in": "path", + "name": "numMessages", + "required": true, + "type": "integer" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic or subscription does not exist" + }, + "405": { + "description": "Skipping messages on a partitioned topic is not allowed" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Skipping messages on a topic subscription.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/skip_all": { + "post": { + "description": "Completely clears the backlog on the subscription.", + "operationId": "PersistentTopics_skipAllMessages", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "Name of subscription", + "in": "path", + "name": "subName", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic or subscription does not exist" + }, + "405": { + "description": "Operation not allowed on non-persistent topic" + }, + "412": { + "description": "Can't find owner for topic" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Skip all messages on a topic subscription.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/subscription/{subscriptionName}": { + "put": { + "description": "Creates a subscription on the topic at the specified message id", + "operationId": "PersistentTopics_createSubscription", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "Name of subscription to be created", + "in": "path", + "name": "subscriptionName", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "messageId where to create the subscription. It can be 'latest', 'earliest' or (ledgerId:entryId)", + "in": "body", + "name": "messageId", + "required": false, + "schema": { + "$ref": "#/definitions/ResetCursorData" + } + }, + { + "description": "Is replicated required to perform this operation", + "in": "query", + "name": "replicated", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "400": { + "description": "Create subscription on non persistent topic is not supported" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic or subscription does not exist" + }, + "405": { + "description": "Not supported for partitioned topics" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Create a subscription on the topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/subscriptionDispatchRate": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeSubscriptionDispatchRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove subscription message dispatch rate configuration for specified topic.", + "tags": [ + "non-persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getSubscriptionDispatchRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/DispatchRate" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Get subscription message dispatch rate configuration for specified topic.", + "tags": [ + "non-persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setSubscriptionDispatchRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "description": "Subscription message dispatch rate for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/DispatchRateImpl" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Set subscription message dispatch rate configuration for specified topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/subscriptionTypesEnabled": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeSubscriptionTypesEnabled", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove subscription types enabled for specified topic.", + "tags": [ + "non-persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getSubscriptionTypesEnabled", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "enum": [ + "Exclusive", + "Shared", + "Failover", + "Key_Shared" + ], + "type": "string" + }, + "type": "array" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Get is enable sub type fors specified topic.", + "tags": [ + "non-persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setSubscriptionTypesEnabled", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "Enable sub types for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "items": { + "enum": [ + "Exclusive", + "Shared", + "Failover", + "Key_Shared" + ], + "type": "string" + }, + "type": "array" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Set is enable sub types for specified topic", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/subscriptions": { + "get": { + "description": "", + "operationId": "PersistentTopics_getSubscriptions", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic does not exist" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Get the list of persistent subscriptions for a given topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/terminate": { + "post": { + "description": "", + "operationId": "PersistentTopics_terminate", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation terminated successfully. The response includes the 'lastMessageId', which is the identifier of the last message processed.", + "schema": { + "$ref": "#/definitions/MessageIdAdv" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic does not exist" + }, + "405": { + "description": "Termination of a partitioned topic is not allowed" + }, + "406": { + "description": "Need to provide a persistent topic name" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "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", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/terminate/partitions": { + "post": { + "description": "", + "operationId": "PersistentTopics_terminatePartitionedTopic", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic does not exist" + }, + "405": { + "description": "Termination of a non-partitioned topic is not allowed" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "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", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/trim": { + "post": { + "description": "", + "operationId": "PersistentTopics_trimTopic", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic does not exist" + }, + "405": { + "description": "Operation is not allowed on the persistent topic" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": " Trim a topic", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/truncate": { + "delete": { + "description": "NonPersistentTopic does not support truncate.", + "operationId": "NonPersistentTopics_truncateTopic", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "412": { + "description": "NonPersistentTopic does not support truncate." + } + }, + "summary": "Truncate a topic.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/unload": { + "put": { + "description": "", + "operationId": "NonPersistentTopics_unloadTopic", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "This operation requires super-user access" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "The tenant/namespace/topic does not exist" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Unload a topic", + "tags": [ + "non-persistent topic" + ] + } + }, + "/non-persistent/{tenant}/{namespace}/{topic}/{subName}/dispatchRate": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeSubscriptionLevelDispatchRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "subName", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove message dispatch rate configuration for specified subscription.", + "tags": [ + "non-persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getSubscriptionLevelDispatchRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "subName", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/DispatchRate" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Get message dispatch rate configuration for specified subscription.", + "tags": [ + "non-persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setSubscriptionLevelDispatchRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "subName", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "description": "Subscription message dispatch rate for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/DispatchRateImpl" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Set message dispatch rate configuration for specified subscription.", + "tags": [ + "non-persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}": { + "get": { + "description": "", + "operationId": "PersistentTopics_getList", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify the bundle name", + "in": "query", + "name": "bundle", + "required": false, + "type": "string" + }, + { + "description": "Include system topic", + "in": "query", + "name": "includeSystemTopic", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin or operate permission on the namespace" + }, + "404": { + "description": "tenant/namespace/topic doesn't exit" + }, + "412": { + "description": "Namespace name is not valid" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Get the list of topics under a namespace.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/partitioned": { + "get": { + "description": "", + "operationId": "PersistentTopics_getPartitionedTopicList", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Include system topic", + "in": "query", + "name": "includeSystemTopic", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin or operate permission on the namespace" + }, + "404": { + "description": "tenant/namespace/topic doesn't exit" + }, + "412": { + "description": "Namespace name is not valid" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Get the list of partitioned topics under a namespace.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}": { + "delete": { + "description": "The topic cannot be deleted if delete is not forcefully and there's any active subscription or producer connected to the it. Force delete ignores connected clients and deletes topic by explicitly closing them.", + "operationId": "PersistentTopics_deleteTopic", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Stop all producer/consumer/replicator and delete topic forcefully", + "in": "query", + "name": "force", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic does not exist" + }, + "412": { + "description": "Topic has active producers/subscriptions" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Delete a topic.", + "tags": [ + "persistent topic" + ] + }, + "put": { + "description": "This is the only REST endpoint from which non-partitioned topics could be created.", + "operationId": "PersistentTopics_createNonPartitionedTopic", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "Key value pair properties for the topic metadata", + "in": "body", + "name": "body", + "required": false, + "schema": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or namespace doesn't exist" + }, + "409": { + "description": "Partitioned topic already exist" + }, + "412": { + "description": "Failed Reason : Name is invalid or Namespace does not have any clusters configured" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Create a non-partitioned topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/all_subscription/expireMessages/{expireTimeInSeconds}": { + "post": { + "description": "", + "operationId": "PersistentTopics_expireMessagesForAllSubscriptions", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": 0, + "description": "Expires beyond the specified number of seconds", + "format": "int32", + "in": "path", + "name": "expireTimeInSeconds", + "required": true, + "type": "integer" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic or subscription does not exist" + }, + "405": { + "description": "Expiry messages on a non-persistent topic is not allowed" + }, + "412": { + "description": "Can't find owner for topic" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Expiry messages on all subscriptions of topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/autoSubscriptionCreation": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeAutoSubscriptionCreation", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Topic does not exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove autoSubscriptionCreation ina a topic.", + "tags": [ + "persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getAutoSubscriptionCreation", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/AutoSubscriptionCreationOverrideImpl" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Topic does not exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Get autoSubscriptionCreation info in a topic", + "tags": [ + "persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setAutoSubscriptionCreation", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "Settings for automatic subscription creation", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/AutoSubscriptionCreationOverrideImpl" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Override namespace's allowAutoSubscriptionCreation setting for a topic", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/backlog": { + "get": { + "description": "", + "operationId": "PersistentTopics_getBacklog", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/PersistentOfflineTopicStats" + } + }, + "404": { + "description": "Namespace does not exist" + }, + "412": { + "description": "Topic name is not valid" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Get estimated backlog for offline topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/backlogQuota": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeBacklogQuota", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "enum": [ + "destination_storage", + "message_age" + ], + "in": "query", + "name": "backlogQuotaType", + "required": false, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove a backlog quota policy from a topic.", + "tags": [ + "persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setBacklogQuota", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "enum": [ + "destination_storage", + "message_age" + ], + "in": "query", + "name": "backlogQuotaType", + "required": false, + "type": "string" + }, + { + "description": "backlog quota policies for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/BacklogQuotaImpl" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "Specified backlog quota exceeds retention quota. Increase retention quota and retry request" + } + }, + "summary": "Set a backlog quota for a topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/backlogQuotaMap": { + "get": { + "description": "", + "operationId": "PersistentTopics_getBacklogQuotaMap", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "additionalProperties": { + "$ref": "#/definitions/BacklogQuota" + }, + "type": "object" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Topic policy or namespace does not exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + } + }, + "summary": "Get backlog quota map on a topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/backlogSize": { + "put": { + "description": "", + "operationId": "PersistentTopics_getBacklogSizeByMessageId", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int64", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic does not exist" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Calculate backlog size by a message ID (in bytes).", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/compaction": { + "get": { + "description": "", + "operationId": "PersistentTopics_compactionStatus", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/LongRunningProcessStatus" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic does not exist, or compaction hasn't run" + }, + "405": { + "description": "Operation is not allowed on the persistent topic" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Get the status of a compaction operation for a topic.", + "tags": [ + "persistent topic" + ] + }, + "put": { + "description": "", + "operationId": "PersistentTopics_compact", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic does not exist" + }, + "405": { + "description": "Operation is not allowed on the persistent topic" + }, + "409": { + "description": "Compaction already running" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Trigger a compaction operation on a topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/compactionThreshold": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeCompactionThreshold", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove compaction threshold configuration for specified topic.", + "tags": [ + "persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getCompactionThreshold", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int64", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Get compaction threshold configuration for specified topic.", + "tags": [ + "persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setCompactionThreshold", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "description": "Dispatch rate for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "format": "int64", + "type": "integer" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Set compaction threshold configuration for specified topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/createMissedPartitions": { + "post": { + "description": "", + "operationId": "PersistentTopics_createMissedPartitions", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant does not exist" + }, + "409": { + "description": "Partitioned topic does not exist" + }, + "412": { + "description": "Partitioned topic name is invalid" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Create missed partitions of an existing partitioned topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/deduplicationEnabled": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeDeduplication", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove deduplication configuration for specified topic.", + "tags": [ + "persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getDeduplication", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "type": "boolean" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + } + }, + "summary": "Get deduplication configuration of a topic.", + "tags": [ + "persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setDeduplication", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "DeduplicationEnabled policies for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "type": "boolean" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + } + }, + "summary": "Set deduplication enabled on a topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/deduplicationSnapshotInterval": { + "delete": { + "description": "", + "operationId": "PersistentTopics_deleteDeduplicationSnapshotInterval", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + } + }, + "summary": "Delete deduplicationSnapshotInterval config on a topic.", + "tags": [ + "persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getDeduplicationSnapshotInterval", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int32", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Get deduplicationSnapshotInterval config on a topic.", + "tags": [ + "persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setDeduplicationSnapshotInterval", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "Interval to take deduplication snapshot for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "format": "int32", + "type": "integer" + } + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + } + }, + "summary": "Set deduplicationSnapshotInterval config on a topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/delayedDelivery": { + "delete": { + "description": "", + "operationId": "PersistentTopics_deleteDelayedDeliveryPolicies", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + } + }, + "summary": "Set delayed delivery messages config on a topic.", + "tags": [ + "persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getDelayedDeliveryPolicies", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/DelayedDeliveryPolicies" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Get delayed delivery messages config on a topic.", + "tags": [ + "persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setDelayedDeliveryPolicies", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "Delayed delivery policies for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/DelayedDeliveryPolicies" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + } + }, + "summary": "Set delayed delivery messages config on a topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/dispatchRate": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeDispatchRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove message dispatch rate configuration for specified topic.", + "tags": [ + "persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getDispatchRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/DispatchRateImpl" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Get dispatch rate configuration for specified topic.", + "tags": [ + "persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setDispatchRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "description": "Dispatch rate for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/DispatchRateImpl" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Set message dispatch rate configuration for specified topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/dispatcherPauseOnAckStatePersistent": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeDispatcherPauseOnAckStatePersistent", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove dispatcher pause on ack state persistent configuration for specified topic.", + "tags": [ + "persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getDispatcherPauseOnAckStatePersistent", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int32", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Get dispatcher pause on ack state persistent config on a topic.", + "tags": [ + "persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setDispatcherPauseOnAckStatePersistent", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Set dispatcher pause on ack state persistent configuration for specified topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/entryFilters": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeEntryFilters", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected thiscall to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove entry filters for specified topic.", + "tags": [ + "persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getEntryFilters", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/EntryFilters" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenants or Namespace doesn't exist" + } + }, + "summary": "Get entry filters for a topic.", + "tags": [ + "persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setEntryFilters", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected thiscall to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "Entry filters for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/EntryFilters" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Set entry filters for specified topic", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/examinemessage": { + "get": { + "description": "", + "operationId": "PersistentTopics_examineMessage", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": "latest", + "description": "Relative start position to examine message.It can be 'latest' or 'earliest'", + "enum": [ + "latest", + "earliest" + ], + "in": "query", + "name": "initialPosition", + "required": false, + "type": "string" + }, + { + "default": 1, + "description": "The position of messages (default 1)", + "format": "int64", + "in": "query", + "name": "messagePosition", + "required": false, + "type": "integer" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successfully retrieved the message. The response is a binary byte stream containing the message data. Clients need to parse this binary stream based on the message metadata provided in the response headers." + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic, the message position does not exist" + }, + "405": { + "description": "If given partitioned topic" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Examine a specific message on a topic by position relative to the earliest or the latest message.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/inactiveTopicPolicies": { + "delete": { + "description": "", + "operationId": "PersistentTopics_deleteInactiveTopicPolicies", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + } + }, + "summary": "Delete inactive topic policies on a topic.", + "tags": [ + "persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getInactiveTopicPolicies", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/InactiveTopicPolicies" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Get inactive topic policies on a topic.", + "tags": [ + "persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setInactiveTopicPolicies", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "description": "inactive topic policies for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/InactiveTopicPolicies" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + } + }, + "summary": "Set inactive topic policies on a topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/internal-info": { + "get": { + "description": "", + "operationId": "PersistentTopics_getManagedLedgerInfo", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/PartitionedManagedLedgerInfo" + } + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic does not exist" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Get the stored topic metadata.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/internalStats": { + "get": { + "description": "", + "operationId": "PersistentTopics_getInternalStats", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "metadata", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/PersistentTopicInternalStats" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic does not exist" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Get the internal stats for the topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/lastMessageId": { + "get": { + "description": "", + "operationId": "PersistentTopics_getLastMessageId", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/MessageIdAdv" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic does not exist" + }, + "405": { + "description": "Operation is not allowed on the persistent topic" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Return the last commit message id of topic", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/ledger/{ledgerId}/entry/{entryId}": { + "get": { + "description": "", + "operationId": "PersistentTopics_getMessageById", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "The ledger id", + "format": "int64", + "in": "path", + "name": "ledgerId", + "required": true, + "type": "integer" + }, + { + "description": "The entry id", + "format": "int64", + "in": "path", + "name": "entryId", + "required": true, + "type": "integer" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successfully retrieved the message. The response is a binary byte stream containing the message data. Clients need to parse this binary stream based on the message metadata provided in the response headers." + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic, subscription or the message position does not exist" + }, + "405": { + "description": "Skipping messages on a non-persistent topic is not allowed" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Get message by its messageId.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/maxConsumers": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeMaxConsumers", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove maxConsumers config for specified topic.", + "tags": [ + "persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getMaxConsumers", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int32", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Get maxConsumers config for specified topic.", + "tags": [ + "persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setMaxConsumers", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "The max consumers of the topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "format": "int32", + "type": "integer" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "Invalid value of maxConsumers" + } + }, + "summary": "Set maxConsumers config for specified topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/maxConsumersPerSubscription": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeMaxConsumersPerSubscription", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove max consumers per subscription configuration for specified topic.", + "tags": [ + "persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getMaxConsumersPerSubscription", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int32", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Get max consumers per subscription configuration for specified topic.", + "tags": [ + "persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setMaxConsumersPerSubscription", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "Dispatch rate for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "format": "int32", + "type": "integer" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Set max consumers per subscription configuration for specified topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/maxMessageSize": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeMaxMessageSize", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove maxMessageSize config for specified topic.", + "tags": [ + "persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getMaxMessageSize", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int32", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Get maxMessageSize config for specified topic.", + "tags": [ + "persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setMaxMessageSize", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "The max message size of the topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "format": "int32", + "type": "integer" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "Invalid value of maxConsumers" + } + }, + "summary": "Set maxMessageSize config for specified topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/maxProducers": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeMaxProducers", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove maxProducers config for specified topic.", + "tags": [ + "persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getMaxProducers", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int32", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Get maxProducers config for specified topic.", + "tags": [ + "persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setMaxProducers", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "description": "The max producers of the topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "format": "int32", + "type": "integer" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "Invalid value of maxProducers" + } + }, + "summary": "Set maxProducers config for specified topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/maxSubscriptionsPerTopic": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeMaxSubscriptionsPerTopic", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove maxSubscriptionsPerTopic config for specified topic.", + "tags": [ + "persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getMaxSubscriptionsPerTopic", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int32", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Get maxSubscriptionsPerTopic config for specified topic.", + "tags": [ + "persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setMaxSubscriptionsPerTopic", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "The max subscriptions of the topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "format": "int32", + "type": "integer" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "Invalid value of maxSubscriptionsPerTopic" + } + }, + "summary": "Set maxSubscriptionsPerTopic config for specified topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/maxUnackedMessagesOnConsumer": { + "delete": { + "description": "", + "operationId": "PersistentTopics_deleteMaxUnackedMessagesOnConsumer", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + } + }, + "summary": "Delete max unacked messages per consumer config on a topic.", + "tags": [ + "persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getMaxUnackedMessagesOnConsumer", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int32", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Get max unacked messages per consumer config on a topic.", + "tags": [ + "persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setMaxUnackedMessagesOnConsumer", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "Max unacked messages on consumer policies for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "format": "int32", + "type": "integer" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + } + }, + "summary": "Set max unacked messages per consumer config on a topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/maxUnackedMessagesOnSubscription": { + "delete": { + "description": "", + "operationId": "PersistentTopics_deleteMaxUnackedMessagesOnSubscription", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + } + }, + "summary": "Delete max unacked messages per subscription config on a topic.", + "tags": [ + "persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getMaxUnackedMessagesOnSubscription", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int32", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Get max unacked messages per subscription config on a topic.", + "tags": [ + "persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setMaxUnackedMessagesOnSubscription", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "Max unacked messages on subscription policies for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "format": "int32", + "type": "integer" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + } + }, + "summary": "Set max unacked messages per subscription config on a topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/messageTTL": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeMessageTTL", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Not authenticate to perform the request or policy is read only" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, enable the topic level policy and retry" + }, + "412": { + "description": "Invalid message TTL value" + } + }, + "summary": "Remove message TTL in seconds for a topic", + "tags": [ + "persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getMessageTTL", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "format": "int32", + "type": "integer" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, enable the topic level policy and retry" + } + }, + "summary": "Get message TTL in seconds for a topic", + "tags": [ + "persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setMessageTTL", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "TTL in seconds for the specified topic", + "format": "int32", + "in": "query", + "name": "messageTTL", + "required": true, + "type": "integer" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Not authenticate to perform the request or policy is read only" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, enable the topic level policy and retry" + }, + "412": { + "description": "Invalid message TTL value" + } + }, + "summary": "Set message TTL in seconds for a topic", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/messageid/{timestamp}": { + "get": { + "description": "", + "operationId": "PersistentTopics_getMessageIdByTimestamp", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "Specify the timestamp", + "format": "int64", + "in": "path", + "name": "timestamp", + "required": true, + "type": "integer" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/MessageIdAdv" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic does not exist" + }, + "405": { + "description": "Topic is not non-partitioned and persistent" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Get message ID published at or just after this absolute timestamp (in ms).", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/offload": { + "get": { + "description": "", + "operationId": "PersistentTopics_offloadStatus", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/OffloadProcessStatus" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic does not exist" + }, + "405": { + "description": "Operation is not allowed on the persistent topic" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Offload a prefix of a topic to long term storage", + "tags": [ + "persistent topic" + ] + }, + "put": { + "description": "", + "operationId": "PersistentTopics_triggerOffload", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "400": { + "description": "Message ID is null" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic does not exist" + }, + "405": { + "description": "Operation is not allowed on the persistent topic" + }, + "409": { + "description": "Offload already running" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Offload a prefix of a topic to long term storage", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/offloadPolicies": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeOffloadPolicies", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + } + }, + "summary": "Delete offload policies on a topic.", + "tags": [ + "persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getOffloadPolicies", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/OffloadPoliciesImpl" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Get offload policies on a topic.", + "tags": [ + "persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setOffloadPolicies", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "description": "Offload policies for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/OffloadPoliciesImpl" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + } + }, + "summary": "Set offload policies on a topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/partitioned-internalStats": { + "get": { + "description": "", + "operationId": "PersistentTopics_getPartitionedStatsInternal", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/PartitionedTopicInternalStats" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic does not exist" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Get the stats-internal for the partitioned topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/partitioned-stats": { + "get": { + "description": "", + "operationId": "PersistentTopics_getPartitionedStats", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": true, + "description": "Get per partition stats", + "in": "query", + "name": "perPartition", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "If return precise backlog or imprecise backlog", + "in": "query", + "name": "getPreciseBacklog", + "required": false, + "type": "boolean" + }, + { + "default": true, + "description": "If return backlog size for each subscription, require locking on ledger so be careful not to use when there's heavy traffic.", + "in": "query", + "name": "subscriptionBacklogSize", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "If return the earliest time in backlog", + "in": "query", + "name": "getEarliestTimeInBacklog", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "If exclude the publishers", + "in": "query", + "name": "excludePublishers", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "If exclude the consumers", + "in": "query", + "name": "excludeConsumers", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/PartitionedTopicStatsImpl" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic does not exist" + }, + "412": { + "description": "Partitioned topic name is invalid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Get the stats for the partitioned topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/partitions": { + "delete": { + "description": "It will also delete all the partitions of the topic if it exists.", + "operationId": "PersistentTopics_deletePartitionedTopic", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Stop all producer/consumer/replicator and delete topic forcefully", + "in": "query", + "name": "force", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Partitioned topic does not exist" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "Partitioned topic name is invalid" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Delete a partitioned topic.", + "tags": [ + "persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getPartitionedMetadata", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Is check configuration required to automatically create topic", + "in": "query", + "name": "checkAllowAutoCreation", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/PartitionedTopicMetadata" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Partitioned topic does not exist" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "Partitioned topic name is invalid" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Get partitioned topic metadata.", + "tags": [ + "persistent topic" + ] + }, + "post": { + "description": "It increments partitions of existing partitioned-topic", + "operationId": "PersistentTopics_updatePartitionedTopic", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "updateLocalTopicOnly", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "force", + "required": false, + "type": "boolean" + }, + { + "description": "The number of partitions for the topic", + "in": "body", + "name": "body", + "required": true, + "schema": { + "default": 0, + "format": "int32", + "type": "integer" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Update topic partition successful." + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Unauthenticated" + }, + "403": { + "description": "Forbidden/Unauthorized" + }, + "404": { + "description": "Topic does not exist" + }, + "412": { + "description": "Partitioned topic name is invalid" + }, + "422": { + "description": "The number of partitions should be more than 0 and less than or equal to maxNumPartitionsPerPartitionedTopic and number of new partitions must be greater than existing number of partitions" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Increment partitions of an existing partitioned topic.", + "tags": [ + "persistent topic" + ] + }, + "put": { + "description": "It needs to be called before creating a producer on a partitioned topic.", + "operationId": "PersistentTopics_createPartitionedTopic", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "The number of partitions for the topic", + "in": "body", + "name": "body", + "required": true, + "schema": { + "default": 0, + "format": "int32", + "type": "integer" + } + }, + { + "default": false, + "in": "query", + "name": "createLocalTopicOnly", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or namespace doesn't exist" + }, + "406": { + "description": "The number of partitions should be more than 0 and less than or equal to maxNumPartitionsPerPartitionedTopic" + }, + "409": { + "description": "Partitioned topic already exist" + }, + "412": { + "description": "Failed Reason : Name is invalid or Namespace does not have any clusters configured" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Create a partitioned topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/permissions": { + "get": { + "description": "Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at thenamespace level combined (union) with any eventual specific permission set on the topic.Returns a nested map structure which Swagger does not fully support for display. Structure: Map>. Please refer to this structure for details.", + "operationId": "PersistentTopics_getPermissionsOnTopic", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "additionalProperties": { + "enum": [ + "produce", + "consume", + "functions", + "sources", + "sinks", + "packages" + ], + "type": "string" + }, + "type": "object" + } + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "tenant/namespace/topic doesn't exit" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Get permissions on a topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/permissions/{role}": { + "delete": { + "description": "Revoke permissions to a role on a single topic. If the permission was not set at the topiclevel, but rather at the namespace level, this operation will return an error (HTTP status code 412).", + "operationId": "PersistentTopics_revokePermissionsOnTopic", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "Client role to which grant permissions", + "in": "path", + "name": "role", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "tenant/namespace/topic doesn't exit" + }, + "412": { + "description": "Permissions are not set at the topic level" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Revoke permissions on a topic.", + "tags": [ + "persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_grantPermissionsOnTopic", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "Client role to which grant permissions", + "in": "path", + "name": "role", + "required": true, + "type": "string" + }, + { + "description": "Actions to be granted (produce,functions,consume)", + "in": "body", + "name": "body", + "required": false, + "schema": { + "items": { + "enum": [ + "produce", + "consume", + "functions", + "sources", + "sinks", + "packages" + ], + "type": "string" + }, + "type": "array" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "tenant/namespace/topic doesn't exit" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Grant a new permission to a role on a single topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/persistence": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removePersistence", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove configuration of persistence policies for specified topic.", + "tags": [ + "persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getPersistence", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/PersistencePolicies" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Get configuration of persistence policies for specified topic.", + "tags": [ + "persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setPersistence", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "description": "Bookkeeper persistence policies for specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/PersistencePolicies" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "400": { + "description": "Invalid persistence policies" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Set configuration of persistence policies for specified topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/properties": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeProperties", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "key", + "required": false, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Partitioned topic does not exist" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "Partitioned topic name is invalid" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Remove the key in properties on the given topic.", + "tags": [ + "persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getProperties", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic does not exist" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "Topic name is invalid" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Get topic properties.", + "tags": [ + "persistent topic" + ] + }, + "put": { + "description": "", + "operationId": "PersistentTopics_updateProperties", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "Key value pair properties for the topic metadata", + "in": "body", + "name": "body", + "required": false, + "schema": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic or subscription does not exist" + }, + "405": { + "description": "Method Not Allowed" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Update the properties on the given topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/publishRate": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removePublishRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove message publish rate configuration for specified topic.", + "tags": [ + "persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getPublishRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/PublishRate" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Get publish rate configuration for specified topic.", + "tags": [ + "persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setPublishRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "Dispatch rate for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/PublishRate" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Set message publish rate configuration for specified topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/replication": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeReplicationClusters", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove the replication clusters from a topic.", + "tags": [ + "persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getReplicationClusters", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, enable the topic level policy and retry" + } + }, + "summary": "Get the replication clusters for a topic", + "tags": [ + "persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setReplicationClusters", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "List of replication clusters", + "in": "body", + "name": "body", + "required": true, + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "Topic is not global or invalid cluster ids" + } + }, + "summary": "Set the replication clusters for a topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/replicatorDispatchRate": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeReplicatorDispatchRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove replicatorDispatchRate config for specified topic.", + "tags": [ + "persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getReplicatorDispatchRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/DispatchRate" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Get replicatorDispatchRate config for specified topic.", + "tags": [ + "persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setReplicatorDispatchRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "Replicator dispatch rate of the topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/DispatchRateImpl" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "Invalid value of replicatorDispatchRate" + } + }, + "summary": "Set replicatorDispatchRate config for specified topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/retention": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeRetention", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "Retention Quota must exceed backlog quota" + } + }, + "summary": "Remove retention configuration for specified topic.", + "tags": [ + "persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getRetention", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/RetentionPolicies" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Get retention configuration for specified topic.", + "tags": [ + "persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setRetention", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "description": "Retention policies for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/RetentionPolicies" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "Retention Quota must exceed backlog quota" + } + }, + "summary": "Set retention configuration for specified topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/schemaCompatibilityStrategy": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeSchemaCompatibilityStrategy", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "Strategy used to check the compatibility of new schema", + "in": "body", + "name": "body", + "required": false, + "schema": { + "type": "string" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Operation not allowed on persistent topic" + } + }, + "summary": "Remove schema compatibility strategy on a topic", + "tags": [ + "persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getSchemaCompatibilityStrategy", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the cluster", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "enum": [ + "UNDEFINED", + "ALWAYS_INCOMPATIBLE", + "ALWAYS_COMPATIBLE", + "BACKWARD", + "FORWARD", + "FULL", + "BACKWARD_TRANSITIVE", + "FORWARD_TRANSITIVE", + "FULL_TRANSITIVE" + ], + "type": "string" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Operation not allowed on persistent topic" + } + }, + "summary": "Get schema compatibility strategy on a topic", + "tags": [ + "persistent topic" + ] + }, + "put": { + "description": "", + "operationId": "PersistentTopics_setSchemaCompatibilityStrategy", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "Strategy used to check the compatibility of new schema", + "in": "body", + "name": "body", + "required": false, + "schema": { + "type": "string" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Operation not allowed on persistent topic" + } + }, + "summary": "Set schema compatibility strategy on a topic", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/schemaValidationEnforced": { + "get": { + "description": "", + "operationId": "PersistentTopics_getSchemaValidationEnforced", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "type": "boolean" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenants or Namespace doesn't exist" + } + }, + "summary": "Get schema validation enforced flag for topic.", + "tags": [ + "persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setSchemaValidationEnforced", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "in": "body", + "name": "body", + "required": true, + "schema": { + "type": "boolean" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or Namespace doesn't exist" + }, + "412": { + "description": "schemaValidationEnforced value is not valid" + } + }, + "summary": "Set schema validation enforced flag on topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/shadowTopics": { + "delete": { + "description": "", + "operationId": "PersistentTopics_deleteShadowTopics", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Delete shadow topics for a topic", + "tags": [ + "persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getShadowTopics", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, enable the topic level policy and retry" + } + }, + "summary": "Get the shadow topic list for a topic", + "tags": [ + "persistent topic" + ] + }, + "put": { + "description": "", + "operationId": "PersistentTopics_setShadowTopics", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "List of shadow topics", + "in": "body", + "name": "body", + "required": true, + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Set shadow topic list for a topic", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/stats": { + "get": { + "description": "", + "operationId": "PersistentTopics_getStats", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "If return precise backlog or imprecise backlog", + "in": "query", + "name": "getPreciseBacklog", + "required": false, + "type": "boolean" + }, + { + "default": true, + "description": "If return backlog size for each subscription, require locking on ledger so be careful not to use when there's heavy traffic.", + "in": "query", + "name": "subscriptionBacklogSize", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "If return time of the earliest message in backlog", + "in": "query", + "name": "getEarliestTimeInBacklog", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "If exclude the publishers", + "in": "query", + "name": "excludePublishers", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "If exclude the consumers", + "in": "query", + "name": "excludeConsumers", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/PersistentTopicStats" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic does not exist" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Get the stats for the topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/subscribeRate": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeSubscribeRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "Subscribe rate for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/SubscribeRate" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove subscribe rate configuration for specified topic.", + "tags": [ + "persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getSubscribeRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/SubscribeRate" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Get subscribe rate configuration for specified topic.", + "tags": [ + "persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setSubscribeRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "Subscribe rate for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/SubscribeRate" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Set subscribe rate configuration for specified topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/subscription/{subName}": { + "delete": { + "description": "The subscription cannot be deleted if delete is not forcefully and there are any active consumers attached to it. Force delete ignores connected consumers and deletes subscription by explicitly closing them.", + "operationId": "PersistentTopics_deleteSubscription", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "Subscription to be deleted", + "in": "path", + "name": "subName", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Disconnect and close all consumers and delete subscription forcefully", + "in": "query", + "name": "force", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic or subscription does not exist" + }, + "412": { + "description": "Subscription has active consumers" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Delete a subscription.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/analyzeBacklog": { + "post": { + "description": "", + "operationId": "PersistentTopics_analyzeSubscriptionBacklog", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "Subscription", + "in": "path", + "name": "subName", + "required": true, + "type": "string" + }, + { + "description": "messageId to start the analysis", + "in": "body", + "name": "position", + "required": false, + "schema": { + "$ref": "#/definitions/ResetCursorData" + } + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic or subscription does not exist" + }, + "405": { + "description": "Method Not Allowed" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Analyse a subscription, by scanning all the unprocessed messages", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/expireMessages": { + "post": { + "description": "", + "operationId": "PersistentTopics_expireTopicMessages", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "Subscription to be Expiry messages on", + "in": "path", + "name": "subName", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "messageId to reset back to (ledgerId:entryId)", + "in": "body", + "name": "messageId", + "required": false, + "schema": { + "$ref": "#/definitions/ResetCursorData" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic or subscription does not exist" + }, + "405": { + "description": "Expiry messages on a non-persistent topic is not allowed" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Expiry messages on a topic subscription.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/expireMessages/{expireTimeInSeconds}": { + "post": { + "description": "", + "operationId": "PersistentTopics_expireTopicMessages", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "Subscription to be Expiry messages on", + "in": "path", + "name": "subName", + "required": true, + "type": "string" + }, + { + "default": 0, + "description": "Expires beyond the specified number of seconds", + "format": "int32", + "in": "path", + "name": "expireTimeInSeconds", + "required": true, + "type": "integer" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic or subscription does not exist" + }, + "405": { + "description": "Expiry messages on a non-persistent topic is not allowed" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Expiry messages on a topic subscription.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/position/{messagePosition}": { + "get": { + "description": "", + "operationId": "PersistentTopics_peekNthMessage", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "Subscribed message expired", + "in": "path", + "name": "subName", + "required": true, + "type": "string" + }, + { + "default": 1, + "description": "The number of messages (default 1)", + "format": "int32", + "in": "path", + "name": "messagePosition", + "required": true, + "type": "integer" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successfully retrieved the message. The response is a binary byte stream containing the message data. Clients need to parse this binary stream based on the message metadata provided in the response headers." + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic, subscription or the message position does not exist" + }, + "405": { + "description": "Skipping messages on a non-persistent topic is not allowed" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Peek nth message on a topic subscription.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/properties": { + "get": { + "description": "", + "operationId": "PersistentTopics_getSubscriptionProperties", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "Subscription", + "in": "path", + "name": "subName", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic or subscription does not exist" + }, + "405": { + "description": "Method Not Allowed" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Return all the properties on the given subscription", + "tags": [ + "persistent topic" + ] + }, + "put": { + "description": "", + "operationId": "PersistentTopics_updateSubscriptionProperties", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "Subscription to update", + "in": "path", + "name": "subName", + "required": true, + "type": "string" + }, + { + "description": "The new properties", + "in": "body", + "name": "body", + "required": false, + "schema": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + } + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic or subscription does not exist" + }, + "405": { + "description": "Method Not Allowed" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Replace all the properties on the given subscription", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/replicatedSubscriptionStatus": { + "get": { + "description": "", + "operationId": "PersistentTopics_getReplicatedSubscriptionStatus", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "Name of subscription", + "in": "path", + "name": "subName", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "additionalProperties": { + "type": "boolean" + }, + "type": "object" + } + }, + "401": { + "description": "Don't have permission to administrate resources" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "412": { + "description": "Can't find owner for topic" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Get replicated subscription status on a topic.", + "tags": [ + "persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setReplicatedSubscriptionStatus", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "Name of subscription", + "in": "path", + "name": "subName", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "Whether to enable replicated subscription", + "in": "body", + "name": "body", + "required": true, + "schema": { + "type": "boolean" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant or subscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Topic or subscription does not exist" + }, + "405": { + "description": "Operation not allowed on this topic" + }, + "412": { + "description": "Can't find owner for topic" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Enable or disable a replicated subscription on a topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/resetcursor": { + "post": { + "description": "It fence cursor and disconnects all active consumers before resetting cursor.", + "operationId": "PersistentTopics_resetCursorOnPosition", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "Subscription to reset position on", + "in": "path", + "name": "subName", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "messageId to reset back to (ledgerId:entryId)", + "in": "body", + "name": "messageId", + "required": false, + "schema": { + "$ref": "#/definitions/ResetCursorData" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic or subscription does not exist" + }, + "405": { + "description": "Not supported for partitioned topics" + }, + "412": { + "description": "Unable to find position for position specified" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Reset subscription to message position closest to given position.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/resetcursor/{timestamp}": { + "post": { + "description": "It fence cursor and disconnects all active consumers before resetting cursor.", + "operationId": "PersistentTopics_resetCursor", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "Subscription to reset position on", + "in": "path", + "name": "subName", + "required": true, + "type": "string" + }, + { + "description": "the timestamp to reset back", + "format": "int64", + "in": "path", + "name": "timestamp", + "required": true, + "type": "integer" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic or subscription does not exist" + }, + "405": { + "description": "Method Not Allowed" + }, + "412": { + "description": "Failed to reset cursor on subscription or Unable to find position for timestamp specified" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Reset subscription to message position closest to absolute timestamp (in ms).", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/skip/{numMessages}": { + "post": { + "description": "", + "operationId": "PersistentTopics_skipMessages", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "Name of subscription", + "in": "path", + "name": "subName", + "required": true, + "type": "string" + }, + { + "default": 0, + "description": "The number of messages to skip", + "format": "int32", + "in": "path", + "name": "numMessages", + "required": true, + "type": "integer" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic or subscription does not exist" + }, + "405": { + "description": "Skipping messages on a partitioned topic is not allowed" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Skipping messages on a topic subscription.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/skip_all": { + "post": { + "description": "Completely clears the backlog on the subscription.", + "operationId": "PersistentTopics_skipAllMessages", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "Name of subscription", + "in": "path", + "name": "subName", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic or subscription does not exist" + }, + "405": { + "description": "Operation not allowed on non-persistent topic" + }, + "412": { + "description": "Can't find owner for topic" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Skip all messages on a topic subscription.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/subscription/{subscriptionName}": { + "put": { + "description": "Creates a subscription on the topic at the specified message id", + "operationId": "PersistentTopics_createSubscription", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "Name of subscription to be created", + "in": "path", + "name": "subscriptionName", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "messageId where to create the subscription. It can be 'latest', 'earliest' or (ledgerId:entryId)", + "in": "body", + "name": "messageId", + "required": false, + "schema": { + "$ref": "#/definitions/ResetCursorData" + } + }, + { + "description": "Is replicated required to perform this operation", + "in": "query", + "name": "replicated", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "400": { + "description": "Create subscription on non persistent topic is not supported" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic or subscription does not exist" + }, + "405": { + "description": "Not supported for partitioned topics" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Create a subscription on the topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/subscriptionDispatchRate": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeSubscriptionDispatchRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove subscription message dispatch rate configuration for specified topic.", + "tags": [ + "persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getSubscriptionDispatchRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/DispatchRate" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Get subscription message dispatch rate configuration for specified topic.", + "tags": [ + "persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setSubscriptionDispatchRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "description": "Subscription message dispatch rate for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/DispatchRateImpl" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Set subscription message dispatch rate configuration for specified topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/subscriptionTypesEnabled": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeSubscriptionTypesEnabled", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, to enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove subscription types enabled for specified topic.", + "tags": [ + "persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getSubscriptionTypesEnabled", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "enum": [ + "Exclusive", + "Shared", + "Failover", + "Key_Shared" + ], + "type": "string" + }, + "type": "array" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Get is enable sub type fors specified topic.", + "tags": [ + "persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setSubscriptionTypesEnabled", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "description": "Enable sub types for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "items": { + "enum": [ + "Exclusive", + "Shared", + "Failover", + "Key_Shared" + ], + "type": "string" + }, + "type": "array" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Set is enable sub types for specified topic", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/subscriptions": { + "get": { + "description": "", + "operationId": "PersistentTopics_getSubscriptions", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic does not exist" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Get the list of persistent subscriptions for a given topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/terminate": { + "post": { + "description": "", + "operationId": "PersistentTopics_terminate", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation terminated successfully. The response includes the 'lastMessageId', which is the identifier of the last message processed.", + "schema": { + "$ref": "#/definitions/MessageIdAdv" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic does not exist" + }, + "405": { + "description": "Termination of a partitioned topic is not allowed" + }, + "406": { + "description": "Need to provide a persistent topic name" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "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", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/terminate/partitions": { + "post": { + "description": "", + "operationId": "PersistentTopics_terminatePartitionedTopic", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic does not exist" + }, + "405": { + "description": "Termination of a non-partitioned topic is not allowed" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "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", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/trim": { + "post": { + "description": "", + "operationId": "PersistentTopics_trimTopic", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant orsubscriber is not authorized to access this operation" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic does not exist" + }, + "405": { + "description": "Operation is not allowed on the persistent topic" + }, + "412": { + "description": "Topic name is not valid" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": " Trim a topic", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/truncate": { + "delete": { + "description": "The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers.", + "operationId": "PersistentTopics_truncateTopic", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic does not exist" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Truncate a topic.", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/unload": { + "put": { + "description": "", + "operationId": "PersistentTopics_unloadTopic", + "parameters": [ + { + "description": "Specify the tenant", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Specify the namespace", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Specify topic name", + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "401": { + "description": "Don't have permission to administrate resources on this tenant" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic does not exist" + }, + "409": { + "description": "Concurrent modification" + }, + "412": { + "description": "Topic name is not valid or can't find owner for topic" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Failed to validate global cluster configuration" + } + }, + "summary": "Unload a topic", + "tags": [ + "persistent topic" + ] + } + }, + "/persistent/{tenant}/{namespace}/{topic}/{subName}/dispatchRate": { + "delete": { + "description": "", + "operationId": "PersistentTopics_removeSubscriptionLevelDispatchRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "subName", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove message dispatch rate configuration for specified subscription.", + "tags": [ + "persistent topic" + ] + }, + "get": { + "description": "", + "operationId": "PersistentTopics_getSubscriptionLevelDispatchRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "subName", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "applied", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/DispatchRate" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Get message dispatch rate configuration for specified subscription.", + "tags": [ + "persistent topic" + ] + }, + "post": { + "description": "", + "operationId": "PersistentTopics_setSubscriptionLevelDispatchRate", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "subName", + "required": true, + "type": "string" + }, + { + "default": false, + "description": "Whether leader broker redirected this call to this broker. For internal use.", + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "isGlobal", + "required": false, + "type": "boolean" + }, + { + "description": "Subscription message dispatch rate for the specified topic", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/DispatchRateImpl" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace or topic doesn't exist" + }, + "405": { + "description": "Topic level policy is disabled, please enable the topic level policy and retry" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Set message dispatch rate configuration for specified subscription.", + "tags": [ + "persistent topic" + ] + } + }, + "/resource-quotas": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "ResourceQuotas_getDefaultResourceQuota", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "403": { + "description": "Don't have admin permission" + } + }, + "summary": "Get the default quota", + "tags": [ + "resource-quotas" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "ResourceQuotas_setDefaultResourceQuota", + "parameters": [ + { + "description": "Default resource quota", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/ResourceQuota" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "403": { + "description": "Don't have admin permission" + } + }, + "summary": "Set the default quota", + "tags": [ + "resource-quotas" + ] + } + }, + "/resource-quotas/{tenant}/{namespace}/{bundle}": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "ResourceQuotas_removeNamespaceBundleResourceQuota", + "parameters": [ + { + "description": "Tenant name", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Namespace name within the specified tenant", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Namespace bundle range", + "in": "path", + "name": "bundle", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace" + }, + "403": { + "description": "Don't have admin permission" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Remove resource quota for a namespace.", + "tags": [ + "resource-quotas" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "ResourceQuotas_getNamespaceBundleResourceQuota", + "parameters": [ + { + "description": "Tenant name", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Namespace name within the specified tenant", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Namespace bundle range", + "in": "path", + "name": "bundle", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/ResourceQuota" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Namespace does not exist" + } + }, + "summary": "Get resource quota of a namespace bundle.", + "tags": [ + "resource-quotas" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "ResourceQuotas_setNamespaceBundleResourceQuota", + "parameters": [ + { + "description": "Tenant name", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "Namespace name within the specified tenant", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "Namespace bundle range", + "in": "path", + "name": "bundle", + "required": true, + "type": "string" + }, + { + "description": "Resource quota for the specified namespace", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/ResourceQuota" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace" + }, + "403": { + "description": "Don't have admin permission" + }, + "409": { + "description": "Concurrent modification" + } + }, + "summary": "Set resource quota on a namespace.", + "tags": [ + "resource-quotas" + ] + } + }, + "/resourcegroups": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "ResourceGroups_getResourceGroups", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + }, + "403": { + "description": "Don't have admin permission" + } + }, + "summary": "Get the list of all the resourcegroups.", + "tags": [ + "resourcegroups" + ] + } + }, + "/resourcegroups/{resourcegroup}": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "ResourceGroups_deleteResourceGroup", + "parameters": [ + { + "in": "path", + "name": "resourcegroup", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "ResourceGroup doesn't exist" + }, + "409": { + "description": "ResourceGroup is in use" + } + }, + "summary": "Delete a resourcegroup.", + "tags": [ + "resourcegroups" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "ResourceGroups_getResourceGroup", + "parameters": [ + { + "in": "path", + "name": "resourcegroup", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/ResourceGroup" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "ResourceGroup doesn't exist" + } + }, + "summary": "Get the rate limiters specified for a resourcegroup.", + "tags": [ + "resourcegroups" + ] + }, + "put": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "ResourceGroups_createOrUpdateResourceGroup", + "parameters": [ + { + "in": "path", + "name": "resourcegroup", + "required": true, + "type": "string" + }, + { + "description": "Rate limiters for the resourcegroup", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/ResourceGroup" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "cluster doesn't exist" + } + }, + "summary": "Creates a new resourcegroup with the specified rate limiters", + "tags": [ + "resourcegroups" + ] + } + }, + "/schemas/{tenant}/{namespace}/{topic}/compatibility": { + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "SchemasResource_testCompatibility", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "A JSON value presenting a schema payload. An example of the expected schema can be found down here.", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/PostSchemaPayload" + }, + "x-examples": { + "application/json": "{\"type\": \"STRING\", \"schema\": \"\", \"properties\": { \"key1\" : \"value1\" + } }" + } + }, + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/IsCompatibilityResponse" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Client is not authorized or Don't have admin permission" + }, + "403": { + "description": "Client is not authenticated" + }, + "404": { + "description": "Tenant or Namespace or Topic doesn't exist" + }, + "412": { + "description": "Failed to find the ownership for the topic" + }, + "500": { + "description": "Internal Server Error" + } + }, + "summary": "test the schema compatibility", + "tags": [ + "schemas" + ] + } + }, + "/schemas/{tenant}/{namespace}/{topic}/metadata": { + "get": { + "description": "", + "operationId": "SchemasResource_getSchemaMetadata", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/GetAllVersionsSchemaResponse" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Client is not authorized or Don't have admin permission" + }, + "403": { + "description": "Client is not authenticated" + }, + "404": { + "description": "Tenant or Namespace or Topic doesn't exist; or Schema is not found for this topic" + }, + "412": { + "description": "Failed to find the ownership for the topic" + }, + "500": { + "description": "Internal Server Error" + } + }, + "summary": "Get the schema metadata of a topic", + "tags": [ + "schemas" + ] + } + }, + "/schemas/{tenant}/{namespace}/{topic}/schema": { + "delete": { + "description": "", + "operationId": "SchemasResource_deleteSchema", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "force", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/DeleteSchemaResponse" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Client is not authorized or Don't have admin permission" + }, + "403": { + "description": "Client is not authenticated" + }, + "404": { + "description": "Tenant or Namespace or Topic doesn't exist" + }, + "412": { + "description": "Failed to find the ownership for the topic" + }, + "500": { + "description": "Internal Server Error" + } + }, + "summary": "Delete all versions schema of a topic", + "tags": [ + "schemas" + ] + }, + "get": { + "description": "", + "operationId": "SchemasResource_getSchema", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/GetSchemaResponse" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Client is not authorized or Don't have admin permission" + }, + "403": { + "description": "Client is not authenticated" + }, + "404": { + "description": "Tenant or Namespace or Topic doesn't exist; or Schema is not found for this topic" + }, + "412": { + "description": "Failed to find the ownership for the topic" + }, + "500": { + "description": "Internal Server Error" + } + }, + "summary": "Get the schema of a topic", + "tags": [ + "schemas" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "SchemasResource_postSchema", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "A JSON value presenting a schema payload. An example of the expected schema can be found down here.", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/PostSchemaPayload" + }, + "x-examples": { + "application/json": "{\"type\": \"STRING\", \"schema\": \"\", \"properties\": { \"key1\" : \"value1\" + } }" + } + }, + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/PostSchemaResponse" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Client is not authorized or Don't have admin permission" + }, + "403": { + "description": "Client is not authenticated" + }, + "404": { + "description": "Tenant or Namespace or Topic doesn't exist" + }, + "409": { + "description": "Incompatible schema" + }, + "412": { + "description": "Failed to find the ownership for the topic" + }, + "422": { + "description": "Invalid schema data" + }, + "500": { + "description": "Internal Server Error" + } + }, + "summary": "Update the schema of a topic", + "tags": [ + "schemas" + ] + } + }, + "/schemas/{tenant}/{namespace}/{topic}/schema/{version}": { + "get": { + "description": "", + "operationId": "SchemasResource_getSchema", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/GetSchemaResponse" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Client is not authorized or Don't have admin permission" + }, + "403": { + "description": "Client is not authenticated" + }, + "404": { + "description": "Tenant or Namespace or Topic doesn't exist; or Schema is not found for this topic" + }, + "412": { + "description": "Failed to find the ownership for the topic" + }, + "500": { + "description": "Internal Server Error" + } + }, + "summary": "Get the schema of a topic at a given version", + "tags": [ + "schemas" + ] + } + }, + "/schemas/{tenant}/{namespace}/{topic}/schemas": { + "get": { + "description": "", + "operationId": "SchemasResource_getAllSchemas", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/GetAllVersionsSchemaResponse" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Client is not authorized or Don't have admin permission" + }, + "403": { + "description": "Client is not authenticated" + }, + "404": { + "description": "Tenant or Namespace or Topic doesn't exist; or Schema is not found for this topic" + }, + "412": { + "description": "Failed to find the ownership for the topic" + }, + "500": { + "description": "Internal Server Error" + } + }, + "summary": "Get the all schemas of a topic", + "tags": [ + "schemas" + ] + } + }, + "/schemas/{tenant}/{namespace}/{topic}/version": { + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "SchemasResource_getVersionBySchema", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "description": "A JSON value presenting a schema payload. An example of the expected schema can be found down here.", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/PostSchemaPayload" + }, + "x-examples": { + "application/json": "{\"type\": \"STRING\", \"schema\": \"\", \"properties\": { \"key1\" : \"value1\" + } }" + } + }, + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/LongSchemaVersion" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + }, + "401": { + "description": "Client is not authorized or Don't have admin permission" + }, + "403": { + "description": "Client is not authenticated" + }, + "404": { + "description": "Tenant or Namespace or Topic doesn't exist" + }, + "412": { + "description": "Failed to find the ownership for the topic" + }, + "422": { + "description": "Invalid schema data" + }, + "500": { + "description": "Internal Server Error" + } + }, + "summary": "get the version of the schema", + "tags": [ + "schemas" + ] + } + }, + "/tenants": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "TenantsBase_getTenants", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "403": { + "description": "The requester doesn't have admin permissions" + }, + "404": { + "description": "Tenant doesn't exist" + } + }, + "summary": "Get the list of existing tenants.", + "tags": [ + "tenants" + ] + } + }, + "/tenants/{tenant}": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "TenantsBase_deleteTenant", + "parameters": [ + { + "description": "The tenant name", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "force", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "The requester doesn't have admin permissions" + }, + "404": { + "description": "Tenant does not exist" + }, + "405": { + "description": "Broker doesn't allow forced deletion of tenants" + }, + "409": { + "description": "The tenant still has active namespaces" + } + }, + "summary": "Delete a tenant and all namespaces and topics under it.", + "tags": [ + "tenants" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "TenantsBase_getTenantAdmin", + "parameters": [ + { + "description": "The tenant name", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/TenantInfo" + } + }, + "403": { + "description": "The requester doesn't have admin permissions" + }, + "404": { + "description": "Tenant does not exist" + } + }, + "summary": "Get the admin configuration for a given tenant.", + "tags": [ + "tenants" + ] + }, + "post": { + "consumes": [ + "application/json" + ], + "description": "This operation requires Pulsar super-user privileges.", + "operationId": "TenantsBase_updateTenant", + "parameters": [ + { + "description": "The tenant name", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "TenantInfo", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/TenantInfo" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "The requester doesn't have admin permissions" + }, + "404": { + "description": "Tenant does not exist" + }, + "409": { + "description": "Tenant already exists" + }, + "412": { + "description": "Clusters do not exist" + } + }, + "summary": "Update the admins for a tenant.", + "tags": [ + "tenants" + ] + }, + "put": { + "consumes": [ + "application/json" + ], + "description": "This operation requires Pulsar super-user privileges.", + "operationId": "TenantsBase_createTenant", + "parameters": [ + { + "description": "The tenant name", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "TenantInfo", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/TenantInfo" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "403": { + "description": "The requester doesn't have admin permissions" + }, + "409": { + "description": "Tenant already exists" + }, + "412": { + "description": "Clusters do not exist" + } + }, + "summary": "Create a new tenant.", + "tags": [ + "tenants" + ] + } + }, + "/worker-stats/functionsmetrics": { + "get": { + "description": "Requested should be executed by Monitoring agent on each worker to fetch the metrics", + "operationId": "WorkerStats_getStats", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "$ref": "#/definitions/WorkerFunctionInstanceStats" + }, + "type": "array" + } + }, + "401": { + "description": "Don't have admin permission" + }, + "503": { + "description": "Worker service is not running" + } + }, + "summary": "Get metrics for all functions owned by worker" + } + }, + "/worker-stats/metrics": { + "get": { + "description": "Request should be executed by Monitoring agent on each worker to fetch the worker-metrics", + "operationId": "WorkerStats_getMetrics", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "$ref": "#/definitions/Metrics" + }, + "type": "array" + } + }, + "401": { + "description": "Don't have admin permission" + }, + "503": { + "description": "Worker service is not running" + } + }, + "summary": "Gets the metrics for Monitoring" + } + }, + "/worker/assignments": { + "get": { + "description": "Returns a nested map structure which Swagger does not fully support for display.Structure: Map>. Please refer to this structure for details.", + "operationId": "Worker_getAssignments", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "additionalProperties": { + "type": "object" + }, + "type": "object" + } + }, + "403": { + "description": "The requester doesn't have admin permissions" + }, + "503": { + "description": "Worker service is not running" + } + }, + "summary": "Fetches information about which Pulsar Functions are assigned to which Pulsar clusters" + } + }, + "/worker/cluster": { + "get": { + "description": "", + "operationId": "Worker_getCluster", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "$ref": "#/definitions/WorkerInfo" + }, + "type": "array" + } + }, + "403": { + "description": "The requester doesn't have admin permissions" + }, + "503": { + "description": "Worker service is not running" + } + }, + "summary": "Fetches information about the Pulsar cluster running Pulsar Functions" + } + }, + "/worker/cluster/leader": { + "get": { + "description": "", + "operationId": "Worker_getClusterLeader", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/WorkerInfo" + } + }, + "403": { + "description": "The requester doesn't have admin permissions" + }, + "503": { + "description": "Worker service is not running" + } + }, + "summary": "Fetches info about the leader node of the Pulsar cluster running Pulsar Functions" + } + }, + "/worker/cluster/leader/ready": { + "get": { + "description": "", + "operationId": "Worker_isLeaderReady", + "responses": { + "200": { + "description": "successful operation", + "schema": { + "type": "boolean" + } + }, + "503": { + "description": "Worker service is not running" + } + }, + "summary": "Checks if this node is the leader and is ready to service requests" + } + }, + "/worker/connectors": { + "get": { + "description": "", + "operationId": "Worker_getConnectorsList", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "$ref": "#/definitions/ConnectorDefinition" + }, + "type": "array" + } + }, + "400": { + "description": "Invalid request" + }, + "403": { + "description": "The requester doesn't have admin permissions" + }, + "408": { + "description": "Request timeout" + } + }, + "summary": "Fetches a list of supported Pulsar IO connectors currently running in cluster mode" + } + }, + "/worker/drain": { + "get": { + "description": "", + "operationId": "Worker_getDrainStatus", + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/LongRunningProcessStatus" + } + }, + "403": { + "description": "The requester doesn't have admin permissions" + }, + "503": { + "description": "Worker service is not ready" + } + }, + "summary": "Get the status of any ongoing drain operation at this worker" + }, + "put": { + "description": "", + "operationId": "Worker_drain", + "responses": { + "204": { + "description": "Operation successful" + }, + "400": { + "description": "Invalid request" + }, + "403": { + "description": "The requester doesn't have admin permissions" + }, + "408": { + "description": "Request timeout" + }, + "409": { + "description": "Drain already in progress" + }, + "503": { + "description": "Worker service is not ready" + } + }, + "summary": "Drains this worker, i.e., moves its work-assignments to other workers" + } + }, + "/worker/leader/drain": { + "get": { + "description": "", + "operationId": "Worker_getDrainStatusFromLeader", + "parameters": [ + { + "in": "query", + "name": "workerId", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/LongRunningProcessStatus" + } + }, + "403": { + "description": "The requester doesn't have admin permissions" + }, + "503": { + "description": "Worker service is not ready" + } + }, + "summary": "Get the status of any ongoing drain operation at the specified worker" + }, + "put": { + "description": "", + "operationId": "Worker_drainAtLeader", + "parameters": [ + { + "in": "query", + "name": "workerId", + "required": false, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "400": { + "description": "Invalid request" + }, + "403": { + "description": "The requester doesn't have admin permissions" + }, + "408": { + "description": "Request timeout" + }, + "409": { + "description": "Drain already in progress" + }, + "503": { + "description": "Worker service is not ready" + } + }, + "summary": "Drains the specified worker, i.e., moves its work-assignments to other workers" + } + }, + "/worker/rebalance": { + "put": { + "description": "", + "operationId": "Worker_rebalance", + "responses": { + "204": { + "description": "Operation successful" + }, + "400": { + "description": "Invalid request" + }, + "403": { + "description": "The requester doesn't have admin permissions" + }, + "408": { + "description": "Request timeout" + } + }, + "summary": "Triggers a rebalance of functions to workers" + } + } + }, + "schemes": [ + "http", + "https" + ], + "swagger": "2.0", + "tags": [ + { + "name": "bookies" + }, + { + "name": "broker-stats" + }, + { + "name": "brokers" + }, + { + "name": "clusters" + }, + { + "name": "namespaces" + }, + { + "name": "non-persistent topic" + }, + { + "name": "persistent topic" + }, + { + "name": "resource-quotas" + }, + { + "name": "resourcegroups" + }, + { + "name": "schemas" + }, + { + "name": "tenants" + } + ] +} diff --git a/static/swagger/4.0.0/v2/swaggerlookup.json b/static/swagger/4.0.0/v2/swaggerlookup.json new file mode 100644 index 000000000000..224562a78f7f --- /dev/null +++ b/static/swagger/4.0.0/v2/swaggerlookup.json @@ -0,0 +1,319 @@ +{ + "basePath": "/lookup", + "definitions": { + "AuthenticationDataSource": { + "properties": { + "commandData": { + "type": "string" + }, + "httpAuthType": { + "type": "string" + }, + "peerAddress": { + "$ref": "#/definitions/SocketAddress" + }, + "subscription": { + "type": "string" + }, + "tlsCertificates": { + "items": { + "$ref": "#/definitions/Certificate" + }, + "type": "array" + } + }, + "type": "object" + }, + "AuthenticationParameters": { + "properties": { + "clientAuthenticationDataSource": { + "$ref": "#/definitions/AuthenticationDataSource" + }, + "clientRole": { + "type": "string" + }, + "originalPrincipal": { + "type": "string" + } + }, + "type": "object" + }, + "Certificate": { + "properties": { + "encoded": { + "items": { + "format": "byte", + "type": "string" + }, + "type": "array" + }, + "publicKey": { + "$ref": "#/definitions/PublicKey" + }, + "type": { + "type": "string" + } + }, + "type": "object" + }, + "CompletableFuture": { + "properties": { + "cancelled": { + "type": "boolean" + }, + "completedExceptionally": { + "type": "boolean" + }, + "done": { + "type": "boolean" + }, + "numberOfDependents": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "CompletableFutureByteBuf": { + "properties": { + "cancelled": { + "type": "boolean" + }, + "completedExceptionally": { + "type": "boolean" + }, + "done": { + "type": "boolean" + }, + "numberOfDependents": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "CompletableFutureClusterData": { + "properties": { + "cancelled": { + "type": "boolean" + }, + "completedExceptionally": { + "type": "boolean" + }, + "done": { + "type": "boolean" + }, + "numberOfDependents": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "CompletableFutureVoid": { + "properties": { + "cancelled": { + "type": "boolean" + }, + "completedExceptionally": { + "type": "boolean" + }, + "done": { + "type": "boolean" + }, + "numberOfDependents": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "LookupData": { + "properties": { + "brokerUrl": { + "type": "string" + }, + "brokerUrlSsl": { + "type": "string" + }, + "brokerUrlTls": { + "type": "string" + }, + "httpUrl": { + "type": "string" + }, + "httpUrlTls": { + "type": "string" + }, + "nativeUrl": { + "type": "string" + } + }, + "type": "object" + }, + "PublicKey": { + "properties": { + "algorithm": { + "type": "string" + }, + "encoded": { + "items": { + "format": "byte", + "type": "string" + }, + "type": "array" + }, + "format": { + "type": "string" + } + }, + "type": "object" + }, + "SocketAddress": { + "type": "object" + } + }, + "info": { + "description": "This provides the REST API for lookup operations", + "license": { + "name": "Apache 2.0", + "url": "http://www.apache.org/licenses/LICENSE-2.0.html" + }, + "title": "Pulsar Lookup REST API", + "version": "v2" + }, + "paths": { + "/v2/topic/{topic-domain}/{tenant}/{namespace}/{topic}": { + "get": { + "description": "", + "operationId": "TopicLookup_lookupTopicAsync", + "parameters": [ + { + "in": "path", + "name": "topic-domain", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "in": "query", + "name": "listenerName", + "required": false, + "type": "string" + }, + { + "in": "header", + "name": "X-Pulsar-ListenerName", + "required": false, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/LookupData" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this topic" + } + }, + "summary": "Get the owner broker of the given topic.", + "tags": [ + "lookup" + ] + } + }, + "/v2/topic/{topic-domain}/{tenant}/{namespace}/{topic}/bundle": { + "get": { + "description": "", + "operationId": "TopicLookup_getNamespaceBundle", + "parameters": [ + { + "in": "path", + "name": "topic-domain", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "type": "string" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "405": { + "description": "Invalid topic domain type" + } + }, + "summary": "Get the namespace bundle which the given topic belongs to.", + "tags": [ + "lookup" + ] + } + } + }, + "schemes": [ + "http", + "https" + ], + "swagger": "2.0", + "tags": [ + { + "name": "lookup" + } + ] +} diff --git a/static/swagger/4.0.0/v3/swaggerfunctions.json b/static/swagger/4.0.0/v3/swaggerfunctions.json new file mode 100644 index 000000000000..9e40f88b1870 --- /dev/null +++ b/static/swagger/4.0.0/v3/swaggerfunctions.json @@ -0,0 +1,2047 @@ +{ + "basePath": "/admin/v3", + "definitions": { + "AuthenticationDataSource": { + "properties": { + "commandData": { + "type": "string" + }, + "httpAuthType": { + "type": "string" + }, + "peerAddress": { + "$ref": "#/definitions/SocketAddress" + }, + "subscription": { + "type": "string" + }, + "tlsCertificates": { + "items": { + "$ref": "#/definitions/Certificate" + }, + "type": "array" + } + }, + "type": "object" + }, + "AuthenticationParameters": { + "properties": { + "clientAuthenticationDataSource": { + "$ref": "#/definitions/AuthenticationDataSource" + }, + "clientRole": { + "type": "string" + }, + "originalPrincipal": { + "type": "string" + } + }, + "type": "object" + }, + "Certificate": { + "properties": { + "encoded": { + "items": { + "format": "byte", + "type": "string" + }, + "type": "array" + }, + "publicKey": { + "$ref": "#/definitions/PublicKey" + }, + "type": { + "type": "string" + } + }, + "type": "object" + }, + "CompletableFuture": { + "properties": { + "cancelled": { + "type": "boolean" + }, + "completedExceptionally": { + "type": "boolean" + }, + "done": { + "type": "boolean" + }, + "numberOfDependents": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "CompletableFutureClusterData": { + "properties": { + "cancelled": { + "type": "boolean" + }, + "completedExceptionally": { + "type": "boolean" + }, + "done": { + "type": "boolean" + }, + "numberOfDependents": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "CompletableFutureVoid": { + "properties": { + "cancelled": { + "type": "boolean" + }, + "completedExceptionally": { + "type": "boolean" + }, + "done": { + "type": "boolean" + }, + "numberOfDependents": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "ConnectorDefinition": { + "properties": { + "description": { + "type": "string" + }, + "name": { + "type": "string" + }, + "sinkClass": { + "type": "string" + }, + "sinkConfigClass": { + "type": "string" + }, + "sourceClass": { + "type": "string" + }, + "sourceConfigClass": { + "type": "string" + } + }, + "type": "object" + }, + "ConsumerConfig": { + "properties": { + "consumerProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "cryptoConfig": { + "$ref": "#/definitions/CryptoConfig" + }, + "poolMessages": { + "type": "boolean" + }, + "receiverQueueSize": { + "format": "int32", + "type": "integer" + }, + "regexPattern": { + "type": "boolean" + }, + "schemaProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "schemaType": { + "type": "string" + }, + "serdeClassName": { + "type": "string" + } + }, + "type": "object" + }, + "CryptoConfig": { + "properties": { + "consumerCryptoFailureAction": { + "enum": [ + "FAIL", + "DISCARD", + "CONSUME" + ], + "type": "string" + }, + "cryptoKeyReaderClassName": { + "type": "string" + }, + "cryptoKeyReaderConfig": { + "additionalProperties": { + "type": "object" + }, + "type": "object" + }, + "encryptionKeys": { + "items": { + "type": "string" + }, + "type": "array" + }, + "producerCryptoFailureAction": { + "enum": [ + "FAIL", + "SEND" + ], + "type": "string" + } + }, + "type": "object" + }, + "ExceptionInformation": { + "properties": { + "exceptionString": { + "type": "string" + }, + "timestampMs": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "FunctionConfig": { + "properties": { + "autoAck": { + "type": "boolean" + }, + "batchBuilder": { + "type": "string" + }, + "className": { + "type": "string" + }, + "cleanupSubscription": { + "type": "boolean" + }, + "customRuntimeOptions": { + "type": "string" + }, + "customSchemaInputs": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "customSchemaOutputs": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "customSerdeInputs": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "deadLetterTopic": { + "type": "string" + }, + "exposePulsarAdminClientEnabled": { + "type": "boolean" + }, + "forwardSourceMessageProperty": { + "type": "boolean" + }, + "fqfn": { + "type": "string" + }, + "functionType": { + "type": "string" + }, + "go": { + "type": "string" + }, + "inputSpecs": { + "additionalProperties": { + "$ref": "#/definitions/ConsumerConfig" + }, + "type": "object" + }, + "inputTypeClassName": { + "type": "string" + }, + "inputs": { + "items": { + "type": "string" + }, + "type": "array" + }, + "jar": { + "type": "string" + }, + "logTopic": { + "type": "string" + }, + "maxMessageRetries": { + "format": "int32", + "type": "integer" + }, + "maxPendingAsyncRequests": { + "format": "int32", + "type": "integer" + }, + "name": { + "type": "string" + }, + "namespace": { + "type": "string" + }, + "output": { + "type": "string" + }, + "outputSchemaType": { + "type": "string" + }, + "outputSerdeClassName": { + "type": "string" + }, + "outputTypeClassName": { + "type": "string" + }, + "parallelism": { + "format": "int32", + "type": "integer" + }, + "processingGuarantees": { + "enum": [ + "ATLEAST_ONCE", + "ATMOST_ONCE", + "EFFECTIVELY_ONCE", + "MANUAL" + ], + "type": "string" + }, + "producerConfig": { + "$ref": "#/definitions/ProducerConfig" + }, + "py": { + "type": "string" + }, + "resources": { + "$ref": "#/definitions/Resources" + }, + "retainKeyOrdering": { + "type": "boolean" + }, + "retainOrdering": { + "type": "boolean" + }, + "runtime": { + "enum": [ + "JAVA", + "PYTHON", + "GO" + ], + "type": "string" + }, + "runtimeFlags": { + "type": "string" + }, + "secrets": { + "additionalProperties": { + "type": "object" + }, + "type": "object" + }, + "skipToLatest": { + "type": "boolean" + }, + "subName": { + "type": "string" + }, + "subscriptionPosition": { + "enum": [ + "Latest", + "Earliest" + ], + "type": "string" + }, + "tenant": { + "type": "string" + }, + "timeoutMs": { + "format": "int64", + "type": "integer" + }, + "topicsPattern": { + "type": "string" + }, + "userConfig": { + "additionalProperties": { + "type": "object" + }, + "type": "object" + }, + "windowConfig": { + "$ref": "#/definitions/WindowConfig" + } + }, + "type": "object" + }, + "FunctionDefinition": { + "properties": { + "description": { + "type": "string" + }, + "functionClass": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "type": "object" + }, + "FunctionInstanceStatsData": { + "properties": { + "avgProcessLatency": { + "format": "double", + "type": "number" + }, + "lastInvocation": { + "format": "int64", + "type": "integer" + }, + "oneMin": { + "$ref": "#/definitions/FunctionInstanceStatsDataBase" + }, + "processedSuccessfullyTotal": { + "format": "int64", + "type": "integer" + }, + "receivedTotal": { + "format": "int64", + "type": "integer" + }, + "systemExceptionsTotal": { + "format": "int64", + "type": "integer" + }, + "userExceptionsTotal": { + "format": "int64", + "type": "integer" + }, + "userMetrics": { + "additionalProperties": { + "format": "double", + "type": "number" + }, + "type": "object" + } + }, + "type": "object" + }, + "FunctionInstanceStatsDataBase": { + "properties": { + "avgProcessLatency": { + "format": "double", + "type": "number" + }, + "processedSuccessfullyTotal": { + "format": "int64", + "type": "integer" + }, + "receivedTotal": { + "format": "int64", + "type": "integer" + }, + "systemExceptionsTotal": { + "format": "int64", + "type": "integer" + }, + "userExceptionsTotal": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "FunctionInstanceStatsDataBaseImpl": { + "properties": { + "avgProcessLatency": { + "format": "double", + "type": "number" + }, + "processedSuccessfullyTotal": { + "format": "int64", + "type": "integer" + }, + "receivedTotal": { + "format": "int64", + "type": "integer" + }, + "systemExceptionsTotal": { + "format": "int64", + "type": "integer" + }, + "userExceptionsTotal": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "FunctionInstanceStatsDataImpl": { + "properties": { + "1min": { + "$ref": "#/definitions/FunctionInstanceStatsDataBaseImpl" + }, + "avgProcessLatency": { + "format": "double", + "type": "number" + }, + "lastInvocation": { + "format": "int64", + "type": "integer" + }, + "processedSuccessfullyTotal": { + "format": "int64", + "type": "integer" + }, + "receivedTotal": { + "format": "int64", + "type": "integer" + }, + "systemExceptionsTotal": { + "format": "int64", + "type": "integer" + }, + "userExceptionsTotal": { + "format": "int64", + "type": "integer" + }, + "userMetrics": { + "additionalProperties": { + "format": "double", + "type": "number" + }, + "type": "object" + } + }, + "type": "object" + }, + "FunctionInstanceStatsImpl": { + "properties": { + "instanceId": { + "format": "int32", + "type": "integer" + }, + "metrics": { + "$ref": "#/definitions/FunctionInstanceStatsData" + } + }, + "type": "object" + }, + "FunctionInstanceStatus": { + "properties": { + "instanceId": { + "format": "int32", + "type": "integer" + }, + "status": { + "$ref": "#/definitions/FunctionInstanceStatusData" + } + }, + "type": "object" + }, + "FunctionInstanceStatusData": { + "properties": { + "averageLatency": { + "format": "double", + "type": "number" + }, + "error": { + "type": "string" + }, + "lastInvocationTime": { + "format": "int64", + "type": "integer" + }, + "latestSystemExceptions": { + "items": { + "$ref": "#/definitions/ExceptionInformation" + }, + "type": "array" + }, + "latestUserExceptions": { + "items": { + "$ref": "#/definitions/ExceptionInformation" + }, + "type": "array" + }, + "numReceived": { + "format": "int64", + "type": "integer" + }, + "numRestarts": { + "format": "int64", + "type": "integer" + }, + "numSuccessfullyProcessed": { + "format": "int64", + "type": "integer" + }, + "numSystemExceptions": { + "format": "int64", + "type": "integer" + }, + "numUserExceptions": { + "format": "int64", + "type": "integer" + }, + "running": { + "type": "boolean" + }, + "workerId": { + "type": "string" + } + }, + "type": "object" + }, + "FunctionState": { + "properties": { + "byteValue": { + "items": { + "format": "byte", + "type": "string" + }, + "type": "array" + }, + "key": { + "type": "string" + }, + "numberValue": { + "format": "int64", + "type": "integer" + }, + "stringValue": { + "type": "string" + }, + "version": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "FunctionStatsImpl": { + "properties": { + "1min": { + "$ref": "#/definitions/FunctionInstanceStatsDataBaseImpl" + }, + "avgProcessLatency": { + "format": "double", + "type": "number" + }, + "instances": { + "items": { + "$ref": "#/definitions/FunctionInstanceStatsImpl" + }, + "type": "array" + }, + "lastInvocation": { + "format": "int64", + "type": "integer" + }, + "processedSuccessfullyTotal": { + "format": "int64", + "type": "integer" + }, + "receivedTotal": { + "format": "int64", + "type": "integer" + }, + "systemExceptionsTotal": { + "format": "int64", + "type": "integer" + }, + "userExceptionsTotal": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "FunctionStatus": { + "properties": { + "instances": { + "items": { + "$ref": "#/definitions/FunctionInstanceStatus" + }, + "type": "array" + }, + "numInstances": { + "format": "int32", + "type": "integer" + }, + "numRunning": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "InputStream": { + "type": "object" + }, + "ProducerConfig": { + "properties": { + "batchBuilder": { + "type": "string" + }, + "compressionType": { + "enum": [ + "NONE", + "LZ4", + "ZLIB", + "ZSTD", + "SNAPPY" + ], + "type": "string" + }, + "cryptoConfig": { + "$ref": "#/definitions/CryptoConfig" + }, + "maxPendingMessages": { + "format": "int32", + "type": "integer" + }, + "maxPendingMessagesAcrossPartitions": { + "format": "int32", + "type": "integer" + }, + "useThreadLocalProducers": { + "type": "boolean" + } + }, + "type": "object" + }, + "PublicKey": { + "properties": { + "algorithm": { + "type": "string" + }, + "encoded": { + "items": { + "format": "byte", + "type": "string" + }, + "type": "array" + }, + "format": { + "type": "string" + } + }, + "type": "object" + }, + "Resources": { + "properties": { + "cpu": { + "format": "double", + "type": "number" + }, + "disk": { + "format": "int64", + "type": "integer" + }, + "ram": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "SocketAddress": { + "type": "object" + }, + "UpdateOptions": { + "description": "Options while updating the sink", + "properties": { + "update-auth-data": { + "description": "Whether or not to update the auth data", + "type": "boolean" + } + }, + "type": "object" + }, + "WindowConfig": { + "properties": { + "actualWindowFunctionClassName": { + "type": "string" + }, + "lateDataTopic": { + "type": "string" + }, + "maxLagMs": { + "format": "int64", + "type": "integer" + }, + "processingGuarantees": { + "enum": [ + "ATLEAST_ONCE", + "ATMOST_ONCE" + ], + "type": "string" + }, + "slidingIntervalCount": { + "format": "int32", + "type": "integer" + }, + "slidingIntervalDurationMs": { + "format": "int64", + "type": "integer" + }, + "timestampExtractorClassName": { + "type": "string" + }, + "watermarkEmitIntervalMs": { + "format": "int64", + "type": "integer" + }, + "windowLengthCount": { + "format": "int32", + "type": "integer" + }, + "windowLengthDurationMs": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + } + }, + "info": { + "description": "This provides the REST API for Pulsar Functions operations", + "license": { + "name": "Apache 2.0", + "url": "http://www.apache.org/licenses/LICENSE-2.0.html" + }, + "title": "Pulsar Functions REST API", + "version": "v3" + }, + "paths": { + "/functions/builtins": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "FunctionsBase_getBuiltinFunction", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "$ref": "#/definitions/FunctionDefinition" + }, + "type": "array" + } + }, + "400": { + "description": "Invalid request" + }, + "403": { + "description": "The requester doesn't have admin permissions" + }, + "408": { + "description": "Request timeout" + } + }, + "summary": "Fetches the list of built-in Pulsar functions", + "tags": [ + "functions" + ] + } + }, + "/functions/builtins/reload": { + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "FunctionsBase_reloadBuiltinFunctions", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "401": { + "description": "This operation requires super-user access" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Function worker service is now initializing. Please try again later." + } + }, + "summary": "Reload the built-in Functions", + "tags": [ + "functions" + ] + } + }, + "/functions/connectors": { + "get": { + "consumes": [ + "application/json" + ], + "deprecated": true, + "description": "", + "operationId": "FunctionsBase_getConnectorsList", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "$ref": "#/definitions/ConnectorDefinition" + }, + "type": "array" + } + }, + "400": { + "description": "Invalid request" + }, + "403": { + "description": "The requester doesn't have admin permissions" + }, + "408": { + "description": "Request timeout" + } + }, + "summary": "Fetches a list of supported Pulsar IO connectors currently running in cluster mode", + "tags": [ + "functions" + ] + } + }, + "/functions/{tenant}/{namespace}": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "FunctionsBase_listFunctions", + "parameters": [ + { + "description": "The tenant of a Pulsar Function", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Function", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "type": "string" + } + }, + "400": { + "description": "Invalid request" + }, + "403": { + "description": "The requester doesn't have admin permissions" + } + }, + "summary": "Lists all Pulsar Functions currently deployed in a given namespace", + "tags": [ + "functions" + ] + } + }, + "/functions/{tenant}/{namespace}/{functionName}": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "FunctionsBase_deregisterFunction", + "parameters": [ + { + "description": "The tenant of a Pulsar Function", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Function", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Function", + "in": "path", + "name": "functionName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Pulsar Function was successfully deleted" + }, + "400": { + "description": "Invalid request" + }, + "403": { + "description": "The requester doesn't have admin permissions" + }, + "404": { + "description": "The Pulsar Function doesn't exist" + }, + "408": { + "description": "Request timeout" + } + }, + "summary": "Deletes a Pulsar Function currently running in cluster mode", + "tags": [ + "functions" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "FunctionsBase_getFunctionInfo", + "parameters": [ + { + "description": "The tenant of a Pulsar Function", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Function", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Function", + "in": "path", + "name": "functionName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/FunctionConfig" + } + }, + "400": { + "description": "Invalid request" + }, + "403": { + "description": "The requester doesn't have admin permissions" + }, + "404": { + "description": "The Pulsar Function doesn't exist" + }, + "408": { + "description": "Request timeout" + } + }, + "summary": "Fetches information about a Pulsar Function currently running in cluster mode", + "tags": [ + "functions" + ] + }, + "post": { + "consumes": [ + "multipart/form-data" + ], + "description": "", + "operationId": "FunctionsBase_registerFunction", + "parameters": [ + { + "description": "The tenant of a Pulsar Function", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Function", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Function", + "in": "path", + "name": "functionName", + "required": true, + "type": "string" + }, + { + "description": "You can submit a function (in any languages that you are familiar with) \nto a Pulsar cluster. Follow the steps below. \n1. Create a JSON object using some of the following parameters.\nA JSON value presenting configuration payload of a Pulsar Function.\n An example of the expected Pulsar Function can be found here.\n- **autoAck**\n Whether or not the framework acknowledges messages automatically.\n- **runtime**\n What is the runtime of the Pulsar Function. Possible Values: [JAVA, PYTHON, GO]\n- **resources**\n The size of the system resources allowed by the Pulsar Function runtime. The resources include: cpu, ram, disk.\n- **className**\n The class name of a Pulsar Function.\n- **customSchemaInputs**\n The map of input topics to Schema class names (specified as a JSON object).\n- **customSerdeInputs**\n The map of input topics to SerDe class names (specified as a JSON object).\n- **deadLetterTopic**\n Messages that are not processed successfully are sent to `deadLetterTopic`.\n- **runtimeFlags**\n Any flags that you want to pass to the runtime. Note that in thread mode, these flags have no impact.\n- **fqfn**\n The Fully Qualified Function Name (FQFN) for the Pulsar Function.\n- **inputSpecs**\n The map of input topics to its consumer configuration, each configuration has schema of {\"schemaType\": \"type-x\", \"serdeClassName\": \"name-x\", \"isRegexPattern\": true, \"receiverQueueSize\": 5}\n- **inputs**\n The input topic or topics (multiple topics can be specified as a comma-separated list) of a Pulsar Function.\n- **jar**\n Path to the JAR file for the Pulsar Function (if the Pulsar Function is written in Java). It also supports URL path [http/https/file (file protocol assumes that file already exists on worker host)] from which worker can download the package.\n- **py**\n Path to the main Python file or Python wheel file for the Pulsar Function (if the Pulsar Function is written in Python).\n- **go**\n Path to the main Go executable binary for the Pulsar Function (if the Pulsar Function is written in Go).\n- **logTopic**\n The topic to which the logs of a Pulsar Function are produced.\n- **maxMessageRetries**\n How many times should we try to process a message before giving up.\n- **output**\n The output topic of a Pulsar Function (If none is specified, no output is written).\n- **outputSerdeClassName**\n The SerDe class to be used for messages output by the Pulsar Function.\n- **parallelism**\n The parallelism factor of a Pulsar Function (i.e. the number of a Pulsar Function instances to run).\n- **processingGuarantees**\n The processing guarantees (that is, delivery semantics) applied to the Pulsar Function. Possible Values: [ATLEAST_ONCE, ATMOST_ONCE, EFFECTIVELY_ONCE]\n- **retainOrdering**\n Function consumes and processes messages in order.\n- **outputSchemaType**\n Represents either a builtin schema type (for example: 'avro', 'json', ect) or the class name for a Schema implementation.- **subName**\n Pulsar source subscription name. User can specify a subscription-name for the input-topic consumer.\n- **windowConfig**\n The window configuration of a Pulsar Function.\n- **timeoutMs**\n The message timeout in milliseconds.\n- **topicsPattern**\n The topic pattern to consume from a list of topics under a namespace that match the pattern. [input] and [topic-pattern] are mutually exclusive. Add SerDe class name for a pattern in customSerdeInputs (supported for java fun only)\n- **userConfig**\n A map of user-defined configurations (specified as a JSON object).\n- **secrets**\n This is a map of secretName(that is how the secret is going to be accessed in the Pulsar Function via context) to an object that encapsulates how the secret is fetched by the underlying secrets provider. The type of an value here can be found by the SecretProviderConfigurator.getSecretObjectType() method. \n- **cleanupSubscription**\n Whether the subscriptions of a Pulsar Function created or used should be deleted when the Pulsar Function is deleted.\n2. Encapsulate the JSON object to a multipart object.", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/FunctionConfig" + }, + "x-examples": { + "text/plain": "Examples\n1. Create a JSON object\n {\n \"inputs\": \"persistent://public/default/input-topic\",\n \"parallelism\": \"4\",\n \"output\": \"persistent://public/default/output-topic\",\n \"log-topic\": \"persistent://public/default/log-topic\",\n \"classname\": \"org.example.test.ExclamationFunction\",\n \"jar\": \"java-function-1.0-SNAPSHOT.jar\"\n }\n2. Encapsulate the JSON object to a multipart object (in Python)\nfrom requests_toolbelt.multipart.encoder import MultipartEncoders\nmp_encoder = MultipartEncoder([('functionConfig',(None, json.dumps(config), 'application/json'))])" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Pulsar Function successfully created" + }, + "400": { + "description": "Invalid request (The Pulsar Function already exists, etc.)" + }, + "403": { + "description": "The requester doesn't have admin permissions" + }, + "408": { + "description": "Request timeout" + } + }, + "summary": "Creates a new Pulsar Function in cluster mode", + "tags": [ + "functions" + ] + }, + "put": { + "consumes": [ + "multipart/form-data" + ], + "description": "", + "operationId": "FunctionsBase_updateFunction", + "parameters": [ + { + "description": "The tenant of a Pulsar Function", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Function", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Function", + "in": "path", + "name": "functionName", + "required": true, + "type": "string" + }, + { + "description": "A JSON value presenting configuration payload of a Pulsar Function. An example of the expected Pulsar Function can be found here.\n- **autoAck**\n Whether or not the framework acknowledges messages automatically.\n- **runtime**\n What is the runtime of the Pulsar Function. Possible Values: [JAVA, PYTHON, GO]\n- **resources**\n The size of the system resources allowed by the Pulsar Function runtime. The resources include: cpu, ram, disk.\n- **className**\n The class name of a Pulsar Function.\n- **customSchemaInputs**\n The map of input topics to Schema class names (specified as a JSON object).\n- **customSerdeInputs**\n The map of input topics to SerDe class names (specified as a JSON object).\n- **deadLetterTopic**\n Messages that are not processed successfully are sent to `deadLetterTopic`.\n- **runtimeFlags**\n Any flags that you want to pass to the runtime. Note that in thread mode, these flags have no impact.\n- **fqfn**\n The Fully Qualified Function Name (FQFN) for the Pulsar Function.\n- **inputSpecs**\n The map of input topics to its consumer configuration, each configuration has schema of {\"schemaType\": \"type-x\", \"serdeClassName\": \"name-x\", \"isRegexPattern\": true, \"receiverQueueSize\": 5}\n- **inputs**\n The input topic or topics (multiple topics can be specified as a comma-separated list) of a Pulsar Function.\n- **jar**\n Path to the JAR file for the Pulsar Function (if the Pulsar Function is written in Java). It also supports URL path [http/https/file (file protocol assumes that file already exists on worker host)] from which worker can download the package.\n- **py**\n Path to the main Python file or Python wheel file for the Pulsar Function (if the Pulsar Function is written in Python).\n- **go**\n Path to the main Go executable binary for the Pulsar Function (if the Pulsar Function is written in Go).\n- **logTopic**\n The topic to which the logs of a Pulsar Function are produced.\n- **maxMessageRetries**\n How many times should we try to process a message before giving up.\n- **output**\n The output topic of a Pulsar Function (If none is specified, no output is written).\n- **outputSerdeClassName**\n The SerDe class to be used for messages output by the Pulsar Function.\n- **parallelism**\n The parallelism factor of a Pulsar Function (i.e. the number of a Pulsar Function instances to run).\n- **processingGuarantees**\n The processing guarantees (that is, delivery semantics) applied to the Pulsar Function. Possible Values: [ATLEAST_ONCE, ATMOST_ONCE, EFFECTIVELY_ONCE]\n- **retainOrdering**\n Function consumes and processes messages in order.\n- **outputSchemaType**\n Represents either a builtin schema type (for example: 'avro', 'json', ect) or the class name for a Schema implementation.- **subName**\n Pulsar source subscription name. User can specify a subscription-name for the input-topic consumer.\n- **windowConfig**\n The window configuration of a Pulsar Function.\n- **timeoutMs**\n The message timeout in milliseconds.\n- **topicsPattern**\n The topic pattern to consume from a list of topics under a namespace that match the pattern. [input] and [topic-pattern] are mutually exclusive. Add SerDe class name for a pattern in customSerdeInputs (supported for java fun only)\n- **userConfig**\n A map of user-defined configurations (specified as a JSON object).\n- **secrets**\n This is a map of secretName(that is how the secret is going to be accessed in the Pulsar Function via context) to an object that encapsulates how the secret is fetched by the underlying secrets provider. The type of an value here can be found by the SecretProviderConfigurator.getSecretObjectType() method. \n- **cleanupSubscription**\n Whether the subscriptions of a Pulsar Function created or used should be deleted when the Pulsar Function is deleted.\n", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/FunctionConfig" + }, + "x-examples": { + "application/json": "{\n \"inputs\": \"persistent://public/default/input-topic\",\n \"parallelism\": 4,\n \"output\": \"persistent://public/default/output-topic\",\n \"log-topic\": \"persistent://public/default/log-topic\",\n \"classname\": \"org.example.test.ExclamationFunction\",\n \"jar\": \"java-function-1.0-SNAPSHOT.jar\"\n}" + } + }, + { + "description": "The update options is for the Pulsar Function that needs to be updated.", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/UpdateOptions" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Pulsar Function successfully updated" + }, + "400": { + "description": "Invalid request (The Pulsar Function doesn't exist, etc.)" + }, + "403": { + "description": "The requester doesn't have admin permissions" + } + }, + "summary": "Updates a Pulsar Function currently running in cluster mode", + "tags": [ + "functions" + ] + } + }, + "/functions/{tenant}/{namespace}/{functionName}/restart": { + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "FunctionsBase_restartFunction", + "parameters": [ + { + "description": "The tenant of a Pulsar Function", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Function", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Function", + "in": "path", + "name": "functionName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "400": { + "description": "Invalid request" + }, + "404": { + "description": "The Pulsar Function does not exist" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Restart all instances of a Pulsar Function", + "tags": [ + "functions" + ] + } + }, + "/functions/{tenant}/{namespace}/{functionName}/start": { + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "FunctionsBase_startFunction", + "parameters": [ + { + "description": "The tenant of a Pulsar Function", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Function", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Function", + "in": "path", + "name": "functionName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "400": { + "description": "Invalid request" + }, + "404": { + "description": "The Pulsar Function does not exist" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Start all instances of a Pulsar Function", + "tags": [ + "functions" + ] + } + }, + "/functions/{tenant}/{namespace}/{functionName}/state/{key}": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "FunctionsBase_getFunctionState", + "parameters": [ + { + "description": "The tenant of a Pulsar Function", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Function", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Function", + "in": "path", + "name": "functionName", + "required": true, + "type": "string" + }, + { + "description": "The stats key", + "in": "path", + "name": "key", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/FunctionState" + } + }, + "400": { + "description": "Invalid request" + }, + "403": { + "description": "The requester doesn't have admin permissions" + }, + "404": { + "description": "The key does not exist" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Fetch the current state associated with a Pulsar Function", + "tags": [ + "functions" + ] + }, + "post": { + "consumes": [ + "multipart/form-data" + ], + "description": "", + "operationId": "FunctionsBase_putFunctionState", + "parameters": [ + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "functionName", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "key", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "400": { + "description": "Invalid request" + }, + "403": { + "description": "The requester doesn't have admin permissions" + }, + "404": { + "description": "The Pulsar Function does not exist" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Put the state associated with a Pulsar Function", + "tags": [ + "functions" + ] + } + }, + "/functions/{tenant}/{namespace}/{functionName}/stats": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "FunctionsBase_getFunctionStats", + "parameters": [ + { + "description": "The tenant of a Pulsar Function", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Function", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Function", + "in": "path", + "name": "functionName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/FunctionStatsImpl" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this function" + }, + "400": { + "description": "Invalid request" + }, + "403": { + "description": "The requester doesn't have admin permissions" + }, + "404": { + "description": "The Pulsar Function doesn't exist" + } + }, + "summary": "Displays the stats of a Pulsar Function", + "tags": [ + "functions" + ] + } + }, + "/functions/{tenant}/{namespace}/{functionName}/status": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "FunctionsBase_getFunctionStatus", + "parameters": [ + { + "description": "The tenant of a Pulsar Function", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Function", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Function", + "in": "path", + "name": "functionName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/FunctionStatus" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this function" + }, + "400": { + "description": "Invalid request" + }, + "403": { + "description": "The requester doesn't have admin permissions" + }, + "404": { + "description": "The Pulsar Function doesn't exist" + } + }, + "summary": "Displays the status of a Pulsar Function", + "tags": [ + "functions" + ] + } + }, + "/functions/{tenant}/{namespace}/{functionName}/stop": { + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "FunctionsBase_stopFunction", + "parameters": [ + { + "description": "The tenant of a Pulsar Function", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Function", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Function", + "in": "path", + "name": "functionName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "400": { + "description": "Invalid request" + }, + "404": { + "description": "The Pulsar Function does not exist" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Stop all instances of a Pulsar Function", + "tags": [ + "functions" + ] + } + }, + "/functions/{tenant}/{namespace}/{functionName}/trigger": { + "post": { + "consumes": [ + "multipart/form-data" + ], + "description": "", + "operationId": "FunctionsBase_triggerFunction", + "parameters": [ + { + "description": "The tenant of a Pulsar Function", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Function", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Function", + "in": "path", + "name": "functionName", + "required": true, + "type": "string" + }, + { + "description": "The value with which you want to trigger the Pulsar Function", + "in": "body", + "name": "body", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "The path to the file that contains the data with which you'd like to trigger the Pulsar Function", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/InputStream" + } + }, + { + "description": "The specific topic name that the Pulsar Function consumes from which you want to inject the data to", + "in": "body", + "name": "body", + "required": false, + "schema": { + "type": "string" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "type": "string" + } + }, + "400": { + "description": "Invalid request" + }, + "404": { + "description": "The Pulsar Function does not exist" + }, + "408": { + "description": "Request timeout" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Triggers a Pulsar Function with a user-specified value or file data", + "tags": [ + "functions" + ] + } + }, + "/functions/{tenant}/{namespace}/{functionName}/{instanceId}/restart": { + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "FunctionsBase_restartFunction", + "parameters": [ + { + "description": "The tenant of a Pulsar Function", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Function", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Function", + "in": "path", + "name": "functionName", + "required": true, + "type": "string" + }, + { + "description": "The instanceId of a Pulsar Function (if instance-id is not provided, all instances are restarted", + "in": "path", + "name": "instanceId", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this function" + }, + "400": { + "description": "Invalid request" + }, + "404": { + "description": "The Pulsar Function does not exist" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Restart an instance of a Pulsar Function", + "tags": [ + "functions" + ] + } + }, + "/functions/{tenant}/{namespace}/{functionName}/{instanceId}/start": { + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "FunctionsBase_startFunction", + "parameters": [ + { + "description": "The tenant of a Pulsar Function", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Function", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Function", + "in": "path", + "name": "functionName", + "required": true, + "type": "string" + }, + { + "description": "The instanceId of a Pulsar Function (if instance-id is not provided, all instances sre started. ", + "in": "path", + "name": "instanceId", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "400": { + "description": "Invalid request" + }, + "404": { + "description": "The Pulsar Function does not exist" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Start an instance of a Pulsar Function", + "tags": [ + "functions" + ] + } + }, + "/functions/{tenant}/{namespace}/{functionName}/{instanceId}/stats": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "FunctionsBase_getFunctionInstanceStats", + "parameters": [ + { + "description": "The tenant of a Pulsar Function", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Function", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Function", + "in": "path", + "name": "functionName", + "required": true, + "type": "string" + }, + { + "description": "The instanceId of a Pulsar Function (if instance-id is not provided, the stats of all instances is returned", + "in": "path", + "name": "instanceId", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/FunctionInstanceStatsDataImpl" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this function" + }, + "400": { + "description": "Invalid request" + }, + "403": { + "description": "The requester doesn't have admin permissions" + }, + "404": { + "description": "The Pulsar Function doesn't exist" + } + }, + "summary": "Displays the stats of a Pulsar Function instance", + "tags": [ + "functions" + ] + } + }, + "/functions/{tenant}/{namespace}/{functionName}/{instanceId}/status": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "FunctionsBase_getFunctionInstanceStatus", + "parameters": [ + { + "description": "The tenant of a Pulsar Function", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Function", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Function", + "in": "path", + "name": "functionName", + "required": true, + "type": "string" + }, + { + "description": "The instanceId of a Pulsar Function (if instance-id is not provided, the stats of all instances is returned", + "in": "path", + "name": "instanceId", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/FunctionInstanceStatusData" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this function" + }, + "400": { + "description": "Invalid request" + }, + "403": { + "description": "The requester doesn't have admin permissions" + }, + "404": { + "description": "The Pulsar Function doesn't exist" + } + }, + "summary": "Displays the status of a Pulsar Function instance", + "tags": [ + "functions" + ] + } + }, + "/functions/{tenant}/{namespace}/{functionName}/{instanceId}/stop": { + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "FunctionsBase_stopFunction", + "parameters": [ + { + "description": "The tenant of a Pulsar Function", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Function", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Function", + "in": "path", + "name": "functionName", + "required": true, + "type": "string" + }, + { + "description": "The instanceId of a Pulsar Function (if instance-id is not provided, all instances are stopped. ", + "in": "path", + "name": "instanceId", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "400": { + "description": "Invalid request" + }, + "404": { + "description": "The Pulsar Function does not exist" + }, + "500": { + "description": "Internal server error" + } + }, + "summary": "Stop an instance of a Pulsar Function", + "tags": [ + "functions" + ] + } + } + }, + "schemes": [ + "http", + "https" + ], + "swagger": "2.0", + "tags": [ + { + "name": "functions" + } + ] +} diff --git a/static/swagger/4.0.0/v3/swaggerpackages.json b/static/swagger/4.0.0/v3/swaggerpackages.json new file mode 100644 index 000000000000..154d67730cf5 --- /dev/null +++ b/static/swagger/4.0.0/v3/swaggerpackages.json @@ -0,0 +1,627 @@ +{ + "basePath": "/admin/v3", + "definitions": { + "AuthenticationDataSource": { + "properties": { + "commandData": { + "type": "string" + }, + "httpAuthType": { + "type": "string" + }, + "peerAddress": { + "$ref": "#/definitions/SocketAddress" + }, + "subscription": { + "type": "string" + }, + "tlsCertificates": { + "items": { + "$ref": "#/definitions/Certificate" + }, + "type": "array" + } + }, + "type": "object" + }, + "AuthenticationParameters": { + "properties": { + "clientAuthenticationDataSource": { + "$ref": "#/definitions/AuthenticationDataSource" + }, + "clientRole": { + "type": "string" + }, + "originalPrincipal": { + "type": "string" + } + }, + "type": "object" + }, + "Certificate": { + "properties": { + "encoded": { + "items": { + "format": "byte", + "type": "string" + }, + "type": "array" + }, + "publicKey": { + "$ref": "#/definitions/PublicKey" + }, + "type": { + "type": "string" + } + }, + "type": "object" + }, + "CompletableFuture": { + "properties": { + "cancelled": { + "type": "boolean" + }, + "completedExceptionally": { + "type": "boolean" + }, + "done": { + "type": "boolean" + }, + "numberOfDependents": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "CompletableFutureClusterData": { + "properties": { + "cancelled": { + "type": "boolean" + }, + "completedExceptionally": { + "type": "boolean" + }, + "done": { + "type": "boolean" + }, + "numberOfDependents": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "CompletableFutureVoid": { + "properties": { + "cancelled": { + "type": "boolean" + }, + "completedExceptionally": { + "type": "boolean" + }, + "done": { + "type": "boolean" + }, + "numberOfDependents": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "PackageMetadata": { + "properties": { + "contact": { + "type": "string" + }, + "createTime": { + "format": "int64", + "type": "integer" + }, + "description": { + "type": "string" + }, + "modificationTime": { + "format": "int64", + "type": "integer" + }, + "properties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + } + }, + "type": "object" + }, + "PublicKey": { + "properties": { + "algorithm": { + "type": "string" + }, + "encoded": { + "items": { + "format": "byte", + "type": "string" + }, + "type": "array" + }, + "format": { + "type": "string" + } + }, + "type": "object" + }, + "SocketAddress": { + "type": "object" + }, + "StreamingOutput": { + "type": "object" + } + }, + "info": { + "description": "This provides the REST API for Pulsar Packages operations", + "license": { + "name": "Apache 2.0", + "url": "http://www.apache.org/licenses/LICENSE-2.0.html" + }, + "title": "Pulsar Packages REST API", + "version": "v3" + }, + "paths": { + "/packages/{type}/{tenant}/{namespace}": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Packages_listPackages", + "parameters": [ + { + "in": "path", + "name": "type", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Return all the specified type package names in the specified namespace.", + "schema": { + "items": { + "$ref": "#/definitions/PackageMetadata" + }, + "type": "array" + } + }, + "412": { + "description": "The package type is illegal." + }, + "500": { + "description": "Internal server error." + }, + "503": { + "description": "Package Management Service is not enabled in the broker." + } + }, + "summary": "Get all the specified type packages in a namespace.", + "tags": [ + "packages" + ] + } + }, + "/packages/{type}/{tenant}/{namespace}/{packageName}": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Packages_listPackageVersion", + "parameters": [ + { + "in": "path", + "name": "type", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "packageName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Return the package versions of the specified package.", + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "404": { + "description": "The specified package is not existent." + }, + "412": { + "description": "The package name is illegal." + }, + "500": { + "description": "Internal server error." + }, + "503": { + "description": "Package Management Service is not enabled in the broker." + } + }, + "summary": "Get all the versions of a package.", + "tags": [ + "packages" + ] + } + }, + "/packages/{type}/{tenant}/{namespace}/{packageName}/{version}": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Packages_delete", + "parameters": [ + { + "in": "path", + "name": "type", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "packageName", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Delete the specified package successfully." + }, + "404": { + "description": "The specified package is not existent." + }, + "412": { + "description": "The package name is illegal." + }, + "500": { + "description": "Internal server error." + }, + "503": { + "description": "Package Management Service is not enabled in the broker." + } + }, + "summary": "Delete a package with the package name.", + "tags": [ + "packages" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Packages_download", + "parameters": [ + { + "in": "path", + "name": "type", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "packageName", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Download the specified package successfully.", + "schema": { + "$ref": "#/definitions/StreamingOutput" + } + }, + "404": { + "description": "The specified package is not existent." + }, + "412": { + "description": "The package name is illegal." + }, + "500": { + "description": "Internal server error." + }, + "503": { + "description": "Package Management Service is not enabled in the broker." + } + }, + "summary": "Download a package with the package name.", + "tags": [ + "packages" + ] + }, + "post": { + "consumes": [ + "multipart/form-data" + ], + "description": "", + "operationId": "Packages_upload", + "parameters": [ + { + "in": "path", + "name": "type", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "packageName", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Upload the specified package successfully." + }, + "412": { + "description": "The package name is illegal." + }, + "500": { + "description": "Internal server error." + }, + "503": { + "description": "Package Management Service is not enabled in the broker." + } + }, + "summary": "Upload a package.", + "tags": [ + "packages" + ] + } + }, + "/packages/{type}/{tenant}/{namespace}/{packageName}/{version}/metadata": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Packages_getMeta", + "parameters": [ + { + "in": "path", + "name": "type", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "packageName", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Return the metadata of the specified package.", + "schema": { + "$ref": "#/definitions/PackageMetadata" + } + }, + "404": { + "description": "The specified package is not existent." + }, + "412": { + "description": "The package name is illegal." + }, + "500": { + "description": "Internal server error." + }, + "503": { + "description": "Package Management Service is not enabled in the broker." + } + }, + "summary": "Get the metadata of a package.", + "tags": [ + "packages" + ] + }, + "put": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Packages_updateMeta", + "parameters": [ + { + "in": "path", + "name": "type", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "packageName", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "version", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Update the metadata of the specified package successfully." + }, + "404": { + "description": "The specified package is not existent." + }, + "412": { + "description": "The package name is illegal." + }, + "500": { + "description": "Internal server error." + }, + "503": { + "description": "Package Management Service is not enabled in the broker." + } + }, + "summary": "Update the metadata of a package.", + "tags": [ + "packages" + ] + } + } + }, + "schemes": [ + "http", + "https" + ], + "swagger": "2.0", + "tags": [ + { + "name": "packages" + } + ] +} diff --git a/static/swagger/4.0.0/v3/swaggersink.json b/static/swagger/4.0.0/v3/swaggersink.json new file mode 100644 index 000000000000..d73048d61938 --- /dev/null +++ b/static/swagger/4.0.0/v3/swaggersink.json @@ -0,0 +1,1449 @@ +{ + "basePath": "/admin/v3", + "definitions": { + "AuthenticationDataSource": { + "properties": { + "commandData": { + "type": "string" + }, + "httpAuthType": { + "type": "string" + }, + "peerAddress": { + "$ref": "#/definitions/SocketAddress" + }, + "subscription": { + "type": "string" + }, + "tlsCertificates": { + "items": { + "$ref": "#/definitions/Certificate" + }, + "type": "array" + } + }, + "type": "object" + }, + "AuthenticationParameters": { + "properties": { + "clientAuthenticationDataSource": { + "$ref": "#/definitions/AuthenticationDataSource" + }, + "clientRole": { + "type": "string" + }, + "originalPrincipal": { + "type": "string" + } + }, + "type": "object" + }, + "Certificate": { + "properties": { + "encoded": { + "items": { + "format": "byte", + "type": "string" + }, + "type": "array" + }, + "publicKey": { + "$ref": "#/definitions/PublicKey" + }, + "type": { + "type": "string" + } + }, + "type": "object" + }, + "CompletableFuture": { + "properties": { + "cancelled": { + "type": "boolean" + }, + "completedExceptionally": { + "type": "boolean" + }, + "done": { + "type": "boolean" + }, + "numberOfDependents": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "CompletableFutureClusterData": { + "properties": { + "cancelled": { + "type": "boolean" + }, + "completedExceptionally": { + "type": "boolean" + }, + "done": { + "type": "boolean" + }, + "numberOfDependents": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "CompletableFutureVoid": { + "properties": { + "cancelled": { + "type": "boolean" + }, + "completedExceptionally": { + "type": "boolean" + }, + "done": { + "type": "boolean" + }, + "numberOfDependents": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "ConfigFieldDefinition": { + "properties": { + "attributes": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "fieldName": { + "type": "string" + }, + "typeName": { + "type": "string" + } + }, + "type": "object" + }, + "ConnectorDefinition": { + "properties": { + "description": { + "type": "string" + }, + "name": { + "type": "string" + }, + "sinkClass": { + "type": "string" + }, + "sinkConfigClass": { + "type": "string" + }, + "sourceClass": { + "type": "string" + }, + "sourceConfigClass": { + "type": "string" + } + }, + "type": "object" + }, + "ConsumerConfig": { + "properties": { + "consumerProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "cryptoConfig": { + "$ref": "#/definitions/CryptoConfig" + }, + "poolMessages": { + "type": "boolean" + }, + "receiverQueueSize": { + "format": "int32", + "type": "integer" + }, + "regexPattern": { + "type": "boolean" + }, + "schemaProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "schemaType": { + "type": "string" + }, + "serdeClassName": { + "type": "string" + } + }, + "type": "object" + }, + "CryptoConfig": { + "properties": { + "consumerCryptoFailureAction": { + "enum": [ + "FAIL", + "DISCARD", + "CONSUME" + ], + "type": "string" + }, + "cryptoKeyReaderClassName": { + "type": "string" + }, + "cryptoKeyReaderConfig": { + "additionalProperties": { + "type": "object" + }, + "type": "object" + }, + "encryptionKeys": { + "items": { + "type": "string" + }, + "type": "array" + }, + "producerCryptoFailureAction": { + "enum": [ + "FAIL", + "SEND" + ], + "type": "string" + } + }, + "type": "object" + }, + "ExceptionInformation": { + "properties": { + "exceptionString": { + "type": "string" + }, + "timestampMs": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "PublicKey": { + "properties": { + "algorithm": { + "type": "string" + }, + "encoded": { + "items": { + "format": "byte", + "type": "string" + }, + "type": "array" + }, + "format": { + "type": "string" + } + }, + "type": "object" + }, + "Resources": { + "properties": { + "cpu": { + "format": "double", + "type": "number" + }, + "disk": { + "format": "int64", + "type": "integer" + }, + "ram": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "SinkConfig": { + "properties": { + "archive": { + "type": "string" + }, + "autoAck": { + "type": "boolean" + }, + "className": { + "type": "string" + }, + "cleanupSubscription": { + "type": "boolean" + }, + "configs": { + "additionalProperties": { + "type": "object" + }, + "type": "object" + }, + "customRuntimeOptions": { + "type": "string" + }, + "deadLetterTopic": { + "type": "string" + }, + "inputSpecs": { + "additionalProperties": { + "$ref": "#/definitions/ConsumerConfig" + }, + "type": "object" + }, + "inputs": { + "items": { + "type": "string" + }, + "type": "array" + }, + "logTopic": { + "type": "string" + }, + "maxMessageRetries": { + "format": "int32", + "type": "integer" + }, + "name": { + "type": "string" + }, + "namespace": { + "type": "string" + }, + "negativeAckRedeliveryDelayMs": { + "format": "int64", + "type": "integer" + }, + "parallelism": { + "format": "int32", + "type": "integer" + }, + "processingGuarantees": { + "enum": [ + "ATLEAST_ONCE", + "ATMOST_ONCE", + "EFFECTIVELY_ONCE", + "MANUAL" + ], + "type": "string" + }, + "resources": { + "$ref": "#/definitions/Resources" + }, + "retainKeyOrdering": { + "type": "boolean" + }, + "retainOrdering": { + "type": "boolean" + }, + "runtimeFlags": { + "type": "string" + }, + "secrets": { + "additionalProperties": { + "type": "object" + }, + "type": "object" + }, + "sinkType": { + "type": "string" + }, + "sourceSubscriptionName": { + "type": "string" + }, + "sourceSubscriptionPosition": { + "enum": [ + "Latest", + "Earliest" + ], + "type": "string" + }, + "tenant": { + "type": "string" + }, + "timeoutMs": { + "format": "int64", + "type": "integer" + }, + "topicToSchemaProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "topicToSchemaType": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "topicToSerdeClassName": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "topicsPattern": { + "type": "string" + }, + "transformFunction": { + "type": "string" + }, + "transformFunctionClassName": { + "type": "string" + }, + "transformFunctionConfig": { + "type": "string" + } + }, + "type": "object" + }, + "SinkInstanceStatus": { + "properties": { + "instanceId": { + "format": "int32", + "type": "integer" + }, + "status": { + "$ref": "#/definitions/SinkInstanceStatusData" + } + }, + "type": "object" + }, + "SinkInstanceStatusData": { + "properties": { + "error": { + "type": "string" + }, + "lastReceivedTime": { + "format": "int64", + "type": "integer" + }, + "latestSinkExceptions": { + "items": { + "$ref": "#/definitions/ExceptionInformation" + }, + "type": "array" + }, + "latestSystemExceptions": { + "items": { + "$ref": "#/definitions/ExceptionInformation" + }, + "type": "array" + }, + "numReadFromPulsar": { + "format": "int64", + "type": "integer" + }, + "numRestarts": { + "format": "int64", + "type": "integer" + }, + "numSinkExceptions": { + "format": "int64", + "type": "integer" + }, + "numSystemExceptions": { + "format": "int64", + "type": "integer" + }, + "numWrittenToSink": { + "format": "int64", + "type": "integer" + }, + "running": { + "type": "boolean" + }, + "workerId": { + "type": "string" + } + }, + "type": "object" + }, + "SinkStatus": { + "properties": { + "instances": { + "items": { + "$ref": "#/definitions/SinkInstanceStatus" + }, + "type": "array" + }, + "numInstances": { + "format": "int32", + "type": "integer" + }, + "numRunning": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "SocketAddress": { + "type": "object" + }, + "UpdateOptions": { + "description": "Options while updating the sink", + "properties": { + "update-auth-data": { + "description": "Whether or not to update the auth data", + "type": "boolean" + } + }, + "type": "object" + } + }, + "info": { + "description": "This provides the REST API for Pulsar Sink operations", + "license": { + "name": "Apache 2.0", + "url": "http://www.apache.org/licenses/LICENSE-2.0.html" + }, + "title": "Pulsar Sink REST API", + "version": "v3" + }, + "paths": { + "/sinks/builtinsinks": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "SinksBase_getSinkList", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Get builtin sinks successfully.", + "schema": { + "items": { + "$ref": "#/definitions/ConnectorDefinition" + }, + "type": "array" + } + } + }, + "summary": "Fetches the list of built-in Pulsar IO sinks", + "tags": [ + "sinks" + ] + } + }, + "/sinks/builtinsinks/{name}/configdefinition": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "SinksBase_getSinkConfigDefinition", + "parameters": [ + { + "description": "The name of the builtin sink", + "in": "path", + "name": "name", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "$ref": "#/definitions/ConfigFieldDefinition" + }, + "type": "array" + } + }, + "403": { + "description": "The requester doesn't have admin permissions" + }, + "404": { + "description": "builtin sink does not exist" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Function worker service is now initializing. Please try again later." + } + }, + "summary": "Fetches information about config fields associated with the specified builtin sink", + "tags": [ + "sinks" + ] + } + }, + "/sinks/reloadBuiltInSinks": { + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "SinksBase_reloadSinks", + "produces": [ + "application/json" + ], + "responses": { + "401": { + "description": "This operation requires super-user access" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Function worker service is now initializing. Please try again later." + } + }, + "summary": "Reload the built-in connectors, including Sources and Sinks", + "tags": [ + "sinks" + ] + } + }, + "/sinks/{tenant}/{namespace}": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "SinksBase_listSinks", + "parameters": [ + { + "description": "The tenant of a Pulsar Sink", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Sink", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "type": "string" + } + }, + "400": { + "description": "Invalid list request" + }, + "401": { + "description": "The client is not authorized to perform this operation" + }, + "500": { + "description": "Internal server error (failed to authorize, etc.)" + }, + "503": { + "description": "Function worker service is now initializing. Please try again later." + } + }, + "summary": "Lists all Pulsar Sinks currently deployed in a given namespace", + "tags": [ + "sinks" + ] + } + }, + "/sinks/{tenant}/{namespace}/{sinkName}": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "SinksBase_deregisterSink", + "parameters": [ + { + "description": "The tenant of a Pulsar Sink", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Sink", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Sink", + "in": "path", + "name": "sinkName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Pulsar Sink was successfully deleted" + }, + "400": { + "description": "Invalid deregister request" + }, + "401": { + "description": "Client is not authorized to perform operation" + }, + "404": { + "description": "The Pulsar Sink does not exist" + }, + "408": { + "description": "Got InterruptedException while deregistering the Pulsar Sink" + }, + "500": { + "description": "Internal server error (failed to authorize, failed to deregister, etc.)" + }, + "503": { + "description": "Function worker service is now initializing. Please try again later." + } + }, + "summary": "Deletes a Pulsar Sink currently running in cluster mode", + "tags": [ + "sinks" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "SinksBase_getSinkInfo", + "parameters": [ + { + "description": "The tenant of a Pulsar Sink", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Sink", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Sink", + "in": "path", + "name": "sinkName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/SinkConfig" + } + }, + "400": { + "description": "Invalid request" + }, + "404": { + "description": "The Pulsar Sink does not exist" + }, + "503": { + "description": "Function worker service is now initializing. Please try again later." + } + }, + "summary": "Fetches information about a Pulsar Sink currently running in cluster mode", + "tags": [ + "sinks" + ] + }, + "post": { + "consumes": [ + "multipart/form-data" + ], + "description": "", + "operationId": "SinksBase_registerSink", + "parameters": [ + { + "description": "The tenant of a Pulsar Sink", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Sink", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Sink", + "in": "path", + "name": "sinkName", + "required": true, + "type": "string" + }, + { + "description": "You can submit a sink (in any languages that you are familiar with) to a Pulsar cluster. Follow the steps below.\n1. Create a JSON object using some of the following parameters.\nA JSON value presenting config payload of a Pulsar Sink. All available configuration options are:\n- **classname**\n The class name of a Pulsar Sink if archive is file-url-path (file://)\n- **sourceSubscriptionName**\n Pulsar source subscription name if user wants a specific\n subscription-name for input-topic consumer\n- **inputs**\n The input topic or topics of a Pulsar Sink (specified as a JSON array)\n- **topicsPattern**\n TopicsPattern to consume from list of topics under a namespace that match the pattern. [input] and [topicsPattern] are mutually exclusive. Add SerDe class name for a pattern in customSerdeInputs (supported for java fun only)- **topicToSerdeClassName**\n The map of input topics to SerDe class names (specified as a JSON object)\n- **topicToSchemaType**\n The map of input topics to Schema types or class names (specified as a JSON object)\n- **inputSpecs**\n The map of input topics to its consumer configuration, each configuration has schema of {\"schemaType\": \"type-x\", \"serdeClassName\": \"name-x\", \"isRegexPattern\": true, \"receiverQueueSize\": 5}\n- **configs**\n The map of configs (specified as a JSON object)\n- **secrets**\n a map of secretName(aka how the secret is going to be \n accessed in the function via context) to an object that \n encapsulates how the secret is fetched by the underlying \n secrets provider. The type of an value here can be found by the \n SecretProviderConfigurator.getSecretObjectType() method. (specified as a JSON object)\n- **parallelism**\n The parallelism factor of a Pulsar Sink (i.e. the number of a Pulsar Sink instances to run \n- **processingGuarantees**\n The processing guarantees (aka delivery semantics) applied to the Pulsar Sink. Possible Values: \"ATLEAST_ONCE\", \"ATMOST_ONCE\", \"EFFECTIVELY_ONCE\"\n- **retainOrdering**\n Boolean denotes whether the Pulsar Sink consumes and processes messages in order\n- **resources**\n {\"cpu\": 1, \"ram\": 2, \"disk\": 3} The CPU (in cores), RAM (in bytes) and disk (in bytes) that needs to be allocated per Pulsar Sink instance (applicable only to Docker runtime)\n- **autoAck**\n Boolean denotes whether or not the framework will automatically acknowledge messages\n- **timeoutMs**\n Long denotes the message timeout in milliseconds\n- **cleanupSubscription**\n Boolean denotes whether the subscriptions the functions created/used should be deleted when the functions is deleted\n- **runtimeFlags**\n Any flags that you want to pass to the runtime as a single string\n2. Encapsulate the JSON object to a multipart object.", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/SinkConfig" + }, + "x-examples": { + "text/plain": "Example\n1. Create a JSON object.\n {\n \"classname\": \"org.example.MySinkTest\",\n \"inputs\": [\"persistent://public/default/sink-input\"],\n \"processingGuarantees\": \"EFFECTIVELY_ONCE\",\n \"parallelism\": \"10\"\n }\n2. Encapsulate the JSON object to a multipart object (in Python).\nfrom requests_toolbelt.multipart.encoder import MultipartEncoder\nmp_encoder = MultipartEncoder( [('sinkConfig',(None, json.dumps(config), 'application/json'))])" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Pulsar Sink successfully created" + }, + "400": { + "description": "Invalid request (The Pulsar Sink already exists, etc.)" + }, + "401": { + "description": "Client is not authorized to perform operation" + }, + "500": { + "description": "Internal server error (failed to authorize, failed to get tenant data, failed to process package, etc.)" + }, + "503": { + "description": "Function worker service is now initializing. Please try again later." + } + }, + "summary": "Creates a new Pulsar Sink in cluster mode", + "tags": [ + "sinks" + ] + }, + "put": { + "consumes": [ + "multipart/form-data" + ], + "description": "", + "operationId": "SinksBase_updateSink", + "parameters": [ + { + "description": "The tenant of a Pulsar Sink", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Sink", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Sink", + "in": "path", + "name": "sinkName", + "required": true, + "type": "string" + }, + { + "description": "A JSON value presenting config payload of a Pulsar Sink. All available configuration options are:\n- **classname**\n The class name of a Pulsar Sink if archive is file-url-path (file://)\n- **sourceSubscriptionName**\n Pulsar source subscription name if user wants a specific\n subscription-name for input-topic consumer\n- **inputs**\n The input topic or topics of a Pulsar Sink (specified as a JSON array)\n- **topicsPattern**\n TopicsPattern to consume from list of topics under a namespace that match the pattern. [input] and [topicsPattern] are mutually exclusive. Add SerDe class name for a pattern in customSerdeInputs (supported for java fun only)- **topicToSerdeClassName**\n The map of input topics to SerDe class names (specified as a JSON object)\n- **topicToSchemaType**\n The map of input topics to Schema types or class names (specified as a JSON object)\n- **inputSpecs**\n The map of input topics to its consumer configuration, each configuration has schema of {\"schemaType\": \"type-x\", \"serdeClassName\": \"name-x\", \"isRegexPattern\": true, \"receiverQueueSize\": 5}\n- **configs**\n The map of configs (specified as a JSON object)\n- **secrets**\n a map of secretName(aka how the secret is going to be \n accessed in the function via context) to an object that \n encapsulates how the secret is fetched by the underlying \n secrets provider. The type of an value here can be found by the \n SecretProviderConfigurator.getSecretObjectType() method. (specified as a JSON object)\n- **parallelism**\n The parallelism factor of a Pulsar Sink (i.e. the number of a Pulsar Sink instances to run \n- **processingGuarantees**\n The processing guarantees (aka delivery semantics) applied to the Pulsar Sink. Possible Values: \"ATLEAST_ONCE\", \"ATMOST_ONCE\", \"EFFECTIVELY_ONCE\"\n- **retainOrdering**\n Boolean denotes whether the Pulsar Sink consumes and processes messages in order\n- **resources**\n {\"cpu\": 1, \"ram\": 2, \"disk\": 3} The CPU (in cores), RAM (in bytes) and disk (in bytes) that needs to be allocated per Pulsar Sink instance (applicable only to Docker runtime)\n- **autoAck**\n Boolean denotes whether or not the framework will automatically acknowledge messages\n- **timeoutMs**\n Long denotes the message timeout in milliseconds\n- **cleanupSubscription**\n Boolean denotes whether the subscriptions the functions created/used should be deleted when the functions is deleted\n- **runtimeFlags**\n Any flags that you want to pass to the runtime as a single string\n", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/SinkConfig" + }, + "x-examples": { + "application/json": "{\n\"classname\": \"org.example.SinkStressTest\",\n\"inputs\": [\"persistent://public/default/sink-input\"],\n\"processingGuarantees\": \"EFFECTIVELY_ONCE\",\n\"parallelism\": 5\n}" + } + }, + { + "description": "Update options for the Pulsar Sink", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/UpdateOptions" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Pulsar Sink successfully updated" + }, + "400": { + "description": "Invalid request (The Pulsar Sink doesn't exist, update contains no change, etc.)" + }, + "401": { + "description": "Client is not authorized to perform operation" + }, + "404": { + "description": "The Pulsar Sink doesn't exist" + }, + "500": { + "description": "Internal server error (failed to authorize, failed to process package, etc.)" + }, + "503": { + "description": "Function worker service is now initializing. Please try again later." + } + }, + "summary": "Updates a Pulsar Sink currently running in cluster mode", + "tags": [ + "sinks" + ] + } + }, + "/sinks/{tenant}/{namespace}/{sinkName}/restart": { + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "SinksBase_restartSink", + "parameters": [ + { + "description": "The tenant of a Pulsar Sink", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Sink", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Sink", + "in": "path", + "name": "sinkName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "400": { + "description": "Invalid restart request" + }, + "401": { + "description": "The client is not authorized to perform this operation" + }, + "404": { + "description": "The Pulsar Sink does not exist" + }, + "500": { + "description": "Internal server error (failed to restart the Pulsar Sink, failed to authorize, etc.)" + }, + "503": { + "description": "Function worker service is now initializing. Please try again later." + } + }, + "summary": "Restart all instances of a Pulsar Sink", + "tags": [ + "sinks" + ] + } + }, + "/sinks/{tenant}/{namespace}/{sinkName}/start": { + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "SinksBase_startSink", + "parameters": [ + { + "description": "The tenant of a Pulsar Sink", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Sink", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Sink", + "in": "path", + "name": "sinkName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "400": { + "description": "Invalid start request" + }, + "401": { + "description": "The client is not authorized to perform this operation" + }, + "404": { + "description": "The Pulsar Sink does not exist" + }, + "500": { + "description": "Internal server error (failed to start the Pulsar Sink, failed to authorize, etc.)" + }, + "503": { + "description": "Function worker service is now initializing. Please try again later." + } + }, + "summary": "Start all instances of a Pulsar Sink", + "tags": [ + "sinks" + ] + } + }, + "/sinks/{tenant}/{namespace}/{sinkName}/status": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "SinksBase_getSinkStatus", + "parameters": [ + { + "description": "The tenant of a Pulsar Sink", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Sink", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Sink", + "in": "path", + "name": "sinkName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/SinkStatus" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this sink" + }, + "400": { + "description": "Invalid get status request" + }, + "401": { + "description": "The client is not authorized to perform this operation" + }, + "404": { + "description": "The Pulsar Sink does not exist" + }, + "503": { + "description": "Function worker service is now initializing. Please try again later." + } + }, + "summary": "Displays the status of a Pulsar Sink running in cluster mode", + "tags": [ + "sinks" + ] + } + }, + "/sinks/{tenant}/{namespace}/{sinkName}/stop": { + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "SinksBase_stopSink", + "parameters": [ + { + "description": "The tenant of a Pulsar Sink", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Sink", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Sink", + "in": "path", + "name": "sinkName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "400": { + "description": "Invalid stop request" + }, + "401": { + "description": "The client is not authorized to perform this operation" + }, + "404": { + "description": "The Pulsar Sink does not exist" + }, + "500": { + "description": "Internal server error (failed to stop the Pulsar Sink, failed to authorize, etc.)" + }, + "503": { + "description": "Function worker service is now initializing. Please try again later." + } + }, + "summary": "Stop all instances of a Pulsar Sink", + "tags": [ + "sinks" + ] + } + }, + "/sinks/{tenant}/{namespace}/{sinkName}/{instanceId}/restart": { + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "SinksBase_restartSink", + "parameters": [ + { + "description": "The tenant of a Pulsar Sink", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Sink", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Sink", + "in": "path", + "name": "sinkName", + "required": true, + "type": "string" + }, + { + "description": "The instanceId of a Pulsar Sink", + "in": "path", + "name": "instanceId", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this sink" + }, + "400": { + "description": "Invalid restart request" + }, + "401": { + "description": "The client is not authorized to perform this operation" + }, + "404": { + "description": "The Pulsar Sink does not exist" + }, + "500": { + "description": "Internal server error (failed to restart the instance of a Pulsar Sink, failed to authorize, etc.)" + }, + "503": { + "description": "Function worker service is now initializing. Please try again later." + } + }, + "summary": "Restart an instance of a Pulsar Sink", + "tags": [ + "sinks" + ] + } + }, + "/sinks/{tenant}/{namespace}/{sinkName}/{instanceId}/start": { + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "SinksBase_startSink", + "parameters": [ + { + "description": "The tenant of a Pulsar Sink", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Sink", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Sink", + "in": "path", + "name": "sinkName", + "required": true, + "type": "string" + }, + { + "description": "The instanceId of a Pulsar Sink", + "in": "path", + "name": "instanceId", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "400": { + "description": "Invalid start request" + }, + "401": { + "description": "The client is not authorized to perform this operation" + }, + "404": { + "description": "The Pulsar Sink does not exist" + }, + "500": { + "description": "Internal server error (failed to start the Pulsar Sink, failed to authorize, etc.)" + }, + "503": { + "description": "Function worker service is now initializing. Please try again later." + } + }, + "summary": "Start an instance of a Pulsar Sink", + "tags": [ + "sinks" + ] + } + }, + "/sinks/{tenant}/{namespace}/{sinkName}/{instanceId}/status": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "SinksBase_getSinkInstanceStatus", + "parameters": [ + { + "description": "The tenant of a Pulsar Sink", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Sink", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Sink", + "in": "path", + "name": "sinkName", + "required": true, + "type": "string" + }, + { + "description": "The instanceId of a Pulsar Sink", + "in": "path", + "name": "instanceId", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/SinkInstanceStatusData" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this sink" + }, + "400": { + "description": "The Pulsar Sink instance does not exist" + }, + "404": { + "description": "The Pulsar Sink does not exist" + }, + "500": { + "description": "Internal Server Error (got exception while getting status, etc.)" + }, + "503": { + "description": "Function worker service is now initializing. Please try again later." + } + }, + "summary": "Displays the status of a Pulsar Sink instance", + "tags": [ + "sinks" + ] + } + }, + "/sinks/{tenant}/{namespace}/{sinkName}/{instanceId}/stop": { + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "SinksBase_stopSink", + "parameters": [ + { + "description": "The tenant of a Pulsar Sink", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Sink", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Sink", + "in": "path", + "name": "sinkName", + "required": true, + "type": "string" + }, + { + "description": "The instanceId of a Pulsar Sink", + "in": "path", + "name": "instanceId", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "400": { + "description": "Invalid stop request" + }, + "401": { + "description": "The client is not authorized to perform this operation" + }, + "404": { + "description": "The Pulsar Sink instance does not exist" + }, + "500": { + "description": "Internal server error (failed to stop the Pulsar Sink, failed to authorize, etc.)" + }, + "503": { + "description": "Function worker service is now initializing. Please try again later." + } + }, + "summary": "Stop an instance of a Pulsar Sink", + "tags": [ + "sinks" + ] + } + } + }, + "schemes": [ + "http", + "https" + ], + "swagger": "2.0", + "tags": [ + { + "name": "sinks" + } + ] +} diff --git a/static/swagger/4.0.0/v3/swaggersource.json b/static/swagger/4.0.0/v3/swaggersource.json new file mode 100644 index 000000000000..188aaeb805a9 --- /dev/null +++ b/static/swagger/4.0.0/v3/swaggersource.json @@ -0,0 +1,1404 @@ +{ + "basePath": "/admin/v3", + "definitions": { + "AuthenticationDataSource": { + "properties": { + "commandData": { + "type": "string" + }, + "httpAuthType": { + "type": "string" + }, + "peerAddress": { + "$ref": "#/definitions/SocketAddress" + }, + "subscription": { + "type": "string" + }, + "tlsCertificates": { + "items": { + "$ref": "#/definitions/Certificate" + }, + "type": "array" + } + }, + "type": "object" + }, + "AuthenticationParameters": { + "properties": { + "clientAuthenticationDataSource": { + "$ref": "#/definitions/AuthenticationDataSource" + }, + "clientRole": { + "type": "string" + }, + "originalPrincipal": { + "type": "string" + } + }, + "type": "object" + }, + "BatchSourceConfig": { + "properties": { + "discoveryTriggererClassName": { + "type": "string" + }, + "discoveryTriggererConfig": { + "additionalProperties": { + "type": "object" + }, + "type": "object" + } + }, + "type": "object" + }, + "Certificate": { + "properties": { + "encoded": { + "items": { + "format": "byte", + "type": "string" + }, + "type": "array" + }, + "publicKey": { + "$ref": "#/definitions/PublicKey" + }, + "type": { + "type": "string" + } + }, + "type": "object" + }, + "CompletableFuture": { + "properties": { + "cancelled": { + "type": "boolean" + }, + "completedExceptionally": { + "type": "boolean" + }, + "done": { + "type": "boolean" + }, + "numberOfDependents": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "CompletableFutureClusterData": { + "properties": { + "cancelled": { + "type": "boolean" + }, + "completedExceptionally": { + "type": "boolean" + }, + "done": { + "type": "boolean" + }, + "numberOfDependents": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "CompletableFutureVoid": { + "properties": { + "cancelled": { + "type": "boolean" + }, + "completedExceptionally": { + "type": "boolean" + }, + "done": { + "type": "boolean" + }, + "numberOfDependents": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "ConfigFieldDefinition": { + "properties": { + "attributes": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "fieldName": { + "type": "string" + }, + "typeName": { + "type": "string" + } + }, + "type": "object" + }, + "ConnectorDefinition": { + "properties": { + "description": { + "type": "string" + }, + "name": { + "type": "string" + }, + "sinkClass": { + "type": "string" + }, + "sinkConfigClass": { + "type": "string" + }, + "sourceClass": { + "type": "string" + }, + "sourceConfigClass": { + "type": "string" + } + }, + "type": "object" + }, + "CryptoConfig": { + "properties": { + "consumerCryptoFailureAction": { + "enum": [ + "FAIL", + "DISCARD", + "CONSUME" + ], + "type": "string" + }, + "cryptoKeyReaderClassName": { + "type": "string" + }, + "cryptoKeyReaderConfig": { + "additionalProperties": { + "type": "object" + }, + "type": "object" + }, + "encryptionKeys": { + "items": { + "type": "string" + }, + "type": "array" + }, + "producerCryptoFailureAction": { + "enum": [ + "FAIL", + "SEND" + ], + "type": "string" + } + }, + "type": "object" + }, + "ExceptionInformation": { + "properties": { + "exceptionString": { + "type": "string" + }, + "timestampMs": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "ProducerConfig": { + "properties": { + "batchBuilder": { + "type": "string" + }, + "compressionType": { + "enum": [ + "NONE", + "LZ4", + "ZLIB", + "ZSTD", + "SNAPPY" + ], + "type": "string" + }, + "cryptoConfig": { + "$ref": "#/definitions/CryptoConfig" + }, + "maxPendingMessages": { + "format": "int32", + "type": "integer" + }, + "maxPendingMessagesAcrossPartitions": { + "format": "int32", + "type": "integer" + }, + "useThreadLocalProducers": { + "type": "boolean" + } + }, + "type": "object" + }, + "PublicKey": { + "properties": { + "algorithm": { + "type": "string" + }, + "encoded": { + "items": { + "format": "byte", + "type": "string" + }, + "type": "array" + }, + "format": { + "type": "string" + } + }, + "type": "object" + }, + "Resources": { + "properties": { + "cpu": { + "format": "double", + "type": "number" + }, + "disk": { + "format": "int64", + "type": "integer" + }, + "ram": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "SocketAddress": { + "type": "object" + }, + "SourceConfig": { + "properties": { + "archive": { + "type": "string" + }, + "batchBuilder": { + "type": "string" + }, + "batchSourceConfig": { + "$ref": "#/definitions/BatchSourceConfig" + }, + "className": { + "type": "string" + }, + "configs": { + "additionalProperties": { + "type": "object" + }, + "type": "object" + }, + "customRuntimeOptions": { + "type": "string" + }, + "logTopic": { + "type": "string" + }, + "name": { + "type": "string" + }, + "namespace": { + "type": "string" + }, + "parallelism": { + "format": "int32", + "type": "integer" + }, + "processingGuarantees": { + "enum": [ + "ATLEAST_ONCE", + "ATMOST_ONCE", + "EFFECTIVELY_ONCE", + "MANUAL" + ], + "type": "string" + }, + "producerConfig": { + "$ref": "#/definitions/ProducerConfig" + }, + "resources": { + "$ref": "#/definitions/Resources" + }, + "runtimeFlags": { + "type": "string" + }, + "schemaType": { + "type": "string" + }, + "secrets": { + "additionalProperties": { + "type": "object" + }, + "type": "object" + }, + "serdeClassName": { + "type": "string" + }, + "sourceType": { + "type": "string" + }, + "tenant": { + "type": "string" + }, + "topicName": { + "type": "string" + } + }, + "type": "object" + }, + "SourceInstanceStatus": { + "properties": { + "instanceId": { + "format": "int32", + "type": "integer" + }, + "status": { + "$ref": "#/definitions/SourceInstanceStatusData" + } + }, + "type": "object" + }, + "SourceInstanceStatusData": { + "properties": { + "error": { + "type": "string" + }, + "lastReceivedTime": { + "format": "int64", + "type": "integer" + }, + "latestSourceExceptions": { + "items": { + "$ref": "#/definitions/ExceptionInformation" + }, + "type": "array" + }, + "latestSystemExceptions": { + "items": { + "$ref": "#/definitions/ExceptionInformation" + }, + "type": "array" + }, + "numReceivedFromSource": { + "format": "int64", + "type": "integer" + }, + "numRestarts": { + "format": "int64", + "type": "integer" + }, + "numSourceExceptions": { + "format": "int64", + "type": "integer" + }, + "numSystemExceptions": { + "format": "int64", + "type": "integer" + }, + "numWritten": { + "format": "int64", + "type": "integer" + }, + "running": { + "type": "boolean" + }, + "workerId": { + "type": "string" + } + }, + "type": "object" + }, + "SourceStatus": { + "properties": { + "instances": { + "items": { + "$ref": "#/definitions/SourceInstanceStatus" + }, + "type": "array" + }, + "numInstances": { + "format": "int32", + "type": "integer" + }, + "numRunning": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "UpdateOptions": { + "description": "Options while updating the sink", + "properties": { + "update-auth-data": { + "description": "Whether or not to update the auth data", + "type": "boolean" + } + }, + "type": "object" + } + }, + "info": { + "description": "This provides the REST API for Pulsar Source operations", + "license": { + "name": "Apache 2.0", + "url": "http://www.apache.org/licenses/LICENSE-2.0.html" + }, + "title": "Pulsar Source REST API", + "version": "v3" + }, + "paths": { + "/sources/builtinsources": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "SourcesBase_getSourceList", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "$ref": "#/definitions/ConnectorDefinition" + }, + "type": "array" + } + }, + "400": { + "description": "Invalid request" + }, + "403": { + "description": "The requester doesn't have admin permissions" + }, + "408": { + "description": "Request timeout" + }, + "503": { + "description": "Function worker service is now initializing. Please try again later." + } + }, + "summary": "Fetches the list of built-in Pulsar IO sources", + "tags": [ + "sources" + ] + } + }, + "/sources/builtinsources/{name}/configdefinition": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "SourcesBase_getSourceConfigDefinition", + "parameters": [ + { + "description": "The name of the builtin source", + "in": "path", + "name": "name", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "$ref": "#/definitions/ConfigFieldDefinition" + }, + "type": "array" + } + }, + "403": { + "description": "The requester doesn't have admin permissions" + }, + "404": { + "description": "builtin source does not exist" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Function worker service is now initializing. Please try again later." + } + }, + "summary": "Fetches information about config fields associated with the specified builtin source", + "tags": [ + "sources" + ] + } + }, + "/sources/reloadBuiltInSources": { + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "SourcesBase_reloadSources", + "produces": [ + "application/json" + ], + "responses": { + "401": { + "description": "This operation requires super-user access" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Function worker service is now initializing. Please try again later." + } + }, + "summary": "Reload the built-in connectors, including Sources and Sinks", + "tags": [ + "sources" + ] + } + }, + "/sources/{tenant}/{namespace}": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "SourcesBase_listSources", + "parameters": [ + { + "description": "The tenant of a Pulsar Source", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Source", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "400": { + "description": "Invalid request" + }, + "401": { + "description": "Client is not authorized to perform operation" + }, + "500": { + "description": "Internal Server Error" + }, + "503": { + "description": "Function worker service is now initializing. Please try again later." + } + }, + "summary": "Lists all Pulsar Sources currently deployed in a given namespace", + "tags": [ + "sources" + ] + } + }, + "/sources/{tenant}/{namespace}/{sourceName}": { + "delete": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "SourcesBase_deregisterSource", + "parameters": [ + { + "description": "The tenant of a Pulsar Source", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Source", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Source", + "in": "path", + "name": "sourceName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The function was successfully deleted" + }, + "400": { + "description": "Invalid request" + }, + "401": { + "description": "Client is not authorized to perform operation" + }, + "404": { + "description": "Not Found(The Pulsar Source doesn't exist)" + }, + "408": { + "description": "Request timeout" + }, + "500": { + "description": "Internal Server Error" + }, + "503": { + "description": "Function worker service is now initializing. Please try again later." + } + }, + "summary": "Deletes a Pulsar Source currently running in cluster mode", + "tags": [ + "sources" + ] + }, + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "SourcesBase_getSourceInfo", + "parameters": [ + { + "description": "The tenant of a Pulsar Source", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Source", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Source", + "in": "path", + "name": "sourceName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/SourceConfig" + } + }, + "400": { + "description": "Invalid request" + }, + "404": { + "description": "Not Found(The Pulsar Source doesn't exist)" + }, + "503": { + "description": "Function worker service is now initializing. Please try again later." + } + }, + "summary": "Fetches information about a Pulsar Source currently running in cluster mode", + "tags": [ + "sources" + ] + }, + "post": { + "consumes": [ + "multipart/form-data" + ], + "description": "", + "operationId": "SourcesBase_registerSource", + "parameters": [ + { + "description": "The tenant of a Pulsar Source", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Source", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Source", + "in": "path", + "name": "sourceName", + "required": true, + "type": "string" + }, + { + "description": "You can submit a source (in any languages that you are familiar with) to a Pulsar cluster. Follow the steps below.\n1. Create a JSON object using some of the following parameters.\nA JSON value presenting configuration payload of a Pulsar Source. An example of the expected functions can be found here.\n- **classname**\n The class name of a Pulsar Source if archive is file-url-path (file://).\n- **topicName**\n The Pulsar topic to which data is sent.\n- **serdeClassName**\n The SerDe classname for the Pulsar Source.\n- **schemaType**\n The schema type (either a builtin schema like 'avro', 'json', etc.. or custom Schema class name to be used to encode messages emitted from the Pulsar Source\n- **configs**\n Source config key/values\n- **secrets**\n This is a map of secretName(that is how the secret is going to be accessed in the function via context) to an object that encapsulates how the secret is fetched by the underlying secrets provider. The type of an value here can be found by the SecretProviderConfigurator.getSecretObjectType() method. \n- **parallelism**\n The parallelism factor of a Pulsar Source (i.e. the number of a Pulsar Source instances to run).\n- **processingGuarantees**\n The processing guarantees (aka delivery semantics) applied to the Pulsar Source. Possible Values: [ATLEAST_ONCE, ATMOST_ONCE, EFFECTIVELY_ONCE]\n- **resources**\n The size of the system resources allowed by the Pulsar Source runtime. The resources include: cpu, ram, disk.\n- **archive**\n The path to the NAR archive for the Pulsar Source. It also supports url-path [http/https/file (file protocol assumes that file already exists on worker host)] from which worker can download the package.\n- **runtimeFlags**\n Any flags that you want to pass to the runtime.\n2. Encapsulate the JSON object to a multipart object.", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/SourceConfig" + }, + "x-examples": { + "text/plain": "Example\n1. Create a JSON object.\n{\n \"tenant\": \"public\",\n \"namespace\": \"default\",\n \"name\": \"pulsar-io-mysql\",\n \"className\": \"TestSourceMysql\",\n \"topicName\": \"pulsar-io-mysql\",\n \"parallelism\": \"1\",\n \"archive\": \"/connectors/pulsar-io-mysql-0.0.1.nar\",\n \"schemaType\": \"avro\"\n}\n2. Encapsulate the JSON object to a multipart object (in Python).\nfrom requests_toolbelt.multipart.encoder import MultipartEncoder\nmp_encoder = MultipartEncoder([('sourceConfig', (None, json.dumps(config), 'application/json'))])" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Pulsar Function successfully created" + }, + "400": { + "description": "Invalid request (Function already exists or Tenant, Namespace or Name is not provided, etc.)" + }, + "401": { + "description": "Client is not authorized to perform operation" + }, + "500": { + "description": "Internal Server Error" + }, + "503": { + "description": "Function worker service is now initializing. Please try again later." + } + }, + "summary": "Creates a new Pulsar Source in cluster mode", + "tags": [ + "sources" + ] + }, + "put": { + "consumes": [ + "multipart/form-data" + ], + "description": "", + "operationId": "SourcesBase_updateSource", + "parameters": [ + { + "description": "The tenant of a Pulsar Source", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Source", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Source", + "in": "path", + "name": "sourceName", + "required": true, + "type": "string" + }, + { + "description": "A JSON value presenting configuration payload of a Pulsar Source. An example of the expected functions can be found here.\n- **classname**\n The class name of a Pulsar Source if archive is file-url-path (file://).\n- **topicName**\n The Pulsar topic to which data is sent.\n- **serdeClassName**\n The SerDe classname for the Pulsar Source.\n- **schemaType**\n The schema type (either a builtin schema like 'avro', 'json', etc.. or custom Schema class name to be used to encode messages emitted from the Pulsar Source\n- **configs**\n Pulsar Source config key/values\n- **secrets**\n This is a map of secretName(that is how the secret is going to be accessed in the function via context) to an object that encapsulates how the secret is fetched by the underlying secrets provider. The type of an value here can be found by the SecretProviderConfigurator.getSecretObjectType() method.\n- **parallelism**\n The parallelism factor of a Pulsar Source (i.e. the number of a Pulsar Source instances to run).\n- **processingGuarantees**\n The processing guarantees (aka delivery semantics) applied to the Pulsar Source. Possible Values: [ATLEAST_ONCE, ATMOST_ONCE, EFFECTIVELY_ONCE]\n- **resources**\n The size of the system resources allowed by the Pulsar Source runtime. The resources include: cpu, ram, disk.\n- **archive**\n The path to the NAR archive for the Pulsar Source. It also supports url-path [http/https/file (file protocol assumes that file already exists on worker host)] from which worker can download the package.\n- **runtimeFlags**\n Any flags that you want to pass to the runtime.\n", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/SourceConfig" + }, + "x-examples": { + "application/json": "{\n \"tenant\": \"public\",\n \"namespace\": \"default\",\n \"name\": \"pulsar-io-mysql\",\n \"className\": \"TestSourceMysql\",\n \"topicName\": \"pulsar-io-mysql\",\n \"parallelism\": 1,\n \"archive\": \"/connectors/pulsar-io-mysql-0.0.1.nar\",\n \"schemaType\": \"avro\"\n}" + } + }, + { + "description": "Update options for Pulsar Source", + "in": "body", + "name": "body", + "required": false, + "schema": { + "$ref": "#/definitions/UpdateOptions" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Pulsar Function successfully updated" + }, + "400": { + "description": "Invalid request (Function already exists or Tenant, Namespace or Name is not provided, etc.)" + }, + "401": { + "description": "Client is not authorized to perform operation" + }, + "403": { + "description": "The requester doesn't have admin permissions" + }, + "404": { + "description": "Not Found(The Pulsar Source doesn't exist)" + }, + "500": { + "description": "Internal Server Error" + }, + "503": { + "description": "Function worker service is now initializing. Please try again later." + } + }, + "summary": "Updates a Pulsar Source currently running in cluster mode", + "tags": [ + "sources" + ] + } + }, + "/sources/{tenant}/{namespace}/{sourceName}/restart": { + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "SourcesBase_restartSource", + "parameters": [ + { + "description": "The tenant of a Pulsar Source", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Source", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Source", + "in": "path", + "name": "sourceName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "400": { + "description": "Invalid request" + }, + "401": { + "description": "Client is not authorized to perform operation" + }, + "404": { + "description": "Not Found(The Pulsar Source doesn't exist)" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Function worker service is now initializing. Please try again later." + } + }, + "summary": "Restart all instances of a Pulsar Source", + "tags": [ + "sources" + ] + } + }, + "/sources/{tenant}/{namespace}/{sourceName}/start": { + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "SourcesBase_startSource", + "parameters": [ + { + "description": "The tenant of a Pulsar Source", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Source", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Source", + "in": "path", + "name": "sourceName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "400": { + "description": "Invalid request" + }, + "401": { + "description": "Client is not authorized to perform operation" + }, + "404": { + "description": "Not Found(The Pulsar Source doesn't exist)" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Function worker service is now initializing. Please try again later." + } + }, + "summary": "Start all instances of a Pulsar Source", + "tags": [ + "sources" + ] + } + }, + "/sources/{tenant}/{namespace}/{sourceName}/status": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "SourcesBase_getSourceStatus", + "parameters": [ + { + "description": "The tenant of a Pulsar Source", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Source", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Source", + "in": "path", + "name": "sourceName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/SourceStatus" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this source" + }, + "500": { + "description": "Internal Server Error" + }, + "503": { + "description": "Function worker service is now initializing. Please try again later." + } + }, + "summary": "Displays the status of a Pulsar Source running in cluster mode", + "tags": [ + "sources" + ] + } + }, + "/sources/{tenant}/{namespace}/{sourceName}/stop": { + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "SourcesBase_stopSource", + "parameters": [ + { + "description": "The tenant of a Pulsar Source", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Source", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Source", + "in": "path", + "name": "sourceName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "400": { + "description": "Invalid request" + }, + "401": { + "description": "Client is not authorized to perform operation" + }, + "404": { + "description": "Not Found(The Pulsar Source doesn't exist)" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Function worker service is now initializing. Please try again later." + } + }, + "summary": "Stop all instances of a Pulsar Source", + "tags": [ + "sources" + ] + } + }, + "/sources/{tenant}/{namespace}/{sourceName}/{instanceId}/restart": { + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "SourcesBase_restartSource", + "parameters": [ + { + "description": "The tenant of a Pulsar Source", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Source", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Source", + "in": "path", + "name": "sourceName", + "required": true, + "type": "string" + }, + { + "description": "The instanceId of a Pulsar Source (if instance-id is not provided, the stats of all instances is returned).", + "in": "path", + "name": "instanceId", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "307": { + "description": "Current broker doesn't serve the namespace of this source" + }, + "400": { + "description": "Invalid request" + }, + "401": { + "description": "Client is not authorized to perform operation" + }, + "404": { + "description": "Not Found(The Pulsar Source doesn't exist)" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Function worker service is now initializing. Please try again later." + } + }, + "summary": "Restart an instance of a Pulsar Source", + "tags": [ + "sources" + ] + } + }, + "/sources/{tenant}/{namespace}/{sourceName}/{instanceId}/start": { + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "SourcesBase_startSource", + "parameters": [ + { + "description": "The tenant of a Pulsar Source", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Source", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Source", + "in": "path", + "name": "sourceName", + "required": true, + "type": "string" + }, + { + "description": "The instanceId of a Pulsar Source (if instance-id is not provided, the stats of all instances is returned).", + "in": "path", + "name": "instanceId", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "400": { + "description": "Invalid request" + }, + "401": { + "description": "Client is not authorized to perform operation" + }, + "404": { + "description": "Not Found(The Pulsar Source doesn't exist)" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Function worker service is now initializing. Please try again later." + } + }, + "summary": "Start an instance of a Pulsar Source", + "tags": [ + "sources" + ] + } + }, + "/sources/{tenant}/{namespace}/{sourceName}/{instanceId}/status": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "SourcesBase_getSourceInstanceStatus", + "parameters": [ + { + "description": "The tenant of a Pulsar Source", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Source", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Source", + "in": "path", + "name": "sourceName", + "required": true, + "type": "string" + }, + { + "description": "The instanceId of a Pulsar Source (if instance-id is not provided, the stats of all instances is returned).", + "in": "path", + "name": "instanceId", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/SourceInstanceStatusData" + } + }, + "307": { + "description": "Current broker doesn't serve the namespace of this source" + }, + "500": { + "description": "Internal Server Error" + }, + "503": { + "description": "Function worker service is now initializing. Please try again later." + } + }, + "summary": "Displays the status of a Pulsar Source instance", + "tags": [ + "sources" + ] + } + }, + "/sources/{tenant}/{namespace}/{sourceName}/{instanceId}/stop": { + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "SourcesBase_stopSource", + "parameters": [ + { + "description": "The tenant of a Pulsar Source", + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "description": "The namespace of a Pulsar Source", + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "description": "The name of a Pulsar Source", + "in": "path", + "name": "sourceName", + "required": true, + "type": "string" + }, + { + "description": "The instanceId of a Pulsar Source (if instance-id is not provided, the stats of all instances is returned).", + "in": "path", + "name": "instanceId", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Operation successful" + }, + "400": { + "description": "Invalid request" + }, + "401": { + "description": "Client is not authorized to perform operation" + }, + "404": { + "description": "Not Found(The Pulsar Source doesn't exist)" + }, + "500": { + "description": "Internal server error" + }, + "503": { + "description": "Function worker service is now initializing. Please try again later." + } + }, + "summary": "Stop instance of a Pulsar Source", + "tags": [ + "sources" + ] + } + } + }, + "schemes": [ + "http", + "https" + ], + "swagger": "2.0", + "tags": [ + { + "name": "sources" + } + ] +} diff --git a/static/swagger/4.0.0/v3/swaggertransactions.json b/static/swagger/4.0.0/v3/swaggertransactions.json new file mode 100644 index 000000000000..5f830b49690a --- /dev/null +++ b/static/swagger/4.0.0/v3/swaggertransactions.json @@ -0,0 +1,1537 @@ +{ + "basePath": "/admin/v3", + "definitions": { + "AuthenticationDataSource": { + "properties": { + "commandData": { + "type": "string" + }, + "httpAuthType": { + "type": "string" + }, + "peerAddress": { + "$ref": "#/definitions/SocketAddress" + }, + "subscription": { + "type": "string" + }, + "tlsCertificates": { + "items": { + "$ref": "#/definitions/Certificate" + }, + "type": "array" + } + }, + "type": "object" + }, + "AuthenticationParameters": { + "properties": { + "clientAuthenticationDataSource": { + "$ref": "#/definitions/AuthenticationDataSource" + }, + "clientRole": { + "type": "string" + }, + "originalPrincipal": { + "type": "string" + } + }, + "type": "object" + }, + "Certificate": { + "properties": { + "encoded": { + "items": { + "format": "byte", + "type": "string" + }, + "type": "array" + }, + "publicKey": { + "$ref": "#/definitions/PublicKey" + }, + "type": { + "type": "string" + } + }, + "type": "object" + }, + "CompletableFuture": { + "properties": { + "cancelled": { + "type": "boolean" + }, + "completedExceptionally": { + "type": "boolean" + }, + "done": { + "type": "boolean" + }, + "numberOfDependents": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "CompletableFutureClusterData": { + "properties": { + "cancelled": { + "type": "boolean" + }, + "completedExceptionally": { + "type": "boolean" + }, + "done": { + "type": "boolean" + }, + "numberOfDependents": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "CompletableFutureVoid": { + "properties": { + "cancelled": { + "type": "boolean" + }, + "completedExceptionally": { + "type": "boolean" + }, + "done": { + "type": "boolean" + }, + "numberOfDependents": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "CursorStats": { + "properties": { + "active": { + "type": "boolean" + }, + "cursorLedger": { + "format": "int64", + "type": "integer" + }, + "cursorLedgerLastEntry": { + "format": "int64", + "type": "integer" + }, + "individuallyDeletedMessages": { + "type": "string" + }, + "lastLedgerSwitchTimestamp": { + "type": "string" + }, + "markDeletePosition": { + "type": "string" + }, + "messagesConsumedCounter": { + "format": "int64", + "type": "integer" + }, + "numberOfEntriesSinceFirstNotAckedMessage": { + "format": "int64", + "type": "integer" + }, + "pendingReadOps": { + "format": "int32", + "type": "integer" + }, + "properties": { + "additionalProperties": { + "format": "int64", + "type": "integer" + }, + "type": "object" + }, + "readPosition": { + "type": "string" + }, + "state": { + "type": "string" + }, + "subscriptionHavePendingRead": { + "type": "boolean" + }, + "subscriptionHavePendingReplayRead": { + "type": "boolean" + }, + "totalNonContiguousDeletedMessagesRange": { + "format": "int32", + "type": "integer" + }, + "waitingReadOp": { + "type": "boolean" + } + }, + "type": "object" + }, + "LedgerInfo": { + "properties": { + "entries": { + "format": "int64", + "type": "integer" + }, + "ledgerId": { + "format": "int64", + "type": "integer" + }, + "metadata": { + "type": "string" + }, + "offloaded": { + "type": "boolean" + }, + "size": { + "format": "int64", + "type": "integer" + }, + "underReplicated": { + "type": "boolean" + } + }, + "type": "object" + }, + "ManagedLedgerInternalStats": { + "properties": { + "currentLedgerEntries": { + "format": "int64", + "type": "integer" + }, + "currentLedgerSize": { + "format": "int64", + "type": "integer" + }, + "cursors": { + "additionalProperties": { + "$ref": "#/definitions/CursorStats" + }, + "type": "object" + }, + "entriesAddedCounter": { + "format": "int64", + "type": "integer" + }, + "lastConfirmedEntry": { + "type": "string" + }, + "lastLedgerCreatedTimestamp": { + "type": "string" + }, + "lastLedgerCreationFailureTimestamp": { + "type": "string" + }, + "ledgers": { + "items": { + "$ref": "#/definitions/LedgerInfo" + }, + "type": "array" + }, + "numberOfEntries": { + "format": "int64", + "type": "integer" + }, + "pendingAddEntriesCount": { + "format": "int32", + "type": "integer" + }, + "state": { + "type": "string" + }, + "totalSize": { + "format": "int64", + "type": "integer" + }, + "waitingCursorsCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "PositionInPendingAckStats": { + "properties": { + "state": { + "enum": [ + "PendingAck", + "MarkDelete", + "NotInPendingAck", + "PendingAckNotReady", + "InvalidPosition" + ], + "type": "string" + } + }, + "type": "object" + }, + "PublicKey": { + "properties": { + "algorithm": { + "type": "string" + }, + "encoded": { + "items": { + "format": "byte", + "type": "string" + }, + "type": "array" + }, + "format": { + "type": "string" + } + }, + "type": "object" + }, + "SegmentStats": { + "properties": { + "lastTxnID": { + "type": "string" + }, + "persistentPosition": { + "type": "string" + } + }, + "type": "object" + }, + "SegmentsStats": { + "properties": { + "currentSegmentCapacity": { + "format": "int64", + "type": "integer" + }, + "lastTookSnapshotSegmentTimestamp": { + "format": "int64", + "type": "integer" + }, + "segmentStats": { + "items": { + "$ref": "#/definitions/SegmentStats" + }, + "type": "array" + }, + "segmentsSize": { + "format": "int64", + "type": "integer" + }, + "unsealedAbortTxnIDSize": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "SnapshotSystemTopicInternalStats": { + "properties": { + "managedLedgerInternalStats": { + "$ref": "#/definitions/ManagedLedgerInternalStats" + }, + "managedLedgerName": { + "type": "string" + } + }, + "type": "object" + }, + "SocketAddress": { + "type": "object" + }, + "TransactionBufferInternalStats": { + "properties": { + "segmentIndexInternalStats": { + "$ref": "#/definitions/SnapshotSystemTopicInternalStats" + }, + "segmentInternalStats": { + "$ref": "#/definitions/SnapshotSystemTopicInternalStats" + }, + "singleSnapshotSystemTopicInternalStats": { + "$ref": "#/definitions/SnapshotSystemTopicInternalStats" + }, + "snapshotType": { + "type": "string" + } + }, + "type": "object" + }, + "TransactionBufferStats": { + "properties": { + "lastSnapshotTimestamps": { + "format": "int64", + "type": "integer" + }, + "lowWaterMarks": { + "additionalProperties": { + "format": "int64", + "type": "integer" + }, + "type": "object" + }, + "maxReadPosition": { + "type": "string" + }, + "ongoingTxnSize": { + "format": "int64", + "type": "integer" + }, + "recoverEndTime": { + "format": "int64", + "type": "integer" + }, + "recoverStartTime": { + "format": "int64", + "type": "integer" + }, + "segmentsStats": { + "$ref": "#/definitions/SegmentsStats" + }, + "snapshotType": { + "type": "string" + }, + "state": { + "type": "string" + }, + "totalAbortedTransactions": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "TransactionCoordinatorInfo": { + "properties": { + "brokerServiceUrl": { + "type": "string" + }, + "id": { + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "TransactionCoordinatorInternalStats": { + "properties": { + "transactionLogStats": { + "$ref": "#/definitions/TransactionLogStats" + } + }, + "type": "object" + }, + "TransactionCoordinatorStats": { + "properties": { + "leastSigBits": { + "format": "int64", + "type": "integer" + }, + "lowWaterMark": { + "format": "int64", + "type": "integer" + }, + "ongoingTxnSize": { + "format": "int64", + "type": "integer" + }, + "recoverEndTime": { + "format": "int64", + "type": "integer" + }, + "recoverStartTime": { + "format": "int64", + "type": "integer" + }, + "state": { + "type": "string" + } + }, + "type": "object" + }, + "TransactionInBufferStats": { + "properties": { + "aborted": { + "type": "boolean" + }, + "startPosition": { + "type": "string" + } + }, + "type": "object" + }, + "TransactionInPendingAckStats": { + "properties": { + "cumulativeAckPosition": { + "type": "string" + } + }, + "type": "object" + }, + "TransactionLogStats": { + "properties": { + "managedLedgerInternalStats": { + "$ref": "#/definitions/ManagedLedgerInternalStats" + }, + "managedLedgerName": { + "type": "string" + } + }, + "type": "object" + }, + "TransactionMetadata": { + "properties": { + "ackedPartitions": { + "additionalProperties": { + "additionalProperties": { + "$ref": "#/definitions/TransactionInPendingAckStats" + }, + "type": "object" + }, + "type": "object" + }, + "openTimestamp": { + "format": "int64", + "type": "integer" + }, + "owner": { + "type": "string" + }, + "producedPartitions": { + "additionalProperties": { + "$ref": "#/definitions/TransactionInBufferStats" + }, + "type": "object" + }, + "status": { + "type": "string" + }, + "timeoutAt": { + "format": "int64", + "type": "integer" + }, + "txnId": { + "type": "string" + } + }, + "type": "object" + }, + "TransactionPendingAckInternalStats": { + "properties": { + "pendingAckLogStats": { + "$ref": "#/definitions/TransactionLogStats" + } + }, + "type": "object" + }, + "TransactionPendingAckStats": { + "properties": { + "lowWaterMarks": { + "additionalProperties": { + "format": "int64", + "type": "integer" + }, + "type": "object" + }, + "ongoingTxnSize": { + "format": "int64", + "type": "integer" + }, + "recoverEndTime": { + "format": "int64", + "type": "integer" + }, + "recoverStartTime": { + "format": "int64", + "type": "integer" + }, + "state": { + "type": "string" + } + }, + "type": "object" + } + }, + "info": { + "description": "This provides the REST API for Pulsar Transactions operations", + "license": { + "name": "Apache 2.0", + "url": "http://www.apache.org/licenses/LICENSE-2.0.html" + }, + "title": "Pulsar Transactions REST API", + "version": "v3" + }, + "paths": { + "/transactions/abortTransaction/{mostSigBits}/{leastSigBits}": { + "post": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Transactions_abortTransaction", + "parameters": [ + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "in": "path", + "name": "mostSigBits", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "leastSigBits", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "307": { + "description": "Topic is not owned by this broker!" + }, + "400": { + "description": "Topic is not a persistent topic!" + }, + "401": { + "description": "This operation requires super-user access" + }, + "404": { + "description": "Tenant or cluster or namespace or topic or coordinator or transaction doesn't exist" + }, + "409": { + "description": "Concurrent modification" + }, + "503": { + "description": "This Broker is not configured with transactionCoordinatorEnabled=true." + } + }, + "summary": "Abort transaction", + "tags": [ + "transactions" + ] + } + }, + "/transactions/coordinatorInternalStats/{coordinatorId}": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Transactions_getCoordinatorInternalStats", + "parameters": [ + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "in": "path", + "name": "coordinatorId", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "metadata", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/TransactionCoordinatorInternalStats" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Transaction coordinator not found" + }, + "405": { + "description": "Broker don't use MLTransactionMetadataStore!" + }, + "409": { + "description": "Concurrent modification" + }, + "503": { + "description": "This Broker is not configured with transactionCoordinatorEnabled=true." + } + }, + "summary": "Get coordinator internal stats.", + "tags": [ + "transactions" + ] + } + }, + "/transactions/coordinatorStats": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Transactions_getCoordinatorStats", + "parameters": [ + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "format": "int32", + "in": "query", + "name": "coordinatorId", + "required": false, + "type": "integer" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/TransactionCoordinatorStats" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Transaction coordinator not found" + }, + "409": { + "description": "Concurrent modification" + }, + "503": { + "description": "This Broker is not configured with transactionCoordinatorEnabled=true." + } + }, + "summary": "Get transaction coordinator stats.", + "tags": [ + "transactions" + ] + } + }, + "/transactions/coordinators": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Transactions_listCoordinators", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "items": { + "$ref": "#/definitions/TransactionCoordinatorInfo" + }, + "type": "array" + } + }, + "403": { + "description": "Don't have admin permission" + }, + "503": { + "description": "This Broker is not configured with transactionCoordinatorEnabled=true." + } + }, + "summary": "List transaction coordinators.", + "tags": [ + "transactions" + ] + } + }, + "/transactions/pendingAckInternalStats/{tenant}/{namespace}/{topic}/{subName}": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Transactions_getPendingAckInternalStats", + "parameters": [ + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "subName", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "metadata", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/TransactionPendingAckInternalStats" + } + }, + "307": { + "description": "Topic is not owned by this broker!" + }, + "400": { + "description": "Topic is not a persistent topic!" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic or subscription name doesn't exist" + }, + "405": { + "description": "Pending ack handle don't use managedLedger!" + }, + "409": { + "description": "Concurrent modification" + }, + "503": { + "description": "This Broker is not configured with transactionCoordinatorEnabled=true." + } + }, + "summary": "Get transaction pending ack internal stats.", + "tags": [ + "transactions" + ] + } + }, + "/transactions/pendingAckStats/{tenant}/{namespace}/{topic}/{subName}": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Transactions_getPendingAckStats", + "parameters": [ + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "subName", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "lowWaterMarks", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/TransactionPendingAckStats" + } + }, + "307": { + "description": "Topic is not owned by this broker!" + }, + "400": { + "description": "Topic is not a persistent topic!" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic or subName doesn't exist" + }, + "409": { + "description": "Concurrent modification" + }, + "503": { + "description": "This Broker is not configured with transactionCoordinatorEnabled=true." + } + }, + "summary": "Get transaction pending ack stats in topic.", + "tags": [ + "transactions" + ] + } + }, + "/transactions/positionStatsInPendingAck/{tenant}/{namespace}/{topic}/{subName}/{ledgerId}/{entryId}": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Transactions_getPositionStatsInPendingAck", + "parameters": [ + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "subName", + "required": true, + "type": "string" + }, + { + "format": "int64", + "in": "path", + "name": "ledgerId", + "required": true, + "type": "integer" + }, + { + "format": "int64", + "in": "path", + "name": "entryId", + "required": true, + "type": "integer" + }, + { + "format": "int32", + "in": "query", + "name": "batchIndex", + "required": false, + "type": "integer" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/PositionInPendingAckStats" + } + }, + "307": { + "description": "Topic is not owned by this broker!" + }, + "400": { + "description": "Topic is not a persistent topic!" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic or subscription name doesn't exist" + }, + "405": { + "description": "Pending ack handle don't use managedLedger!" + }, + "409": { + "description": "Concurrent modification" + }, + "503": { + "description": "This Broker is not configured with transactionCoordinatorEnabled=true." + } + }, + "summary": "Get position stats in pending ack.", + "tags": [ + "transactions" + ] + } + }, + "/transactions/slowTransactions/{timeout}": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Transactions_getSlowTransactions", + "parameters": [ + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "in": "path", + "name": "timeout", + "required": true, + "type": "string" + }, + { + "format": "int32", + "in": "query", + "name": "coordinatorId", + "required": false, + "type": "integer" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "additionalProperties": { + "$ref": "#/definitions/TransactionMetadata" + }, + "type": "object" + } + }, + "307": { + "description": "Topic don't owner by this broker!" + }, + "400": { + "description": "Topic is not a persistent topic!" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic or coordinator or transaction doesn't exist" + }, + "409": { + "description": "Concurrent modification" + }, + "503": { + "description": "This Broker is not configured with transactionCoordinatorEnabled=true." + } + }, + "summary": "Get slow transactions.", + "tags": [ + "transactions" + ] + } + }, + "/transactions/transactionBufferInternalStats/{tenant}/{namespace}/{topic}": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Transactions_getTransactionBufferInternalStats", + "parameters": [ + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "metadata", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/TransactionBufferInternalStats" + } + }, + "307": { + "description": "Topic is not owned by this broker!" + }, + "400": { + "description": "Topic is not a persistent topic!" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + }, + "405": { + "description": "Transaction buffer don't use managedLedger!" + }, + "409": { + "description": "Concurrent modification" + }, + "503": { + "description": "This Broker is not enable transaction" + } + }, + "summary": "Get transaction buffer internal stats.", + "tags": [ + "transactions" + ] + } + }, + "/transactions/transactionBufferStats/{tenant}/{namespace}/{topic}": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Transactions_getTransactionBufferStats", + "parameters": [ + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "default": false, + "in": "query", + "name": "lowWaterMarks", + "required": false, + "type": "boolean" + }, + { + "default": false, + "in": "query", + "name": "segmentStats", + "required": false, + "type": "boolean" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/TransactionBufferStats" + } + }, + "307": { + "description": "Topic is not owned by this broker!" + }, + "400": { + "description": "Topic is not a persistent topic!" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + }, + "409": { + "description": "Concurrent modification" + }, + "503": { + "description": "This Broker is not configured with transactionCoordinatorEnabled=true." + } + }, + "summary": "Get transaction buffer stats in topic.", + "tags": [ + "transactions" + ] + } + }, + "/transactions/transactionCoordinator/replicas": { + "post": { + "consumes": [ + "application/json" + ], + "operationId": "Transactions_scaleTransactionCoordinators", + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Operation successful" + }, + "401": { + "description": "This operation requires super-user access" + }, + "406": { + "description": "The number of replicas should be more than the current number of transaction coordinator replicas" + }, + "503": { + "description": "This Broker is not configured with transactionCoordinatorEnabled=true." + } + }, + "tags": [ + "transactions" + ] + } + }, + "/transactions/transactionInBufferStats/{tenant}/{namespace}/{topic}/{mostSigBits}/{leastSigBits}": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Transactions_getTransactionInBufferStats", + "parameters": [ + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "mostSigBits", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "leastSigBits", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/TransactionInBufferStats" + } + }, + "307": { + "description": "Topic is not owned by this broker!" + }, + "400": { + "description": "Topic is not a persistent topic!" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + }, + "409": { + "description": "Concurrent modification" + }, + "503": { + "description": "This Broker is not configured with transactionCoordinatorEnabled=true." + } + }, + "summary": "Get transaction state in transaction buffer.", + "tags": [ + "transactions" + ] + } + }, + "/transactions/transactionInPendingAckStats/{tenant}/{namespace}/{topic}/{subName}/{mostSigBits}/{leastSigBits}": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Transactions_getTransactionInPendingAckStats", + "parameters": [ + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "in": "path", + "name": "tenant", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "namespace", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "topic", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "mostSigBits", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "leastSigBits", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "subName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/TransactionInPendingAckStats" + } + }, + "307": { + "description": "Topic is not owned by this broker!" + }, + "400": { + "description": "Topic is not a persistent topic!" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic doesn't exist" + }, + "409": { + "description": "Concurrent modification" + }, + "503": { + "description": "This Broker is not configured with transactionCoordinatorEnabled=true." + } + }, + "summary": "Get transaction state in pending ack.", + "tags": [ + "transactions" + ] + } + }, + "/transactions/transactionMetadata/{mostSigBits}/{leastSigBits}": { + "get": { + "consumes": [ + "application/json" + ], + "description": "", + "operationId": "Transactions_getTransactionMetadata", + "parameters": [ + { + "default": false, + "in": "query", + "name": "authoritative", + "required": false, + "type": "boolean" + }, + { + "in": "path", + "name": "mostSigBits", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "leastSigBits", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/TransactionMetadata" + } + }, + "307": { + "description": "Topic is not owned by this broker!" + }, + "400": { + "description": "Topic is not a persistent topic!" + }, + "403": { + "description": "Don't have admin permission" + }, + "404": { + "description": "Tenant or cluster or namespace or topic or coordinator or transaction doesn't exist" + }, + "409": { + "description": "Concurrent modification" + }, + "503": { + "description": "This Broker is not configured with transactionCoordinatorEnabled=true." + } + }, + "summary": "Get transaction metadata", + "tags": [ + "transactions" + ] + } + } + }, + "schemes": [ + "http", + "https" + ], + "swagger": "2.0", + "tags": [ + { + "name": "transactions" + } + ] +} diff --git a/static/swagger/restApiVersions.json b/static/swagger/restApiVersions.json index c1b1e24eb5bc..d4d3da619d3a 100644 --- a/static/swagger/restApiVersions.json +++ b/static/swagger/restApiVersions.json @@ -1070,6 +1070,25 @@ "version": "v3" } ], + "4.0.0": [ + { + "fileName": [ + "swagger", + "swaggerlookup" + ], + "version": "v2" + }, + { + "fileName": [ + "swaggerfunctions", + "swaggerpackages", + "swaggersink", + "swaggersource", + "swaggertransactions" + ], + "version": "v3" + } + ], "master": [ { "fileName": [ From 9bf6081e0e10100d420c00805607c0b3c3bd9ce2 Mon Sep 17 00:00:00 2001 From: Lari Hotari Date: Mon, 14 Oct 2024 20:46:31 +0300 Subject: [PATCH 2/9] update java-apidoc for 4.0.0 --- static/api/admin/4.0.x/allclasses-index.html | 851 ++ static/api/admin/4.0.x/allpackages-index.html | 127 + static/api/admin/4.0.x/constant-values.html | 145 + static/api/admin/4.0.x/copy.svg | 33 + static/api/admin/4.0.x/deprecated-list.html | 938 ++ static/api/admin/4.0.x/element-list | 16 + static/api/admin/4.0.x/help-doc.html | 208 + static/api/admin/4.0.x/index-all.html | 9382 +++++++++++++++++ static/api/admin/4.0.x/index.html | 129 + .../admin/4.0.x/legal/ADDITIONAL_LICENSE_INFO | 37 + .../api/admin/4.0.x/legal/ASSEMBLY_EXCEPTION | 27 + static/api/admin/4.0.x/legal/LICENSE | 347 + static/api/admin/4.0.x/legal/jquery.md | 72 + static/api/admin/4.0.x/legal/jqueryUI.md | 49 + static/api/admin/4.0.x/link.svg | 31 + static/api/admin/4.0.x/member-search-index.js | 1 + static/api/admin/4.0.x/module-search-index.js | 1 + .../apache/pulsar/client/admin/Bookies.html | 288 + .../pulsar/client/admin/BrokerStats.html | 349 + .../apache/pulsar/client/admin/Brokers.html | 753 ++ .../apache/pulsar/client/admin/Clusters.html | 1137 ++ .../apache/pulsar/client/admin/Functions.html | 1620 +++ .../pulsar/client/admin/GetStatsOptions.html | 150 + .../admin/GrantTopicPermissionOptions.html | 150 + .../admin/ListNamespaceTopicsOptions.html | 179 + .../client/admin/ListTopicsOptions.html | 179 + .../LongRunningProcessStatus.Status.html | 257 + .../admin/LongRunningProcessStatus.html | 242 + .../apache/pulsar/client/admin/Lookup.html | 250 + .../org/apache/pulsar/client/admin/Mode.html | 277 + .../pulsar/client/admin/Namespaces.html | 7829 ++++++++++++++ .../client/admin/NonPersistentTopics.html | 525 + .../client/admin/OffloadProcessStatus.html | 189 + .../apache/pulsar/client/admin/Packages.html | 428 + .../pulsar/client/admin/Properties.html | 279 + .../pulsar/client/admin/ProxyStats.html | 171 + .../pulsar/client/admin/PulsarAdmin.html | 534 + .../client/admin/PulsarAdminBuilder.html | 787 ++ ...ulsarAdminException.ConflictException.html | 230 + ...PulsarAdminException.ConnectException.html | 236 + ...on.GettingAuthenticationDataException.html | 238 + ...lsarAdminException.HttpErrorException.html | 234 + ...sarAdminException.NotAllowedException.html | 230 + ...AdminException.NotAuthorizedException.html | 230 + ...ulsarAdminException.NotFoundException.html | 230 + ...Exception.PreconditionFailedException.html | 230 + ...minException.ServerSideErrorException.html | 244 + ...PulsarAdminException.TimeoutException.html | 226 + .../client/admin/PulsarAdminException.html | 353 + .../pulsar/client/admin/ResourceGroups.html | 397 + .../pulsar/client/admin/ResourceQuotas.html | 528 + .../admin/RevokeTopicPermissionOptions.html | 150 + .../apache/pulsar/client/admin/Schemas.html | 651 ++ .../org/apache/pulsar/client/admin/Sink.html | 124 + .../org/apache/pulsar/client/admin/Sinks.html | 1062 ++ .../apache/pulsar/client/admin/Source.html | 124 + .../apache/pulsar/client/admin/Sources.html | 1062 ++ .../apache/pulsar/client/admin/Tenants.html | 413 + .../pulsar/client/admin/TopicPolicies.html | 4073 +++++++ .../client/admin/Topics.QueryParam.html | 261 + .../apache/pulsar/client/admin/Topics.html | 8962 ++++++++++++++++ .../pulsar/client/admin/Transactions.html | 983 ++ .../apache/pulsar/client/admin/Worker.html | 333 + .../client/admin/class-use/Bookies.html | 87 + .../client/admin/class-use/BrokerStats.html | 87 + .../client/admin/class-use/Brokers.html | 87 + .../client/admin/class-use/Clusters.html | 87 + .../client/admin/class-use/Functions.html | 87 + .../admin/class-use/GetStatsOptions.html | 104 + .../GrantTopicPermissionOptions.html | 94 + .../class-use/ListNamespaceTopicsOptions.html | 105 + .../admin/class-use/ListTopicsOptions.html | 119 + .../LongRunningProcessStatus.Status.html | 139 + .../class-use/LongRunningProcessStatus.html | 106 + .../pulsar/client/admin/class-use/Lookup.html | 87 + .../pulsar/client/admin/class-use/Mode.html | 100 + .../client/admin/class-use/Namespaces.html | 87 + .../admin/class-use/NonPersistentTopics.html | 91 + .../admin/class-use/OffloadProcessStatus.html | 129 + .../client/admin/class-use/Packages.html | 87 + .../client/admin/class-use/Properties.html | 91 + .../client/admin/class-use/ProxyStats.html | 87 + .../client/admin/class-use/PulsarAdmin.html | 87 + .../admin/class-use/PulsarAdminBuilder.html | 266 + ...ulsarAdminException.ConflictException.html | 62 + ...PulsarAdminException.ConnectException.html | 62 + ...on.GettingAuthenticationDataException.html | 62 + ...lsarAdminException.HttpErrorException.html | 62 + ...sarAdminException.NotAllowedException.html | 62 + ...AdminException.NotAuthorizedException.html | 62 + ...ulsarAdminException.NotFoundException.html | 62 + ...Exception.PreconditionFailedException.html | 62 + ...minException.ServerSideErrorException.html | 62 + ...PulsarAdminException.TimeoutException.html | 62 + .../admin/class-use/PulsarAdminException.html | 4093 +++++++ .../admin/class-use/ResourceGroups.html | 87 + .../admin/class-use/ResourceQuotas.html | 87 + .../RevokeTopicPermissionOptions.html | 94 + .../client/admin/class-use/Schemas.html | 87 + .../pulsar/client/admin/class-use/Sink.html | 91 + .../pulsar/client/admin/class-use/Sinks.html | 100 + .../pulsar/client/admin/class-use/Source.html | 91 + .../client/admin/class-use/Sources.html | 100 + .../client/admin/class-use/Tenants.html | 87 + .../client/admin/class-use/TopicPolicies.html | 94 + .../admin/class-use/Topics.QueryParam.html | 119 + .../pulsar/client/admin/class-use/Topics.html | 87 + .../client/admin/class-use/Transactions.html | 87 + .../pulsar/client/admin/class-use/Worker.html | 87 + .../pulsar/client/admin/package-summary.html | 275 + .../pulsar/client/admin/package-tree.html | 164 + .../pulsar/client/admin/package-use.html | 241 + .../admin/utils/DefaultImplementation.html | 191 + .../client/admin/utils/ReflectionUtils.html | 177 + .../class-use/DefaultImplementation.html | 62 + .../utils/class-use/ReflectionUtils.html | 62 + .../client/admin/utils/package-summary.html | 114 + .../client/admin/utils/package-tree.html | 77 + .../client/admin/utils/package-use.html | 62 + .../conf/InternalConfigurationData.html | 312 + .../class-use/InternalConfigurationData.html | 100 + .../pulsar/common/conf/package-summary.html | 101 + .../pulsar/common/conf/package-tree.html | 76 + .../pulsar/common/conf/package-use.html | 86 + .../functions/AuthenticationConfig.html | 151 + .../common/functions/ConsumerConfig.html | 151 + .../pulsar/common/functions/CryptoConfig.html | 151 + .../FunctionConfig.ProcessingGuarantees.html | 257 + .../functions/FunctionConfig.Runtime.html | 249 + .../common/functions/FunctionConfig.html | 173 + .../common/functions/FunctionDefinition.html | 151 + .../common/functions/FunctionState.html | 151 + .../common/functions/ProducerConfig.html | 151 + .../pulsar/common/functions/Resources.html | 187 + .../common/functions/UpdateOptions.html | 152 + .../WindowConfig.ProcessingGuarantees.html | 243 + .../pulsar/common/functions/WindowConfig.html | 207 + .../pulsar/common/functions/WorkerInfo.html | 191 + .../class-use/AuthenticationConfig.html | 62 + .../functions/class-use/ConsumerConfig.html | 62 + .../functions/class-use/CryptoConfig.html | 62 + .../FunctionConfig.ProcessingGuarantees.html | 97 + .../class-use/FunctionConfig.Runtime.html | 97 + .../functions/class-use/FunctionConfig.html | 186 + .../class-use/FunctionDefinition.html | 94 + .../functions/class-use/FunctionState.html | 128 + .../functions/class-use/ProducerConfig.html | 62 + .../common/functions/class-use/Resources.html | 101 + .../functions/class-use/UpdateOptions.html | 168 + .../WindowConfig.ProcessingGuarantees.html | 97 + .../functions/class-use/WindowConfig.html | 62 + .../functions/class-use/WorkerInfo.html | 133 + .../common/functions/package-summary.html | 155 + .../pulsar/common/functions/package-tree.html | 107 + .../pulsar/common/functions/package-use.html | 135 + .../pulsar/common/io/BatchSourceConfig.html | 205 + .../pulsar/common/io/ConnectorDefinition.html | 151 + .../apache/pulsar/common/io/SinkConfig.html | 151 + .../apache/pulsar/common/io/SourceConfig.html | 151 + .../io/class-use/BatchSourceConfig.html | 62 + .../io/class-use/ConnectorDefinition.html | 109 + .../common/io/class-use/SinkConfig.html | 186 + .../common/io/class-use/SourceConfig.html | 186 + .../pulsar/common/io/package-summary.html | 113 + .../apache/pulsar/common/io/package-tree.html | 79 + .../apache/pulsar/common/io/package-use.html | 94 + .../pulsar/common/naming/TopicDomain.html | 268 + .../pulsar/common/naming/TopicVersion.html | 236 + .../common/naming/class-use/TopicDomain.html | 157 + .../common/naming/class-use/TopicVersion.html | 127 + .../pulsar/common/naming/package-summary.html | 103 + .../pulsar/common/naming/package-tree.html | 81 + .../pulsar/common/naming/package-use.html | 107 + .../partition/PartitionedTopicMetadata.html | 253 + .../class-use/PartitionedTopicMetadata.html | 148 + .../common/partition/package-summary.html | 101 + .../pulsar/common/partition/package-tree.html | 76 + .../pulsar/common/partition/package-use.html | 103 + .../common/policies/AutoFailoverPolicy.html | 216 + .../class-use/AutoFailoverPolicy.html | 100 + .../common/policies/data/AuthAction.html | 287 + .../policies/data/AuthPolicies.Builder.html | 174 + .../common/policies/data/AuthPolicies.html | 186 + .../data/AutoFailoverPolicyData.Builder.html | 165 + .../policies/data/AutoFailoverPolicyData.html | 185 + .../policies/data/AutoFailoverPolicyType.html | 238 + ...oSubscriptionCreationOverride.Builder.html | 160 + .../AutoSubscriptionCreationOverride.html | 172 + .../AutoTopicCreationOverride.Builder.html | 178 + .../data/AutoTopicCreationOverride.html | 190 + .../data/BacklogQuota.BacklogQuotaType.html | 241 + .../policies/data/BacklogQuota.Builder.html | 178 + .../data/BacklogQuota.RetentionPolicy.html | 258 + .../common/policies/data/BacklogQuota.html | 236 + .../data/BookieAffinityGroupData.Builder.html | 169 + .../data/BookieAffinityGroupData.html | 181 + .../policies/data/BookieInfo.Builder.html | 169 + .../common/policies/data/BookieInfo.html | 181 + .../data/BookiesClusterInfo.Builder.html | 160 + .../policies/data/BookiesClusterInfo.html | 172 + .../data/BookiesRackConfiguration.html | 240 + .../policies/data/BrokerAssignment.html | 245 + .../policies/data/BrokerInfo.Builder.html | 169 + .../common/policies/data/BrokerInfo.html | 181 + .../BrokerNamespaceIsolationData.Builder.html | 183 + .../data/BrokerNamespaceIsolationData.html | 194 + .../policies/data/BrokerStatus.Builder.html | 178 + .../common/policies/data/BrokerStatus.html | 198 + .../policies/data/BundlesData.Builder.html | 169 + .../common/policies/data/BundlesData.html | 181 + .../policies/data/ClusterData.Builder.html | 363 + .../common/policies/data/ClusterData.html | 383 + .../data/ClusterPolicies.Builder.html | 165 + .../data/ClusterPolicies.ClusterUrl.html | 181 + .../common/policies/data/ClusterPolicies.html | 188 + .../common/policies/data/CompactionStats.html | 183 + .../common/policies/data/ConsumerStats.html | 486 + .../data/DelayedDeliveryPolicies.Builder.html | 178 + .../data/DelayedDeliveryPolicies.html | 190 + .../policies/data/DispatchRate.Builder.html | 187 + .../common/policies/data/DispatchRate.html | 199 + .../common/policies/data/DrainingHash.html | 191 + .../common/policies/data/EntryFilters.html | 150 + .../common/policies/data/ErrorData.html | 188 + .../policies/data/ExceptionInformation.html | 151 + .../policies/data/FailureDomain.Builder.html | 156 + .../common/policies/data/FailureDomain.html | 167 + .../policies/data/FunctionInstanceStats.html | 152 + .../data/FunctionInstanceStatsData.html | 169 + .../data/FunctionInstanceStatsDataBase.html | 183 + .../common/policies/data/FunctionStats.html | 215 + ...anceStatus.FunctionInstanceStatusData.html | 283 + ...FunctionStatus.FunctionInstanceStatus.html | 210 + .../common/policies/data/FunctionStatus.html | 242 + .../data/InactiveTopicDeleteMode.html | 243 + .../policies/data/InactiveTopicPolicies.html | 151 + ...anagedLedgerInternalStats.CursorStats.html | 319 + ...ManagedLedgerInternalStats.LedgerInfo.html | 229 + .../data/ManagedLedgerInternalStats.html | 355 + .../data/NamespaceIsolationData.Builder.html | 192 + .../policies/data/NamespaceIsolationData.html | 212 + .../NamespaceIsolationPolicyUnloadScope.html | 254 + .../data/NamespaceOwnershipStatus.html | 241 + .../NonPersistentPartitionedTopicStats.html | 168 + .../data/NonPersistentPublisherStats.html | 157 + .../data/NonPersistentReplicatorStats.html | 167 + .../data/NonPersistentSubscriptionStats.html | 157 + .../data/NonPersistentTopicStats.html | 205 + .../data/OffloadPolicies.Builder.html | 408 + .../common/policies/data/OffloadPolicies.html | 419 + .../policies/data/OffloadedReadPriority.html | 288 + .../data/PartitionedTopicInternalStats.html | 224 + .../policies/data/PartitionedTopicStats.html | 174 + .../policies/data/PersistencePolicies.html | 270 + .../data/PersistentTopicInternalStats.html | 203 + .../policies/data/Policies.BundleType.html | 240 + .../pulsar/common/policies/data/Policies.html | 695 ++ .../common/policies/data/PublishRate.html | 252 + .../common/policies/data/PublisherStats.html | 280 + .../common/policies/data/RawBookieInfo.html | 151 + .../common/policies/data/ReplicatorStats.html | 353 + .../common/policies/data/ResourceGroup.html | 150 + .../common/policies/data/ResourceQuota.html | 210 + .../policies/data/RetentionPolicies.html | 242 + ...SchemaAutoUpdateCompatibilityStrategy.html | 318 + .../data/SchemaCompatibilityStrategy.html | 342 + .../policies/data/SchemaMetadata.Entry.html | 185 + .../common/policies/data/SchemaMetadata.html | 204 + .../common/policies/data/SegmentStats.html | 198 + .../common/policies/data/SegmentsStats.html | 218 + ...InstanceStatus.SinkInstanceStatusData.html | 274 + .../data/SinkStatus.SinkInstanceStatus.html | 210 + .../common/policies/data/SinkStatus.html | 242 + .../SnapshotSystemTopicInternalStats.html | 188 + ...stanceStatus.SourceInstanceStatusData.html | 274 + .../SourceStatus.SourceInstanceStatus.html | 210 + .../common/policies/data/SourceStatus.html | 242 + .../common/policies/data/SubscribeRate.html | 252 + .../policies/data/SubscriptionAuthMode.html | 243 + .../policies/data/SubscriptionStats.html | 637 ++ .../policies/data/TenantInfo.Builder.html | 165 + .../common/policies/data/TenantInfo.html | 176 + .../policies/data/TopicHashPositions.html | 150 + .../common/policies/data/TopicStats.html | 487 + .../common/policies/data/TopicType.html | 259 + .../data/TransactionBufferInternalStats.html | 206 + .../policies/data/TransactionBufferStats.html | 275 + .../data/TransactionCoordinatorInfo.html | 151 + .../TransactionCoordinatorInternalStats.html | 183 + .../data/TransactionCoordinatorStats.html | 237 + .../data/TransactionCoordinatorStatus.html | 207 + .../data/TransactionInBufferStats.html | 194 + .../data/TransactionInPendingAckStats.html | 182 + .../policies/data/TransactionLogStats.html | 195 + .../policies/data/TransactionMetadata.html | 254 + .../TransactionPendingAckInternalStats.html | 183 + .../data/TransactionPendingAckStats.html | 224 + .../common/policies/data/ValidateResult.html | 159 + .../data/WorkerFunctionInstanceStats.html | 192 + .../policies/data/class-use/AuthAction.html | 188 + .../data/class-use/AuthPolicies.Builder.html | 98 + .../policies/data/class-use/AuthPolicies.html | 98 + .../AutoFailoverPolicyData.Builder.html | 95 + .../class-use/AutoFailoverPolicyData.html | 128 + .../class-use/AutoFailoverPolicyType.html | 112 + ...oSubscriptionCreationOverride.Builder.html | 108 + .../AutoSubscriptionCreationOverride.html | 187 + .../AutoTopicCreationOverride.Builder.html | 114 + .../class-use/AutoTopicCreationOverride.html | 172 + .../BacklogQuota.BacklogQuotaType.html | 218 + .../data/class-use/BacklogQuota.Builder.html | 114 + .../BacklogQuota.RetentionPolicy.html | 148 + .../policies/data/class-use/BacklogQuota.html | 220 + .../BookieAffinityGroupData.Builder.html | 111 + .../class-use/BookieAffinityGroupData.html | 156 + .../data/class-use/BookieInfo.Builder.html | 111 + .../policies/data/class-use/BookieInfo.html | 176 + .../class-use/BookiesClusterInfo.Builder.html | 108 + .../data/class-use/BookiesClusterInfo.html | 136 + .../class-use/BookiesRackConfiguration.html | 100 + .../data/class-use/BrokerAssignment.html | 117 + .../data/class-use/BrokerInfo.Builder.html | 111 + .../policies/data/class-use/BrokerInfo.html | 136 + .../BrokerNamespaceIsolationData.Builder.html | 101 + .../BrokerNamespaceIsolationData.html | 130 + .../data/class-use/BrokerStatus.Builder.html | 114 + .../policies/data/class-use/BrokerStatus.html | 174 + .../data/class-use/BundlesData.Builder.html | 111 + .../policies/data/class-use/BundlesData.html | 163 + .../data/class-use/ClusterData.Builder.html | 164 + .../policies/data/class-use/ClusterData.html | 148 + .../class-use/ClusterPolicies.Builder.html | 98 + .../class-use/ClusterPolicies.ClusterUrl.html | 125 + .../data/class-use/ClusterPolicies.html | 118 + .../data/class-use/CompactionStats.html | 91 + .../data/class-use/ConsumerStats.html | 91 + .../DelayedDeliveryPolicies.Builder.html | 114 + .../class-use/DelayedDeliveryPolicies.html | 243 + .../data/class-use/DispatchRate.Builder.html | 117 + .../policies/data/class-use/DispatchRate.html | 478 + .../policies/data/class-use/DrainingHash.html | 92 + .../policies/data/class-use/EntryFilters.html | 160 + .../policies/data/class-use/ErrorData.html | 62 + .../data/class-use/ExceptionInformation.html | 104 + .../data/class-use/FailureDomain.Builder.html | 92 + .../data/class-use/FailureDomain.html | 164 + .../data/class-use/FunctionInstanceStats.html | 89 + .../class-use/FunctionInstanceStatsData.html | 133 + .../FunctionInstanceStatsDataBase.html | 101 + .../data/class-use/FunctionStats.html | 122 + ...anceStatus.FunctionInstanceStatusData.html | 124 + ...FunctionStatus.FunctionInstanceStatus.html | 98 + .../data/class-use/FunctionStatus.html | 104 + .../class-use/InactiveTopicDeleteMode.html | 97 + .../data/class-use/InactiveTopicPolicies.html | 216 + ...anagedLedgerInternalStats.CursorStats.html | 91 + ...ManagedLedgerInternalStats.LedgerInfo.html | 103 + .../class-use/ManagedLedgerInternalStats.html | 105 + .../NamespaceIsolationData.Builder.html | 104 + .../class-use/NamespaceIsolationData.html | 164 + .../NamespaceIsolationPolicyUnloadScope.html | 112 + .../class-use/NamespaceOwnershipStatus.html | 96 + .../NonPersistentPartitionedTopicStats.html | 62 + .../NonPersistentPublisherStats.html | 91 + .../NonPersistentReplicatorStats.html | 91 + .../NonPersistentSubscriptionStats.html | 91 + .../class-use/NonPersistentTopicStats.html | 138 + .../class-use/OffloadPolicies.Builder.html | 176 + .../data/class-use/OffloadPolicies.html | 225 + .../data/class-use/OffloadedReadPriority.html | 112 + .../PartitionedTopicInternalStats.html | 100 + .../data/class-use/PartitionedTopicStats.html | 146 + .../data/class-use/PersistencePolicies.html | 216 + .../PersistentTopicInternalStats.html | 142 + .../data/class-use/Policies.BundleType.html | 97 + .../policies/data/class-use/Policies.html | 118 + .../policies/data/class-use/PublishRate.html | 206 + .../data/class-use/PublisherStats.html | 102 + .../data/class-use/RawBookieInfo.html | 114 + .../data/class-use/ReplicatorStats.html | 102 + .../data/class-use/ResourceGroup.html | 130 + .../data/class-use/ResourceQuota.html | 167 + .../data/class-use/RetentionPolicies.html | 216 + ...SchemaAutoUpdateCompatibilityStrategy.html | 147 + .../SchemaCompatibilityStrategy.html | 193 + .../data/class-use/SchemaMetadata.Entry.html | 98 + .../data/class-use/SchemaMetadata.html | 100 + .../policies/data/class-use/SegmentStats.html | 89 + .../data/class-use/SegmentsStats.html | 89 + ...InstanceStatus.SinkInstanceStatusData.html | 124 + .../SinkStatus.SinkInstanceStatus.html | 98 + .../policies/data/class-use/SinkStatus.html | 104 + .../SnapshotSystemTopicInternalStats.html | 95 + ...stanceStatus.SourceInstanceStatusData.html | 124 + .../SourceStatus.SourceInstanceStatus.html | 98 + .../policies/data/class-use/SourceStatus.html | 104 + .../data/class-use/SubscribeRate.html | 234 + .../data/class-use/SubscriptionAuthMode.html | 153 + .../data/class-use/SubscriptionStats.html | 102 + .../data/class-use/TenantInfo.Builder.html | 95 + .../policies/data/class-use/TenantInfo.html | 168 + .../data/class-use/TopicHashPositions.html | 104 + .../policies/data/class-use/TopicStats.html | 186 + .../policies/data/class-use/TopicType.html | 97 + .../TransactionBufferInternalStats.html | 102 + .../class-use/TransactionBufferStats.html | 126 + .../class-use/TransactionCoordinatorInfo.html | 94 + .../TransactionCoordinatorInternalStats.html | 102 + .../TransactionCoordinatorStats.html | 110 + .../TransactionCoordinatorStatus.html | 62 + .../class-use/TransactionInBufferStats.html | 122 + .../TransactionInPendingAckStats.html | 124 + .../data/class-use/TransactionLogStats.html | 96 + .../data/class-use/TransactionMetadata.html | 126 + .../TransactionPendingAckInternalStats.html | 104 + .../class-use/TransactionPendingAckStats.html | 116 + .../data/class-use/ValidateResult.html | 108 + .../WorkerFunctionInstanceStats.html | 94 + ...bscriptionCreationOverrideImplBuilder.html | 203 + .../AutoSubscriptionCreationOverrideImpl.html | 204 + ....AutoTopicCreationOverrideImplBuilder.html | 229 + .../impl/AutoTopicCreationOverrideImpl.html | 213 + ...klogQuotaImpl.BacklogQuotaImplBuilder.html | 229 + .../policies/data/impl/BacklogQuotaImpl.html | 354 + ...pl.BookieAffinityGroupDataImplBuilder.html | 216 + .../impl/BookieAffinityGroupDataImpl.html | 204 + .../BookieInfoImpl.BookieInfoImplBuilder.html | 228 + .../policies/data/impl/BookieInfoImpl.html | 204 + ...nfoImpl.BookiesClusterInfoImplBuilder.html | 203 + .../data/impl/BookiesClusterInfoImpl.html | 204 + .../BrokerInfoImpl.BrokerInfoImplBuilder.html | 216 + .../policies/data/impl/BrokerInfoImpl.html | 204 + ...kerStatusImpl.BrokerStatusImplBuilder.html | 229 + .../policies/data/impl/BrokerStatusImpl.html | 217 + ...undlesDataImpl.BundlesDataImplBuilder.html | 216 + .../policies/data/impl/BundlesDataImpl.html | 204 + ...pl.DelayedDeliveryPoliciesImplBuilder.html | 229 + .../impl/DelayedDeliveryPoliciesImpl.html | 204 + ...patchRateImpl.DispatchRateImplBuilder.html | 242 + .../policies/data/impl/DispatchRateImpl.html | 213 + ...bscriptionCreationOverrideImplBuilder.html | 90 + .../AutoSubscriptionCreationOverrideImpl.html | 87 + ....AutoTopicCreationOverrideImplBuilder.html | 96 + .../AutoTopicCreationOverrideImpl.html | 87 + ...klogQuotaImpl.BacklogQuotaImplBuilder.html | 96 + .../data/impl/class-use/BacklogQuotaImpl.html | 87 + ...pl.BookieAffinityGroupDataImplBuilder.html | 93 + .../BookieAffinityGroupDataImpl.html | 87 + .../BookieInfoImpl.BookieInfoImplBuilder.html | 93 + .../data/impl/class-use/BookieInfoImpl.html | 87 + ...nfoImpl.BookiesClusterInfoImplBuilder.html | 90 + .../class-use/BookiesClusterInfoImpl.html | 87 + .../BrokerInfoImpl.BrokerInfoImplBuilder.html | 93 + .../data/impl/class-use/BrokerInfoImpl.html | 87 + ...kerStatusImpl.BrokerStatusImplBuilder.html | 96 + .../data/impl/class-use/BrokerStatusImpl.html | 87 + ...undlesDataImpl.BundlesDataImplBuilder.html | 93 + .../data/impl/class-use/BundlesDataImpl.html | 87 + ...pl.DelayedDeliveryPoliciesImplBuilder.html | 96 + .../DelayedDeliveryPoliciesImpl.html | 87 + ...patchRateImpl.DispatchRateImplBuilder.html | 99 + .../data/impl/class-use/DispatchRateImpl.html | 128 + .../policies/data/impl/package-summary.html | 171 + .../policies/data/impl/package-tree.html | 97 + .../policies/data/impl/package-use.html | 163 + .../common/policies/data/package-summary.html | 496 + .../common/policies/data/package-tree.html | 245 + .../common/policies/data/package-use.html | 722 ++ .../impl/AutoFailoverPolicyFactory.html | 178 + .../policies/impl/MinAvailablePolicy.html | 262 + .../class-use/AutoFailoverPolicyFactory.html | 62 + .../impl/class-use/MinAvailablePolicy.html | 62 + .../common/policies/impl/package-summary.html | 122 + .../common/policies/impl/package-tree.html | 81 + .../common/policies/impl/package-use.html | 62 + .../common/policies/package-summary.html | 118 + .../pulsar/common/policies/package-tree.html | 76 + .../pulsar/common/policies/package-use.html | 88 + .../schema/IsCompatibilityResponse.html | 151 + .../protocol/schema/PostSchemaPayload.html | 151 + .../class-use/IsCompatibilityResponse.html | 114 + .../schema/class-use/PostSchemaPayload.html | 120 + .../protocol/schema/package-summary.html | 105 + .../common/protocol/schema/package-tree.html | 77 + .../common/protocol/schema/package-use.html | 90 + .../stats/AllocatorStats.PoolArenaStats.html | 319 + .../AllocatorStats.PoolChunkListStats.html | 202 + .../stats/AllocatorStats.PoolChunkStats.html | 202 + .../AllocatorStats.PoolSubpageStats.html | 211 + .../pulsar/common/stats/AllocatorStats.html | 284 + .../AnalyzeSubscriptionBacklogResult.html | 150 + .../apache/pulsar/common/stats/Metrics.html | 287 + .../PositionInPendingAckStats.State.html | 264 + .../stats/PositionInPendingAckStats.html | 202 + .../AllocatorStats.PoolArenaStats.html | 92 + .../AllocatorStats.PoolChunkListStats.html | 89 + .../AllocatorStats.PoolChunkStats.html | 89 + .../AllocatorStats.PoolSubpageStats.html | 89 + .../stats/class-use/AllocatorStats.html | 100 + .../AnalyzeSubscriptionBacklogResult.html | 104 + .../common/stats/class-use/Metrics.html | 114 + .../PositionInPendingAckStats.State.html | 115 + .../class-use/PositionInPendingAckStats.html | 108 + .../pulsar/common/stats/package-summary.html | 129 + .../pulsar/common/stats/package-tree.html | 97 + .../pulsar/common/stats/package-use.html | 129 + .../core/common/PackageMetadata.html | 164 + .../management/core/common/PackageType.html | 276 + .../common/class-use/PackageMetadata.html | 132 + .../core/common/class-use/PackageType.html | 100 + .../core/common/package-summary.html | 107 + .../management/core/common/package-tree.html | 90 + .../management/core/common/package-use.html | 103 + ...mentException.MetadataFormatException.html | 209 + ...ManagementException.NotFoundException.html | 224 + .../PackagesManagementException.html | 232 + ...mentException.MetadataFormatException.html | 62 + ...ManagementException.NotFoundException.html | 62 + .../PackagesManagementException.html | 92 + .../core/exceptions/package-summary.html | 105 + .../core/exceptions/package-tree.html | 89 + .../core/exceptions/package-use.html | 88 + .../data/loadbalancer/LoadManagerReport.html | 305 + .../loadbalancer/NamespaceBundleStats.html | 340 + .../data/loadbalancer/ResourceUsage.html | 243 + .../data/loadbalancer/ServiceLookupData.html | 227 + .../class-use/LoadManagerReport.html | 100 + .../class-use/NamespaceBundleStats.html | 113 + .../loadbalancer/class-use/ResourceUsage.html | 112 + .../class-use/ServiceLookupData.html | 91 + .../data/loadbalancer/package-summary.html | 113 + .../data/loadbalancer/package-tree.html | 87 + .../data/loadbalancer/package-use.html | 109 + static/api/admin/4.0.x/overview-summary.html | 25 + static/api/admin/4.0.x/overview-tree.html | 409 + .../api/admin/4.0.x/package-search-index.js | 1 + static/api/admin/4.0.x/resources/glass.png | Bin 0 -> 499 bytes static/api/admin/4.0.x/resources/x.png | Bin 0 -> 394 bytes .../4.0.x/script-dir/jquery-3.6.1.min.js | 2 + .../admin/4.0.x/script-dir/jquery-ui.min.css | 6 + .../admin/4.0.x/script-dir/jquery-ui.min.js | 6 + static/api/admin/4.0.x/script.js | 253 + static/api/admin/4.0.x/search-page.js | 284 + static/api/admin/4.0.x/search.html | 77 + static/api/admin/4.0.x/search.js | 458 + static/api/admin/4.0.x/serialized-form.html | 292 + static/api/admin/4.0.x/stylesheet.css | 1272 +++ static/api/admin/4.0.x/tag-search-index.js | 1 + static/api/admin/4.0.x/type-search-index.js | 1 + static/api/client/4.0.x/allclasses-index.html | 747 ++ .../api/client/4.0.x/allpackages-index.html | 99 + static/api/client/4.0.x/constant-values.html | 151 + static/api/client/4.0.x/copy.svg | 33 + static/api/client/4.0.x/deprecated-list.html | 170 + static/api/client/4.0.x/element-list | 8 + static/api/client/4.0.x/help-doc.html | 208 + static/api/client/4.0.x/index-all.html | 4694 +++++++++ static/api/client/4.0.x/index.html | 101 + .../4.0.x/legal/ADDITIONAL_LICENSE_INFO | 37 + .../api/client/4.0.x/legal/ASSEMBLY_EXCEPTION | 27 + static/api/client/4.0.x/legal/LICENSE | 347 + static/api/client/4.0.x/legal/jquery.md | 72 + static/api/client/4.0.x/legal/jqueryUI.md | 49 + static/api/client/4.0.x/link.svg | 31 + .../api/client/4.0.x/member-search-index.js | 1 + .../api/client/4.0.x/module-search-index.js | 1 + .../pulsar/client/api/Authentication.html | 280 + .../api/AuthenticationDataProvider.html | 379 + .../client/api/AuthenticationFactory.html | 279 + ...ClusterFailoverBuilder.FailoverPolicy.html | 232 + .../api/AutoClusterFailoverBuilder.html | 351 + .../client/api/BatchMessageContainer.html | 244 + .../api/BatchReceivePolicy.Builder.html | 220 + .../pulsar/client/api/BatchReceivePolicy.html | 304 + .../pulsar/client/api/BatcherBuilder.html | 214 + .../pulsar/client/api/ClientBuilder.html | 1378 +++ .../pulsar/client/api/CompressionType.html | 278 + .../apache/pulsar/client/api/Consumer.html | 1194 +++ .../pulsar/client/api/ConsumerBuilder.html | 1623 +++ .../api/ConsumerCryptoFailureAction.html | 263 + .../client/api/ConsumerEventListener.html | 180 + .../client/api/ConsumerInterceptor.html | 373 + .../pulsar/client/api/ConsumerStats.html | 459 + .../api/ControlledClusterFailoverBuilder.html | 230 + .../pulsar/client/api/CryptoKeyReader.html | 189 + .../pulsar/client/api/DeadLetterPolicy.html | 161 + .../client/api/DummyCryptoKeyReaderImpl.html | 232 + ...EncodedAuthenticationParameterSupport.html | 154 + .../pulsar/client/api/EncryptionKeyInfo.html | 218 + .../pulsar/client/api/HashingScheme.html | 246 + .../pulsar/client/api/KeySharedMode.html | 247 + ...SharedPolicy.KeySharedPolicyAutoSplit.html | 182 + ...KeySharedPolicy.KeySharedPolicySticky.html | 236 + .../pulsar/client/api/KeySharedPolicy.html | 328 + .../pulsar/client/api/KeyStoreParams.html | 153 + .../org/apache/pulsar/client/api/Message.html | 702 ++ .../client/api/MessageAcknowledger.html | 406 + .../pulsar/client/api/MessageCrypto.html | 256 + .../apache/pulsar/client/api/MessageId.html | 264 + .../pulsar/client/api/MessageListener.html | 185 + .../client/api/MessageListenerExecutor.html | 165 + .../pulsar/client/api/MessagePayload.html | 166 + .../client/api/MessagePayloadContext.html | 243 + .../client/api/MessagePayloadFactory.html | 200 + .../client/api/MessagePayloadProcessor.html | 202 + .../pulsar/client/api/MessageRouter.html | 198 + .../pulsar/client/api/MessageRoutingMode.html | 271 + .../apache/pulsar/client/api/Messages.html | 161 + .../client/api/MultiTopicConsumerStats.html | 163 + .../api/PartitionedTopicProducerStats.html | 163 + .../apache/pulsar/client/api/Producer.html | 479 + .../pulsar/client/api/ProducerAccessMode.html | 266 + .../pulsar/client/api/ProducerBuilder.html | 1138 ++ .../api/ProducerCryptoFailureAction.html | 245 + .../client/api/ProducerInterceptor.html | 281 + .../pulsar/client/api/ProducerStats.html | 441 + .../pulsar/client/api/ProxyProtocol.html | 242 + .../pulsar/client/api/PulsarClient.html | 688 ++ ...lientException.AlreadyClosedException.html | 217 + ...ientException.AuthenticationException.html | 198 + ...lientException.AuthorizationException.html | 198 + ...ientException.BrokerMetadataException.html | 198 + ...tException.BrokerPersistenceException.html | 198 + ...lsarClientException.ChecksumException.html | 198 + ...ulsarClientException.ConnectException.html | 215 + ...ientException.ConsumerAssignException.html | 197 + ...ClientException.ConsumerBusyException.html | 198 + ...PulsarClientException.CryptoException.html | 198 + ...sarClientException.FailedFeatureCheck.html | 236 + ...xception.FeatureNotSupportedException.html | 194 + ...on.GettingAuthenticationDataException.html | 215 + ...Exception.IncompatibleSchemaException.html | 215 + ...ception.InvalidConfigurationException.html | 236 + ...ientException.InvalidMessageException.html | 217 + ...lsarClientException.InvalidServiceURL.html | 220 + ...ntException.InvalidTopicNameException.html | 198 + ...PulsarClientException.LookupException.html | 202 + ...ientException.MemoryBufferIsFullError.html | 217 + ...Exception.MessageAcknowledgeException.html | 214 + ...arClientException.NotAllowedException.html | 198 + ...ClientException.NotConnectedException.html | 206 + ...lsarClientException.NotFoundException.html | 215 + ...ClientException.NotSupportedException.html | 202 + ...ion.ProducerBlockedQuotaExceededError.html | 198 + ...ProducerBlockedQuotaExceededException.html | 198 + ...ClientException.ProducerBusyException.html | 198 + ...ientException.ProducerFencedException.html | 198 + ...entException.ProducerQueueIsFullError.html | 217 + ...ception.SubscriptionNotFoundException.html | 198 + ...ulsarClientException.TimeoutException.html | 253 + ...entException.TooManyRequestsException.html | 200 + ...tException.TopicDoesNotExistException.html | 198 + ...ientException.TopicMigrationException.html | 198 + ...entException.TopicTerminatedException.html | 217 + ...xception.TransactionConflictException.html | 214 + ...ransactionHasOperationFailedException.html | 207 + ...on.UnsupportedAuthenticationException.html | 215 + .../client/api/PulsarClientException.html | 563 + .../org/apache/pulsar/client/api/Range.html | 320 + .../org/apache/pulsar/client/api/Reader.html | 513 + .../pulsar/client/api/ReaderBuilder.html | 758 ++ .../pulsar/client/api/ReaderInterceptor.html | 203 + .../pulsar/client/api/ReaderListener.html | 183 + .../pulsar/client/api/RedeliveryBackoff.html | 160 + .../client/api/RegexSubscriptionMode.html | 257 + .../org/apache/pulsar/client/api/Schema.html | 978 ++ .../api/SchemaSerializationException.html | 199 + .../pulsar/client/api/ServiceUrlProvider.html | 201 + .../apache/pulsar/client/api/SizeUnit.html | 289 + .../api/SubscriptionInitialPosition.html | 261 + .../pulsar/client/api/SubscriptionMode.html | 239 + .../pulsar/client/api/SubscriptionType.html | 282 + .../apache/pulsar/client/api/TableView.html | 385 + .../pulsar/client/api/TableViewBuilder.html | 351 + .../client/api/TopicConsumerBuilder.html | 190 + .../pulsar/client/api/TopicMessageId.html | 191 + .../pulsar/client/api/TopicMetadata.html | 153 + .../client/api/TransactionIsolationLevel.html | 238 + .../client/api/TypedMessageBuilder.html | 708 ++ .../client/api/class-use/Authentication.html | 170 + .../class-use/AuthenticationDataProvider.html | 115 + .../api/class-use/AuthenticationFactory.html | 62 + ...ClusterFailoverBuilder.FailoverPolicy.html | 108 + .../class-use/AutoClusterFailoverBuilder.html | 139 + .../api/class-use/BatchMessageContainer.html | 91 + .../class-use/BatchReceivePolicy.Builder.html | 102 + .../api/class-use/BatchReceivePolicy.html | 114 + .../client/api/class-use/BatcherBuilder.html | 128 + .../client/api/class-use/ClientBuilder.html | 405 + .../client/api/class-use/CompressionType.html | 108 + .../pulsar/client/api/class-use/Consumer.html | 171 + .../client/api/class-use/ConsumerBuilder.html | 406 + .../ConsumerCryptoFailureAction.html | 118 + .../api/class-use/ConsumerEventListener.html | 91 + .../api/class-use/ConsumerInterceptor.html | 91 + .../client/api/class-use/ConsumerStats.html | 116 + .../ControlledClusterFailoverBuilder.html | 107 + .../client/api/class-use/CryptoKeyReader.html | 134 + .../api/class-use/DeadLetterPolicy.html | 91 + .../class-use/DummyCryptoKeyReaderImpl.html | 89 + ...EncodedAuthenticationParameterSupport.html | 62 + .../api/class-use/EncryptionKeyInfo.html | 104 + .../client/api/class-use/HashingScheme.html | 108 + .../client/api/class-use/KeySharedMode.html | 109 + ...SharedPolicy.KeySharedPolicyAutoSplit.html | 89 + ...KeySharedPolicy.KeySharedPolicySticky.html | 95 + .../client/api/class-use/KeySharedPolicy.html | 119 + .../client/api/class-use/KeyStoreParams.html | 91 + .../pulsar/client/api/class-use/Message.html | 403 + .../api/class-use/MessageAcknowledger.html | 91 + .../client/api/class-use/MessageCrypto.html | 101 + .../client/api/class-use/MessageId.html | 367 + .../client/api/class-use/MessageListener.html | 91 + .../class-use/MessageListenerExecutor.html | 91 + .../client/api/class-use/MessagePayload.html | 125 + .../api/class-use/MessagePayloadContext.html | 94 + .../api/class-use/MessagePayloadFactory.html | 107 + .../class-use/MessagePayloadProcessor.html | 101 + .../client/api/class-use/MessageRouter.html | 91 + .../api/class-use/MessageRoutingMode.html | 108 + .../pulsar/client/api/class-use/Messages.html | 141 + .../class-use/MultiTopicConsumerStats.html | 62 + .../PartitionedTopicProducerStats.html | 62 + .../pulsar/client/api/class-use/Producer.html | 167 + .../api/class-use/ProducerAccessMode.html | 108 + .../client/api/class-use/ProducerBuilder.html | 286 + .../ProducerCryptoFailureAction.html | 108 + .../api/class-use/ProducerInterceptor.html | 109 + .../client/api/class-use/ProducerStats.html | 126 + .../client/api/class-use/ProxyProtocol.html | 109 + .../client/api/class-use/PulsarClient.html | 102 + ...lientException.AlreadyClosedException.html | 62 + ...ientException.AuthenticationException.html | 62 + ...lientException.AuthorizationException.html | 62 + ...ientException.BrokerMetadataException.html | 62 + ...tException.BrokerPersistenceException.html | 62 + ...lsarClientException.ChecksumException.html | 62 + ...ulsarClientException.ConnectException.html | 62 + ...ientException.ConsumerAssignException.html | 62 + ...ClientException.ConsumerBusyException.html | 62 + ...PulsarClientException.CryptoException.html | 90 + ...sarClientException.FailedFeatureCheck.html | 107 + ...xception.FeatureNotSupportedException.html | 62 + ...on.GettingAuthenticationDataException.html | 62 + ...Exception.IncompatibleSchemaException.html | 62 + ...ception.InvalidConfigurationException.html | 62 + ...ientException.InvalidMessageException.html | 62 + ...lsarClientException.InvalidServiceURL.html | 62 + ...ntException.InvalidTopicNameException.html | 62 + ...PulsarClientException.LookupException.html | 91 + ...ientException.MemoryBufferIsFullError.html | 62 + ...Exception.MessageAcknowledgeException.html | 62 + ...arClientException.NotAllowedException.html | 62 + ...ClientException.NotConnectedException.html | 62 + ...lsarClientException.NotFoundException.html | 62 + ...ClientException.NotSupportedException.html | 91 + ...ion.ProducerBlockedQuotaExceededError.html | 62 + ...ProducerBlockedQuotaExceededException.html | 62 + ...ClientException.ProducerBusyException.html | 62 + ...ientException.ProducerFencedException.html | 62 + ...entException.ProducerQueueIsFullError.html | 62 + ...ception.SubscriptionNotFoundException.html | 62 + ...ulsarClientException.TimeoutException.html | 62 + ...entException.TooManyRequestsException.html | 62 + ...tException.TopicDoesNotExistException.html | 62 + ...ientException.TopicMigrationException.html | 62 + ...entException.TopicTerminatedException.html | 62 + ...xception.TransactionConflictException.html | 62 + ...ransactionHasOperationFailedException.html | 62 + ...on.UnsupportedAuthenticationException.html | 135 + .../api/class-use/PulsarClientException.html | 522 + .../pulsar/client/api/class-use/Range.html | 146 + .../pulsar/client/api/class-use/Reader.html | 128 + .../client/api/class-use/ReaderBuilder.html | 233 + .../api/class-use/ReaderInterceptor.html | 91 + .../client/api/class-use/ReaderListener.html | 91 + .../api/class-use/RedeliveryBackoff.html | 99 + .../api/class-use/RegexSubscriptionMode.html | 108 + .../pulsar/client/api/class-use/Schema.html | 592 ++ .../SchemaSerializationException.html | 62 + .../api/class-use/ServiceUrlProvider.html | 107 + .../pulsar/client/api/class-use/SizeUnit.html | 109 + .../SubscriptionInitialPosition.html | 108 + .../api/class-use/SubscriptionMode.html | 108 + .../api/class-use/SubscriptionType.html | 108 + .../client/api/class-use/TableView.html | 102 + .../api/class-use/TableViewBuilder.html | 145 + .../api/class-use/TopicConsumerBuilder.html | 119 + .../client/api/class-use/TopicMessageId.html | 135 + .../client/api/class-use/TopicMetadata.html | 92 + .../class-use/TransactionIsolationLevel.html | 97 + .../api/class-use/TypedMessageBuilder.html | 169 + .../api/interceptor/ProducerInterceptor.html | 283 + .../ProducerInterceptorWrapper.html | 316 + .../class-use/ProducerInterceptor.html | 111 + .../class-use/ProducerInterceptorWrapper.html | 62 + .../api/interceptor/package-summary.html | 130 + .../client/api/interceptor/package-tree.html | 86 + .../client/api/interceptor/package-use.html | 109 + .../pulsar/client/api/package-summary.html | 577 + .../pulsar/client/api/package-tree.html | 278 + .../apache/pulsar/client/api/package-use.html | 500 + .../pulsar/client/api/schema/Field.html | 154 + .../client/api/schema/FieldSchemaBuilder.html | 264 + .../client/api/schema/GenericObject.html | 188 + .../client/api/schema/GenericRecord.html | 260 + .../api/schema/GenericRecordBuilder.html | 231 + .../client/api/schema/GenericSchema.html | 206 + .../client/api/schema/KeyValueSchema.html | 213 + .../api/schema/RecordSchemaBuilder.html | 231 + .../client/api/schema/SchemaBuilder.html | 153 + .../client/api/schema/SchemaDefinition.html | 297 + .../api/schema/SchemaDefinitionBuilder.html | 344 + .../client/api/schema/SchemaInfoProvider.html | 187 + .../client/api/schema/SchemaReader.html | 271 + .../client/api/schema/SchemaWriter.html | 160 + .../client/api/schema/class-use/Field.html | 118 + .../schema/class-use/FieldSchemaBuilder.html | 108 + .../api/schema/class-use/GenericObject.html | 91 + .../api/schema/class-use/GenericRecord.html | 154 + .../class-use/GenericRecordBuilder.html | 113 + .../api/schema/class-use/GenericSchema.html | 143 + .../api/schema/class-use/KeyValueSchema.html | 62 + .../schema/class-use/RecordSchemaBuilder.html | 120 + .../api/schema/class-use/SchemaBuilder.html | 62 + .../schema/class-use/SchemaDefinition.html | 153 + .../class-use/SchemaDefinitionBuilder.html | 160 + .../schema/class-use/SchemaInfoProvider.html | 109 + .../api/schema/class-use/SchemaReader.html | 102 + .../api/schema/class-use/SchemaWriter.html | 102 + .../client/api/schema/package-summary.html | 177 + .../client/api/schema/package-tree.html | 105 + .../pulsar/client/api/schema/package-use.html | 195 + .../api/transaction/Transaction.State.html | 315 + .../client/api/transaction/Transaction.html | 216 + .../transaction/TransactionBufferClient.html | 279 + ...Exception.ReachMaxPendingOpsException.html | 198 + ...ientException.RequestTimeoutException.html | 198 + .../TransactionBufferClientException.html | 235 + .../api/transaction/TransactionBuilder.html | 181 + .../TransactionCoordinatorClient.State.html | 265 + .../TransactionCoordinatorClient.html | 521 + ...ption.CoordinatorClientStateException.html | 198 + ...xception.CoordinatorNotFoundException.html | 190 + ...ntException.InvalidTxnStatusException.html | 202 + ...on.MetaStoreHandlerNotExistsException.html | 198 + ...ion.MetaStoreHandlerNotReadyException.html | 198 + ...xception.TransactionNotFoundException.html | 190 + ...TransactionCoordinatorClientException.html | 255 + .../pulsar/client/api/transaction/TxnID.html | 225 + .../class-use/Transaction.State.html | 102 + .../transaction/class-use/Transaction.html | 135 + .../class-use/TransactionBufferClient.html | 62 + ...Exception.ReachMaxPendingOpsException.html | 62 + ...ientException.RequestTimeoutException.html | 62 + .../TransactionBufferClientException.html | 105 + .../class-use/TransactionBuilder.html | 115 + .../TransactionCoordinatorClient.State.html | 102 + .../TransactionCoordinatorClient.html | 62 + ...ption.CoordinatorClientStateException.html | 62 + ...xception.CoordinatorNotFoundException.html | 62 + ...ntException.InvalidTxnStatusException.html | 62 + ...on.MetaStoreHandlerNotExistsException.html | 62 + ...ion.MetaStoreHandlerNotReadyException.html | 62 + ...xception.TransactionNotFoundException.html | 62 + ...TransactionCoordinatorClientException.html | 170 + .../api/transaction/class-use/TxnID.html | 205 + .../api/transaction/package-summary.html | 186 + .../client/api/transaction/package-tree.html | 136 + .../client/api/transaction/package-use.html | 131 + .../internal/DefaultImplementation.html | 188 + .../client/internal/PropertiesUtils.html | 218 + .../PulsarClientImplementationBinding.html | 820 ++ .../class-use/DefaultImplementation.html | 62 + .../internal/class-use/PropertiesUtils.html | 62 + .../PulsarClientImplementationBinding.html | 91 + .../client/internal/package-summary.html | 112 + .../pulsar/client/internal/package-tree.html | 83 + .../pulsar/client/internal/package-use.html | 88 + .../apache/pulsar/common/api/AuthData.html | 234 + .../api/EncryptionContext.EncryptionKey.html | 155 + .../pulsar/common/api/EncryptionContext.html | 168 + .../pulsar/common/api/class-use/AuthData.html | 127 + .../EncryptionContext.EncryptionKey.html | 62 + .../api/class-use/EncryptionContext.html | 92 + .../pulsar/common/api/package-summary.html | 109 + .../pulsar/common/api/package-tree.html | 78 + .../apache/pulsar/common/api/package-use.html | 109 + .../InterfaceAudience.LimitedPrivate.html | 107 + .../InterfaceAudience.Private.html | 106 + .../InterfaceAudience.Public.html | 106 + .../classification/InterfaceAudience.html | 149 + .../InterfaceStability.Evolving.html | 105 + .../InterfaceStability.Stable.html | 106 + .../InterfaceStability.Unstable.html | 106 + .../classification/InterfaceStability.html | 152 + .../InterfaceAudience.LimitedPrivate.html | 102 + .../class-use/InterfaceAudience.Private.html | 172 + .../class-use/InterfaceAudience.Public.html | 554 + .../class-use/InterfaceAudience.html | 62 + .../InterfaceStability.Evolving.html | 165 + .../class-use/InterfaceStability.Stable.html | 532 + .../InterfaceStability.Unstable.html | 62 + .../class-use/InterfaceStability.html | 62 + .../classification/package-summary.html | 134 + .../common/classification/package-tree.html | 88 + .../common/classification/package-use.html | 226 + .../schema/KeyValue.KeyValueDecoder.html | 165 + .../apache/pulsar/common/schema/KeyValue.html | 299 + .../common/schema/KeyValueEncodingType.html | 245 + .../schema/SchemaInfo.SchemaInfoBuilder.html | 199 + .../pulsar/common/schema/SchemaInfo.html | 227 + .../common/schema/SchemaInfoWithVersion.html | 184 + .../pulsar/common/schema/SchemaType.html | 593 ++ .../class-use/KeyValue.KeyValueDecoder.html | 93 + .../common/schema/class-use/KeyValue.html | 206 + .../class-use/KeyValueEncodingType.html | 189 + .../SchemaInfo.SchemaInfoBuilder.html | 104 + .../common/schema/class-use/SchemaInfo.html | 285 + .../class-use/SchemaInfoWithVersion.html | 91 + .../common/schema/class-use/SchemaType.html | 214 + .../pulsar/common/schema/package-summary.html | 125 + .../pulsar/common/schema/package-tree.html | 100 + .../pulsar/common/schema/package-use.html | 193 + static/api/client/4.0.x/overview-summary.html | 25 + static/api/client/4.0.x/overview-tree.html | 356 + .../api/client/4.0.x/package-search-index.js | 1 + static/api/client/4.0.x/resources/glass.png | Bin 0 -> 499 bytes static/api/client/4.0.x/resources/x.png | Bin 0 -> 394 bytes .../4.0.x/script-dir/jquery-3.6.1.min.js | 2 + .../client/4.0.x/script-dir/jquery-ui.min.css | 6 + .../client/4.0.x/script-dir/jquery-ui.min.js | 6 + static/api/client/4.0.x/script.js | 253 + static/api/client/4.0.x/search-page.js | 284 + static/api/client/4.0.x/search.html | 77 + static/api/client/4.0.x/search.js | 458 + static/api/client/4.0.x/serialized-form.html | 485 + static/api/client/4.0.x/stylesheet.css | 1272 +++ static/api/client/4.0.x/tag-search-index.js | 1 + static/api/client/4.0.x/type-search-index.js | 1 + .../4.0.x/allclasses-index.html | 123 + .../4.0.x/allpackages-index.html | 79 + static/api/pulsar-functions/4.0.x/copy.svg | 33 + .../4.0.x/deprecated-list.html | 99 + .../api/pulsar-functions/4.0.x/element-list | 3 + .../api/pulsar-functions/4.0.x/help-doc.html | 198 + .../api/pulsar-functions/4.0.x/index-all.html | 592 ++ static/api/pulsar-functions/4.0.x/index.html | 81 + .../4.0.x/legal/ADDITIONAL_LICENSE_INFO | 37 + .../4.0.x/legal/ASSEMBLY_EXCEPTION | 27 + .../api/pulsar-functions/4.0.x/legal/LICENSE | 347 + .../pulsar-functions/4.0.x/legal/jquery.md | 72 + .../pulsar-functions/4.0.x/legal/jqueryUI.md | 49 + static/api/pulsar-functions/4.0.x/link.svg | 31 + .../4.0.x/member-search-index.js | 1 + .../4.0.x/module-search-index.js | 1 + .../pulsar/functions/api/BaseContext.html | 549 + .../apache/pulsar/functions/api/Context.html | 461 + .../apache/pulsar/functions/api/Function.html | 203 + .../apache/pulsar/functions/api/KVRecord.html | 172 + .../apache/pulsar/functions/api/Record.html | 323 + .../apache/pulsar/functions/api/SerDe.html | 155 + .../pulsar/functions/api/StateStore.html | 238 + .../functions/api/StateStoreContext.html | 105 + .../pulsar/functions/api/WindowContext.html | 506 + .../pulsar/functions/api/WindowFunction.html | 164 + .../functions/api/class-use/BaseContext.html | 91 + .../functions/api/class-use/Context.html | 118 + .../functions/api/class-use/Function.html | 62 + .../functions/api/class-use/KVRecord.html | 62 + .../functions/api/class-use/Record.html | 132 + .../pulsar/functions/api/class-use/SerDe.html | 62 + .../functions/api/class-use/StateStore.html | 123 + .../api/class-use/StateStoreContext.html | 91 + .../api/class-use/WindowContext.html | 92 + .../api/class-use/WindowFunction.html | 62 + .../pulsar/functions/api/package-summary.html | 150 + .../pulsar/functions/api/package-tree.html | 91 + .../pulsar/functions/api/package-use.html | 140 + .../api/state/ByteBufferStateStore.html | 285 + .../api/state/CounterStateStore.html | 221 + .../functions/api/state/StateValue.html | 150 + .../state/class-use/ByteBufferStateStore.html | 62 + .../state/class-use/CounterStateStore.html | 62 + .../api/state/class-use/StateValue.html | 102 + .../functions/api/state/package-summary.html | 126 + .../functions/api/state/package-tree.html | 91 + .../functions/api/state/package-use.html | 86 + .../FunctionRecord.FunctionRecordBuilder.html | 123 + .../functions/api/utils/FunctionRecord.html | 397 + .../functions/api/utils/IdentityFunction.html | 191 + .../FunctionRecord.FunctionRecordBuilder.html | 112 + .../api/utils/class-use/FunctionRecord.html | 62 + .../api/utils/class-use/IdentityFunction.html | 62 + .../functions/api/utils/package-summary.html | 120 + .../functions/api/utils/package-tree.html | 78 + .../functions/api/utils/package-use.html | 101 + .../4.0.x/overview-summary.html | 25 + .../pulsar-functions/4.0.x/overview-tree.html | 111 + .../4.0.x/package-search-index.js | 1 + .../4.0.x/resources/glass.png | Bin 0 -> 499 bytes .../pulsar-functions/4.0.x/resources/x.png | Bin 0 -> 394 bytes .../4.0.x/script-dir/jquery-3.6.1.min.js | 2 + .../4.0.x/script-dir/jquery-ui.min.css | 6 + .../4.0.x/script-dir/jquery-ui.min.js | 6 + static/api/pulsar-functions/4.0.x/script.js | 253 + .../api/pulsar-functions/4.0.x/search-page.js | 284 + static/api/pulsar-functions/4.0.x/search.html | 77 + static/api/pulsar-functions/4.0.x/search.js | 458 + .../api/pulsar-functions/4.0.x/stylesheet.css | 1272 +++ .../4.0.x/tag-search-index.js | 1 + .../4.0.x/type-search-index.js | 1 + 1012 files changed, 223526 insertions(+) create mode 100644 static/api/admin/4.0.x/allclasses-index.html create mode 100644 static/api/admin/4.0.x/allpackages-index.html create mode 100644 static/api/admin/4.0.x/constant-values.html create mode 100644 static/api/admin/4.0.x/copy.svg create mode 100644 static/api/admin/4.0.x/deprecated-list.html create mode 100644 static/api/admin/4.0.x/element-list create mode 100644 static/api/admin/4.0.x/help-doc.html create mode 100644 static/api/admin/4.0.x/index-all.html create mode 100644 static/api/admin/4.0.x/index.html create mode 100644 static/api/admin/4.0.x/legal/ADDITIONAL_LICENSE_INFO create mode 100644 static/api/admin/4.0.x/legal/ASSEMBLY_EXCEPTION create mode 100644 static/api/admin/4.0.x/legal/LICENSE create mode 100644 static/api/admin/4.0.x/legal/jquery.md create mode 100644 static/api/admin/4.0.x/legal/jqueryUI.md create mode 100644 static/api/admin/4.0.x/link.svg create mode 100644 static/api/admin/4.0.x/member-search-index.js create mode 100644 static/api/admin/4.0.x/module-search-index.js create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/Bookies.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/BrokerStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/Brokers.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/Clusters.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/Functions.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/GetStatsOptions.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/GrantTopicPermissionOptions.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/ListNamespaceTopicsOptions.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/ListTopicsOptions.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/LongRunningProcessStatus.Status.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/LongRunningProcessStatus.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/Lookup.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/Mode.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/Namespaces.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/NonPersistentTopics.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/OffloadProcessStatus.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/Packages.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/Properties.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/ProxyStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/PulsarAdmin.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/PulsarAdminBuilder.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/PulsarAdminException.ConflictException.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/PulsarAdminException.ConnectException.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/PulsarAdminException.GettingAuthenticationDataException.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/PulsarAdminException.HttpErrorException.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/PulsarAdminException.NotAllowedException.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/PulsarAdminException.NotAuthorizedException.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/PulsarAdminException.NotFoundException.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/PulsarAdminException.PreconditionFailedException.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/PulsarAdminException.ServerSideErrorException.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/PulsarAdminException.TimeoutException.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/PulsarAdminException.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/ResourceGroups.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/ResourceQuotas.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/RevokeTopicPermissionOptions.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/Schemas.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/Sink.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/Sinks.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/Source.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/Sources.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/Tenants.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/TopicPolicies.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/Topics.QueryParam.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/Topics.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/Transactions.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/Worker.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Bookies.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/BrokerStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Brokers.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Clusters.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Functions.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/GetStatsOptions.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/GrantTopicPermissionOptions.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/ListNamespaceTopicsOptions.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/ListTopicsOptions.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/LongRunningProcessStatus.Status.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/LongRunningProcessStatus.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Lookup.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Mode.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Namespaces.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/NonPersistentTopics.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/OffloadProcessStatus.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Packages.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Properties.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/ProxyStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/PulsarAdmin.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/PulsarAdminBuilder.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/PulsarAdminException.ConflictException.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/PulsarAdminException.ConnectException.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/PulsarAdminException.GettingAuthenticationDataException.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/PulsarAdminException.HttpErrorException.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/PulsarAdminException.NotAllowedException.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/PulsarAdminException.NotAuthorizedException.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/PulsarAdminException.NotFoundException.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/PulsarAdminException.PreconditionFailedException.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/PulsarAdminException.ServerSideErrorException.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/PulsarAdminException.TimeoutException.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/PulsarAdminException.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/ResourceGroups.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/ResourceQuotas.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/RevokeTopicPermissionOptions.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Schemas.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Sink.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Sinks.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Source.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Sources.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Tenants.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/TopicPolicies.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Topics.QueryParam.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Topics.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Transactions.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Worker.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/package-summary.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/package-tree.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/package-use.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/utils/DefaultImplementation.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/utils/ReflectionUtils.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/utils/class-use/DefaultImplementation.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/utils/class-use/ReflectionUtils.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/utils/package-summary.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/utils/package-tree.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/client/admin/utils/package-use.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/conf/InternalConfigurationData.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/conf/class-use/InternalConfigurationData.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/conf/package-summary.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/conf/package-tree.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/conf/package-use.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/functions/AuthenticationConfig.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/functions/ConsumerConfig.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/functions/CryptoConfig.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/functions/FunctionConfig.ProcessingGuarantees.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/functions/FunctionConfig.Runtime.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/functions/FunctionConfig.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/functions/FunctionDefinition.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/functions/FunctionState.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/functions/ProducerConfig.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/functions/Resources.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/functions/UpdateOptions.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/functions/WindowConfig.ProcessingGuarantees.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/functions/WindowConfig.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/functions/WorkerInfo.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/functions/class-use/AuthenticationConfig.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/functions/class-use/ConsumerConfig.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/functions/class-use/CryptoConfig.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/functions/class-use/FunctionConfig.ProcessingGuarantees.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/functions/class-use/FunctionConfig.Runtime.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/functions/class-use/FunctionConfig.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/functions/class-use/FunctionDefinition.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/functions/class-use/FunctionState.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/functions/class-use/ProducerConfig.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/functions/class-use/Resources.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/functions/class-use/UpdateOptions.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/functions/class-use/WindowConfig.ProcessingGuarantees.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/functions/class-use/WindowConfig.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/functions/class-use/WorkerInfo.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/functions/package-summary.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/functions/package-tree.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/functions/package-use.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/io/BatchSourceConfig.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/io/ConnectorDefinition.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/io/SinkConfig.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/io/SourceConfig.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/io/class-use/BatchSourceConfig.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/io/class-use/ConnectorDefinition.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/io/class-use/SinkConfig.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/io/class-use/SourceConfig.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/io/package-summary.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/io/package-tree.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/io/package-use.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/naming/TopicDomain.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/naming/TopicVersion.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/naming/class-use/TopicDomain.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/naming/class-use/TopicVersion.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/naming/package-summary.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/naming/package-tree.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/naming/package-use.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/partition/PartitionedTopicMetadata.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/partition/class-use/PartitionedTopicMetadata.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/partition/package-summary.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/partition/package-tree.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/partition/package-use.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/AutoFailoverPolicy.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/class-use/AutoFailoverPolicy.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/AuthAction.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/AuthPolicies.Builder.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/AuthPolicies.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/AutoFailoverPolicyData.Builder.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/AutoFailoverPolicyData.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/AutoFailoverPolicyType.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/AutoSubscriptionCreationOverride.Builder.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/AutoSubscriptionCreationOverride.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/AutoTopicCreationOverride.Builder.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/AutoTopicCreationOverride.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BacklogQuota.BacklogQuotaType.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BacklogQuota.Builder.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BacklogQuota.RetentionPolicy.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BacklogQuota.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BookieAffinityGroupData.Builder.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BookieAffinityGroupData.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BookieInfo.Builder.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BookieInfo.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BookiesClusterInfo.Builder.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BookiesClusterInfo.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BookiesRackConfiguration.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BrokerAssignment.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BrokerInfo.Builder.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BrokerInfo.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BrokerNamespaceIsolationData.Builder.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BrokerNamespaceIsolationData.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BrokerStatus.Builder.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BrokerStatus.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BundlesData.Builder.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BundlesData.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/ClusterData.Builder.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/ClusterData.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/ClusterPolicies.Builder.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/ClusterPolicies.ClusterUrl.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/ClusterPolicies.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/CompactionStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/ConsumerStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/DelayedDeliveryPolicies.Builder.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/DelayedDeliveryPolicies.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/DispatchRate.Builder.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/DispatchRate.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/DrainingHash.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/EntryFilters.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/ErrorData.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/ExceptionInformation.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/FailureDomain.Builder.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/FailureDomain.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/FunctionInstanceStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/FunctionInstanceStatsData.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/FunctionInstanceStatsDataBase.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/FunctionStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/FunctionStatus.FunctionInstanceStatus.FunctionInstanceStatusData.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/FunctionStatus.FunctionInstanceStatus.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/FunctionStatus.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/InactiveTopicDeleteMode.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/InactiveTopicPolicies.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/ManagedLedgerInternalStats.CursorStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/ManagedLedgerInternalStats.LedgerInfo.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/ManagedLedgerInternalStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/NamespaceIsolationData.Builder.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/NamespaceIsolationData.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/NamespaceIsolationPolicyUnloadScope.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/NamespaceOwnershipStatus.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/NonPersistentPartitionedTopicStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/NonPersistentPublisherStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/NonPersistentReplicatorStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/NonPersistentSubscriptionStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/NonPersistentTopicStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/OffloadPolicies.Builder.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/OffloadPolicies.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/OffloadedReadPriority.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/PartitionedTopicInternalStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/PartitionedTopicStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/PersistencePolicies.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/PersistentTopicInternalStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/Policies.BundleType.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/Policies.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/PublishRate.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/PublisherStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/RawBookieInfo.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/ReplicatorStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/ResourceGroup.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/ResourceQuota.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/RetentionPolicies.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/SchemaAutoUpdateCompatibilityStrategy.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/SchemaCompatibilityStrategy.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/SchemaMetadata.Entry.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/SchemaMetadata.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/SegmentStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/SegmentsStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/SinkStatus.SinkInstanceStatus.SinkInstanceStatusData.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/SinkStatus.SinkInstanceStatus.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/SinkStatus.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/SnapshotSystemTopicInternalStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/SourceStatus.SourceInstanceStatus.SourceInstanceStatusData.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/SourceStatus.SourceInstanceStatus.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/SourceStatus.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/SubscribeRate.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/SubscriptionAuthMode.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/SubscriptionStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/TenantInfo.Builder.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/TenantInfo.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/TopicHashPositions.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/TopicStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/TopicType.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/TransactionBufferInternalStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/TransactionBufferStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/TransactionCoordinatorInfo.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/TransactionCoordinatorInternalStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/TransactionCoordinatorStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/TransactionCoordinatorStatus.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/TransactionInBufferStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/TransactionInPendingAckStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/TransactionLogStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/TransactionMetadata.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/TransactionPendingAckInternalStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/TransactionPendingAckStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/ValidateResult.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/WorkerFunctionInstanceStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/AuthAction.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/AuthPolicies.Builder.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/AuthPolicies.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/AutoFailoverPolicyData.Builder.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/AutoFailoverPolicyData.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/AutoFailoverPolicyType.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/AutoSubscriptionCreationOverride.Builder.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/AutoSubscriptionCreationOverride.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/AutoTopicCreationOverride.Builder.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/AutoTopicCreationOverride.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BacklogQuota.BacklogQuotaType.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BacklogQuota.Builder.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BacklogQuota.RetentionPolicy.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BacklogQuota.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BookieAffinityGroupData.Builder.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BookieAffinityGroupData.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BookieInfo.Builder.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BookieInfo.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BookiesClusterInfo.Builder.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BookiesClusterInfo.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BookiesRackConfiguration.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BrokerAssignment.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BrokerInfo.Builder.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BrokerInfo.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BrokerNamespaceIsolationData.Builder.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BrokerNamespaceIsolationData.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BrokerStatus.Builder.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BrokerStatus.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BundlesData.Builder.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BundlesData.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/ClusterData.Builder.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/ClusterData.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/ClusterPolicies.Builder.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/ClusterPolicies.ClusterUrl.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/ClusterPolicies.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/CompactionStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/ConsumerStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/DelayedDeliveryPolicies.Builder.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/DelayedDeliveryPolicies.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/DispatchRate.Builder.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/DispatchRate.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/DrainingHash.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/EntryFilters.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/ErrorData.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/ExceptionInformation.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/FailureDomain.Builder.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/FailureDomain.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/FunctionInstanceStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/FunctionInstanceStatsData.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/FunctionInstanceStatsDataBase.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/FunctionStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/FunctionStatus.FunctionInstanceStatus.FunctionInstanceStatusData.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/FunctionStatus.FunctionInstanceStatus.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/FunctionStatus.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/InactiveTopicDeleteMode.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/InactiveTopicPolicies.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/ManagedLedgerInternalStats.CursorStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/ManagedLedgerInternalStats.LedgerInfo.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/ManagedLedgerInternalStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/NamespaceIsolationData.Builder.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/NamespaceIsolationData.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/NamespaceIsolationPolicyUnloadScope.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/NamespaceOwnershipStatus.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/NonPersistentPartitionedTopicStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/NonPersistentPublisherStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/NonPersistentReplicatorStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/NonPersistentSubscriptionStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/NonPersistentTopicStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/OffloadPolicies.Builder.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/OffloadPolicies.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/OffloadedReadPriority.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/PartitionedTopicInternalStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/PartitionedTopicStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/PersistencePolicies.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/PersistentTopicInternalStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/Policies.BundleType.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/Policies.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/PublishRate.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/PublisherStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/RawBookieInfo.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/ReplicatorStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/ResourceGroup.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/ResourceQuota.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/RetentionPolicies.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/SchemaAutoUpdateCompatibilityStrategy.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/SchemaCompatibilityStrategy.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/SchemaMetadata.Entry.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/SchemaMetadata.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/SegmentStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/SegmentsStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/SinkStatus.SinkInstanceStatus.SinkInstanceStatusData.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/SinkStatus.SinkInstanceStatus.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/SinkStatus.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/SnapshotSystemTopicInternalStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/SourceStatus.SourceInstanceStatus.SourceInstanceStatusData.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/SourceStatus.SourceInstanceStatus.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/SourceStatus.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/SubscribeRate.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/SubscriptionAuthMode.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/SubscriptionStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/TenantInfo.Builder.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/TenantInfo.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/TopicHashPositions.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/TopicStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/TopicType.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/TransactionBufferInternalStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/TransactionBufferStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/TransactionCoordinatorInfo.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/TransactionCoordinatorInternalStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/TransactionCoordinatorStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/TransactionCoordinatorStatus.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/TransactionInBufferStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/TransactionInPendingAckStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/TransactionLogStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/TransactionMetadata.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/TransactionPendingAckInternalStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/TransactionPendingAckStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/ValidateResult.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/WorkerFunctionInstanceStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/AutoSubscriptionCreationOverrideImpl.AutoSubscriptionCreationOverrideImplBuilder.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/AutoSubscriptionCreationOverrideImpl.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/AutoTopicCreationOverrideImpl.AutoTopicCreationOverrideImplBuilder.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/AutoTopicCreationOverrideImpl.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/BacklogQuotaImpl.BacklogQuotaImplBuilder.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/BacklogQuotaImpl.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/BookieAffinityGroupDataImpl.BookieAffinityGroupDataImplBuilder.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/BookieAffinityGroupDataImpl.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/BookieInfoImpl.BookieInfoImplBuilder.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/BookieInfoImpl.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/BookiesClusterInfoImpl.BookiesClusterInfoImplBuilder.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/BookiesClusterInfoImpl.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/BrokerInfoImpl.BrokerInfoImplBuilder.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/BrokerInfoImpl.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/BrokerStatusImpl.BrokerStatusImplBuilder.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/BrokerStatusImpl.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/BundlesDataImpl.BundlesDataImplBuilder.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/BundlesDataImpl.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/DelayedDeliveryPoliciesImpl.DelayedDeliveryPoliciesImplBuilder.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/DelayedDeliveryPoliciesImpl.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/DispatchRateImpl.DispatchRateImplBuilder.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/DispatchRateImpl.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/AutoSubscriptionCreationOverrideImpl.AutoSubscriptionCreationOverrideImplBuilder.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/AutoSubscriptionCreationOverrideImpl.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/AutoTopicCreationOverrideImpl.AutoTopicCreationOverrideImplBuilder.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/AutoTopicCreationOverrideImpl.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/BacklogQuotaImpl.BacklogQuotaImplBuilder.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/BacklogQuotaImpl.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/BookieAffinityGroupDataImpl.BookieAffinityGroupDataImplBuilder.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/BookieAffinityGroupDataImpl.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/BookieInfoImpl.BookieInfoImplBuilder.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/BookieInfoImpl.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/BookiesClusterInfoImpl.BookiesClusterInfoImplBuilder.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/BookiesClusterInfoImpl.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/BrokerInfoImpl.BrokerInfoImplBuilder.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/BrokerInfoImpl.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/BrokerStatusImpl.BrokerStatusImplBuilder.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/BrokerStatusImpl.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/BundlesDataImpl.BundlesDataImplBuilder.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/BundlesDataImpl.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/DelayedDeliveryPoliciesImpl.DelayedDeliveryPoliciesImplBuilder.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/DelayedDeliveryPoliciesImpl.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/DispatchRateImpl.DispatchRateImplBuilder.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/DispatchRateImpl.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/package-summary.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/package-tree.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/package-use.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/package-summary.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/package-tree.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/package-use.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/impl/AutoFailoverPolicyFactory.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/impl/MinAvailablePolicy.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/impl/class-use/AutoFailoverPolicyFactory.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/impl/class-use/MinAvailablePolicy.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/impl/package-summary.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/impl/package-tree.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/impl/package-use.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/package-summary.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/package-tree.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/policies/package-use.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/protocol/schema/IsCompatibilityResponse.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/protocol/schema/PostSchemaPayload.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/protocol/schema/class-use/IsCompatibilityResponse.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/protocol/schema/class-use/PostSchemaPayload.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/protocol/schema/package-summary.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/protocol/schema/package-tree.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/protocol/schema/package-use.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/stats/AllocatorStats.PoolArenaStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/stats/AllocatorStats.PoolChunkListStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/stats/AllocatorStats.PoolChunkStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/stats/AllocatorStats.PoolSubpageStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/stats/AllocatorStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/stats/AnalyzeSubscriptionBacklogResult.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/stats/Metrics.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/stats/PositionInPendingAckStats.State.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/stats/PositionInPendingAckStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/stats/class-use/AllocatorStats.PoolArenaStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/stats/class-use/AllocatorStats.PoolChunkListStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/stats/class-use/AllocatorStats.PoolChunkStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/stats/class-use/AllocatorStats.PoolSubpageStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/stats/class-use/AllocatorStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/stats/class-use/AnalyzeSubscriptionBacklogResult.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/stats/class-use/Metrics.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/stats/class-use/PositionInPendingAckStats.State.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/stats/class-use/PositionInPendingAckStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/stats/package-summary.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/stats/package-tree.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/common/stats/package-use.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/packages/management/core/common/PackageMetadata.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/packages/management/core/common/PackageType.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/packages/management/core/common/class-use/PackageMetadata.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/packages/management/core/common/class-use/PackageType.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/packages/management/core/common/package-summary.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/packages/management/core/common/package-tree.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/packages/management/core/common/package-use.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/packages/management/core/exceptions/PackagesManagementException.MetadataFormatException.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/packages/management/core/exceptions/PackagesManagementException.NotFoundException.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/packages/management/core/exceptions/PackagesManagementException.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/packages/management/core/exceptions/class-use/PackagesManagementException.MetadataFormatException.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/packages/management/core/exceptions/class-use/PackagesManagementException.NotFoundException.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/packages/management/core/exceptions/class-use/PackagesManagementException.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/packages/management/core/exceptions/package-summary.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/packages/management/core/exceptions/package-tree.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/packages/management/core/exceptions/package-use.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/policies/data/loadbalancer/LoadManagerReport.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/policies/data/loadbalancer/NamespaceBundleStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/policies/data/loadbalancer/ResourceUsage.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/policies/data/loadbalancer/ServiceLookupData.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/policies/data/loadbalancer/class-use/LoadManagerReport.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/policies/data/loadbalancer/class-use/NamespaceBundleStats.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/policies/data/loadbalancer/class-use/ResourceUsage.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/policies/data/loadbalancer/class-use/ServiceLookupData.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/policies/data/loadbalancer/package-summary.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/policies/data/loadbalancer/package-tree.html create mode 100644 static/api/admin/4.0.x/org/apache/pulsar/policies/data/loadbalancer/package-use.html create mode 100644 static/api/admin/4.0.x/overview-summary.html create mode 100644 static/api/admin/4.0.x/overview-tree.html create mode 100644 static/api/admin/4.0.x/package-search-index.js create mode 100644 static/api/admin/4.0.x/resources/glass.png create mode 100644 static/api/admin/4.0.x/resources/x.png create mode 100644 static/api/admin/4.0.x/script-dir/jquery-3.6.1.min.js create mode 100644 static/api/admin/4.0.x/script-dir/jquery-ui.min.css create mode 100644 static/api/admin/4.0.x/script-dir/jquery-ui.min.js create mode 100644 static/api/admin/4.0.x/script.js create mode 100644 static/api/admin/4.0.x/search-page.js create mode 100644 static/api/admin/4.0.x/search.html create mode 100644 static/api/admin/4.0.x/search.js create mode 100644 static/api/admin/4.0.x/serialized-form.html create mode 100644 static/api/admin/4.0.x/stylesheet.css create mode 100644 static/api/admin/4.0.x/tag-search-index.js create mode 100644 static/api/admin/4.0.x/type-search-index.js create mode 100644 static/api/client/4.0.x/allclasses-index.html create mode 100644 static/api/client/4.0.x/allpackages-index.html create mode 100644 static/api/client/4.0.x/constant-values.html create mode 100644 static/api/client/4.0.x/copy.svg create mode 100644 static/api/client/4.0.x/deprecated-list.html create mode 100644 static/api/client/4.0.x/element-list create mode 100644 static/api/client/4.0.x/help-doc.html create mode 100644 static/api/client/4.0.x/index-all.html create mode 100644 static/api/client/4.0.x/index.html create mode 100644 static/api/client/4.0.x/legal/ADDITIONAL_LICENSE_INFO create mode 100644 static/api/client/4.0.x/legal/ASSEMBLY_EXCEPTION create mode 100644 static/api/client/4.0.x/legal/LICENSE create mode 100644 static/api/client/4.0.x/legal/jquery.md create mode 100644 static/api/client/4.0.x/legal/jqueryUI.md create mode 100644 static/api/client/4.0.x/link.svg create mode 100644 static/api/client/4.0.x/member-search-index.js create mode 100644 static/api/client/4.0.x/module-search-index.js create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/Authentication.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/AuthenticationDataProvider.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/AuthenticationFactory.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/AutoClusterFailoverBuilder.FailoverPolicy.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/AutoClusterFailoverBuilder.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/BatchMessageContainer.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/BatchReceivePolicy.Builder.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/BatchReceivePolicy.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/BatcherBuilder.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/ClientBuilder.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/CompressionType.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/Consumer.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/ConsumerBuilder.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/ConsumerCryptoFailureAction.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/ConsumerEventListener.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/ConsumerInterceptor.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/ConsumerStats.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/ControlledClusterFailoverBuilder.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/CryptoKeyReader.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/DeadLetterPolicy.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/DummyCryptoKeyReaderImpl.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/EncodedAuthenticationParameterSupport.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/EncryptionKeyInfo.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/HashingScheme.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/KeySharedMode.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/KeySharedPolicy.KeySharedPolicyAutoSplit.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/KeySharedPolicy.KeySharedPolicySticky.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/KeySharedPolicy.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/KeyStoreParams.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/Message.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/MessageAcknowledger.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/MessageCrypto.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/MessageId.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/MessageListener.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/MessageListenerExecutor.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/MessagePayload.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/MessagePayloadContext.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/MessagePayloadFactory.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/MessagePayloadProcessor.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/MessageRouter.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/MessageRoutingMode.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/Messages.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/MultiTopicConsumerStats.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/PartitionedTopicProducerStats.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/Producer.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/ProducerAccessMode.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/ProducerBuilder.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/ProducerCryptoFailureAction.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/ProducerInterceptor.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/ProducerStats.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/ProxyProtocol.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClient.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.AlreadyClosedException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.AuthenticationException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.AuthorizationException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.BrokerMetadataException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.BrokerPersistenceException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.ChecksumException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.ConnectException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.ConsumerAssignException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.ConsumerBusyException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.CryptoException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.FailedFeatureCheck.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.FeatureNotSupportedException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.GettingAuthenticationDataException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.IncompatibleSchemaException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.InvalidConfigurationException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.InvalidMessageException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.InvalidServiceURL.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.InvalidTopicNameException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.LookupException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.MemoryBufferIsFullError.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.MessageAcknowledgeException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.NotAllowedException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.NotConnectedException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.NotFoundException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.NotSupportedException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.ProducerBlockedQuotaExceededError.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.ProducerBlockedQuotaExceededException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.ProducerBusyException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.ProducerFencedException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.ProducerQueueIsFullError.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.SubscriptionNotFoundException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.TimeoutException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.TooManyRequestsException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.TopicDoesNotExistException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.TopicMigrationException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.TopicTerminatedException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.TransactionConflictException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.TransactionHasOperationFailedException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.UnsupportedAuthenticationException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/Range.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/Reader.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/ReaderBuilder.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/ReaderInterceptor.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/ReaderListener.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/RedeliveryBackoff.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/RegexSubscriptionMode.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/Schema.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/SchemaSerializationException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/ServiceUrlProvider.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/SizeUnit.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/SubscriptionInitialPosition.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/SubscriptionMode.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/SubscriptionType.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/TableView.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/TableViewBuilder.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/TopicConsumerBuilder.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/TopicMessageId.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/TopicMetadata.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/TransactionIsolationLevel.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/TypedMessageBuilder.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/Authentication.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/AuthenticationDataProvider.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/AuthenticationFactory.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/AutoClusterFailoverBuilder.FailoverPolicy.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/AutoClusterFailoverBuilder.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/BatchMessageContainer.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/BatchReceivePolicy.Builder.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/BatchReceivePolicy.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/BatcherBuilder.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/ClientBuilder.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/CompressionType.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/Consumer.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/ConsumerBuilder.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/ConsumerCryptoFailureAction.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/ConsumerEventListener.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/ConsumerInterceptor.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/ConsumerStats.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/ControlledClusterFailoverBuilder.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/CryptoKeyReader.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/DeadLetterPolicy.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/DummyCryptoKeyReaderImpl.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/EncodedAuthenticationParameterSupport.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/EncryptionKeyInfo.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/HashingScheme.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/KeySharedMode.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/KeySharedPolicy.KeySharedPolicyAutoSplit.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/KeySharedPolicy.KeySharedPolicySticky.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/KeySharedPolicy.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/KeyStoreParams.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/Message.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/MessageAcknowledger.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/MessageCrypto.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/MessageId.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/MessageListener.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/MessageListenerExecutor.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/MessagePayload.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/MessagePayloadContext.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/MessagePayloadFactory.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/MessagePayloadProcessor.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/MessageRouter.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/MessageRoutingMode.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/Messages.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/MultiTopicConsumerStats.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PartitionedTopicProducerStats.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/Producer.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/ProducerAccessMode.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/ProducerBuilder.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/ProducerCryptoFailureAction.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/ProducerInterceptor.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/ProducerStats.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/ProxyProtocol.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClient.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.AlreadyClosedException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.AuthenticationException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.AuthorizationException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.BrokerMetadataException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.BrokerPersistenceException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.ChecksumException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.ConnectException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.ConsumerAssignException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.ConsumerBusyException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.CryptoException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.FailedFeatureCheck.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.FeatureNotSupportedException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.GettingAuthenticationDataException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.IncompatibleSchemaException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.InvalidConfigurationException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.InvalidMessageException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.InvalidServiceURL.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.InvalidTopicNameException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.LookupException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.MemoryBufferIsFullError.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.MessageAcknowledgeException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.NotAllowedException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.NotConnectedException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.NotFoundException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.NotSupportedException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.ProducerBlockedQuotaExceededError.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.ProducerBlockedQuotaExceededException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.ProducerBusyException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.ProducerFencedException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.ProducerQueueIsFullError.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.SubscriptionNotFoundException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.TimeoutException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.TooManyRequestsException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.TopicDoesNotExistException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.TopicMigrationException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.TopicTerminatedException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.TransactionConflictException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.TransactionHasOperationFailedException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.UnsupportedAuthenticationException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/Range.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/Reader.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/ReaderBuilder.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/ReaderInterceptor.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/ReaderListener.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/RedeliveryBackoff.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/RegexSubscriptionMode.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/Schema.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/SchemaSerializationException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/ServiceUrlProvider.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/SizeUnit.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/SubscriptionInitialPosition.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/SubscriptionMode.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/SubscriptionType.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/TableView.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/TableViewBuilder.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/TopicConsumerBuilder.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/TopicMessageId.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/TopicMetadata.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/TransactionIsolationLevel.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/TypedMessageBuilder.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/interceptor/ProducerInterceptor.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/interceptor/ProducerInterceptorWrapper.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/interceptor/class-use/ProducerInterceptor.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/interceptor/class-use/ProducerInterceptorWrapper.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/interceptor/package-summary.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/interceptor/package-tree.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/interceptor/package-use.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/package-summary.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/package-tree.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/package-use.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/schema/Field.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/schema/FieldSchemaBuilder.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/schema/GenericObject.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/schema/GenericRecord.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/schema/GenericRecordBuilder.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/schema/GenericSchema.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/schema/KeyValueSchema.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/schema/RecordSchemaBuilder.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/schema/SchemaBuilder.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/schema/SchemaDefinition.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/schema/SchemaDefinitionBuilder.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/schema/SchemaInfoProvider.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/schema/SchemaReader.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/schema/SchemaWriter.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/schema/class-use/Field.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/schema/class-use/FieldSchemaBuilder.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/schema/class-use/GenericObject.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/schema/class-use/GenericRecord.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/schema/class-use/GenericRecordBuilder.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/schema/class-use/GenericSchema.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/schema/class-use/KeyValueSchema.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/schema/class-use/RecordSchemaBuilder.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/schema/class-use/SchemaBuilder.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/schema/class-use/SchemaDefinition.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/schema/class-use/SchemaDefinitionBuilder.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/schema/class-use/SchemaInfoProvider.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/schema/class-use/SchemaReader.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/schema/class-use/SchemaWriter.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/schema/package-summary.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/schema/package-tree.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/schema/package-use.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/Transaction.State.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/Transaction.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/TransactionBufferClient.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/TransactionBufferClientException.ReachMaxPendingOpsException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/TransactionBufferClientException.RequestTimeoutException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/TransactionBufferClientException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/TransactionBuilder.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/TransactionCoordinatorClient.State.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/TransactionCoordinatorClient.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/TransactionCoordinatorClientException.CoordinatorClientStateException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/TransactionCoordinatorClientException.CoordinatorNotFoundException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/TransactionCoordinatorClientException.InvalidTxnStatusException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/TransactionCoordinatorClientException.MetaStoreHandlerNotExistsException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/TransactionCoordinatorClientException.MetaStoreHandlerNotReadyException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/TransactionCoordinatorClientException.TransactionNotFoundException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/TransactionCoordinatorClientException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/TxnID.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/class-use/Transaction.State.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/class-use/Transaction.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/class-use/TransactionBufferClient.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/class-use/TransactionBufferClientException.ReachMaxPendingOpsException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/class-use/TransactionBufferClientException.RequestTimeoutException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/class-use/TransactionBufferClientException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/class-use/TransactionBuilder.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/class-use/TransactionCoordinatorClient.State.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/class-use/TransactionCoordinatorClient.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/class-use/TransactionCoordinatorClientException.CoordinatorClientStateException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/class-use/TransactionCoordinatorClientException.CoordinatorNotFoundException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/class-use/TransactionCoordinatorClientException.InvalidTxnStatusException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/class-use/TransactionCoordinatorClientException.MetaStoreHandlerNotExistsException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/class-use/TransactionCoordinatorClientException.MetaStoreHandlerNotReadyException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/class-use/TransactionCoordinatorClientException.TransactionNotFoundException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/class-use/TransactionCoordinatorClientException.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/class-use/TxnID.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/package-summary.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/package-tree.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/package-use.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/internal/DefaultImplementation.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/internal/PropertiesUtils.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/internal/PulsarClientImplementationBinding.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/internal/class-use/DefaultImplementation.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/internal/class-use/PropertiesUtils.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/internal/class-use/PulsarClientImplementationBinding.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/internal/package-summary.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/internal/package-tree.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/client/internal/package-use.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/common/api/AuthData.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/common/api/EncryptionContext.EncryptionKey.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/common/api/EncryptionContext.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/common/api/class-use/AuthData.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/common/api/class-use/EncryptionContext.EncryptionKey.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/common/api/class-use/EncryptionContext.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/common/api/package-summary.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/common/api/package-tree.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/common/api/package-use.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/common/classification/InterfaceAudience.LimitedPrivate.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/common/classification/InterfaceAudience.Private.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/common/classification/InterfaceAudience.Public.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/common/classification/InterfaceAudience.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/common/classification/InterfaceStability.Evolving.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/common/classification/InterfaceStability.Stable.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/common/classification/InterfaceStability.Unstable.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/common/classification/InterfaceStability.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/common/classification/class-use/InterfaceAudience.LimitedPrivate.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/common/classification/class-use/InterfaceAudience.Private.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/common/classification/class-use/InterfaceAudience.Public.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/common/classification/class-use/InterfaceAudience.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/common/classification/class-use/InterfaceStability.Evolving.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/common/classification/class-use/InterfaceStability.Stable.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/common/classification/class-use/InterfaceStability.Unstable.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/common/classification/class-use/InterfaceStability.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/common/classification/package-summary.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/common/classification/package-tree.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/common/classification/package-use.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/common/schema/KeyValue.KeyValueDecoder.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/common/schema/KeyValue.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/common/schema/KeyValueEncodingType.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/common/schema/SchemaInfo.SchemaInfoBuilder.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/common/schema/SchemaInfo.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/common/schema/SchemaInfoWithVersion.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/common/schema/SchemaType.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/common/schema/class-use/KeyValue.KeyValueDecoder.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/common/schema/class-use/KeyValue.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/common/schema/class-use/KeyValueEncodingType.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/common/schema/class-use/SchemaInfo.SchemaInfoBuilder.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/common/schema/class-use/SchemaInfo.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/common/schema/class-use/SchemaInfoWithVersion.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/common/schema/class-use/SchemaType.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/common/schema/package-summary.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/common/schema/package-tree.html create mode 100644 static/api/client/4.0.x/org/apache/pulsar/common/schema/package-use.html create mode 100644 static/api/client/4.0.x/overview-summary.html create mode 100644 static/api/client/4.0.x/overview-tree.html create mode 100644 static/api/client/4.0.x/package-search-index.js create mode 100644 static/api/client/4.0.x/resources/glass.png create mode 100644 static/api/client/4.0.x/resources/x.png create mode 100644 static/api/client/4.0.x/script-dir/jquery-3.6.1.min.js create mode 100644 static/api/client/4.0.x/script-dir/jquery-ui.min.css create mode 100644 static/api/client/4.0.x/script-dir/jquery-ui.min.js create mode 100644 static/api/client/4.0.x/script.js create mode 100644 static/api/client/4.0.x/search-page.js create mode 100644 static/api/client/4.0.x/search.html create mode 100644 static/api/client/4.0.x/search.js create mode 100644 static/api/client/4.0.x/serialized-form.html create mode 100644 static/api/client/4.0.x/stylesheet.css create mode 100644 static/api/client/4.0.x/tag-search-index.js create mode 100644 static/api/client/4.0.x/type-search-index.js create mode 100644 static/api/pulsar-functions/4.0.x/allclasses-index.html create mode 100644 static/api/pulsar-functions/4.0.x/allpackages-index.html create mode 100644 static/api/pulsar-functions/4.0.x/copy.svg create mode 100644 static/api/pulsar-functions/4.0.x/deprecated-list.html create mode 100644 static/api/pulsar-functions/4.0.x/element-list create mode 100644 static/api/pulsar-functions/4.0.x/help-doc.html create mode 100644 static/api/pulsar-functions/4.0.x/index-all.html create mode 100644 static/api/pulsar-functions/4.0.x/index.html create mode 100644 static/api/pulsar-functions/4.0.x/legal/ADDITIONAL_LICENSE_INFO create mode 100644 static/api/pulsar-functions/4.0.x/legal/ASSEMBLY_EXCEPTION create mode 100644 static/api/pulsar-functions/4.0.x/legal/LICENSE create mode 100644 static/api/pulsar-functions/4.0.x/legal/jquery.md create mode 100644 static/api/pulsar-functions/4.0.x/legal/jqueryUI.md create mode 100644 static/api/pulsar-functions/4.0.x/link.svg create mode 100644 static/api/pulsar-functions/4.0.x/member-search-index.js create mode 100644 static/api/pulsar-functions/4.0.x/module-search-index.js create mode 100644 static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/BaseContext.html create mode 100644 static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/Context.html create mode 100644 static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/Function.html create mode 100644 static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/KVRecord.html create mode 100644 static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/Record.html create mode 100644 static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/SerDe.html create mode 100644 static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/StateStore.html create mode 100644 static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/StateStoreContext.html create mode 100644 static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/WindowContext.html create mode 100644 static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/WindowFunction.html create mode 100644 static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/class-use/BaseContext.html create mode 100644 static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/class-use/Context.html create mode 100644 static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/class-use/Function.html create mode 100644 static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/class-use/KVRecord.html create mode 100644 static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/class-use/Record.html create mode 100644 static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/class-use/SerDe.html create mode 100644 static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/class-use/StateStore.html create mode 100644 static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/class-use/StateStoreContext.html create mode 100644 static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/class-use/WindowContext.html create mode 100644 static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/class-use/WindowFunction.html create mode 100644 static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/package-summary.html create mode 100644 static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/package-tree.html create mode 100644 static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/package-use.html create mode 100644 static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/state/ByteBufferStateStore.html create mode 100644 static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/state/CounterStateStore.html create mode 100644 static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/state/StateValue.html create mode 100644 static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/state/class-use/ByteBufferStateStore.html create mode 100644 static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/state/class-use/CounterStateStore.html create mode 100644 static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/state/class-use/StateValue.html create mode 100644 static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/state/package-summary.html create mode 100644 static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/state/package-tree.html create mode 100644 static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/state/package-use.html create mode 100644 static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/utils/FunctionRecord.FunctionRecordBuilder.html create mode 100644 static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/utils/FunctionRecord.html create mode 100644 static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/utils/IdentityFunction.html create mode 100644 static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/utils/class-use/FunctionRecord.FunctionRecordBuilder.html create mode 100644 static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/utils/class-use/FunctionRecord.html create mode 100644 static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/utils/class-use/IdentityFunction.html create mode 100644 static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/utils/package-summary.html create mode 100644 static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/utils/package-tree.html create mode 100644 static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/utils/package-use.html create mode 100644 static/api/pulsar-functions/4.0.x/overview-summary.html create mode 100644 static/api/pulsar-functions/4.0.x/overview-tree.html create mode 100644 static/api/pulsar-functions/4.0.x/package-search-index.js create mode 100644 static/api/pulsar-functions/4.0.x/resources/glass.png create mode 100644 static/api/pulsar-functions/4.0.x/resources/x.png create mode 100644 static/api/pulsar-functions/4.0.x/script-dir/jquery-3.6.1.min.js create mode 100644 static/api/pulsar-functions/4.0.x/script-dir/jquery-ui.min.css create mode 100644 static/api/pulsar-functions/4.0.x/script-dir/jquery-ui.min.js create mode 100644 static/api/pulsar-functions/4.0.x/script.js create mode 100644 static/api/pulsar-functions/4.0.x/search-page.js create mode 100644 static/api/pulsar-functions/4.0.x/search.html create mode 100644 static/api/pulsar-functions/4.0.x/search.js create mode 100644 static/api/pulsar-functions/4.0.x/stylesheet.css create mode 100644 static/api/pulsar-functions/4.0.x/tag-search-index.js create mode 100644 static/api/pulsar-functions/4.0.x/type-search-index.js diff --git a/static/api/admin/4.0.x/allclasses-index.html b/static/api/admin/4.0.x/allclasses-index.html new file mode 100644 index 000000000000..6d6e6e0f9530 --- /dev/null +++ b/static/api/admin/4.0.x/allclasses-index.html @@ -0,0 +1,851 @@ + + + + +All Classes and Interfaces (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

All Classes and Interfaces

+
+
+
+
+
+
Class
+
Description
+
AllocatorStats
+
+
Allocator statistics.
+
+
AllocatorStats.PoolArenaStats
+
+
Pool arena statistics.
+
+
AllocatorStats.PoolChunkListStats
+
+
Pool chunk list statistics.
+
+
AllocatorStats.PoolChunkStats
+
+
Pool chunk statistics.
+
+
AllocatorStats.PoolSubpageStats
+
+
Pool subpage statistics.
+
+
AnalyzeSubscriptionBacklogResult
+
 
+
AuthAction
+
+
Authorization action for Pulsar policies.
+
+
AuthenticationConfig
+
+
Configuration to aggregate various authentication params.
+
+
AuthPolicies
+
+
Authentication policies.
+
+
AuthPolicies.Builder
+
 
+
AutoFailoverPolicy
+
+
Basic definition of an auto-failover policy.
+
+
AutoFailoverPolicyData
+
 
+
AutoFailoverPolicyData.Builder
+
 
+
AutoFailoverPolicyFactory
+
+
Factory to generate an instance of AutoFailoverPolicy.
+
+
AutoFailoverPolicyType
+
+
The policy type of auto failover.
+
+
AutoSubscriptionCreationOverride
+
+
Override of autoSubscriptionCreation settings on a namespace level.
+
+
AutoSubscriptionCreationOverride.Builder
+
 
+
AutoSubscriptionCreationOverrideImpl
+
+
Override of autoSubscriptionCreation settings on a topic or namespace level.
+
+
AutoSubscriptionCreationOverrideImpl.AutoSubscriptionCreationOverrideImplBuilder
+
 
+
AutoTopicCreationOverride
+
+
Override of autoTopicCreation settings on a namespace level.
+
+
AutoTopicCreationOverride.Builder
+
 
+
AutoTopicCreationOverrideImpl
+
+
Override of autoTopicCreation settings on a namespace level.
+
+
AutoTopicCreationOverrideImpl.AutoTopicCreationOverrideImplBuilder
+
 
+
BacklogQuota
+
+
Unit of a backlog quota configuration for a scoped resource in a Pulsar instance.
+
+
BacklogQuota.BacklogQuotaType
+
+
Identifier to a backlog quota configuration (an instance of BacklogQuota).
+
+
BacklogQuota.Builder
+
 
+
BacklogQuota.RetentionPolicy
+
+
Enumeration type determines how to retain backlog against the resource shortages.
+
+
BacklogQuotaImpl
+
 
+
BacklogQuotaImpl.BacklogQuotaImplBuilder
+
 
+
BatchSourceConfig
+
+
Pulsar Batch Source configuration.
+
+
BookieAffinityGroupData
+
+
Description of a BookKeeper's affinity group.
+
+
BookieAffinityGroupData.Builder
+
 
+
BookieAffinityGroupDataImpl
+
+
Description of a BookKeeper's affinity group.
+
+
BookieAffinityGroupDataImpl.BookieAffinityGroupDataImplBuilder
+
 
+
BookieInfo
+
+
Bookie information.
+
+
BookieInfo.Builder
+
 
+
BookieInfoImpl
+
+
Bookie information.
+
+
BookieInfoImpl.BookieInfoImplBuilder
+
 
+
Bookies
+
+
Admin interface for bookies rack placement management.
+
+
BookiesClusterInfo
+
+
Raw bookies information.
+
+
BookiesClusterInfo.Builder
+
 
+
BookiesClusterInfoImpl
+
+
Raw bookies information.
+
+
BookiesClusterInfoImpl.BookiesClusterInfoImplBuilder
+
 
+
BookiesRackConfiguration
+
+
The rack configuration map for bookies.
+
+
BrokerAssignment
+
+
Definition of possible broker assignments.
+
+
BrokerInfo
+
+
Broker Information.
+
+
BrokerInfo.Builder
+
 
+
BrokerInfoImpl
+
+
Broker Information.
+
+
BrokerInfoImpl.BrokerInfoImplBuilder
+
 
+
BrokerNamespaceIsolationData
+
 
+
BrokerNamespaceIsolationData.Builder
+
 
+
Brokers
+
+
Admin interface for brokers management.
+
+
BrokerStats
+
+
Admin interface for brokers management.
+
+
BrokerStatus
+
+
Information about the broker status.
+
+
BrokerStatus.Builder
+
 
+
BrokerStatusImpl
+
+
Information about the broker status.
+
+
BrokerStatusImpl.BrokerStatusImplBuilder
+
 
+
BundlesData
+
+
Holder for bundles.
+
+
BundlesData.Builder
+
 
+
BundlesDataImpl
+
+
Holder for bundles.
+
+
BundlesDataImpl.BundlesDataImplBuilder
+
 
+
ClusterData
+
 
+
ClusterData.Builder
+
 
+
ClusterPolicies
+
 
+
ClusterPolicies.Builder
+
 
+
ClusterPolicies.ClusterUrl
+
 
+
Clusters
+
+
Admin interface for clusters management.
+
+
CompactionStats
+
+
Statistics about compaction.
+
+
ConnectorDefinition
+
+
Basic information about a Pulsar connector.
+
+
ConsumerConfig
+
+
Configuration of a consumer.
+
+
ConsumerStats
+
+
Consumer statistics.
+
+
CryptoConfig
+
+
Configuration of the producer inside the function.
+
+
DefaultImplementation
+
+
Helper class for class instantiations and it also contains methods to work with schemas.
+
+
DelayedDeliveryPolicies
+
+
Definition of the delayed delivery policy.
+
+
DelayedDeliveryPolicies.Builder
+
 
+
DelayedDeliveryPoliciesImpl
+
+
Definition of the delayed delivery policy.
+
+
DelayedDeliveryPoliciesImpl.DelayedDeliveryPoliciesImplBuilder
+
 
+
DispatchRate
+
+
Dispatch rate.
+
+
DispatchRate.Builder
+
 
+
DispatchRateImpl
+
+
Dispatch rate.
+
+
DispatchRateImpl.DispatchRateImplBuilder
+
 
+
DrainingHash
+
+
Contains information about a draining hash in a Key_Shared subscription.
+
+
EntryFilters
+
 
+
ErrorData
+
+
Class holding data in case of error responses.
+
+
ExceptionInformation
+
+
Exception information.
+
+
FailureDomain
+
 
+
FailureDomain.Builder
+
 
+
FunctionConfig
+
+
Configuration of Pulsar Function.
+
+
FunctionConfig.ProcessingGuarantees
+
+
Definition of possible processing guarantees.
+
+
FunctionConfig.Runtime
+
+
Definition of possible runtime environments.
+
+
FunctionDefinition
+
+
Basic information about a Pulsar function.
+
+
FunctionInstanceStats
+
 
+
FunctionInstanceStatsData
+
 
+
FunctionInstanceStatsDataBase
+
 
+
Functions
+
+
Admin interface for function management.
+
+
FunctionState
+
+
Function state.
+
+
FunctionStats
+
 
+
FunctionStatus
+
+
Data lass containing status of Pulsar Function.
+
+
FunctionStatus.FunctionInstanceStatus
+
+
Function instance status.
+
+
FunctionStatus.FunctionInstanceStatus.FunctionInstanceStatusData
+
+
Function instance status data.
+
+
GetStatsOptions
+
 
+
GrantTopicPermissionOptions
+
 
+
InactiveTopicDeleteMode
+
+
Inactive topic deletion mode.
+
+
InactiveTopicPolicies
+
+
Definition of the inactive topic policy.
+
+
InternalConfigurationData
+
+
Internal configuration data.
+
+
IsCompatibilityResponse
+
+
Response defining if a schema is compatible with existing topic's schema.
+
+
ListNamespaceTopicsOptions
+
 
+
ListTopicsOptions
+
 
+
LoadManagerReport
+
+
This class represents the overall load of the broker - it includes overall SystemResourceUsage and Bundle-usage.
+
+
LongRunningProcessStatus
+
+
Status of long running process.
+
+
LongRunningProcessStatus.Status
+
+
Status code.
+
+
Lookup
+
+
This is an interface class to allow using command line tool to quickly lookup the broker serving the topic.
+
+
ManagedLedgerInternalStats
+
+
ManagedLedger internal statistics.
+
+
ManagedLedgerInternalStats.CursorStats
+
+
Pulsar cursor statistics.
+
+
ManagedLedgerInternalStats.LedgerInfo
+
+
Ledger information.
+
+
Metrics
+
+
WARNING : do not add any getters as the Jackson parser will output that getter.
+
+
MinAvailablePolicy
+
+
Implementation of min available policy.
+
+
Mode
+
 
+
NamespaceBundleStats
+
 
+
NamespaceIsolationData
+
 
+
NamespaceIsolationData.Builder
+
 
+
NamespaceIsolationPolicyUnloadScope
+
+
The type of unload to perform while setting the isolation policy.
+
+
NamespaceOwnershipStatus
+
+
Information about the namespace's ownership.
+
+
Namespaces
+
+
Admin interface for namespaces management.
+
+
NonPersistentPartitionedTopicStats
+
+
Statistics for a non-persistent partitioned topic.
+
+
NonPersistentPublisherStats
+
+
Non-persistent publisher statistics.
+
+
NonPersistentReplicatorStats
+
+
Statistics for a non-persistent replicator.
+
+
NonPersistentSubscriptionStats
+
+
Statistics for subscription to non-persistent topics.
+
+
NonPersistentTopics
+
Deprecated. +
since 2.0.
+
+
NonPersistentTopicStats
+
+
Statistics for a non-persistent topic.
+
+
OffloadedReadPriority
+
 
+
OffloadPolicies
+
 
+
OffloadPolicies.Builder
+
 
+
OffloadProcessStatus
+
+
interface class of Status of offload process.
+
+
PackageMetadata
+
+
Package metadata.
+
+
Packages
+
+
Administration operations of the packages management service.
+
+
PackagesManagementException
+
+
Packages management related exceptions.
+
+
PackagesManagementException.MetadataFormatException
+
 
+
PackagesManagementException.NotFoundException
+
 
+
PackageType
+
+
PackageType used to identify the package type.
+
+
PartitionedTopicInternalStats
+
+
Internal statistics for a partitioned topic.
+
+
PartitionedTopicMetadata
+
+
Metadata of a partitioned topic.
+
+
PartitionedTopicStats
+
+
Statistics for a partitioned topic.
+
+
PersistencePolicies
+
+
Configuration of bookkeeper persistence policies.
+
+
PersistentTopicInternalStats
+
+
Persistent topic internal statistics.
+
+
Policies
+
+
Definition of Pulsar policies.
+
+
Policies.BundleType
+
 
+
PositionInPendingAckStats
+
 
+
PositionInPendingAckStats.State
+
 
+
PostSchemaPayload
+
+
Payload with information about a schema.
+
+
ProducerConfig
+
+
Configuration of the producer inside the function.
+
+
Properties
+
Deprecated. +
see Tenants from PulsarAdmin.tenants()
+
+
ProxyStats
+
+
Admin interface for proxy stats management.
+
+
PublisherStats
+
+
Statistics about a publisher.
+
+
PublishRate
+
+
Publish-rate to manage publish throttling.
+
+
PulsarAdmin
+
 
+
PulsarAdminBuilder
+
+
Builder class for a PulsarAdmin instance.
+
+
PulsarAdminException
+
+
Pulsar admin exceptions.
+
+
PulsarAdminException.ConflictException
+
+
Conflict Exception.
+
+
PulsarAdminException.ConnectException
+
+
Connect Exception.
+
+
PulsarAdminException.GettingAuthenticationDataException
+
+
Getting Authentication Data Exception.
+
+
PulsarAdminException.HttpErrorException
+
+
Http Error Exception.
+
+
PulsarAdminException.NotAllowedException
+
+
Not Allowed Exception.
+
+
PulsarAdminException.NotAuthorizedException
+
+
Not Authorized Exception.
+
+
PulsarAdminException.NotFoundException
+
+
Not Found Exception.
+
+
PulsarAdminException.PreconditionFailedException
+
+
Precondition Failed Exception.
+
+
PulsarAdminException.ServerSideErrorException
+
+
Server Side Error Exception.
+
+
PulsarAdminException.TimeoutException
+
+
Timeout Exception.
+
+
RawBookieInfo
+
+
Bookie information.
+
+
ReflectionUtils
+
 
+
ReplicatorStats
+
+
Statistics about a replicator.
+
+
ResourceGroup
+
 
+
ResourceGroups
+
+
Admin interface for ResourceGroups management.
+
+
ResourceQuota
+
+
Resource quota for a namespace or namespace bundle.
+
+
ResourceQuotas
+
+
Admin interface on interacting with resource quotas.
+
+
Resources
+
+
Class representing resources, such as CPU, RAM, and disk size.
+
+
ResourceUsage
+
+
POJO used to represent any system specific resource usage this is the format that load manager expects it in.
+
+
RetentionPolicies
+
+
Definition of the retention policy.
+
+
RevokeTopicPermissionOptions
+
 
+
SchemaAutoUpdateCompatibilityStrategy
+
+
Strategy to use when checking an auto-updated schema for compatibility to the current schema.
+
+
SchemaCompatibilityStrategy
+
+
Pulsar Schema compatibility strategy.
+
+
SchemaMetadata
+
+
Schema metadata info.
+
+
SchemaMetadata.Entry
+
 
+
Schemas
+
+
Admin interface on interacting with schemas.
+
+
SegmentsStats
+
 
+
SegmentStats
+
 
+
ServiceLookupData
+
+
For backwards compatibility purposes.
+
+
Sink
+
Deprecated. +
in favor of Sinks
+
+
SinkConfig
+
+
Configuration of Pulsar Sink.
+
+
Sinks
+
+
Admin interface for Sink management.
+
+
SinkStatus
+
+
Status of Pulsar Sink.
+
+
SinkStatus.SinkInstanceStatus
+
+
Status of a Sink instance.
+
+
SinkStatus.SinkInstanceStatus.SinkInstanceStatusData
+
+
Status data of a Sink instance.
+
+
SnapshotSystemTopicInternalStats
+
 
+
Source
+
Deprecated. +
in favor of Sources
+
+
SourceConfig
+
+
Pulsar source configuration.
+
+
Sources
+
+
Admin interface for Source management.
+
+
SourceStatus
+
+
Source status.
+
+
SourceStatus.SourceInstanceStatus
+
+
Source instance status.
+
+
SourceStatus.SourceInstanceStatus.SourceInstanceStatusData
+
+
Source instance status data.
+
+
SubscribeRate
+
+
Information about subscription rate.
+
+
SubscriptionAuthMode
+
+
Subscription authorization for Pulsar policies.
+
+
SubscriptionStats
+
+
Statistics about subscription.
+
+
TenantInfo
+
 
+
TenantInfo.Builder
+
 
+
Tenants
+
+
Admin interface for tenants management.
+
+
TopicDomain
+
+
Enumeration showing if a topic is persistent.
+
+
TopicHashPositions
+
 
+
TopicPolicies
+
+
Admin interface for topic policies management.
+
+
Topics
+
+
Admin interface for Topics management.
+
+
Topics.QueryParam
+
 
+
TopicStats
+
+
Statistics for a Pulsar topic.
+
+
TopicType
+
+
Topic types -- partitioned or non-partitioned.
+
+
TopicVersion
+
 
+
TransactionBufferInternalStats
+
 
+
TransactionBufferStats
+
 
+
TransactionCoordinatorInfo
+
+
Transaction coordinator information.
+
+
TransactionCoordinatorInternalStats
+
+
Transaction coordinator internal stats.
+
+
TransactionCoordinatorStats
+
+
Transaction coordinator stats.
+
+
TransactionCoordinatorStatus
+
+
Transaction coordinator status.
+
+
TransactionInBufferStats
+
 
+
TransactionInPendingAckStats
+
 
+
TransactionLogStats
+
+
Transaction log stats.
+
+
TransactionMetadata
+
 
+
TransactionPendingAckInternalStats
+
+
Transaction pending ack internal stats.
+
+
TransactionPendingAckStats
+
 
+
Transactions
+
 
+
UpdateOptions
+
 
+
ValidateResult
+
 
+
WindowConfig
+
+
Configuration of a windowing function.
+
+
WindowConfig.ProcessingGuarantees
+
+
This is a semantic option that windows can provide, + forcing the semantics of the FunctionConfig.ProcessingGuarantees to be equal to MANUAL, + and then letting the windows function handle the semantic timing by itself.
+
+
Worker
+
+
Admin interface for worker stats management.
+
+
WorkerFunctionInstanceStats
+
+
Data class holding statistics about a function.
+
+
WorkerInfo
+
+
Worker information.
+
+
+
+
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/allpackages-index.html b/static/api/admin/4.0.x/allpackages-index.html new file mode 100644 index 000000000000..c8497bd25b0a --- /dev/null +++ b/static/api/admin/4.0.x/allpackages-index.html @@ -0,0 +1,127 @@ + + + + +All Packages (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

All Packages

+
+
Package Summary
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
org.apache.pulsar.client.admin.utils
+
+
Helpers which provide useful functionality for the implementation of Pulsar Client API.
+
+
org.apache.pulsar.common.conf
+
+
Classes for internal configuration.
+
+
org.apache.pulsar.common.functions
+
+
Implementation of policies.
+
+
org.apache.pulsar.common.io
+
+
Implementation of policies.
+
+
org.apache.pulsar.common.naming
+
+
Implementation of policies.
+
+
org.apache.pulsar.common.partition
+
+
Implementation of policies.
+
+
org.apache.pulsar.common.policies
+
+
Implementation of policies.
+
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
org.apache.pulsar.common.policies.data.impl
+
 
+
org.apache.pulsar.common.policies.impl
+
+
Implementation of policies.
+
+
org.apache.pulsar.common.protocol.schema
+
+
Implementation of policies.
+
+
org.apache.pulsar.common.stats
+
+
Implementation of policies.
+
+
org.apache.pulsar.packages.management.core.common
+
+
Packages management general classes.
+
+
org.apache.pulsar.packages.management.core.exceptions
+
+
Exceptions of the packages management service thrown.
+
+
org.apache.pulsar.policies.data.loadbalancer
+
+
Implementation of policies.
+
+
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/constant-values.html b/static/api/admin/4.0.x/constant-values.html new file mode 100644 index 000000000000..b180037203e2 --- /dev/null +++ b/static/api/admin/4.0.x/constant-values.html @@ -0,0 +1,145 @@ + + + + +Constant Field Values (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Constant Field Values

+
+
+

Contents

+ +
+
+

org.apache.*

+ + + + +
    +
  • +
    org.apache.pulsar.common.policies.data.impl.BacklogQuotaImpl
    +
    +
    Modifier and Type
    +
    Constant Field
    +
    Value
    +
    public static final long
    +
    BYTES_IN_GIGABYTE
    +
    1073741824L
    +
    +
    • +
+
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/copy.svg b/static/api/admin/4.0.x/copy.svg new file mode 100644 index 000000000000..7c46ab15feaf --- /dev/null +++ b/static/api/admin/4.0.x/copy.svg @@ -0,0 +1,33 @@ + + + + + + + + diff --git a/static/api/admin/4.0.x/deprecated-list.html b/static/api/admin/4.0.x/deprecated-list.html new file mode 100644 index 000000000000..8291ce9728e9 --- /dev/null +++ b/static/api/admin/4.0.x/deprecated-list.html @@ -0,0 +1,938 @@ + + + + +Deprecated List (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Deprecated API

+
+

Contents

+ + + + + + +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/element-list b/static/api/admin/4.0.x/element-list new file mode 100644 index 000000000000..9b50aec9b8d9 --- /dev/null +++ b/static/api/admin/4.0.x/element-list @@ -0,0 +1,16 @@ +org.apache.pulsar.client.admin +org.apache.pulsar.client.admin.utils +org.apache.pulsar.common.conf +org.apache.pulsar.common.functions +org.apache.pulsar.common.io +org.apache.pulsar.common.naming +org.apache.pulsar.common.partition +org.apache.pulsar.common.policies +org.apache.pulsar.common.policies.data +org.apache.pulsar.common.policies.data.impl +org.apache.pulsar.common.policies.impl +org.apache.pulsar.common.protocol.schema +org.apache.pulsar.common.stats +org.apache.pulsar.packages.management.core.common +org.apache.pulsar.packages.management.core.exceptions +org.apache.pulsar.policies.data.loadbalancer diff --git a/static/api/admin/4.0.x/help-doc.html b/static/api/admin/4.0.x/help-doc.html new file mode 100644 index 000000000000..7b9c3c07537d --- /dev/null +++ b/static/api/admin/4.0.x/help-doc.html @@ -0,0 +1,208 @@ + + + + +API Help (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+

JavaDoc Help

+ +
+
+

Navigation

+Starting from the Overview page, you can browse the documentation using the links in each page, and in the navigation bar at the top of each page. The Index and Search box allow you to navigate to specific declarations and summary pages, including: All Packages, All Classes and Interfaces + +
+
+
+

Kinds of Pages

+The following sections describe the different kinds of pages in this collection. +
+

Overview

+

The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.

+
+
+

Package

+

Each package has a page that contains a list of its classes and interfaces, with a summary for each. These pages may contain the following categories:

+
    +
  • Interfaces
    • +
  • Classes
    • +
  • Enum Classes
    • +
  • Exception Classes
    • +
  • Annotation Interfaces
    • +
+
+
+

Class or Interface

+

Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a declaration and description, member summary tables, and detailed member descriptions. Entries in each of these sections are omitted if they are empty or not applicable.

+
    +
  • Class Inheritance Diagram
    • +
  • Direct Subclasses
    • +
  • All Known Subinterfaces
    • +
  • All Known Implementing Classes
    • +
  • Class or Interface Declaration
    • +
  • Class or Interface Description
    • +
+
+
    +
  • Nested Class Summary
    • +
  • Enum Constant Summary
    • +
  • Field Summary
    • +
  • Property Summary
    • +
  • Constructor Summary
    • +
  • Method Summary
    • +
  • Required Element Summary
    • +
  • Optional Element Summary
    • +
+
+
    +
  • Enum Constant Details
    • +
  • Field Details
    • +
  • Property Details
    • +
  • Constructor Details
    • +
  • Method Details
    • +
  • Element Details
    • +
+

Note: Annotation interfaces have required and optional elements, but not methods. Only enum classes have enum constants. The components of a record class are displayed as part of the declaration of the record class. Properties are a feature of JavaFX.

+

The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.

+
+
+

Other Files

+

Packages and modules may contain pages with additional information related to the declarations nearby.

+
+
+

Use

+

Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the USE link in the navigation bar.

+
+
+

Tree (Class Hierarchy)

+

There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. Classes are organized by inheritance structure starting with java.lang.Object. Interfaces do not inherit from java.lang.Object.

+
    +
  • When viewing the Overview page, clicking on TREE displays the hierarchy for all packages.
    • +
  • When viewing a particular package, class or interface page, clicking on TREE displays the hierarchy for only that package.
    • +
+
+
+

Deprecated API

+

The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to shortcomings, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.

+
+
+

Constant Field Values

+

The Constant Field Values page lists the static final fields and their values.

+
+
+

Serialized Form

+

Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to those who implement rather than use the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See Also" section of the class description.

+
+
+

All Packages

+

The All Packages page contains an alphabetic index of all packages contained in the documentation.

+
+
+

All Classes and Interfaces

+

The All Classes and Interfaces page contains an alphabetic index of all classes and interfaces contained in the documentation, including annotation interfaces, enum classes, and record classes.

+
+
+

Index

+

The Index contains an alphabetic index of all classes, interfaces, constructors, methods, and fields in the documentation, as well as summary pages such as All Packages, All Classes and Interfaces.

+
+
+
+This help file applies to API documentation generated by the standard doclet.
+ +
+
+ + diff --git a/static/api/admin/4.0.x/index-all.html b/static/api/admin/4.0.x/index-all.html new file mode 100644 index 000000000000..f3b721c5b67e --- /dev/null +++ b/static/api/admin/4.0.x/index-all.html @@ -0,0 +1,9382 @@ + + + + +Index (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Index

+
+A B C D E F G H I J L M N O P R S T U V W 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form +

A

+
+
aborted - Variable in class org.apache.pulsar.common.policies.data.TransactionInBufferStats
+
+
The flag of this transaction have been aborted.
+
+
abortTransaction(TxnID) - Method in interface org.apache.pulsar.client.admin.Transactions
+
+
Abort a transaction.
+
+
abortTransactionAsync(TxnID) - Method in interface org.apache.pulsar.client.admin.Transactions
+
+
Asynchronously abort a transaction.
+
+
acceptGzipCompression(boolean) - Method in interface org.apache.pulsar.client.admin.PulsarAdminBuilder
+
+
Determines whether to include the "Accept-Encoding: gzip" header in HTTP requests.
+
+
ackedPartitions - Variable in class org.apache.pulsar.common.policies.data.TransactionMetadata
+
+
The ackedPartitions of this transaction.
+
+
active - Variable in class org.apache.pulsar.common.policies.data.ManagedLedgerInternalStats.CursorStats
+
 
+
active(boolean) - Method in interface org.apache.pulsar.common.policies.data.BrokerStatus.Builder
+
 
+
active(boolean) - Method in interface org.apache.pulsar.common.policies.data.DelayedDeliveryPolicies.Builder
+
 
+
active(boolean) - Method in class org.apache.pulsar.common.policies.data.impl.BrokerStatusImpl.BrokerStatusImplBuilder
+
 
+
active(boolean) - Method in class org.apache.pulsar.common.policies.data.impl.DelayedDeliveryPoliciesImpl.DelayedDeliveryPoliciesImplBuilder
+
 
+
add(NonPersistentTopicStats) - Method in interface org.apache.pulsar.common.policies.data.NonPersistentPartitionedTopicStats
+
 
+
add(ResourceQuota) - Method in class org.apache.pulsar.common.policies.data.ResourceQuota
+
+
Add quota.
+
+
add(TopicStats) - Method in interface org.apache.pulsar.common.policies.data.PartitionedTopicStats
+
 
+
addInstance(FunctionStatus.FunctionInstanceStatus) - Method in class org.apache.pulsar.common.policies.data.FunctionStatus
+
 
+
addInstance(SinkStatus.SinkInstanceStatus) - Method in class org.apache.pulsar.common.policies.data.SinkStatus
+
 
+
addInstance(SourceStatus.SourceInstanceStatus) - Method in class org.apache.pulsar.common.policies.data.SourceStatus
+
 
+
adminRoles(Set<String>) - Method in interface org.apache.pulsar.common.policies.data.TenantInfo.Builder
+
 
+
ALL - Enum constant in enum class org.apache.pulsar.client.admin.Mode
+
 
+
all_matching - Enum constant in enum class org.apache.pulsar.common.policies.data.NamespaceIsolationPolicyUnloadScope
+
 
+
AllocatorStats - Class in org.apache.pulsar.common.stats
+
+
Allocator statistics.
+
+
AllocatorStats() - Constructor for class org.apache.pulsar.common.stats.AllocatorStats
+
 
+
AllocatorStats.PoolArenaStats - Class in org.apache.pulsar.common.stats
+
+
Pool arena statistics.
+
+
AllocatorStats.PoolChunkListStats - Class in org.apache.pulsar.common.stats
+
+
Pool chunk list statistics.
+
+
AllocatorStats.PoolChunkStats - Class in org.apache.pulsar.common.stats
+
+
Pool chunk statistics.
+
+
AllocatorStats.PoolSubpageStats - Class in org.apache.pulsar.common.stats
+
+
Pool subpage statistics.
+
+
allowAutoSubscriptionCreation(boolean) - Method in interface org.apache.pulsar.common.policies.data.AutoSubscriptionCreationOverride.Builder
+
 
+
allowAutoSubscriptionCreation(boolean) - Method in class org.apache.pulsar.common.policies.data.impl.AutoSubscriptionCreationOverrideImpl.AutoSubscriptionCreationOverrideImplBuilder
+
 
+
allowAutoTopicCreation(boolean) - Method in interface org.apache.pulsar.common.policies.data.AutoTopicCreationOverride.Builder
+
 
+
allowAutoTopicCreation(boolean) - Method in class org.apache.pulsar.common.policies.data.impl.AutoTopicCreationOverrideImpl.AutoTopicCreationOverrideImplBuilder
+
 
+
allowed_clusters - Variable in class org.apache.pulsar.common.policies.data.Policies
+
 
+
allowedClusters(Set<String>) - Method in interface org.apache.pulsar.common.policies.data.TenantInfo.Builder
+
 
+
allowTlsInsecureConnection(boolean) - Method in interface org.apache.pulsar.client.admin.PulsarAdminBuilder
+
+
Configure whether the Pulsar admin client accept untrusted TLS certificate from broker (default: false).
+
+
ALWAYS_COMPATIBLE - Enum constant in enum class org.apache.pulsar.common.policies.data.SchemaCompatibilityStrategy
+
+
Always compatible.
+
+
ALWAYS_INCOMPATIBLE - Enum constant in enum class org.apache.pulsar.common.policies.data.SchemaCompatibilityStrategy
+
+
Always incompatible.
+
+
AlwaysCompatible - Enum constant in enum class org.apache.pulsar.common.policies.data.SchemaAutoUpdateCompatibilityStrategy
+
+
Always Compatible - The new schema will not be checked for compatibility against + old schemas.
+
+
analyzeSubscriptionBacklog(String, String, Optional<MessageId>) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Analyze subscription backlog.
+
+
analyzeSubscriptionBacklogAsync(String, String, Optional<MessageId>) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Analyze subscription backlog.
+
+
AnalyzeSubscriptionBacklogResult - Class in org.apache.pulsar.common.stats
+
 
+
AnalyzeSubscriptionBacklogResult() - Constructor for class org.apache.pulsar.common.stats.AnalyzeSubscriptionBacklogResult
+
 
+
ATLEAST_ONCE - Enum constant in enum class org.apache.pulsar.common.functions.FunctionConfig.ProcessingGuarantees
+
 
+
ATLEAST_ONCE - Enum constant in enum class org.apache.pulsar.common.functions.WindowConfig.ProcessingGuarantees
+
 
+
ATMOST_ONCE - Enum constant in enum class org.apache.pulsar.common.functions.FunctionConfig.ProcessingGuarantees
+
 
+
ATMOST_ONCE - Enum constant in enum class org.apache.pulsar.common.functions.WindowConfig.ProcessingGuarantees
+
 
+
auth_policies - Variable in class org.apache.pulsar.common.policies.data.Policies
+
 
+
AuthAction - Enum Class in org.apache.pulsar.common.policies.data
+
+
Authorization action for Pulsar policies.
+
+
authentication(String, String) - Method in interface org.apache.pulsar.client.admin.PulsarAdminBuilder
+
+
Set the authentication provider to use in the Pulsar client instance.
+
+
authentication(String, Map<String, String>) - Method in interface org.apache.pulsar.client.admin.PulsarAdminBuilder
+
+
Set the authentication provider to use in the Pulsar client instance.
+
+
authentication(Authentication) - Method in interface org.apache.pulsar.client.admin.PulsarAdminBuilder
+
+
Set the authentication provider to use in the Pulsar admin instance.
+
+
AuthenticationConfig - Class in org.apache.pulsar.common.functions
+
+
Configuration to aggregate various authentication params.
+
+
AuthenticationConfig() - Constructor for class org.apache.pulsar.common.functions.AuthenticationConfig
+
 
+
authenticationParameters(String) - Method in interface org.apache.pulsar.common.policies.data.ClusterData.Builder
+
 
+
authenticationPlugin(String) - Method in interface org.apache.pulsar.common.policies.data.ClusterData.Builder
+
 
+
AuthPolicies - Interface in org.apache.pulsar.common.policies.data
+
+
Authentication policies.
+
+
AuthPolicies.Builder - Interface in org.apache.pulsar.common.policies.data
+
 
+
autoCertRefreshTime(int, TimeUnit) - Method in interface org.apache.pulsar.client.admin.PulsarAdminBuilder
+
+
This sets auto cert refresh time if Pulsar admin uses tls authentication.
+
+
autoFailoverPolicy(AutoFailoverPolicyData) - Method in interface org.apache.pulsar.common.policies.data.NamespaceIsolationData.Builder
+
 
+
AutoFailoverPolicy - Class in org.apache.pulsar.common.policies
+
+
Basic definition of an auto-failover policy.
+
+
AutoFailoverPolicy() - Constructor for class org.apache.pulsar.common.policies.AutoFailoverPolicy
+
 
+
AutoFailoverPolicyData - Interface in org.apache.pulsar.common.policies.data
+
 
+
AutoFailoverPolicyData.Builder - Interface in org.apache.pulsar.common.policies.data
+
 
+
AutoFailoverPolicyFactory - Class in org.apache.pulsar.common.policies.impl
+
+
Factory to generate an instance of AutoFailoverPolicy.
+
+
AutoFailoverPolicyFactory() - Constructor for class org.apache.pulsar.common.policies.impl.AutoFailoverPolicyFactory
+
 
+
AutoFailoverPolicyType - Enum Class in org.apache.pulsar.common.policies.data
+
+
The policy type of auto failover.
+
+
autoSubscriptionCreationOverride - Variable in class org.apache.pulsar.common.policies.data.Policies
+
 
+
AutoSubscriptionCreationOverride - Interface in org.apache.pulsar.common.policies.data
+
+
Override of autoSubscriptionCreation settings on a namespace level.
+
+
AutoSubscriptionCreationOverride.Builder - Interface in org.apache.pulsar.common.policies.data
+
 
+
AutoSubscriptionCreationOverrideImpl - Class in org.apache.pulsar.common.policies.data.impl
+
+
Override of autoSubscriptionCreation settings on a topic or namespace level.
+
+
AutoSubscriptionCreationOverrideImpl() - Constructor for class org.apache.pulsar.common.policies.data.impl.AutoSubscriptionCreationOverrideImpl
+
 
+
AutoSubscriptionCreationOverrideImpl.AutoSubscriptionCreationOverrideImplBuilder - Class in org.apache.pulsar.common.policies.data.impl
+
 
+
AutoSubscriptionCreationOverrideImplBuilder() - Constructor for class org.apache.pulsar.common.policies.data.impl.AutoSubscriptionCreationOverrideImpl.AutoSubscriptionCreationOverrideImplBuilder
+
 
+
autoTopicCreationOverride - Variable in class org.apache.pulsar.common.policies.data.Policies
+
 
+
AutoTopicCreationOverride - Interface in org.apache.pulsar.common.policies.data
+
+
Override of autoTopicCreation settings on a namespace level.
+
+
AutoTopicCreationOverride.Builder - Interface in org.apache.pulsar.common.policies.data
+
 
+
AutoTopicCreationOverrideImpl - Class in org.apache.pulsar.common.policies.data.impl
+
+
Override of autoTopicCreation settings on a namespace level.
+
+
AutoTopicCreationOverrideImpl() - Constructor for class org.apache.pulsar.common.policies.data.impl.AutoTopicCreationOverrideImpl
+
 
+
AutoTopicCreationOverrideImpl.AutoTopicCreationOverrideImplBuilder - Class in org.apache.pulsar.common.policies.data.impl
+
 
+
AutoTopicCreationOverrideImplBuilder() - Constructor for class org.apache.pulsar.common.policies.data.impl.AutoTopicCreationOverrideImpl.AutoTopicCreationOverrideImplBuilder
+
 
+
AutoUpdateDisabled - Enum constant in enum class org.apache.pulsar.common.policies.data.SchemaAutoUpdateCompatibilityStrategy
+
+
Don't allow any auto updates.
+
+
averageLatency - Variable in class org.apache.pulsar.common.policies.data.FunctionStatus.FunctionInstanceStatus.FunctionInstanceStatusData
+
 
+
+

B

+
+
backlog_quota_map - Variable in class org.apache.pulsar.common.policies.data.Policies
+
 
+
BacklogQuota - Interface in org.apache.pulsar.common.policies.data
+
+
Unit of a backlog quota configuration for a scoped resource in a Pulsar instance.
+
+
BacklogQuota.BacklogQuotaType - Enum Class in org.apache.pulsar.common.policies.data
+
+
Identifier to a backlog quota configuration (an instance of BacklogQuota).
+
+
BacklogQuota.Builder - Interface in org.apache.pulsar.common.policies.data
+
 
+
BacklogQuota.RetentionPolicy - Enum Class in org.apache.pulsar.common.policies.data
+
+
Enumeration type determines how to retain backlog against the resource shortages.
+
+
backlogQuotaCheck() - Method in interface org.apache.pulsar.client.admin.Brokers
+
+
Manually trigger backlogQuotaCheck.
+
+
backlogQuotaCheckAsync() - Method in interface org.apache.pulsar.client.admin.Brokers
+
+
Manually trigger backlogQuotaCheck asynchronously.
+
+
BacklogQuotaImpl - Class in org.apache.pulsar.common.policies.data.impl
+
 
+
BacklogQuotaImpl(long, int, BacklogQuota.RetentionPolicy) - Constructor for class org.apache.pulsar.common.policies.data.impl.BacklogQuotaImpl
+
 
+
BacklogQuotaImpl.BacklogQuotaImplBuilder - Class in org.apache.pulsar.common.policies.data.impl
+
 
+
BacklogQuotaImplBuilder() - Constructor for class org.apache.pulsar.common.policies.data.impl.BacklogQuotaImpl.BacklogQuotaImplBuilder
+
 
+
Backward - Enum constant in enum class org.apache.pulsar.common.policies.data.SchemaAutoUpdateCompatibilityStrategy
+
+
Messages written in the previous schema can be read by the new schema.
+
+
BACKWARD - Enum constant in enum class org.apache.pulsar.common.policies.data.SchemaCompatibilityStrategy
+
+
Messages written by an old schema can be read by a new schema.
+
+
BACKWARD_TRANSITIVE - Enum constant in enum class org.apache.pulsar.common.policies.data.SchemaCompatibilityStrategy
+
+
Be similar to BACKWARD, BACKWARD_TRANSITIVE ensure all previous version schema can + be read by the new schema.
+
+
BackwardTransitive - Enum constant in enum class org.apache.pulsar.common.policies.data.SchemaAutoUpdateCompatibilityStrategy
+
+
Be similar to Backward.
+
+
BATCHSOURCE_CLASSNAME_KEY - Static variable in class org.apache.pulsar.common.io.BatchSourceConfig
+
 
+
BATCHSOURCE_CONFIG_KEY - Static variable in class org.apache.pulsar.common.io.BatchSourceConfig
+
 
+
BatchSourceConfig - Class in org.apache.pulsar.common.io
+
+
Pulsar Batch Source configuration.
+
+
BatchSourceConfig() - Constructor for class org.apache.pulsar.common.io.BatchSourceConfig
+
 
+
BookieAffinityGroupData - Interface in org.apache.pulsar.common.policies.data
+
+
Description of a BookKeeper's affinity group.
+
+
BookieAffinityGroupData.Builder - Interface in org.apache.pulsar.common.policies.data
+
 
+
BookieAffinityGroupDataImpl - Class in org.apache.pulsar.common.policies.data.impl
+
+
Description of a BookKeeper's affinity group.
+
+
BookieAffinityGroupDataImpl() - Constructor for class org.apache.pulsar.common.policies.data.impl.BookieAffinityGroupDataImpl
+
 
+
BookieAffinityGroupDataImpl.BookieAffinityGroupDataImplBuilder - Class in org.apache.pulsar.common.policies.data.impl
+
 
+
BookieAffinityGroupDataImplBuilder() - Constructor for class org.apache.pulsar.common.policies.data.impl.BookieAffinityGroupDataImpl.BookieAffinityGroupDataImplBuilder
+
 
+
BookieInfo - Interface in org.apache.pulsar.common.policies.data
+
+
Bookie information.
+
+
BookieInfo.Builder - Interface in org.apache.pulsar.common.policies.data
+
 
+
BookieInfoImpl - Class in org.apache.pulsar.common.policies.data.impl
+
+
Bookie information.
+
+
BookieInfoImpl() - Constructor for class org.apache.pulsar.common.policies.data.impl.BookieInfoImpl
+
 
+
BookieInfoImpl.BookieInfoImplBuilder - Class in org.apache.pulsar.common.policies.data.impl
+
 
+
BookieInfoImplBuilder() - Constructor for class org.apache.pulsar.common.policies.data.impl.BookieInfoImpl.BookieInfoImplBuilder
+
 
+
bookies() - Method in interface org.apache.pulsar.client.admin.PulsarAdmin
+
 
+
bookies(List<RawBookieInfo>) - Method in interface org.apache.pulsar.common.policies.data.BookiesClusterInfo.Builder
+
 
+
bookies(List<RawBookieInfo>) - Method in class org.apache.pulsar.common.policies.data.impl.BookiesClusterInfoImpl.BookiesClusterInfoImplBuilder
+
 
+
Bookies - Interface in org.apache.pulsar.client.admin
+
+
Admin interface for bookies rack placement management.
+
+
BookiesClusterInfo - Interface in org.apache.pulsar.common.policies.data
+
+
Raw bookies information.
+
+
BookiesClusterInfo.Builder - Interface in org.apache.pulsar.common.policies.data
+
 
+
BookiesClusterInfoImpl - Class in org.apache.pulsar.common.policies.data.impl
+
+
Raw bookies information.
+
+
BookiesClusterInfoImpl() - Constructor for class org.apache.pulsar.common.policies.data.impl.BookiesClusterInfoImpl
+
 
+
BookiesClusterInfoImpl.BookiesClusterInfoImplBuilder - Class in org.apache.pulsar.common.policies.data.impl
+
 
+
BookiesClusterInfoImplBuilder() - Constructor for class org.apache.pulsar.common.policies.data.impl.BookiesClusterInfoImpl.BookiesClusterInfoImplBuilder
+
 
+
BookiesRackConfiguration - Class in org.apache.pulsar.common.policies.data
+
+
The rack configuration map for bookies.
+
+
BookiesRackConfiguration() - Constructor for class org.apache.pulsar.common.policies.data.BookiesRackConfiguration
+
 
+
BOOKKEEPER_FIRST - Enum constant in enum class org.apache.pulsar.common.policies.data.OffloadedReadPriority
+
+
For offloaded messages, readers will try to read from bookkeeper at first, + if messages not exist at bookkeeper then read from offloaded storage.
+
+
bookkeeperAffinityGroupPrimary(String) - Method in interface org.apache.pulsar.common.policies.data.BookieAffinityGroupData.Builder
+
 
+
bookkeeperAffinityGroupPrimary(String) - Method in class org.apache.pulsar.common.policies.data.impl.BookieAffinityGroupDataImpl.BookieAffinityGroupDataImplBuilder
+
 
+
bookkeeperAffinityGroupSecondary(String) - Method in interface org.apache.pulsar.common.policies.data.BookieAffinityGroupData.Builder
+
 
+
bookkeeperAffinityGroupSecondary(String) - Method in class org.apache.pulsar.common.policies.data.impl.BookieAffinityGroupDataImpl.BookieAffinityGroupDataImplBuilder
+
 
+
boundaries(List<String>) - Method in interface org.apache.pulsar.common.policies.data.BundlesData.Builder
+
 
+
boundaries(List<String>) - Method in class org.apache.pulsar.common.policies.data.impl.BundlesDataImpl.BundlesDataImplBuilder
+
 
+
broker_assignment - Variable in class org.apache.pulsar.common.policies.data.NamespaceOwnershipStatus
+
 
+
brokerAddress(String) - Method in interface org.apache.pulsar.common.policies.data.BrokerStatus.Builder
+
 
+
brokerAddress(String) - Method in class org.apache.pulsar.common.policies.data.impl.BrokerStatusImpl.BrokerStatusImplBuilder
+
 
+
BrokerAssignment - Enum Class in org.apache.pulsar.common.policies.data
+
+
Definition of possible broker assignments.
+
+
brokerClientCertificateFilePath(String) - Method in interface org.apache.pulsar.common.policies.data.ClusterData.Builder
+
 
+
brokerClientKeyFilePath(String) - Method in interface org.apache.pulsar.common.policies.data.ClusterData.Builder
+
 
+
brokerClientSslFactoryPlugin(String) - Method in interface org.apache.pulsar.common.policies.data.ClusterData.Builder
+
 
+
brokerClientSslFactoryPluginParams(String) - Method in interface org.apache.pulsar.common.policies.data.ClusterData.Builder
+
 
+
brokerClientTlsEnabled(boolean) - Method in interface org.apache.pulsar.common.policies.data.ClusterData.Builder
+
 
+
brokerClientTlsEnabledWithKeyStore(boolean) - Method in interface org.apache.pulsar.common.policies.data.ClusterData.Builder
+
 
+
brokerClientTlsKeyStore(String) - Method in interface org.apache.pulsar.common.policies.data.ClusterData.Builder
+
 
+
brokerClientTlsKeyStorePassword(String) - Method in interface org.apache.pulsar.common.policies.data.ClusterData.Builder
+
 
+
brokerClientTlsKeyStoreType(String) - Method in interface org.apache.pulsar.common.policies.data.ClusterData.Builder
+
 
+
brokerClientTlsTrustStore(String) - Method in interface org.apache.pulsar.common.policies.data.ClusterData.Builder
+
 
+
brokerClientTlsTrustStorePassword(String) - Method in interface org.apache.pulsar.common.policies.data.ClusterData.Builder
+
 
+
brokerClientTlsTrustStoreType(String) - Method in interface org.apache.pulsar.common.policies.data.ClusterData.Builder
+
 
+
brokerClientTrustCertsFilePath(String) - Method in interface org.apache.pulsar.common.policies.data.ClusterData.Builder
+
 
+
brokerId(String) - Method in interface org.apache.pulsar.common.policies.data.BrokerInfo.Builder
+
 
+
brokerId(String) - Method in class org.apache.pulsar.common.policies.data.impl.BrokerInfoImpl.BrokerInfoImplBuilder
+
 
+
BrokerInfo - Interface in org.apache.pulsar.common.policies.data
+
+
Broker Information.
+
+
BrokerInfo.Builder - Interface in org.apache.pulsar.common.policies.data
+
 
+
BrokerInfoImpl - Class in org.apache.pulsar.common.policies.data.impl
+
+
Broker Information.
+
+
BrokerInfoImpl() - Constructor for class org.apache.pulsar.common.policies.data.impl.BrokerInfoImpl
+
 
+
BrokerInfoImpl.BrokerInfoImplBuilder - Class in org.apache.pulsar.common.policies.data.impl
+
 
+
BrokerInfoImplBuilder() - Constructor for class org.apache.pulsar.common.policies.data.impl.BrokerInfoImpl.BrokerInfoImplBuilder
+
 
+
brokerName(String) - Method in interface org.apache.pulsar.common.policies.data.BrokerNamespaceIsolationData.Builder
+
 
+
BrokerNamespaceIsolationData - Interface in org.apache.pulsar.common.policies.data
+
 
+
BrokerNamespaceIsolationData.Builder - Interface in org.apache.pulsar.common.policies.data
+
 
+
brokers() - Method in interface org.apache.pulsar.client.admin.PulsarAdmin
+
 
+
brokers(Set<String>) - Method in interface org.apache.pulsar.common.policies.data.FailureDomain.Builder
+
 
+
Brokers - Interface in org.apache.pulsar.client.admin
+
+
Admin interface for brokers management.
+
+
brokerServiceUrl(String) - Method in interface org.apache.pulsar.common.policies.data.ClusterData.Builder
+
 
+
brokerServiceUrlTls(String) - Method in interface org.apache.pulsar.common.policies.data.ClusterData.Builder
+
 
+
brokerStats() - Method in interface org.apache.pulsar.client.admin.PulsarAdmin
+
 
+
BrokerStats - Interface in org.apache.pulsar.client.admin
+
+
Admin interface for brokers management.
+
+
BrokerStatus - Interface in org.apache.pulsar.common.policies.data
+
+
Information about the broker status.
+
+
BrokerStatus.Builder - Interface in org.apache.pulsar.common.policies.data
+
 
+
BrokerStatusImpl - Class in org.apache.pulsar.common.policies.data.impl
+
+
Information about the broker status.
+
+
BrokerStatusImpl() - Constructor for class org.apache.pulsar.common.policies.data.impl.BrokerStatusImpl
+
 
+
BrokerStatusImpl.BrokerStatusImplBuilder - Class in org.apache.pulsar.common.policies.data.impl
+
 
+
BrokerStatusImplBuilder() - Constructor for class org.apache.pulsar.common.policies.data.impl.BrokerStatusImpl.BrokerStatusImplBuilder
+
 
+
build() - Method in interface org.apache.pulsar.client.admin.PulsarAdminBuilder
+
 
+
build() - Method in interface org.apache.pulsar.common.policies.data.AuthPolicies.Builder
+
 
+
build() - Method in interface org.apache.pulsar.common.policies.data.AutoFailoverPolicyData.Builder
+
 
+
build() - Method in interface org.apache.pulsar.common.policies.data.AutoSubscriptionCreationOverride.Builder
+
 
+
build() - Method in interface org.apache.pulsar.common.policies.data.AutoTopicCreationOverride.Builder
+
 
+
build() - Method in interface org.apache.pulsar.common.policies.data.BacklogQuota.Builder
+
 
+
build() - Method in interface org.apache.pulsar.common.policies.data.BookieAffinityGroupData.Builder
+
 
+
build() - Method in interface org.apache.pulsar.common.policies.data.BookieInfo.Builder
+
 
+
build() - Method in interface org.apache.pulsar.common.policies.data.BookiesClusterInfo.Builder
+
 
+
build() - Method in interface org.apache.pulsar.common.policies.data.BrokerInfo.Builder
+
 
+
build() - Method in interface org.apache.pulsar.common.policies.data.BrokerNamespaceIsolationData.Builder
+
 
+
build() - Method in interface org.apache.pulsar.common.policies.data.BrokerStatus.Builder
+
 
+
build() - Method in interface org.apache.pulsar.common.policies.data.BundlesData.Builder
+
 
+
build() - Method in interface org.apache.pulsar.common.policies.data.ClusterData.Builder
+
 
+
build() - Method in interface org.apache.pulsar.common.policies.data.ClusterPolicies.Builder
+
 
+
build() - Method in interface org.apache.pulsar.common.policies.data.DelayedDeliveryPolicies.Builder
+
 
+
build() - Method in interface org.apache.pulsar.common.policies.data.DispatchRate.Builder
+
 
+
build() - Method in interface org.apache.pulsar.common.policies.data.FailureDomain.Builder
+
 
+
build() - Method in class org.apache.pulsar.common.policies.data.impl.AutoSubscriptionCreationOverrideImpl.AutoSubscriptionCreationOverrideImplBuilder
+
 
+
build() - Method in class org.apache.pulsar.common.policies.data.impl.AutoTopicCreationOverrideImpl.AutoTopicCreationOverrideImplBuilder
+
 
+
build() - Method in class org.apache.pulsar.common.policies.data.impl.BacklogQuotaImpl.BacklogQuotaImplBuilder
+
 
+
build() - Method in class org.apache.pulsar.common.policies.data.impl.BookieAffinityGroupDataImpl.BookieAffinityGroupDataImplBuilder
+
 
+
build() - Method in class org.apache.pulsar.common.policies.data.impl.BookieInfoImpl.BookieInfoImplBuilder
+
 
+
build() - Method in class org.apache.pulsar.common.policies.data.impl.BookiesClusterInfoImpl.BookiesClusterInfoImplBuilder
+
 
+
build() - Method in class org.apache.pulsar.common.policies.data.impl.BrokerInfoImpl.BrokerInfoImplBuilder
+
 
+
build() - Method in class org.apache.pulsar.common.policies.data.impl.BrokerStatusImpl.BrokerStatusImplBuilder
+
 
+
build() - Method in class org.apache.pulsar.common.policies.data.impl.BundlesDataImpl.BundlesDataImplBuilder
+
 
+
build() - Method in class org.apache.pulsar.common.policies.data.impl.DelayedDeliveryPoliciesImpl.DelayedDeliveryPoliciesImplBuilder
+
 
+
build() - Method in class org.apache.pulsar.common.policies.data.impl.DispatchRateImpl.DispatchRateImplBuilder
+
 
+
build() - Method in interface org.apache.pulsar.common.policies.data.NamespaceIsolationData.Builder
+
 
+
build() - Method in interface org.apache.pulsar.common.policies.data.OffloadPolicies.Builder
+
 
+
build() - Method in interface org.apache.pulsar.common.policies.data.TenantInfo.Builder
+
 
+
builder() - Static method in interface org.apache.pulsar.client.admin.PulsarAdmin
+
+
Get a new builder instance that can used to configure and build a PulsarAdmin instance.
+
+
builder() - Static method in interface org.apache.pulsar.common.policies.data.AuthPolicies
+
 
+
builder() - Static method in interface org.apache.pulsar.common.policies.data.AutoFailoverPolicyData
+
 
+
builder() - Static method in interface org.apache.pulsar.common.policies.data.AutoSubscriptionCreationOverride
+
 
+
builder() - Static method in interface org.apache.pulsar.common.policies.data.AutoTopicCreationOverride
+
 
+
builder() - Static method in interface org.apache.pulsar.common.policies.data.BacklogQuota
+
 
+
builder() - Static method in interface org.apache.pulsar.common.policies.data.BookieAffinityGroupData
+
 
+
builder() - Static method in interface org.apache.pulsar.common.policies.data.BookieInfo
+
 
+
builder() - Static method in interface org.apache.pulsar.common.policies.data.BookiesClusterInfo
+
 
+
builder() - Static method in interface org.apache.pulsar.common.policies.data.BrokerInfo
+
 
+
builder() - Static method in interface org.apache.pulsar.common.policies.data.BrokerNamespaceIsolationData
+
 
+
builder() - Static method in interface org.apache.pulsar.common.policies.data.BrokerStatus
+
 
+
builder() - Static method in interface org.apache.pulsar.common.policies.data.BundlesData
+
 
+
builder() - Static method in interface org.apache.pulsar.common.policies.data.ClusterData
+
 
+
builder() - Static method in interface org.apache.pulsar.common.policies.data.ClusterPolicies
+
 
+
builder() - Static method in interface org.apache.pulsar.common.policies.data.DelayedDeliveryPolicies
+
 
+
builder() - Static method in interface org.apache.pulsar.common.policies.data.DispatchRate
+
 
+
builder() - Static method in interface org.apache.pulsar.common.policies.data.FailureDomain
+
 
+
builder() - Static method in class org.apache.pulsar.common.policies.data.impl.AutoSubscriptionCreationOverrideImpl
+
 
+
builder() - Static method in class org.apache.pulsar.common.policies.data.impl.AutoTopicCreationOverrideImpl
+
 
+
builder() - Static method in class org.apache.pulsar.common.policies.data.impl.BacklogQuotaImpl
+
 
+
builder() - Static method in class org.apache.pulsar.common.policies.data.impl.BookieAffinityGroupDataImpl
+
 
+
builder() - Static method in class org.apache.pulsar.common.policies.data.impl.BookieInfoImpl
+
 
+
builder() - Static method in class org.apache.pulsar.common.policies.data.impl.BookiesClusterInfoImpl
+
 
+
builder() - Static method in class org.apache.pulsar.common.policies.data.impl.BrokerInfoImpl
+
 
+
builder() - Static method in class org.apache.pulsar.common.policies.data.impl.BrokerStatusImpl
+
 
+
builder() - Static method in class org.apache.pulsar.common.policies.data.impl.BundlesDataImpl
+
 
+
builder() - Static method in class org.apache.pulsar.common.policies.data.impl.DelayedDeliveryPoliciesImpl
+
 
+
builder() - Static method in class org.apache.pulsar.common.policies.data.impl.DispatchRateImpl
+
 
+
builder() - Static method in interface org.apache.pulsar.common.policies.data.NamespaceIsolationData
+
 
+
builder() - Static method in interface org.apache.pulsar.common.policies.data.OffloadPolicies
+
 
+
builder() - Static method in interface org.apache.pulsar.common.policies.data.TenantInfo
+
 
+
Bundle - Enum constant in enum class org.apache.pulsar.client.admin.Topics.QueryParam
+
 
+
bundles - Variable in class org.apache.pulsar.common.policies.data.Policies
+
 
+
BundlesData - Interface in org.apache.pulsar.common.policies.data
+
+
Holder for bundles.
+
+
BundlesData.Builder - Interface in org.apache.pulsar.common.policies.data
+
 
+
BundlesDataImpl - Class in org.apache.pulsar.common.policies.data.impl
+
+
Holder for bundles.
+
+
BundlesDataImpl() - Constructor for class org.apache.pulsar.common.policies.data.impl.BundlesDataImpl
+
 
+
BundlesDataImpl.BundlesDataImplBuilder - Class in org.apache.pulsar.common.policies.data.impl
+
 
+
BundlesDataImplBuilder() - Constructor for class org.apache.pulsar.common.policies.data.impl.BundlesDataImpl.BundlesDataImplBuilder
+
 
+
BYTES_IN_GIGABYTE - Static variable in class org.apache.pulsar.common.policies.data.impl.BacklogQuotaImpl
+
 
+
+

C

+
+
cacheSize - Variable in class org.apache.pulsar.policies.data.loadbalancer.NamespaceBundleStats
+
 
+
calculateOverall() - Method in interface org.apache.pulsar.common.policies.data.FunctionStats
+
 
+
changed - Enum constant in enum class org.apache.pulsar.common.policies.data.NamespaceIsolationPolicyUnloadScope
+
 
+
checkArgument(boolean, Object) - Static method in class org.apache.pulsar.common.policies.data.impl.BookieInfoImpl.BookieInfoImplBuilder
+
 
+
chunkLists - Variable in class org.apache.pulsar.common.stats.AllocatorStats.PoolArenaStats
+
 
+
chunks - Variable in class org.apache.pulsar.common.stats.AllocatorStats.PoolChunkListStats
+
 
+
chunkSize - Variable in class org.apache.pulsar.common.stats.AllocatorStats.PoolChunkStats
+
 
+
clearNamespaceBacklog(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Clear backlog for all topics on a namespace.
+
+
clearNamespaceBacklogAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Clear backlog for all topics on a namespace asynchronously.
+
+
clearNamespaceBacklogForSubscription(String, String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Clear backlog for a given subscription on all topics on a namespace.
+
+
clearNamespaceBacklogForSubscriptionAsync(String, String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Clear backlog for a given subscription on all topics on a namespace asynchronously.
+
+
clearNamespaceBundleBacklog(String, String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Clear backlog for all topics on a namespace bundle.
+
+
clearNamespaceBundleBacklogAsync(String, String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Clear backlog for all topics on a namespace bundle asynchronously.
+
+
clearNamespaceBundleBacklogForSubscription(String, String, String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Clear backlog for a given subscription on all topics on a namespace bundle.
+
+
clearNamespaceBundleBacklogForSubscriptionAsync(String, String, String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Clear backlog for a given subscription on all topics on a namespace bundle asynchronously.
+
+
clearOffloadDeleteLag(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Clear the offload deletion lag for a namespace.
+
+
clearOffloadDeleteLagAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Clear the offload deletion lag for a namespace asynchronously.
+
+
clearProperties(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Clear all properties of a namespace.
+
+
clearPropertiesAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Clear all properties of a namespace asynchronously.
+
+
clone() - Method in interface org.apache.pulsar.client.admin.PulsarAdminBuilder
+
+
Create a copy of the current client builder.
+
+
clone() - Method in exception class org.apache.pulsar.client.admin.PulsarAdminException
+
+
This method is meant to be overriden by all subclasses.
+
+
clone() - Method in exception class org.apache.pulsar.client.admin.PulsarAdminException.ConflictException
+
 
+
clone() - Method in exception class org.apache.pulsar.client.admin.PulsarAdminException.ConnectException
+
 
+
clone() - Method in exception class org.apache.pulsar.client.admin.PulsarAdminException.GettingAuthenticationDataException
+
 
+
clone() - Method in exception class org.apache.pulsar.client.admin.PulsarAdminException.HttpErrorException
+
 
+
clone() - Method in exception class org.apache.pulsar.client.admin.PulsarAdminException.NotAllowedException
+
 
+
clone() - Method in exception class org.apache.pulsar.client.admin.PulsarAdminException.NotAuthorizedException
+
 
+
clone() - Method in exception class org.apache.pulsar.client.admin.PulsarAdminException.NotFoundException
+
 
+
clone() - Method in exception class org.apache.pulsar.client.admin.PulsarAdminException.PreconditionFailedException
+
 
+
clone() - Method in exception class org.apache.pulsar.client.admin.PulsarAdminException.ServerSideErrorException
+
 
+
clone() - Method in exception class org.apache.pulsar.client.admin.PulsarAdminException.TimeoutException
+
 
+
clone() - Method in interface org.apache.pulsar.common.policies.data.ClusterData
+
 
+
clone() - Method in interface org.apache.pulsar.common.policies.data.ClusterPolicies
+
 
+
close() - Method in interface org.apache.pulsar.client.admin.PulsarAdmin
+
+
Close the PulsarAdminClient and release all the resources.
+
+
ClusterData - Interface in org.apache.pulsar.common.policies.data
+
 
+
ClusterData.Builder - Interface in org.apache.pulsar.common.policies.data
+
 
+
clusterDispatchRate - Variable in class org.apache.pulsar.common.policies.data.Policies
+
+
Deprecated.
+
+
ClusterPolicies - Interface in org.apache.pulsar.common.policies.data
+
 
+
ClusterPolicies.Builder - Interface in org.apache.pulsar.common.policies.data
+
 
+
ClusterPolicies.ClusterUrl - Class in org.apache.pulsar.common.policies.data
+
 
+
clusters() - Method in interface org.apache.pulsar.client.admin.PulsarAdmin
+
 
+
Clusters - Interface in org.apache.pulsar.client.admin
+
+
Admin interface for clusters management.
+
+
clusterSubscribeRate - Variable in class org.apache.pulsar.common.policies.data.Policies
+
 
+
ClusterUrl() - Constructor for class org.apache.pulsar.common.policies.data.ClusterPolicies.ClusterUrl
+
 
+
compactedLedger - Variable in class org.apache.pulsar.common.policies.data.PersistentTopicInternalStats
+
 
+
compaction_threshold - Variable in class org.apache.pulsar.common.policies.data.Policies
+
 
+
CompactionStats - Interface in org.apache.pulsar.common.policies.data
+
+
Statistics about compaction.
+
+
compactionStatus(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Check the status of an ongoing compaction for a topic.
+
+
compactionStatusAsync(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Check the status of an ongoing compaction for a topic asynchronously.
+
+
compareByBandwidthIn(NamespaceBundleStats) - Method in class org.apache.pulsar.policies.data.loadbalancer.NamespaceBundleStats
+
 
+
compareByBandwidthOut(NamespaceBundleStats) - Method in class org.apache.pulsar.policies.data.loadbalancer.NamespaceBundleStats
+
 
+
compareByCacheSize(NamespaceBundleStats) - Method in class org.apache.pulsar.policies.data.loadbalancer.NamespaceBundleStats
+
 
+
compareByMsgRate(NamespaceBundleStats) - Method in class org.apache.pulsar.policies.data.loadbalancer.NamespaceBundleStats
+
 
+
compareByTopicConnections(NamespaceBundleStats) - Method in class org.apache.pulsar.policies.data.loadbalancer.NamespaceBundleStats
+
 
+
compareTo(BrokerStatus) - Method in class org.apache.pulsar.common.policies.data.impl.BrokerStatusImpl
+
 
+
compareTo(NamespaceBundleStats) - Method in class org.apache.pulsar.policies.data.loadbalancer.NamespaceBundleStats
+
 
+
compareTo(ResourceUsage) - Method in class org.apache.pulsar.policies.data.loadbalancer.ResourceUsage
+
+
this may be wrong since we are comparing available and not the usage.
+
+
ConflictException(Throwable, String, int) - Constructor for exception class org.apache.pulsar.client.admin.PulsarAdminException.ConflictException
+
 
+
ConnectException(String, Throwable) - Constructor for exception class org.apache.pulsar.client.admin.PulsarAdminException.ConnectException
+
 
+
ConnectException(Throwable) - Constructor for exception class org.apache.pulsar.client.admin.PulsarAdminException.ConnectException
+
 
+
connectionMaxIdleSeconds(int) - Method in interface org.apache.pulsar.client.admin.PulsarAdminBuilder
+
+
Sets the maximum idle time for a pooled connection.
+
+
connectionTimeout(int, TimeUnit) - Method in interface org.apache.pulsar.client.admin.PulsarAdminBuilder
+
+
This sets the connection time out for the pulsar admin client.
+
+
ConnectorDefinition - Class in org.apache.pulsar.common.io
+
+
Basic information about a Pulsar connector.
+
+
ConnectorDefinition() - Constructor for class org.apache.pulsar.common.io.ConnectorDefinition
+
 
+
consume - Enum constant in enum class org.apache.pulsar.common.policies.data.AuthAction
+
+
Permission to consume messages.
+
+
consumer_backlog_eviction - Enum constant in enum class org.apache.pulsar.common.policies.data.BacklogQuota.RetentionPolicy
+
+
Policy which evicts the oldest message from the slowest consumer's backlog.
+
+
ConsumerConfig - Class in org.apache.pulsar.common.functions
+
+
Configuration of a consumer.
+
+
ConsumerConfig(String) - Constructor for class org.apache.pulsar.common.functions.ConsumerConfig
+
 
+
consumerCount - Variable in class org.apache.pulsar.policies.data.loadbalancer.NamespaceBundleStats
+
 
+
ConsumerStats - Interface in org.apache.pulsar.common.policies.data
+
+
Consumer statistics.
+
+
create(Map<String, String>) - Static method in class org.apache.pulsar.common.stats.Metrics
+
+
Creates a metrics object with the dimensions map immutable.
+
+
create(AutoFailoverPolicyData) - Static method in class org.apache.pulsar.common.policies.impl.AutoFailoverPolicyFactory
+
 
+
createCluster(String, ClusterData) - Method in interface org.apache.pulsar.client.admin.Clusters
+
+
Create a new cluster.
+
+
createClusterAsync(String, ClusterData) - Method in interface org.apache.pulsar.client.admin.Clusters
+
+
Create a new cluster asynchronously.
+
+
createFailureDomain(String, String, FailureDomain) - Method in interface org.apache.pulsar.client.admin.Clusters
+
+
Create a domain into cluster.
+
+
createFailureDomainAsync(String, String, FailureDomain) - Method in interface org.apache.pulsar.client.admin.Clusters
+
+
Create a domain into cluster asynchronously.
+
+
createFunction(FunctionConfig, String) - Method in interface org.apache.pulsar.client.admin.Functions
+
+
Create a new function.
+
+
createFunctionAsync(FunctionConfig, String) - Method in interface org.apache.pulsar.client.admin.Functions
+
+
Create a new function asynchronously.
+
+
createFunctionWithUrl(FunctionConfig, String) - Method in interface org.apache.pulsar.client.admin.Functions
+
+
Create a new function with package url.
+
+
createFunctionWithUrlAsync(FunctionConfig, String) - Method in interface org.apache.pulsar.client.admin.Functions
+
+
Create a new function with package url asynchronously.
+
+
createMissedPartitions(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Create missed partitions for partitioned topic.
+
+
createMissedPartitionsAsync(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Create missed partitions for partitioned topic asynchronously.
+
+
createNamespace(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Create a new namespace.
+
+
createNamespace(String, int) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Create a new namespace.
+
+
createNamespace(String, Set<String>) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Create a new namespace.
+
+
createNamespace(String, BundlesData) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Create a new namespace.
+
+
createNamespace(String, Policies) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Create a new namespace.
+
+
createNamespaceAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Create a new namespace asynchronously.
+
+
createNamespaceAsync(String, int) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Create a new namespace.
+
+
createNamespaceAsync(String, Set<String>) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Create a new namespace asynchronously.
+
+
createNamespaceAsync(String, BundlesData) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Create a new namespace asynchronously.
+
+
createNamespaceAsync(String, Policies) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Create a new namespace asynchronously.
+
+
createNamespaceIsolationPolicy(String, String, NamespaceIsolationData) - Method in interface org.apache.pulsar.client.admin.Clusters
+
+
Create a namespace isolation policy for a cluster.
+
+
createNamespaceIsolationPolicyAsync(String, String, NamespaceIsolationData) - Method in interface org.apache.pulsar.client.admin.Clusters
+
+
Create a namespace isolation policy for a cluster asynchronously.
+
+
createNonPartitionedTopic(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Create a non-partitioned topic.
+
+
createNonPartitionedTopic(String, Map<String, String>) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Create a non-partitioned topic.
+
+
createNonPartitionedTopicAsync(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Create a non-partitioned topic asynchronously.
+
+
createNonPartitionedTopicAsync(String, Map<String, String>) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Create a non-partitioned topic asynchronously.
+
+
createPartitionedTopic(String, int) - Method in interface org.apache.pulsar.client.admin.NonPersistentTopics
+
+
Deprecated.
+
Create a partitioned topic.
+
+
createPartitionedTopic(String, int) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Create a partitioned topic.
+
+
createPartitionedTopic(String, int, Map<String, String>) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Create a partitioned topic.
+
+
createPartitionedTopicAsync(String, int) - Method in interface org.apache.pulsar.client.admin.NonPersistentTopics
+
+
Deprecated.
+
Create a partitioned topic asynchronously.
+
+
createPartitionedTopicAsync(String, int) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Create a partitioned topic asynchronously.
+
+
createPartitionedTopicAsync(String, int, Map<String, String>) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Create a partitioned topic asynchronously.
+
+
createProperty(String, TenantInfo) - Method in interface org.apache.pulsar.client.admin.Properties
+
+
Deprecated.
+
Create a new property.
+
+
createResourceGroup(String, ResourceGroup) - Method in interface org.apache.pulsar.client.admin.ResourceGroups
+
+
Create a new resourcegroup.
+
+
createResourceGroupAsync(String, ResourceGroup) - Method in interface org.apache.pulsar.client.admin.ResourceGroups
+
+
Create a new resourcegroup.
+
+
createSchema(String, PostSchemaPayload) - Method in interface org.apache.pulsar.client.admin.Schemas
+
+
Create a schema for a given topic.
+
+
createSchema(String, SchemaInfo) - Method in interface org.apache.pulsar.client.admin.Schemas
+
+
Create a schema for a given topic with the provided schema info.
+
+
createSchemaAsync(String, PostSchemaPayload) - Method in interface org.apache.pulsar.client.admin.Schemas
+
+
Create a schema for a given topic asynchronously.
+
+
createSchemaAsync(String, SchemaInfo) - Method in interface org.apache.pulsar.client.admin.Schemas
+
+
Create a schema for a given topic with the provided schema info asynchronously.
+
+
createShadowTopic(String, String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Create a new shadow topic, see #Topics.createShadowTopic(String, String, Map) for details.
+
+
createShadowTopic(String, String, Map<String, String>) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Create a new shadow topic as the shadow of the source topic.
+
+
createShadowTopicAsync(String, String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Create a new shadow topic, see #Topics.createShadowTopic(String, String, Map) for details.
+
+
createShadowTopicAsync(String, String, Map<String, String>) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Create a new shadow topic, see #Topics.createShadowTopic(String, String, Map) for details.
+
+
createSink(SinkConfig, String) - Method in interface org.apache.pulsar.client.admin.Sinks
+
+
Create a new sink.
+
+
createSinkAsync(SinkConfig, String) - Method in interface org.apache.pulsar.client.admin.Sinks
+
+
Create a new sink asynchronously.
+
+
createSinkWithUrl(SinkConfig, String) - Method in interface org.apache.pulsar.client.admin.Sinks
+
+
Create a new sink with package url.
+
+
createSinkWithUrlAsync(SinkConfig, String) - Method in interface org.apache.pulsar.client.admin.Sinks
+
+
Create a new sink with package url asynchronously.
+
+
createSource(SourceConfig, String) - Method in interface org.apache.pulsar.client.admin.Sources
+
+
Create a new source.
+
+
createSourceAsync(SourceConfig, String) - Method in interface org.apache.pulsar.client.admin.Sources
+
+
Create a new source asynchronously.
+
+
createSourceWithUrl(SourceConfig, String) - Method in interface org.apache.pulsar.client.admin.Sources
+
+
Create a new source with package url.
+
+
createSourceWithUrlAsync(SourceConfig, String) - Method in interface org.apache.pulsar.client.admin.Sources
+
+
Create a new source with package url asynchronously.
+
+
createSubscription(String, String, MessageId) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Create a new subscription on a topic.
+
+
createSubscription(String, String, MessageId, boolean) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Create a new subscription on a topic.
+
+
createSubscription(String, String, MessageId, boolean, Map<String, String>) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Create a new subscription on a topic.
+
+
createSubscriptionAsync(String, String, MessageId) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Create a new subscription on a topic.
+
+
createSubscriptionAsync(String, String, MessageId, boolean) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Create a new subscription on a topic.
+
+
createSubscriptionAsync(String, String, MessageId, boolean, Map<String, String>) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Create a new subscription on a topic.
+
+
createTenant(String, TenantInfo) - Method in interface org.apache.pulsar.client.admin.Tenants
+
+
Create a new tenant.
+
+
createTenantAsync(String, TenantInfo) - Method in interface org.apache.pulsar.client.admin.Tenants
+
+
Create a new tenant asynchronously.
+
+
CryptoConfig - Class in org.apache.pulsar.common.functions
+
+
Configuration of the producer inside the function.
+
+
CryptoConfig() - Constructor for class org.apache.pulsar.common.functions.CryptoConfig
+
 
+
cumulativeAckPosition - Variable in class org.apache.pulsar.common.policies.data.TransactionInPendingAckStats
+
+
The position of this transaction cumulative ack.
+
+
currentLedgerEntries - Variable in class org.apache.pulsar.common.policies.data.ManagedLedgerInternalStats
+
+
The count of messages written to the ledger that is currently open for writing.
+
+
currentLedgerSize - Variable in class org.apache.pulsar.common.policies.data.ManagedLedgerInternalStats
+
+
The size of messages written to the ledger that is currently open for writing (in bytes).
+
+
currentSegmentCapacity - Variable in class org.apache.pulsar.common.policies.data.SegmentsStats
+
 
+
cursorLedger - Variable in class org.apache.pulsar.common.policies.data.ManagedLedgerInternalStats.CursorStats
+
 
+
cursorLedgerLastEntry - Variable in class org.apache.pulsar.common.policies.data.ManagedLedgerInternalStats.CursorStats
+
 
+
cursors - Variable in class org.apache.pulsar.common.policies.data.ManagedLedgerInternalStats
+
+
The list of all cursors on this topic.
+
+
CursorStats() - Constructor for class org.apache.pulsar.common.policies.data.ManagedLedgerInternalStats.CursorStats
+
 
+
+

D

+
+
deduplicationEnabled - Variable in class org.apache.pulsar.common.policies.data.Policies
+
 
+
deduplicationSnapshotIntervalSeconds - Variable in class org.apache.pulsar.common.policies.data.Policies
+
 
+
DefaultImplementation - Class in org.apache.pulsar.client.admin.utils
+
+
Helper class for class instantiations and it also contains methods to work with schemas.
+
+
DefaultImplementation() - Constructor for class org.apache.pulsar.client.admin.utils.DefaultImplementation
+
 
+
defaultNumPartitions(Integer) - Method in interface org.apache.pulsar.common.policies.data.AutoTopicCreationOverride.Builder
+
 
+
defaultNumPartitions(Integer) - Method in class org.apache.pulsar.common.policies.data.impl.AutoTopicCreationOverrideImpl.AutoTopicCreationOverrideImplBuilder
+
 
+
delayed_delivery_policies - Variable in class org.apache.pulsar.common.policies.data.Policies
+
 
+
DelayedDeliveryPolicies - Interface in org.apache.pulsar.common.policies.data
+
+
Definition of the delayed delivery policy.
+
+
DelayedDeliveryPolicies.Builder - Interface in org.apache.pulsar.common.policies.data
+
 
+
DelayedDeliveryPoliciesImpl - Class in org.apache.pulsar.common.policies.data.impl
+
+
Definition of the delayed delivery policy.
+
+
DelayedDeliveryPoliciesImpl() - Constructor for class org.apache.pulsar.common.policies.data.impl.DelayedDeliveryPoliciesImpl
+
 
+
DelayedDeliveryPoliciesImpl.DelayedDeliveryPoliciesImplBuilder - Class in org.apache.pulsar.common.policies.data.impl
+
 
+
DelayedDeliveryPoliciesImplBuilder() - Constructor for class org.apache.pulsar.common.policies.data.impl.DelayedDeliveryPoliciesImpl.DelayedDeliveryPoliciesImplBuilder
+
 
+
delete(String) - Method in interface org.apache.pulsar.client.admin.Packages
+
+
Delete the specified package.
+
+
delete(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Delete a topic.
+
+
delete(String, boolean) - Method in interface org.apache.pulsar.client.admin.Topics
+
 
+
delete(String, boolean, boolean) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use Topics.delete(String, boolean) instead because + parameter `deleteSchema` is always true
+
+
+
delete_when_no_subscriptions - Enum constant in enum class org.apache.pulsar.common.policies.data.InactiveTopicDeleteMode
+
+
The topic can be deleted when no subscriptions and no active producers.
+
+
delete_when_subscriptions_caught_up - Enum constant in enum class org.apache.pulsar.common.policies.data.InactiveTopicDeleteMode
+
+
The topic can be deleted when all subscriptions catchup and no active producers.
+
+
deleteAsync(String) - Method in interface org.apache.pulsar.client.admin.Packages
+
+
Delete the specified package asynchronously.
+
+
deleteAsync(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Delete a topic asynchronously.
+
+
deleteAsync(String, boolean) - Method in interface org.apache.pulsar.client.admin.Topics
+
 
+
deleteAsync(String, boolean, boolean) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use Topics.deleteAsync(String, boolean) instead because + parameter `deleteSchema` is always true
+
+
+
deleteBookieAffinityGroup(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Delete bookie affinity group configured for a namespace.
+
+
deleteBookieAffinityGroupAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Delete bookie affinity group configured for a namespace asynchronously.
+
+
deleteBookieRackInfo(String) - Method in interface org.apache.pulsar.client.admin.Bookies
+
+
Remove rack placement information for a specific bookie in the cluster.
+
+
deleteBookieRackInfoAsync(String) - Method in interface org.apache.pulsar.client.admin.Bookies
+
+
Remove rack placement information for a specific bookie in the cluster asynchronously.
+
+
deleteCluster(String) - Method in interface org.apache.pulsar.client.admin.Clusters
+
+
Delete an existing cluster.
+
+
deleteClusterAsync(String) - Method in interface org.apache.pulsar.client.admin.Clusters
+
+
Delete an existing cluster asynchronously.
+
+
deleted - Variable in class org.apache.pulsar.common.partition.PartitionedTopicMetadata
+
 
+
deleted - Variable in class org.apache.pulsar.common.policies.data.Policies
+
 
+
deleteDynamicConfiguration(String) - Method in interface org.apache.pulsar.client.admin.Brokers
+
+
It deletes dynamic configuration value into ZooKeeper.
+
+
deleteDynamicConfigurationAsync(String) - Method in interface org.apache.pulsar.client.admin.Brokers
+
+
It deletes dynamic configuration value into ZooKeeper asynchronously.
+
+
deleteFailureDomain(String, String) - Method in interface org.apache.pulsar.client.admin.Clusters
+
+
Delete a domain in cluster.
+
+
deleteFailureDomainAsync(String, String) - Method in interface org.apache.pulsar.client.admin.Clusters
+
+
Delete a domain in cluster asynchronously.
+
+
deleteFunction(String, String, String) - Method in interface org.apache.pulsar.client.admin.Functions
+
+
Delete an existing function.
+
+
deleteFunctionAsync(String, String, String) - Method in interface org.apache.pulsar.client.admin.Functions
+
+
Delete an existing function asynchronously.
+
+
deleteNamespace(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Delete an existing namespace.
+
+
deleteNamespace(String, boolean) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Delete an existing namespace.
+
+
deleteNamespaceAntiAffinityGroup(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Delete anti-affinity group name for a namespace.
+
+
deleteNamespaceAntiAffinityGroupAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Delete anti-affinity group name for a namespace.
+
+
deleteNamespaceAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Delete an existing namespace asynchronously.
+
+
deleteNamespaceAsync(String, boolean) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Delete an existing namespace asynchronously.
+
+
deleteNamespaceBundle(String, String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Delete an existing bundle in a namespace.
+
+
deleteNamespaceBundle(String, String, boolean) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Delete an existing bundle in a namespace.
+
+
deleteNamespaceBundleAsync(String, String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Delete an existing bundle in a namespace asynchronously.
+
+
deleteNamespaceBundleAsync(String, String, boolean) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Delete an existing bundle in a namespace asynchronously.
+
+
deleteNamespaceIsolationPolicy(String, String) - Method in interface org.apache.pulsar.client.admin.Clusters
+
+
Delete a namespace isolation policy for a cluster.
+
+
deleteNamespaceIsolationPolicyAsync(String, String) - Method in interface org.apache.pulsar.client.admin.Clusters
+
+
Delete a namespace isolation policy for a cluster asynchronously.
+
+
deletePartitionedTopic(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Delete a partitioned topic.
+
+
deletePartitionedTopic(String, boolean) - Method in interface org.apache.pulsar.client.admin.Topics
+
 
+
deletePartitionedTopic(String, boolean, boolean) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use Topics.deletePartitionedTopic(String, boolean) instead because parameter + `deleteSchema` is always true
+
+
+
deletePartitionedTopicAsync(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Delete a partitioned topic asynchronously.
+
+
deletePartitionedTopicAsync(String, boolean) - Method in interface org.apache.pulsar.client.admin.Topics
+
 
+
deletePartitionedTopicAsync(String, boolean, boolean) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use Topics.deletePartitionedTopicAsync(String, boolean) instead because parameter + `deleteSchema` is always true
+
+
+
deleteProperty(String) - Method in interface org.apache.pulsar.client.admin.Properties
+
+
Deprecated.
+
Delete an existing property.
+
+
deleteResourceGroup(String) - Method in interface org.apache.pulsar.client.admin.ResourceGroups
+
+
Delete an existing resourcegroup.
+
+
deleteResourceGroupAsync(String) - Method in interface org.apache.pulsar.client.admin.ResourceGroups
+
+
Delete an existing resourcegroup.
+
+
deleteSchema(String) - Method in interface org.apache.pulsar.client.admin.Schemas
+
+
Delete the schema associated with a given topic.
+
+
deleteSchema(String, boolean) - Method in interface org.apache.pulsar.client.admin.Schemas
+
+
Delete the schema associated with a given topic.
+
+
deleteSchemaAsync(String) - Method in interface org.apache.pulsar.client.admin.Schemas
+
+
Delete the schema associated with a given topic asynchronously.
+
+
deleteSchemaAsync(String, boolean) - Method in interface org.apache.pulsar.client.admin.Schemas
+
+
Delete the schema associated with a given topic asynchronously.
+
+
deleteSink(String, String, String) - Method in interface org.apache.pulsar.client.admin.Sinks
+
+
Delete an existing sink.
+
+
deleteSinkAsync(String, String, String) - Method in interface org.apache.pulsar.client.admin.Sinks
+
+
Delete an existing sink asynchronously.
+
+
deleteSource(String, String, String) - Method in interface org.apache.pulsar.client.admin.Sources
+
+
Delete an existing source.
+
+
deleteSourceAsync(String, String, String) - Method in interface org.apache.pulsar.client.admin.Sources
+
+
Delete an existing source asynchronously.
+
+
deleteSubscription(String, String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Delete a subscription.
+
+
deleteSubscription(String, String, boolean) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Delete a subscription.
+
+
deleteSubscriptionAsync(String, String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Delete a subscription asynchronously.
+
+
deleteSubscriptionAsync(String, String, boolean) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Delete a subscription asynchronously.
+
+
deleteTenant(String) - Method in interface org.apache.pulsar.client.admin.Tenants
+
+
Delete an existing tenant.
+
+
deleteTenant(String, boolean) - Method in interface org.apache.pulsar.client.admin.Tenants
+
+
Delete an existing tenant.
+
+
deleteTenantAsync(String) - Method in interface org.apache.pulsar.client.admin.Tenants
+
+
Delete an existing tenant asynchronously.
+
+
deleteTenantAsync(String, boolean) - Method in interface org.apache.pulsar.client.admin.Tenants
+
+
Delete an existing tenant asynchronously.
+
+
destination_storage - Enum constant in enum class org.apache.pulsar.common.policies.data.BacklogQuota.BacklogQuotaType
+
 
+
directArenas - Variable in class org.apache.pulsar.common.stats.AllocatorStats
+
 
+
disableDeduplication(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.removeDeduplicationStatus(String) instead.
+
+
+
disableDeduplicationAsync(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.removeDeduplicationStatusAsync(String) instead.
+
+
+
dispatcherPauseOnAckStatePersistentEnabled - Variable in class org.apache.pulsar.common.policies.data.Policies
+
 
+
DispatchRate - Interface in org.apache.pulsar.common.policies.data
+
+
Dispatch rate.
+
+
DispatchRate.Builder - Interface in org.apache.pulsar.common.policies.data
+
 
+
DispatchRateImpl - Class in org.apache.pulsar.common.policies.data.impl
+
+
Dispatch rate.
+
+
DispatchRateImpl() - Constructor for class org.apache.pulsar.common.policies.data.impl.DispatchRateImpl
+
 
+
DispatchRateImpl.DispatchRateImplBuilder - Class in org.apache.pulsar.common.policies.data.impl
+
 
+
DispatchRateImplBuilder() - Constructor for class org.apache.pulsar.common.policies.data.impl.DispatchRateImpl.DispatchRateImplBuilder
+
 
+
dispatchThrottlingRateInByte(long) - Method in interface org.apache.pulsar.common.policies.data.DispatchRate.Builder
+
 
+
dispatchThrottlingRateInByte(long) - Method in class org.apache.pulsar.common.policies.data.impl.DispatchRateImpl.DispatchRateImplBuilder
+
 
+
dispatchThrottlingRateInMsg(int) - Method in interface org.apache.pulsar.common.policies.data.DispatchRate.Builder
+
 
+
dispatchThrottlingRateInMsg(int) - Method in class org.apache.pulsar.common.policies.data.impl.DispatchRateImpl.DispatchRateImplBuilder
+
 
+
download(String, String) - Method in interface org.apache.pulsar.client.admin.Packages
+
+
Download a package from the package management service.
+
+
downloadAsync(String, String) - Method in interface org.apache.pulsar.client.admin.Packages
+
+
Download a package from the package management service asynchronously.
+
+
downloadFunction(String, String) - Method in interface org.apache.pulsar.client.admin.Functions
+
+
Download Function Code.
+
+
downloadFunction(String, String, String, String) - Method in interface org.apache.pulsar.client.admin.Functions
+
+
Download Function Code.
+
+
downloadFunction(String, String, String, String, boolean) - Method in interface org.apache.pulsar.client.admin.Functions
+
+
Download Function Code.
+
+
downloadFunctionAsync(String, String) - Method in interface org.apache.pulsar.client.admin.Functions
+
+
Download Function Code.
+
+
downloadFunctionAsync(String, String, String, String) - Method in interface org.apache.pulsar.client.admin.Functions
+
+
Download Function Code asynchronously.
+
+
downloadFunctionAsync(String, String, String, String, boolean) - Method in interface org.apache.pulsar.client.admin.Functions
+
+
Download Function Code asynchronously.
+
+
DrainingHash - Interface in org.apache.pulsar.common.policies.data
+
+
Contains information about a draining hash in a Key_Shared subscription.
+
+
+

E

+
+
EFFECTIVELY_ONCE - Enum constant in enum class org.apache.pulsar.common.functions.FunctionConfig.ProcessingGuarantees
+
 
+
elementSize - Variable in class org.apache.pulsar.common.stats.AllocatorStats.PoolSubpageStats
+
 
+
EMPTY - Static variable in class org.apache.pulsar.client.admin.ListNamespaceTopicsOptions
+
 
+
EMPTY - Static variable in class org.apache.pulsar.client.admin.ListTopicsOptions
+
 
+
enableDeduplication(String, boolean) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.setDeduplicationStatus(String, boolean) instead.
+
+
+
enableDeduplicationAsync(String, boolean) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.setDeduplicationStatusAsync(String, boolean) instead.
+
+
+
enableTlsHostnameVerification(boolean) - Method in interface org.apache.pulsar.client.admin.PulsarAdminBuilder
+
+
It allows to validate hostname verification when client connects to broker over TLS.
+
+
encryption_required - Variable in class org.apache.pulsar.common.policies.data.Policies
+
 
+
entries - Variable in class org.apache.pulsar.common.policies.data.ManagedLedgerInternalStats.LedgerInfo
+
 
+
entriesAddedCounter - Variable in class org.apache.pulsar.common.policies.data.ManagedLedgerInternalStats
+
+
Messages published since this broker loaded this managedLedger.
+
+
Entry() - Constructor for class org.apache.pulsar.common.policies.data.SchemaMetadata.Entry
+
 
+
entryFilters - Variable in class org.apache.pulsar.common.policies.data.Policies
+
 
+
EntryFilters - Class in org.apache.pulsar.common.policies.data
+
 
+
EntryFilters() - Constructor for class org.apache.pulsar.common.policies.data.EntryFilters
+
 
+
equals(Object) - Method in class org.apache.pulsar.common.conf.InternalConfigurationData
+
 
+
equals(Object) - Method in class org.apache.pulsar.common.policies.data.PersistencePolicies
+
 
+
equals(Object) - Method in class org.apache.pulsar.common.policies.data.Policies
+
 
+
equals(Object) - Method in class org.apache.pulsar.common.policies.data.PublishRate
+
 
+
equals(Object) - Method in class org.apache.pulsar.common.policies.data.RetentionPolicies
+
 
+
equals(Object) - Method in class org.apache.pulsar.common.policies.data.SubscribeRate
+
 
+
equals(Object) - Method in class org.apache.pulsar.common.stats.Metrics
+
 
+
equalsName(String) - Method in enum class org.apache.pulsar.common.policies.data.OffloadedReadPriority
+
 
+
error - Variable in class org.apache.pulsar.common.policies.data.FunctionStatus.FunctionInstanceStatus.FunctionInstanceStatusData
+
 
+
error - Variable in class org.apache.pulsar.common.policies.data.SinkStatus.SinkInstanceStatus.SinkInstanceStatusData
+
 
+
error - Variable in class org.apache.pulsar.common.policies.data.SourceStatus.SourceInstanceStatus.SourceInstanceStatusData
+
 
+
ERROR - Enum constant in enum class org.apache.pulsar.client.admin.LongRunningProcessStatus.Status
+
 
+
ErrorData - Class in org.apache.pulsar.common.policies.data
+
+
Class holding data in case of error responses.
+
+
ErrorData() - Constructor for class org.apache.pulsar.common.policies.data.ErrorData
+
 
+
ErrorData(String) - Constructor for class org.apache.pulsar.common.policies.data.ErrorData
+
 
+
examineMessage(String, String, long) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Examine a specific message on a topic by position relative to the earliest or the latest message.
+
+
examineMessageAsync(String, String, long) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Examine a specific message on a topic by position relative to the earliest or the latest message.
+
+
ExceptionInformation - Class in org.apache.pulsar.common.policies.data
+
+
Exception information.
+
+
ExceptionInformation() - Constructor for class org.apache.pulsar.common.policies.data.ExceptionInformation
+
 
+
expireMessages(String, String, long) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Expire all messages older than given N (expireTimeInSeconds) seconds for a given subscription.
+
+
expireMessages(String, String, MessageId, boolean) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Expire all messages older than given N (expireTimeInSeconds) seconds for a given subscription.
+
+
expireMessagesAsync(String, String, long) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Expire all messages older than given N (expireTimeInSeconds) seconds for a given subscription asynchronously.
+
+
expireMessagesAsync(String, String, MessageId, boolean) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Expire all messages older than given N (expireTimeInSeconds) seconds for a given subscription asynchronously.
+
+
expireMessagesForAllSubscriptions(String, long) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Expire all messages older than given N seconds for all subscriptions of the persistent-topic.
+
+
expireMessagesForAllSubscriptionsAsync(String, long) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Expire all messages older than given N seconds for all subscriptions of the persistent-topic asynchronously.
+
+
+

F

+
+
fail(String) - Static method in class org.apache.pulsar.common.policies.data.ValidateResult
+
 
+
FailureDomain - Interface in org.apache.pulsar.common.policies.data
+
 
+
FailureDomain.Builder - Interface in org.apache.pulsar.common.policies.data
+
 
+
fileSystemProfilePath(String) - Method in interface org.apache.pulsar.common.policies.data.OffloadPolicies.Builder
+
 
+
fileSystemURI(String) - Method in interface org.apache.pulsar.common.policies.data.OffloadPolicies.Builder
+
 
+
FIRST_BOUNDARY - Static variable in class org.apache.pulsar.common.policies.data.Policies
+
 
+
forError(String) - Static method in class org.apache.pulsar.client.admin.LongRunningProcessStatus
+
 
+
forError(String) - Static method in interface org.apache.pulsar.client.admin.OffloadProcessStatus
+
 
+
forStatus(LongRunningProcessStatus.Status) - Static method in class org.apache.pulsar.client.admin.LongRunningProcessStatus
+
 
+
forStatus(LongRunningProcessStatus.Status) - Static method in interface org.apache.pulsar.client.admin.OffloadProcessStatus
+
 
+
forSuccess(MessageId) - Static method in interface org.apache.pulsar.client.admin.OffloadProcessStatus
+
 
+
Forward - Enum constant in enum class org.apache.pulsar.common.policies.data.SchemaAutoUpdateCompatibilityStrategy
+
+
Messages written in the new schema can be read by the previous schema.
+
+
FORWARD - Enum constant in enum class org.apache.pulsar.common.policies.data.SchemaCompatibilityStrategy
+
+
Messages written by a new schema can be read by an old schema.
+
+
FORWARD_TRANSITIVE - Enum constant in enum class org.apache.pulsar.common.policies.data.SchemaCompatibilityStrategy
+
+
Be similar to FORWARD, FORWARD_TRANSITIVE ensure new schema can be ready by all previous + version schema.
+
+
ForwardTransitive - Enum constant in enum class org.apache.pulsar.common.policies.data.SchemaAutoUpdateCompatibilityStrategy
+
+
Be similar to Forward, ForwardTransitive ensure new schema can be ready by all previous + version schema.
+
+
freeBytes - Variable in class org.apache.pulsar.common.stats.AllocatorStats.PoolChunkStats
+
 
+
fromAutoUpdatePolicy(SchemaAutoUpdateCompatibilityStrategy) - Static method in enum class org.apache.pulsar.common.policies.data.SchemaCompatibilityStrategy
+
 
+
fromString(String) - Static method in enum class org.apache.pulsar.common.policies.data.AutoFailoverPolicyType
+
 
+
fromString(String) - Static method in enum class org.apache.pulsar.common.policies.data.NamespaceIsolationPolicyUnloadScope
+
 
+
fromString(String) - Static method in enum class org.apache.pulsar.common.policies.data.OffloadedReadPriority
+
 
+
Full - Enum constant in enum class org.apache.pulsar.common.policies.data.SchemaAutoUpdateCompatibilityStrategy
+
+
Backward and Forward.
+
+
FULL - Enum constant in enum class org.apache.pulsar.common.policies.data.SchemaCompatibilityStrategy
+
+
Equivalent to both FORWARD and BACKWARD.
+
+
FULL_TRANSITIVE - Enum constant in enum class org.apache.pulsar.common.policies.data.SchemaCompatibilityStrategy
+
+
Equivalent to both FORWARD_TRANSITIVE and BACKWARD_TRANSITIVE.
+
+
FullTransitive - Enum constant in enum class org.apache.pulsar.common.policies.data.SchemaAutoUpdateCompatibilityStrategy
+
+
BackwardTransitive and ForwardTransitive.
+
+
FUNCTION - Enum constant in enum class org.apache.pulsar.packages.management.core.common.PackageType
+
 
+
FunctionConfig - Class in org.apache.pulsar.common.functions
+
+
Configuration of Pulsar Function.
+
+
FunctionConfig() - Constructor for class org.apache.pulsar.common.functions.FunctionConfig
+
 
+
FunctionConfig.ProcessingGuarantees - Enum Class in org.apache.pulsar.common.functions
+
+
Definition of possible processing guarantees.
+
+
FunctionConfig.Runtime - Enum Class in org.apache.pulsar.common.functions
+
+
Definition of possible runtime environments.
+
+
FunctionDefinition - Class in org.apache.pulsar.common.functions
+
+
Basic information about a Pulsar function.
+
+
FunctionDefinition() - Constructor for class org.apache.pulsar.common.functions.FunctionDefinition
+
 
+
FunctionInstanceStats - Interface in org.apache.pulsar.common.policies.data
+
 
+
FunctionInstanceStatsData - Interface in org.apache.pulsar.common.policies.data
+
 
+
FunctionInstanceStatsDataBase - Interface in org.apache.pulsar.common.policies.data
+
 
+
FunctionInstanceStatus() - Constructor for class org.apache.pulsar.common.policies.data.FunctionStatus.FunctionInstanceStatus
+
 
+
FunctionInstanceStatusData() - Constructor for class org.apache.pulsar.common.policies.data.FunctionStatus.FunctionInstanceStatus.FunctionInstanceStatusData
+
 
+
functions - Enum constant in enum class org.apache.pulsar.common.policies.data.AuthAction
+
+
Permissions for functions ops.
+
+
functions() - Method in interface org.apache.pulsar.client.admin.PulsarAdmin
+
 
+
Functions - Interface in org.apache.pulsar.client.admin
+
+
Admin interface for function management.
+
+
FunctionState - Class in org.apache.pulsar.common.functions
+
+
Function state.
+
+
FunctionState() - Constructor for class org.apache.pulsar.common.functions.FunctionState
+
 
+
FunctionStats - Interface in org.apache.pulsar.common.policies.data
+
 
+
FunctionStatus - Class in org.apache.pulsar.common.policies.data
+
+
Data lass containing status of Pulsar Function.
+
+
FunctionStatus() - Constructor for class org.apache.pulsar.common.policies.data.FunctionStatus
+
 
+
FunctionStatus.FunctionInstanceStatus - Class in org.apache.pulsar.common.policies.data
+
+
Function instance status.
+
+
FunctionStatus.FunctionInstanceStatus.FunctionInstanceStatusData - Class in org.apache.pulsar.common.policies.data
+
+
Function instance status data.
+
+
+

G

+
+
gcsManagedLedgerOffloadBucket(String) - Method in interface org.apache.pulsar.common.policies.data.OffloadPolicies.Builder
+
 
+
gcsManagedLedgerOffloadMaxBlockSizeInBytes(Integer) - Method in interface org.apache.pulsar.common.policies.data.OffloadPolicies.Builder
+
 
+
gcsManagedLedgerOffloadReadBufferSizeInBytes(Integer) - Method in interface org.apache.pulsar.common.policies.data.OffloadPolicies.Builder
+
 
+
gcsManagedLedgerOffloadRegion(String) - Method in interface org.apache.pulsar.common.policies.data.OffloadPolicies.Builder
+
 
+
gcsManagedLedgerOffloadServiceAccountKeyFile(String) - Method in interface org.apache.pulsar.common.policies.data.OffloadPolicies.Builder
+
 
+
getAccessMode() - Method in interface org.apache.pulsar.common.policies.data.PublisherStats
+
 
+
getActiveBrokers() - Method in interface org.apache.pulsar.client.admin.Brokers
+
+
Get the list of active brokers in the local cluster.
+
+
getActiveBrokers(String) - Method in interface org.apache.pulsar.client.admin.Brokers
+
+
Get the list of active brokers in the cluster.
+
+
getActiveBrokersAsync() - Method in interface org.apache.pulsar.client.admin.Brokers
+
+
Get the list of active brokers in the local cluster asynchronously.
+
+
getActiveBrokersAsync(String) - Method in interface org.apache.pulsar.client.admin.Brokers
+
+
Get the list of active brokers in the cluster asynchronously.
+
+
getActiveConsumerName() - Method in interface org.apache.pulsar.common.policies.data.SubscriptionStats
+
+
The name of the consumer that is active for single active consumer subscriptions i.e.
+
+
getAddress() - Method in interface org.apache.pulsar.common.policies.data.ConsumerStats
+
+
Address of this consumer.
+
+
getAddress() - Method in interface org.apache.pulsar.common.policies.data.PublisherStats
+
+
Address of this publisher.
+
+
getAdminRoles() - Method in interface org.apache.pulsar.common.policies.data.TenantInfo
+
 
+
getAllDynamicConfigurations() - Method in interface org.apache.pulsar.client.admin.Brokers
+
+
Get values of all overridden dynamic-configs.
+
+
getAllDynamicConfigurationsAsync() - Method in interface org.apache.pulsar.client.admin.Brokers
+
+
Get values of all overridden dynamic-configs asynchronously.
+
+
getAllocatorStats(String) - Method in interface org.apache.pulsar.client.admin.BrokerStats
+
+
Get the stats for the Netty allocator.
+
+
getAllocatorStatsAsync(String) - Method in interface org.apache.pulsar.client.admin.BrokerStats
+
+
Get the stats for the Netty allocator asynchronously.
+
+
getAllowedClusters() - Method in interface org.apache.pulsar.common.policies.data.TenantInfo
+
 
+
getAllSchemas(String) - Method in interface org.apache.pulsar.client.admin.Schemas
+
+
Get all version schemas topic.
+
+
getAllSchemasAsync(String) - Method in interface org.apache.pulsar.client.admin.Schemas
+
+
Get all version schemas topic asynchronously.
+
+
getAntiAffinityNamespaces(String, String, String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get all namespaces that grouped with given anti-affinity group.
+
+
getAntiAffinityNamespacesAsync(String, String, String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get all namespaces that grouped with given anti-affinity group asynchronously.
+
+
getAppId() - Method in interface org.apache.pulsar.common.policies.data.ConsumerStats
+
+
the app id.
+
+
getAssignments() - Method in interface org.apache.pulsar.client.admin.Worker
+
+
Get the function assignment among the cluster.
+
+
getAssignmentsAsync() - Method in interface org.apache.pulsar.client.admin.Worker
+
+
Get the function assignment among the cluster asynchronously.
+
+
getAuthenticationParameters() - Method in interface org.apache.pulsar.common.policies.data.ClusterData
+
 
+
getAuthenticationPlugin() - Method in interface org.apache.pulsar.common.policies.data.ClusterData
+
 
+
getAutoFailoverPolicy() - Method in interface org.apache.pulsar.common.policies.data.NamespaceIsolationData
+
 
+
getAutoSubscriptionCreation(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get the autoSubscriptionCreation info within a namespace.
+
+
getAutoSubscriptionCreation(String, boolean) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Get the autoSubscriptionCreation info within a topic.
+
+
getAutoSubscriptionCreationAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get the autoSubscriptionCreation info within a namespace asynchronously.
+
+
getAutoSubscriptionCreationAsync(String, boolean) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Get the autoSubscriptionCreation info within a topic asynchronously.
+
+
getAutoTopicCreation(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get the autoTopicCreation info within a namespace.
+
+
getAutoTopicCreationAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get the autoTopicCreation info within a namespace asynchronously.
+
+
getAvailablePermits() - Method in interface org.apache.pulsar.common.policies.data.ConsumerStats
+
+
Number of available message permits for the consumer.
+
+
getAverageMsgSize() - Method in interface org.apache.pulsar.common.policies.data.PublisherStats
+
+
Average message size published by this publisher.
+
+
getAverageMsgSize() - Method in interface org.apache.pulsar.common.policies.data.TopicStats
+
+
Average size of published messages (bytes).
+
+
getAvgMessagesPerEntry() - Method in interface org.apache.pulsar.common.policies.data.ConsumerStats
+
+
Number of average messages per entry for the consumer consumed.
+
+
getAvgProcessLatency() - Method in interface org.apache.pulsar.common.policies.data.FunctionInstanceStatsDataBase
+
 
+
getAvgProcessLatency() - Method in interface org.apache.pulsar.common.policies.data.FunctionStats
+
 
+
getBacklogQuotaLimitSize() - Method in interface org.apache.pulsar.common.policies.data.TopicStats
+
+
the size in bytes of the topic backlog quota.
+
+
getBacklogQuotaLimitTime() - Method in interface org.apache.pulsar.common.policies.data.TopicStats
+
+
the topic backlog age quota, in seconds.
+
+
getBacklogQuotaMap(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get backlog quota map on a namespace.
+
+
getBacklogQuotaMap(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Get backlog quota map for a topic.
+
+
getBacklogQuotaMap(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getBacklogQuotaMap(String) instead.
+
+
+
getBacklogQuotaMap(String, boolean) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Get applied backlog quota map for a topic.
+
+
getBacklogQuotaMap(String, boolean) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getBacklogQuotaMap(String, boolean) instead.
+
+
+
getBacklogQuotaMapAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get backlog quota map on a namespace asynchronously.
+
+
getBacklogSize() - Method in interface org.apache.pulsar.common.policies.data.SubscriptionStats
+
+
Size of backlog in byte.
+
+
getBacklogSize() - Method in interface org.apache.pulsar.common.policies.data.TopicStats
+
+
Get estimated total unconsumed or backlog size in bytes.
+
+
getBacklogSizeByMessageId(String, MessageId) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Get backlog size by a message ID.
+
+
getBacklogSizeByMessageIdAsync(String, MessageId) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Get backlog size by a message ID asynchronously.
+
+
getBandwidthIn() - Method in interface org.apache.pulsar.policies.data.loadbalancer.LoadManagerReport
+
 
+
getBandwidthOut() - Method in interface org.apache.pulsar.policies.data.loadbalancer.LoadManagerReport
+
 
+
getBlockedAttempts() - Method in interface org.apache.pulsar.common.policies.data.DrainingHash
+
+
Get the number of times the hash has blocked an attempted delivery of a message.
+
+
getBookie(String) - Method in class org.apache.pulsar.common.policies.data.BookiesRackConfiguration
+
 
+
getBookieAffinityGroup(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get bookie affinity group configured for a namespace.
+
+
getBookieAffinityGroupAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get bookie affinity group configured for a namespace asynchronously.
+
+
getBookieRackInfo(String) - Method in interface org.apache.pulsar.client.admin.Bookies
+
+
Gets the rack placement information for a specific bookie in the cluster.
+
+
getBookieRackInfoAsync(String) - Method in interface org.apache.pulsar.client.admin.Bookies
+
+
Gets the rack placement information for a specific bookie in the cluster asynchronously.
+
+
getBookies() - Method in interface org.apache.pulsar.client.admin.Bookies
+
+
Gets discovery information for all the bookies in the cluster.
+
+
getBookies() - Method in interface org.apache.pulsar.common.policies.data.BookiesClusterInfo
+
 
+
getBookiesAsync() - Method in interface org.apache.pulsar.client.admin.Bookies
+
+
Gets discovery information for all the bookies in the cluster asynchronously.
+
+
getBookiesRackInfo() - Method in interface org.apache.pulsar.client.admin.Bookies
+
+
Gets the rack placement information for all the bookies in the cluster.
+
+
getBookiesRackInfoAsync() - Method in interface org.apache.pulsar.client.admin.Bookies
+
+
Gets the rack placement information for all the bookies in the cluster asynchronously.
+
+
getBookkeeperAckQuorum() - Method in class org.apache.pulsar.common.policies.data.PersistencePolicies
+
 
+
getBookkeeperAffinityGroupPrimary() - Method in interface org.apache.pulsar.common.policies.data.BookieAffinityGroupData
+
 
+
getBookkeeperAffinityGroupSecondary() - Method in interface org.apache.pulsar.common.policies.data.BookieAffinityGroupData
+
 
+
getBookkeeperEnsemble() - Method in class org.apache.pulsar.common.policies.data.PersistencePolicies
+
 
+
getBookkeeperMetadataServiceUri() - Method in class org.apache.pulsar.common.conf.InternalConfigurationData
+
 
+
getBookkeeperWriteQuorum() - Method in class org.apache.pulsar.common.policies.data.PersistencePolicies
+
 
+
getBoundaries() - Method in interface org.apache.pulsar.common.policies.data.BundlesData
+
 
+
getBrokerAddress() - Method in interface org.apache.pulsar.common.policies.data.BrokerStatus
+
 
+
getBrokerClientCertificateFilePath() - Method in interface org.apache.pulsar.common.policies.data.ClusterData
+
 
+
getBrokerClientKeyFilePath() - Method in interface org.apache.pulsar.common.policies.data.ClusterData
+
 
+
getBrokerClientSslFactoryPlugin() - Method in interface org.apache.pulsar.common.policies.data.ClusterData
+
 
+
getBrokerClientSslFactoryPluginParams() - Method in interface org.apache.pulsar.common.policies.data.ClusterData
+
 
+
getBrokerClientTlsKeyStore() - Method in interface org.apache.pulsar.common.policies.data.ClusterData
+
 
+
getBrokerClientTlsKeyStorePassword() - Method in interface org.apache.pulsar.common.policies.data.ClusterData
+
 
+
getBrokerClientTlsKeyStoreType() - Method in interface org.apache.pulsar.common.policies.data.ClusterData
+
 
+
getBrokerClientTlsTrustStore() - Method in interface org.apache.pulsar.common.policies.data.ClusterData
+
 
+
getBrokerClientTlsTrustStorePassword() - Method in interface org.apache.pulsar.common.policies.data.ClusterData
+
 
+
getBrokerClientTlsTrustStoreType() - Method in interface org.apache.pulsar.common.policies.data.ClusterData
+
 
+
getBrokerClientTrustCertsFilePath() - Method in interface org.apache.pulsar.common.policies.data.ClusterData
+
 
+
getBrokerId() - Method in interface org.apache.pulsar.common.policies.data.BrokerInfo
+
 
+
getBrokerName() - Method in interface org.apache.pulsar.common.policies.data.BrokerNamespaceIsolationData
+
 
+
getBrokers() - Method in interface org.apache.pulsar.common.policies.data.FailureDomain
+
 
+
getBrokerServiceUrl() - Method in interface org.apache.pulsar.common.policies.data.ClusterData
+
 
+
getBrokerServiceUrlTls() - Method in interface org.apache.pulsar.common.policies.data.ClusterData
+
 
+
getBrokersWithNamespaceIsolationPolicy(String) - Method in interface org.apache.pulsar.client.admin.Clusters
+
+
Returns list of active brokers with namespace-isolation policies attached to it.
+
+
getBrokersWithNamespaceIsolationPolicyAsync(String) - Method in interface org.apache.pulsar.client.admin.Clusters
+
+
Returns list of active brokers with namespace-isolation policies attached to it asynchronously.
+
+
getBrokerVersionString() - Method in interface org.apache.pulsar.policies.data.loadbalancer.LoadManagerReport
+
 
+
getBrokerWithNamespaceIsolationPolicy(String, String) - Method in interface org.apache.pulsar.client.admin.Clusters
+
+
Returns active broker with namespace-isolation policies attached to it.
+
+
getBrokerWithNamespaceIsolationPolicyAsync(String, String) - Method in interface org.apache.pulsar.client.admin.Clusters
+
+
Returns active broker with namespace-isolation policies attached to it asynchronously.
+
+
getBuiltInFunctions() - Method in interface org.apache.pulsar.client.admin.Functions
+
+
Fetches a list of supported Pulsar Functions currently running in cluster mode.
+
+
getBuiltInFunctionsAsync() - Method in interface org.apache.pulsar.client.admin.Functions
+
+
Fetches a list of supported Pulsar Functions currently running in cluster mode asynchronously.
+
+
getBuiltInSinks() - Method in interface org.apache.pulsar.client.admin.Sinks
+
+
Fetches a list of supported Pulsar IO sinks currently running in cluster mode.
+
+
getBuiltInSinksAsync() - Method in interface org.apache.pulsar.client.admin.Sinks
+
+
Fetches a list of supported Pulsar IO sinks currently running in cluster mode asynchronously.
+
+
getBuiltInSources() - Method in interface org.apache.pulsar.client.admin.Sources
+
+
Fetches a list of supported Pulsar IO sources currently running in cluster mode.
+
+
getBuiltInSourcesAsync() - Method in interface org.apache.pulsar.client.admin.Sources
+
+
Fetches a list of supported Pulsar IO sources currently running in cluster mode asynchronously.
+
+
getBundleRange(String) - Method in interface org.apache.pulsar.client.admin.Lookup
+
+
Get a bundle range of a topic.
+
+
getBundleRangeAsync(String) - Method in interface org.apache.pulsar.client.admin.Lookup
+
+
Get a bundle range of a topic asynchronously.
+
+
getBundles(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get the list of bundles.
+
+
getBundlesAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get the list of bundles asynchronously.
+
+
getBundleStats() - Method in interface org.apache.pulsar.policies.data.loadbalancer.LoadManagerReport
+
 
+
getBytesInCount() - Method in interface org.apache.pulsar.common.policies.data.ReplicatorStats
+
+
Total number of bytes received from the remote cluster.
+
+
getBytesInCounter() - Method in interface org.apache.pulsar.common.policies.data.TopicStats
+
+
Total bytes published to the topic (bytes).
+
+
getBytesOutCount() - Method in interface org.apache.pulsar.common.policies.data.ReplicatorStats
+
+
Total number of bytes sent to the remote cluster.
+
+
getBytesOutCounter() - Method in interface org.apache.pulsar.common.policies.data.ConsumerStats
+
+
Total bytes delivered to consumer (bytes).
+
+
getBytesOutCounter() - Method in interface org.apache.pulsar.common.policies.data.SubscriptionStats
+
+
Total bytes delivered to consumer (bytes).
+
+
getBytesOutCounter() - Method in interface org.apache.pulsar.common.policies.data.TopicStats
+
+
Total bytes delivered to consumer (bytes).
+
+
getChunkedMessageRate() - Method in interface org.apache.pulsar.common.policies.data.ConsumerStats
+
+
The total rate of chunked messages delivered to this consumer.
+
+
getChunkedMessageRate() - Method in interface org.apache.pulsar.common.policies.data.PublisherStats
+
+
The total rate of chunked messages published by this publisher.
+
+
getChunkedMessageRate() - Method in interface org.apache.pulsar.common.policies.data.SubscriptionStats
+
+
Chunked message dispatch rate.
+
+
getClientVersion() - Method in interface org.apache.pulsar.common.policies.data.ConsumerStats
+
+
Client library version.
+
+
getClientVersion() - Method in interface org.apache.pulsar.common.policies.data.PublisherStats
+
+
Client library version.
+
+
getCluster() - Method in interface org.apache.pulsar.client.admin.Worker
+
+
Get List of all workers belonging to this cluster.
+
+
getCluster(String) - Method in interface org.apache.pulsar.client.admin.Clusters
+
+
Get the configuration data for the specified cluster.
+
+
getClusterAsync() - Method in interface org.apache.pulsar.client.admin.Worker
+
+
Get List of all workers belonging to this cluster asynchronously.
+
+
getClusterAsync(String) - Method in interface org.apache.pulsar.client.admin.Clusters
+
+
Get the configuration data for the specified cluster asynchronously.
+
+
getClusterLeader() - Method in interface org.apache.pulsar.client.admin.Worker
+
+
Get the worker who is the leader of the cluster.
+
+
getClusterLeaderAsync() - Method in interface org.apache.pulsar.client.admin.Worker
+
+
Get the worker who is the leader of the cluster asynchronously.
+
+
getClusterMigration(String) - Method in interface org.apache.pulsar.client.admin.Clusters
+
+
Get the cluster migration configuration data for the specified cluster.
+
+
getClusterMigrationAsync(String) - Method in interface org.apache.pulsar.client.admin.Clusters
+
+
Get the cluster migration configuration data for the specified cluster asynchronously.
+
+
getClusters() - Method in interface org.apache.pulsar.client.admin.Clusters
+
+
Get the list of clusters.
+
+
getClustersAsync() - Method in interface org.apache.pulsar.client.admin.Clusters
+
+
Get the list of clusters asynchronously.
+
+
getCompaction() - Method in interface org.apache.pulsar.common.policies.data.TopicStats
+
+
The compaction stats.
+
+
getCompactionThreshold(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get the compactionThreshold for a namespace.
+
+
getCompactionThreshold(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Get the compactionThreshold for a topic.
+
+
getCompactionThreshold(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getCompactionThreshold(String) instead.
+
+
+
getCompactionThreshold(String, boolean) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Get the compactionThreshold for a topic.
+
+
getCompactionThreshold(String, boolean) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getCompactionThreshold(String, boolean) instead.
+
+
+
getCompactionThresholdAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get the compactionThreshold for a namespace asynchronously.
+
+
getCompactionThresholdAsync(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Get the compactionThreshold for a topic asynchronously.
+
+
getCompactionThresholdAsync(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getCompactionThresholdAsync(String) instead.
+
+
+
getCompactionThresholdAsync(String, boolean) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Get the compactionThreshold for a topic asynchronously.
+
+
getCompactionThresholdAsync(String, boolean) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getCompactionThreshold(String, boolean) instead.
+
+
+
getConfigurationMetadataStoreUrl() - Method in class org.apache.pulsar.common.conf.InternalConfigurationData
+
 
+
getConfigurationStoreServers() - Method in class org.apache.pulsar.common.conf.InternalConfigurationData
+
+
Deprecated.
+
+
getConnectedSince() - Method in interface org.apache.pulsar.common.policies.data.ConsumerStats
+
+
Timestamp of connection.
+
+
getConnectedSince() - Method in interface org.apache.pulsar.common.policies.data.PublisherStats
+
+
Timestamp of connection.
+
+
getConnections() - Method in interface org.apache.pulsar.client.admin.ProxyStats
+
+
Returns Connections metrics.
+
+
getConnectorsList() - Method in interface org.apache.pulsar.client.admin.Functions
+
+
Deprecated.
+
+
getConsumerName() - Method in interface org.apache.pulsar.common.policies.data.ConsumerStats
+
+
Name of the consumer.
+
+
getConsumers() - Method in interface org.apache.pulsar.common.policies.data.SubscriptionStats
+
+
List of connected consumers on this subscription w/ their stats.
+
+
getConsumersAfterMarkDeletePosition() - Method in interface org.apache.pulsar.common.policies.data.SubscriptionStats
+
+
This is for Key_Shared subscription to get the recentJoinedConsumers in the Key_Shared subscription.
+
+
getCoordinatorInternalStats(int, boolean) - Method in interface org.apache.pulsar.client.admin.Transactions
+
+
Get transaction coordinator internal stats.
+
+
getCoordinatorInternalStatsAsync(int, boolean) - Method in interface org.apache.pulsar.client.admin.Transactions
+
+
Get transaction coordinator internal stats.
+
+
getCoordinatorStats() - Method in interface org.apache.pulsar.client.admin.Transactions
+
+
Get transaction metadataStore stats.
+
+
getCoordinatorStatsAsync() - Method in interface org.apache.pulsar.client.admin.Transactions
+
+
Get transaction metadataStore stats.
+
+
getCoordinatorStatsById(int) - Method in interface org.apache.pulsar.client.admin.Transactions
+
+
Get transaction metadataStore stats.
+
+
getCoordinatorStatsByIdAsync(int) - Method in interface org.apache.pulsar.client.admin.Transactions
+
+
Get transaction metadataStore stats.
+
+
getCpu() - Method in interface org.apache.pulsar.policies.data.loadbalancer.LoadManagerReport
+
 
+
getDeduplicationEnabled(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getDeduplicationStatus(String) instead.
+
+
+
getDeduplicationEnabledAsync(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getDeduplicationStatusAsync(String) instead.
+
+
+
getDeduplicationSnapshotInterval(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get the deduplicationSnapshotInterval for a namespace.
+
+
getDeduplicationSnapshotInterval(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Get the deduplication snapshot interval for specified topic.
+
+
getDeduplicationSnapshotInterval(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getDeduplicationSnapshotInterval(String) instead.
+
+
+
getDeduplicationSnapshotIntervalAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get the deduplicationSnapshotInterval for a namespace asynchronously.
+
+
getDeduplicationSnapshotIntervalAsync(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Get the deduplication snapshot interval for specified topic asynchronously.
+
+
getDeduplicationSnapshotIntervalAsync(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getDeduplicationSnapshotIntervalAsync(String) instead.
+
+
+
getDeduplicationStatus() - Method in interface org.apache.pulsar.common.policies.data.TopicStats
+
 
+
getDeduplicationStatus(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get the deduplication status for all topics within a namespace .
+
+
getDeduplicationStatus(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
get deduplication enabled of a topic.
+
+
getDeduplicationStatus(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getDeduplicationStatus(String) instead.
+
+
+
getDeduplicationStatus(String, boolean) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
get applied deduplication enabled of a topic.
+
+
getDeduplicationStatus(String, boolean) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getDeduplicationStatus(String, boolean) instead.
+
+
+
getDeduplicationStatusAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get the deduplication status for all topics within a namespace asynchronously.
+
+
getDeduplicationStatusAsync(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
get deduplication enabled of a topic asynchronously.
+
+
getDeduplicationStatusAsync(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getDeduplicationStatusAsync(String) instead.
+
+
+
getDeduplicationStatusAsync(String, boolean) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
get applied deduplication enabled of a topic asynchronously.
+
+
getDeduplicationStatusAsync(String, boolean) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getDeduplicationStatusAsync(String, boolean) instead.
+
+
+
getDefaultNumPartitions() - Method in interface org.apache.pulsar.common.policies.data.AutoTopicCreationOverride
+
 
+
getDefaultResourceQuota() - Method in interface org.apache.pulsar.client.admin.ResourceQuotas
+
+
Get default resource quota for new resource bundles.
+
+
getDefaultResourceQuotaAsync() - Method in interface org.apache.pulsar.client.admin.ResourceQuotas
+
+
Get default resource quota for new resource bundles asynchronously.
+
+
getDefaultResources() - Static method in class org.apache.pulsar.common.functions.Resources
+
 
+
getDelayedDelivery(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get the delayed delivery messages for all topics within a namespace.
+
+
getDelayedDeliveryAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get the delayed delivery messages for all topics within a namespace asynchronously.
+
+
getDelayedDeliveryPolicy(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Get the delayed delivery policy for a specified topic.
+
+
getDelayedDeliveryPolicy(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getDelayedDeliveryPolicy(String) instead.
+
+
+
getDelayedDeliveryPolicy(String, boolean) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Get the delayed delivery policy applied for a specified topic.
+
+
getDelayedDeliveryPolicy(String, boolean) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getDelayedDeliveryPolicy(String, boolean) instead.
+
+
+
getDelayedDeliveryPolicyAsync(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Get the delayed delivery policy for a specified topic asynchronously.
+
+
getDelayedDeliveryPolicyAsync(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getDelayedDeliveryPolicyAsync(String) instead.
+
+
+
getDelayedDeliveryPolicyAsync(String, boolean) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Get the delayed delivery policy applied for a specified topic asynchronously.
+
+
getDelayedDeliveryPolicyAsync(String, boolean) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getDelayedDeliveryPolicyAsync(String, boolean) instead.
+
+
+
getDelayedMessageIndexSizeInBytes() - Method in interface org.apache.pulsar.common.policies.data.SubscriptionStats
+
 
+
getDelayedMessageIndexSizeInBytes() - Method in interface org.apache.pulsar.common.policies.data.TopicStats
+
 
+
getDimension(String) - Method in class org.apache.pulsar.common.stats.Metrics
+
 
+
getDimensions() - Method in class org.apache.pulsar.common.stats.Metrics
+
 
+
getDirectMemory() - Method in interface org.apache.pulsar.policies.data.loadbalancer.LoadManagerReport
+
 
+
getDispatcherPauseOnAckStatePersistent(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get the dispatcherPauseOnAckStatePersistentEnabled policy for a given namespace.
+
+
getDispatcherPauseOnAckStatePersistent(String, boolean) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Get the dispatcherPauseOnAckStatePersistentEnabled policy for a given topic asynchronously.
+
+
getDispatcherPauseOnAckStatePersistentAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get the dispatcherPauseOnAckStatePersistentEnabled policy for a given namespace asynchronously.
+
+
getDispatchRate(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get message-dispatch-rate (topics under this namespace can dispatch this many messages per second).
+
+
getDispatchRate(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Get message-dispatch-rate (topic can dispatch this many messages per second).
+
+
getDispatchRate(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getDispatchRate(String) instead.
+
+
+
getDispatchRate(String, boolean) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Get applied message-dispatch-rate (topic can dispatch this many messages per second).
+
+
getDispatchRate(String, boolean) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getDispatchRate(String, boolean) instead.
+
+
+
getDispatchRateAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get message-dispatch-rate asynchronously.
+
+
getDispatchRateAsync(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Get message-dispatch-rate asynchronously.
+
+
getDispatchRateAsync(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getDispatchRateAsync(String) instead.
+
+
+
getDispatchRateAsync(String, boolean) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Get applied message-dispatch-rate asynchronously.
+
+
getDispatchRateAsync(String, boolean) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getDispatchRateAsync(String, boolean) instead.
+
+
+
getDispatchThrottlingRateInByte() - Method in interface org.apache.pulsar.common.policies.data.DispatchRate
+
 
+
getDispatchThrottlingRateInMsg() - Method in interface org.apache.pulsar.common.policies.data.DispatchRate
+
 
+
getDrainingHashes() - Method in interface org.apache.pulsar.common.policies.data.ConsumerStats
+
+
For Key_Shared subscription in AUTO_SPLIT ordered mode: + Retrieves the draining hashes for this consumer.
+
+
getDrainingHashesClearedTotal() - Method in interface org.apache.pulsar.common.policies.data.ConsumerStats
+
+
For Key_Shared subscription in AUTO_SPLIT ordered mode: + Retrieves the total number of hashes cleared from the draining state since the consumer connected.
+
+
getDrainingHashesClearedTotal() - Method in interface org.apache.pulsar.common.policies.data.SubscriptionStats
+
+
For Key_Shared subscription in AUTO_SPLIT ordered mode: + Retrieves the total number of hashes cleared from the draining state for the connected consumers.
+
+
getDrainingHashesCount() - Method in interface org.apache.pulsar.common.policies.data.ConsumerStats
+
+
For Key_Shared subscription in AUTO_SPLIT ordered mode: + Retrieves the current number of hashes in the draining state for this consumer.
+
+
getDrainingHashesCount() - Method in interface org.apache.pulsar.common.policies.data.SubscriptionStats
+
+
For Key_Shared subscription in AUTO_SPLIT ordered mode: + Retrieves the current number of hashes in the draining state.
+
+
getDrainingHashesUnackedMessages() - Method in interface org.apache.pulsar.common.policies.data.ConsumerStats
+
+
For Key_Shared subscription in AUTO_SPLIT ordered mode: + Retrieves the total number of unacked messages for all draining hashes for this consumer.
+
+
getDrainingHashesUnackedMessages() - Method in interface org.apache.pulsar.common.policies.data.SubscriptionStats
+
+
For Key_Shared subscription in AUTO_SPLIT ordered mode: + Retrieves the total number of unacked messages for all draining hashes.
+
+
getDynamic() - Method in class org.apache.pulsar.common.policies.data.ResourceQuota
+
 
+
getDynamicConfigurationNames() - Method in interface org.apache.pulsar.client.admin.Brokers
+
+
Get list of updatable configuration name.
+
+
getDynamicConfigurationNamesAsync() - Method in interface org.apache.pulsar.client.admin.Brokers
+
+
Get list of updatable configuration name asynchronously.
+
+
getEarliestMsgPublishTimeInBacklog() - Method in interface org.apache.pulsar.common.policies.data.SubscriptionStats
+
+
Get the publish time of the earliest message in the backlog.
+
+
getEarliestMsgPublishTimeInBacklogs() - Method in interface org.apache.pulsar.common.policies.data.TopicStats
+
+
Get the publish time of the earliest message over all the backlogs.
+
+
getEncryptionRequiredStatus(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get the encryption required status within a namespace.
+
+
getEncryptionRequiredStatusAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get the encryption required status within a namespace asynchronously.
+
+
getEntryFiltersPerTopic(String, boolean) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Get applied entry filters for a topic.
+
+
getEntryFiltersPerTopicAsync(String, boolean) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Get applied entry filters for a topic asynchronously.
+
+
getEnum(String) - Static method in enum class org.apache.pulsar.common.naming.TopicDomain
+
 
+
getEnum(String) - Static method in enum class org.apache.pulsar.packages.management.core.common.PackageType
+
 
+
getFailureDomain(String, String) - Method in interface org.apache.pulsar.client.admin.Clusters
+
+
Get the domain registered into a cluster.
+
+
getFailureDomainAsync(String, String) - Method in interface org.apache.pulsar.client.admin.Clusters
+
+
Get the domain registered into a cluster asynchronously.
+
+
getFailureDomains(String) - Method in interface org.apache.pulsar.client.admin.Clusters
+
+
Get all registered domains in cluster.
+
+
getFailureDomainsAsync(String) - Method in interface org.apache.pulsar.client.admin.Clusters
+
+
Get all registered domains in cluster asynchronously.
+
+
getFileSystemProfilePath() - Method in interface org.apache.pulsar.common.policies.data.OffloadPolicies
+
 
+
getFileSystemURI() - Method in interface org.apache.pulsar.common.policies.data.OffloadPolicies
+
 
+
getFilterAcceptedMsgCount() - Method in interface org.apache.pulsar.common.policies.data.SubscriptionStats
+
 
+
getFilterProcessedMsgCount() - Method in interface org.apache.pulsar.common.policies.data.SubscriptionStats
+
 
+
getFilterRejectedMsgCount() - Method in interface org.apache.pulsar.common.policies.data.SubscriptionStats
+
 
+
getFilterRescheduledMsgCount() - Method in interface org.apache.pulsar.common.policies.data.SubscriptionStats
+
 
+
getFirstUnoffloadedMessage() - Method in interface org.apache.pulsar.client.admin.OffloadProcessStatus
+
 
+
getFunction(String, String, String) - Method in interface org.apache.pulsar.client.admin.Functions
+
+
Get the configuration for the specified function.
+
+
getFunctionAsync(String, String, String) - Method in interface org.apache.pulsar.client.admin.Functions
+
+
Get the configuration for the specified function asynchronously.
+
+
getFunctions(String, String) - Method in interface org.apache.pulsar.client.admin.Functions
+
+
Get the list of functions.
+
+
getFunctionsAsync(String, String) - Method in interface org.apache.pulsar.client.admin.Functions
+
+
Get the list of functions asynchronously.
+
+
getFunctionsStats() - Method in interface org.apache.pulsar.client.admin.Worker
+
+
Get all functions stats on a worker.
+
+
getFunctionsStatsAsync() - Method in interface org.apache.pulsar.client.admin.Worker
+
+
Get all functions stats on a worker asynchronously.
+
+
getFunctionState(String, String, String, String) - Method in interface org.apache.pulsar.client.admin.Functions
+
+
Fetch the current state associated with a Pulsar Function.
+
+
getFunctionStateAsync(String, String, String, String) - Method in interface org.apache.pulsar.client.admin.Functions
+
+
Fetch the current state associated with a Pulsar Function asynchronously.
+
+
getFunctionStats(String, String, String) - Method in interface org.apache.pulsar.client.admin.Functions
+
+
Gets the current stats of a function.
+
+
getFunctionStats(String, String, String, int) - Method in interface org.apache.pulsar.client.admin.Functions
+
+
Gets the current stats of a function instance.
+
+
getFunctionStatsAsync(String, String, String) - Method in interface org.apache.pulsar.client.admin.Functions
+
+
Gets the current stats of a function asynchronously.
+
+
getFunctionStatsAsync(String, String, String, int) - Method in interface org.apache.pulsar.client.admin.Functions
+
+
Gets the current stats of a function instance asynchronously.
+
+
getFunctionStatus(String, String, String) - Method in interface org.apache.pulsar.client.admin.Functions
+
+
Gets the current status of a function.
+
+
getFunctionStatus(String, String, String, int) - Method in interface org.apache.pulsar.client.admin.Functions
+
+
Gets the current status of a function instance.
+
+
getFunctionStatusAsync(String, String, String) - Method in interface org.apache.pulsar.client.admin.Functions
+
+
Gets the current status of a function asynchronously.
+
+
getFunctionStatusAsync(String, String, String, int) - Method in interface org.apache.pulsar.client.admin.Functions
+
+
Gets the current status of a function instance asynchronously.
+
+
getGcsManagedLedgerOffloadBucket() - Method in interface org.apache.pulsar.common.policies.data.OffloadPolicies
+
 
+
getGcsManagedLedgerOffloadMaxBlockSizeInBytes() - Method in interface org.apache.pulsar.common.policies.data.OffloadPolicies
+
 
+
getGcsManagedLedgerOffloadReadBufferSizeInBytes() - Method in interface org.apache.pulsar.common.policies.data.OffloadPolicies
+
 
+
getGcsManagedLedgerOffloadRegion() - Method in interface org.apache.pulsar.common.policies.data.OffloadPolicies
+
 
+
getGcsManagedLedgerOffloadServiceAccountKeyFile() - Method in interface org.apache.pulsar.common.policies.data.OffloadPolicies
+
 
+
getHash() - Method in interface org.apache.pulsar.common.policies.data.DrainingHash
+
+
Get the sticky key hash value of the draining hash.
+
+
getHostname() - Method in interface org.apache.pulsar.common.policies.data.BookieInfo
+
 
+
getHttpError() - Method in exception class org.apache.pulsar.client.admin.PulsarAdminException
+
 
+
getInactiveTopicPolicies(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get the inactive deletion strategy for all topics within a namespace synchronously.
+
+
getInactiveTopicPolicies(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
get inactive topic policies of a topic.
+
+
getInactiveTopicPolicies(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getInactiveTopicPolicies(String) instead.
+
+
+
getInactiveTopicPolicies(String, boolean) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Get inactive topic policies applied for a topic.
+
+
getInactiveTopicPolicies(String, boolean) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getInactiveTopicPolicies(String, boolean) instead.
+
+
+
getInactiveTopicPoliciesAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get the inactive deletion strategy for all topics within a namespace asynchronously.
+
+
getInactiveTopicPoliciesAsync(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
get inactive topic policies of a topic asynchronously.
+
+
getInactiveTopicPoliciesAsync(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getInactiveTopicPoliciesAsync(String) instead.
+
+
+
getInactiveTopicPoliciesAsync(String, boolean) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Get inactive topic policies applied for a topic asynchronously.
+
+
getInactiveTopicPoliciesAsync(String, boolean) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getInactiveTopicPoliciesAsync(String, boolean) instead.
+
+
+
getInboundConnectedSince() - Method in interface org.apache.pulsar.common.policies.data.ReplicatorStats
+
+
Timestamp of incoming connection establishment time.
+
+
getInboundConnection() - Method in interface org.apache.pulsar.common.policies.data.ReplicatorStats
+
+
Address of incoming replication connection.
+
+
getInstanceId() - Method in interface org.apache.pulsar.common.policies.data.FunctionInstanceStats
+
 
+
getInstances() - Method in interface org.apache.pulsar.common.policies.data.FunctionStats
+
 
+
getInternalConfigurationData() - Method in interface org.apache.pulsar.client.admin.Brokers
+
+
Get the internal configuration data.
+
+
getInternalConfigurationDataAsync() - Method in interface org.apache.pulsar.client.admin.Brokers
+
+
Get the internal configuration data asynchronously.
+
+
getInternalInfo(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Get a JSON representation of the topic metadata stored in ZooKeeper.
+
+
getInternalInfoAsync(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Get a JSON representation of the topic metadata stored in ZooKeeper.
+
+
getInternalStats(String) - Method in interface org.apache.pulsar.client.admin.NonPersistentTopics
+
+
Deprecated.
+
Get the internal stats for the topic.
+
+
getInternalStats(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Get the internal stats for the topic.
+
+
getInternalStats(String, boolean) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Get the internal stats for the topic.
+
+
getInternalStatsAsync(String) - Method in interface org.apache.pulsar.client.admin.NonPersistentTopics
+
+
Deprecated.
+
Get the internal stats for the topic asynchronously.
+
+
getInternalStatsAsync(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Get the internal stats for the topic asynchronously.
+
+
getInternalStatsAsync(String, boolean) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Get the internal stats for the topic asynchronously.
+
+
getIsAllowAutoUpdateSchema(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get whether allow auto update schema.
+
+
getIsAllowAutoUpdateSchemaAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get whether allow auto update schema asynchronously.
+
+
getKeyHashRangeArrays() - Method in interface org.apache.pulsar.common.policies.data.ConsumerStats
+
+
Hash ranges assigned to this consumer if in Key_Shared subscription mode.
+
+
getKeyHashRanges() - Method in interface org.apache.pulsar.common.policies.data.ConsumerStats
+
+
Deprecated.
+
+
getKeySharedMode() - Method in interface org.apache.pulsar.common.policies.data.SubscriptionStats
+
+
Whether the Key_Shared subscription mode is AUTO_SPLIT or STICKY.
+
+
getLastAckedTimestamp() - Method in interface org.apache.pulsar.common.policies.data.ConsumerStats
+
 
+
getLastAckedTimestamp() - Method in interface org.apache.pulsar.common.policies.data.SubscriptionStats
+
+
Last acked message timestamp.
+
+
getLastCompactionDurationTimeInMills() - Method in interface org.apache.pulsar.common.policies.data.CompactionStats
+
+
The duration time of last compaction.
+
+
getLastCompactionFailedTimestamp() - Method in interface org.apache.pulsar.common.policies.data.CompactionStats
+
+
The timestamp of last failed compaction.
+
+
getLastCompactionRemovedEventCount() - Method in interface org.apache.pulsar.common.policies.data.CompactionStats
+
+
The removed event count of last compaction.
+
+
getLastCompactionSucceedTimestamp() - Method in interface org.apache.pulsar.common.policies.data.CompactionStats
+
+
The timestamp of last succeed compaction.
+
+
getLastConsumedFlowTimestamp() - Method in interface org.apache.pulsar.common.policies.data.ConsumerStats
+
 
+
getLastConsumedFlowTimestamp() - Method in interface org.apache.pulsar.common.policies.data.SubscriptionStats
+
+
Last received consume flow command timestamp.
+
+
getLastConsumedTimestamp() - Method in interface org.apache.pulsar.common.policies.data.ConsumerStats
+
 
+
getLastConsumedTimestamp() - Method in interface org.apache.pulsar.common.policies.data.SubscriptionStats
+
+
Last consume message timestamp.
+
+
getLastError() - Method in interface org.apache.pulsar.client.admin.OffloadProcessStatus
+
 
+
getLastExpireTimestamp() - Method in interface org.apache.pulsar.common.policies.data.SubscriptionStats
+
+
Last message expire execution timestamp.
+
+
getLastInvocation() - Method in interface org.apache.pulsar.common.policies.data.FunctionInstanceStatsData
+
 
+
getLastInvocation() - Method in interface org.apache.pulsar.common.policies.data.FunctionStats
+
 
+
getLastMarkDeleteAdvancedTimestamp() - Method in interface org.apache.pulsar.common.policies.data.SubscriptionStats
+
+
Last MarkDelete position advanced timesetamp.
+
+
getLastMessageId(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Get the last commit message Id of a topic.
+
+
getLastMessageIdAsync(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Get the last commit message Id of a topic asynchronously.
+
+
getLastUpdate() - Method in interface org.apache.pulsar.policies.data.loadbalancer.LoadManagerReport
+
 
+
getLeaderBroker() - Method in interface org.apache.pulsar.client.admin.Brokers
+
+
Get the information of the leader broker.
+
+
getLeaderBrokerAsync() - Method in interface org.apache.pulsar.client.admin.Brokers
+
+
Get the service url of the leader broker asynchronously.
+
+
getLedgersRootPath() - Method in class org.apache.pulsar.common.conf.InternalConfigurationData
+
+
Deprecated. 
+
+
getLimit() - Method in interface org.apache.pulsar.common.policies.data.BacklogQuota
+
+
Deprecated.
+
+
getLimit() - Method in class org.apache.pulsar.common.policies.data.impl.BacklogQuotaImpl
+
+
Deprecated.
+
+
getLimitSize() - Method in interface org.apache.pulsar.common.policies.data.BacklogQuota
+
+
Gets quota limit in size.
+
+
getLimitSize() - Method in class org.apache.pulsar.common.policies.data.impl.BacklogQuotaImpl
+
 
+
getLimitTime() - Method in interface org.apache.pulsar.common.policies.data.BacklogQuota
+
+
Gets quota limit in time.
+
+
getLimitTime() - Method in class org.apache.pulsar.common.policies.data.impl.BacklogQuotaImpl
+
 
+
getList(String) - Method in interface org.apache.pulsar.client.admin.NonPersistentTopics
+
+
Deprecated.
+
Get list of topics exist into given namespace.
+
+
getList(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Get the both persistent and non-persistent topics under a namespace.
+
+
getList(String, TopicDomain) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Get the list of topics under a namespace.
+
+
getList(String, TopicDomain, Map<Topics.QueryParam, Object>) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
use Topics.getList(String, TopicDomain, ListTopicsOptions) instead.
+
+
+
getList(String, TopicDomain, ListTopicsOptions) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Get the list of topics under a namespace.
+
+
getListAsync(String) - Method in interface org.apache.pulsar.client.admin.NonPersistentTopics
+
+
Deprecated.
+
Get list of topics exist into given namespace asynchronously.
+
+
getListAsync(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Get both persistent and non-persistent topics under a namespace asynchronously.
+
+
getListAsync(String, TopicDomain) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Get the list of topics under a namespace asynchronously.
+
+
getListAsync(String, TopicDomain, Map<Topics.QueryParam, Object>) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
use Topics.getListAsync(String, TopicDomain, ListTopicsOptions) instead.
+
+
+
getListAsync(String, TopicDomain, ListTopicsOptions) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Get the list of topics under a namespace asynchronously.
+
+
getListenerName() - Method in interface org.apache.pulsar.common.policies.data.ClusterData
+
 
+
getListInBundle(String, String) - Method in interface org.apache.pulsar.client.admin.NonPersistentTopics
+
+
Deprecated.
+
Get list of topics exist into given bundle.
+
+
getListInBundle(String, String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Get list of topics exist into given bundle.
+
+
getListInBundleAsync(String, String) - Method in interface org.apache.pulsar.client.admin.NonPersistentTopics
+
+
Deprecated.
+
Get list of topics exist into given bundle asynchronously.
+
+
getListInBundleAsync(String, String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Get list of topics exist into given bundle asynchronously.
+
+
getLoadFactor() - Method in interface org.apache.pulsar.common.policies.data.BrokerStatus
+
 
+
getLoadManagerClassName() - Method in interface org.apache.pulsar.policies.data.loadbalancer.ServiceLookupData
+
 
+
getLoadReport() - Method in interface org.apache.pulsar.client.admin.BrokerStats
+
+
Get load for this broker.
+
+
getLoadReportAsync() - Method in interface org.apache.pulsar.client.admin.BrokerStats
+
+
Get load for this broker asynchronously.
+
+
getManagedLedgerMaxMarkDeleteRate() - Method in class org.apache.pulsar.common.policies.data.PersistencePolicies
+
 
+
getManagedLedgerOffloadBucket() - Method in interface org.apache.pulsar.common.policies.data.OffloadPolicies
+
 
+
getManagedLedgerOffloadDeletionLagInMillis() - Method in interface org.apache.pulsar.common.policies.data.OffloadPolicies
+
 
+
getManagedLedgerOffloadDriver() - Method in interface org.apache.pulsar.common.policies.data.OffloadPolicies
+
 
+
getManagedLedgerOffloadedReadPriority() - Method in interface org.apache.pulsar.common.policies.data.OffloadPolicies
+
 
+
getManagedLedgerOffloadMaxBlockSizeInBytes() - Method in interface org.apache.pulsar.common.policies.data.OffloadPolicies
+
 
+
getManagedLedgerOffloadMaxThreads() - Method in interface org.apache.pulsar.common.policies.data.OffloadPolicies
+
 
+
getManagedLedgerOffloadPrefetchRounds() - Method in interface org.apache.pulsar.common.policies.data.OffloadPolicies
+
 
+
getManagedLedgerOffloadReadBufferSizeInBytes() - Method in interface org.apache.pulsar.common.policies.data.OffloadPolicies
+
 
+
getManagedLedgerOffloadRegion() - Method in interface org.apache.pulsar.common.policies.data.OffloadPolicies
+
 
+
getManagedLedgerOffloadServiceEndpoint() - Method in interface org.apache.pulsar.common.policies.data.OffloadPolicies
+
 
+
getManagedLedgerOffloadThresholdInBytes() - Method in interface org.apache.pulsar.common.policies.data.OffloadPolicies
+
 
+
getManagedLedgerOffloadThresholdInSeconds() - Method in interface org.apache.pulsar.common.policies.data.OffloadPolicies
+
 
+
getManagedLedgerStorageClassName() - Method in class org.apache.pulsar.common.policies.data.PersistencePolicies
+
 
+
getMaxConsumers(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Get the max number of consumer for specified topic.
+
+
getMaxConsumers(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getMaxConsumers(String) instead.
+
+
+
getMaxConsumers(String, boolean) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Get the max number of consumer applied for specified topic.
+
+
getMaxConsumers(String, boolean) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getMaxConsumers(String, boolean) instead.
+
+
+
getMaxConsumersAsync(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Get the max number of consumer for specified topic asynchronously.
+
+
getMaxConsumersAsync(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getMaxConsumersAsync(String) instead.
+
+
+
getMaxConsumersAsync(String, boolean) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Get the max number of consumer applied for specified topic asynchronously.
+
+
getMaxConsumersAsync(String, boolean) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getMaxConsumersAsync(String, boolean) instead.
+
+
+
getMaxConsumersPerSubscription(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get the maxConsumersPerSubscription for a namespace.
+
+
getMaxConsumersPerSubscription(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Get the maxConsumersPerSubscription for a topic.
+
+
getMaxConsumersPerSubscription(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getMaxConsumersPerSubscription(String) instead.
+
+
+
getMaxConsumersPerSubscriptionAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get the maxConsumersPerSubscription for a namespace asynchronously.
+
+
getMaxConsumersPerSubscriptionAsync(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Get the maxConsumersPerSubscription for a topic asynchronously.
+
+
getMaxConsumersPerSubscriptionAsync(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getMaxConsumersPerSubscriptionAsync(String) instead.
+
+
+
getMaxConsumersPerTopic(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get the maxProducersPerTopic for a namespace.
+
+
getMaxConsumersPerTopicAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get the maxProducersPerTopic for a namespace asynchronously.
+
+
getMaxDeliveryDelayInMillis() - Method in interface org.apache.pulsar.common.policies.data.DelayedDeliveryPolicies
+
 
+
getMaxMessageSize(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Get the max message size for specified topic.
+
+
getMaxMessageSize(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getMaxMessageSize(String) instead.
+
+
+
getMaxMessageSizeAsync(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Get the max message size for specified topic asynchronously.
+
+
getMaxMessageSizeAsync(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getMaxMessageSizeAsync(String) instead.
+
+
+
getMaxProducers(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Get the max number of producer for specified topic.
+
+
getMaxProducers(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getMaxProducers(String) instead.
+
+
+
getMaxProducers(String, boolean) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Get the max number of producer applied for specified topic.
+
+
getMaxProducers(String, boolean) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getMaxProducers(String, boolean) instead.
+
+
+
getMaxProducersAsync(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Get the max number of producer for specified topic asynchronously.
+
+
getMaxProducersAsync(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getMaxProducersAsync(String) instead.
+
+
+
getMaxProducersAsync(String, boolean) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Get the max number of producer applied for specified topic asynchronously.
+
+
getMaxProducersAsync(String, boolean) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getMaxProducersAsync(String, boolean) instead.
+
+
+
getMaxProducersPerTopic(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get the maxProducersPerTopic for a namespace.
+
+
getMaxProducersPerTopicAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get the maxProducersPerTopic for a namespace asynchronously.
+
+
getMaxSubscriptionsPerTopic(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get the maxSubscriptionsPerTopic for a namespace.
+
+
getMaxSubscriptionsPerTopic(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Get the max number of subscriptions for specified topic.
+
+
getMaxSubscriptionsPerTopic(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getMaxSubscriptionsPerTopic(String) instead.
+
+
+
getMaxSubscriptionsPerTopicAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get the maxSubscriptionsPerTopic for a namespace asynchronously.
+
+
getMaxSubscriptionsPerTopicAsync(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Get the max number of subscriptions for specified topic asynchronously.
+
+
getMaxSubscriptionsPerTopicAsync(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getMaxSubscriptionsPerTopicAsync(String) instead.
+
+
+
getMaxTopicsPerNamespace(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get maxTopicsPerNamespace for a namespace.
+
+
getMaxTopicsPerNamespaceAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get maxTopicsPerNamespace for a namespace asynchronously.
+
+
getMaxUnackedMessagesOnConsumer(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Get max unacked messages on a consumer of a topic.
+
+
getMaxUnackedMessagesOnConsumer(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getMaxUnackedMessagesOnConsumer(String) instead.
+
+
+
getMaxUnackedMessagesOnConsumer(String, boolean) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
get applied max unacked messages on consumer of a topic.
+
+
getMaxUnackedMessagesOnConsumer(String, boolean) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getMaxUnackedMessagesOnConsumer(String, boolean) instead.
+
+
+
getMaxUnackedMessagesOnConsumerAsync(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
get max unacked messages on consumer of a topic asynchronously.
+
+
getMaxUnackedMessagesOnConsumerAsync(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getMaxUnackedMessagesOnConsumerAsync(String) instead.
+
+
+
getMaxUnackedMessagesOnConsumerAsync(String, boolean) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
get applied max unacked messages on consumer of a topic asynchronously.
+
+
getMaxUnackedMessagesOnConsumerAsync(String, boolean) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getMaxUnackedMessagesOnConsumerAsync(String, boolean) instead.
+
+
+
getMaxUnackedMessagesOnSubscription(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
get max unacked messages on subscription of a topic.
+
+
getMaxUnackedMessagesOnSubscription(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getMaxUnackedMessagesOnSubscription(String) instead.
+
+
+
getMaxUnackedMessagesOnSubscription(String, boolean) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
get max unacked messages on subscription of a topic.
+
+
getMaxUnackedMessagesOnSubscription(String, boolean) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getMaxUnackedMessagesOnSubscriptionAsync(String, boolean) instead.
+
+
+
getMaxUnackedMessagesOnSubscriptionAsync(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
get max unacked messages on subscription of a topic asynchronously.
+
+
getMaxUnackedMessagesOnSubscriptionAsync(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getMaxUnackedMessagesOnSubscriptionAsync(String) instead.
+
+
+
getMaxUnackedMessagesOnSubscriptionAsync(String, boolean) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
get max unacked messages on subscription of a topic asynchronously.
+
+
getMaxUnackedMessagesOnSubscriptionAsync(String, boolean) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getMaxUnackedMessagesOnSubscriptionAsync(String, boolean) instead.
+
+
+
getMaxUnackedMessagesPerConsumer(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get the maxUnackedMessagesPerConsumer for a namespace.
+
+
getMaxUnackedMessagesPerConsumerAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get the maxUnackedMessagesPerConsumer for a namespace asynchronously.
+
+
getMaxUnackedMessagesPerSubscription(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get the maxUnackedMessagesPerSubscription for a namespace.
+
+
getMaxUnackedMessagesPerSubscriptionAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get the maxUnackedMessagesPerSubscription for a namespace asynchronously.
+
+
getMBeans() - Method in interface org.apache.pulsar.client.admin.BrokerStats
+
+
Requests JSON string server mbean dump.
+
+
getMBeansAsync() - Method in interface org.apache.pulsar.client.admin.BrokerStats
+
+
Requests JSON string server mbean dump asynchronously.
+
+
getMemory() - Method in interface org.apache.pulsar.policies.data.loadbalancer.LoadManagerReport
+
 
+
getMessageAckRate() - Method in interface org.apache.pulsar.common.policies.data.ConsumerStats
+
+
Total rate of message ack(msg/s).
+
+
getMessageAckRate() - Method in interface org.apache.pulsar.common.policies.data.SubscriptionStats
+
+
Total rate of message ack(msg/s).
+
+
getMessageById(String, long, long) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Using Topics.getMessagesById(String, long, long) instead.
+
+
+
getMessageByIdAsync(String, long, long) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Using Topics.getMessagesByIdAsync(String, long, long) instead.
+
+
+
getMessageIdByTimestamp(String, long) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Get message ID published at or just after this absolute timestamp (in ms).
+
+
getMessageIdByTimestampAsync(String, long) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Get message ID published at or just after this absolute timestamp (in ms) asynchronously.
+
+
getMessagesById(String, long, long) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Get the messages by messageId.
+
+
getMessagesByIdAsync(String, long, long) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Get the messages by messageId asynchronously.
+
+
getMessageTTL(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Get message TTL for a topic.
+
+
getMessageTTL(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getMessageTTL(String) instead.
+
+
+
getMessageTTL(String, boolean) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Get message TTL applied for a topic.
+
+
getMessageTTL(String, boolean) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getMessageTTL(String, boolean) instead.
+
+
+
getMetadata() - Method in interface org.apache.pulsar.common.policies.data.ConsumerStats
+
+
Metadata (key/value strings) associated with this consumer.
+
+
getMetadata() - Method in interface org.apache.pulsar.common.policies.data.PartitionedTopicStats
+
 
+
getMetadata() - Method in interface org.apache.pulsar.common.policies.data.PublisherStats
+
+
Metadata (key/value strings) associated with this publisher.
+
+
getMetadata(String) - Method in interface org.apache.pulsar.client.admin.Packages
+
+
Get a package metadata information.
+
+
getMetadataAsync(String) - Method in interface org.apache.pulsar.client.admin.Packages
+
+
Get a package metadata information asynchronously.
+
+
getMetadataStoreUrl() - Method in class org.apache.pulsar.common.conf.InternalConfigurationData
+
 
+
getMetrics() - Method in interface org.apache.pulsar.client.admin.BrokerStats
+
+
Returns Monitoring metrics.
+
+
getMetrics() - Method in interface org.apache.pulsar.client.admin.Worker
+
+
Get worker metrics.
+
+
getMetrics() - Method in interface org.apache.pulsar.common.policies.data.FunctionInstanceStats
+
 
+
getMetrics() - Method in class org.apache.pulsar.common.stats.Metrics
+
 
+
getMetricsAsync() - Method in interface org.apache.pulsar.client.admin.BrokerStats
+
+
Returns Monitoring metrics asynchronously.
+
+
getMetricsAsync() - Method in interface org.apache.pulsar.client.admin.Worker
+
+
Get worker metrics asynchronously.
+
+
getMigratedClusterUrl() - Method in interface org.apache.pulsar.common.policies.data.ClusterPolicies
+
 
+
getMsgBacklog() - Method in interface org.apache.pulsar.common.policies.data.SubscriptionStats
+
+
Number of entries in the subscription backlog.
+
+
getMsgBacklogNoDelayed() - Method in interface org.apache.pulsar.common.policies.data.SubscriptionStats
+
+
Number of entries in the subscription backlog that do not contain the delay messages.
+
+
getMsgDelayed() - Method in interface org.apache.pulsar.common.policies.data.SubscriptionStats
+
+
Number of delayed messages currently being tracked.
+
+
getMsgDropCount() - Method in interface org.apache.pulsar.common.policies.data.NonPersistentReplicatorStats
+
+
Total number of messages dropped by the broker for the replicator.
+
+
getMsgDropRate() - Method in interface org.apache.pulsar.common.policies.data.NonPersistentPublisherStats
+
+
for non-persistent topic: broker drops msg if publisher publishes messages more than configured max inflight + messages per connection.
+
+
getMsgDropRate() - Method in interface org.apache.pulsar.common.policies.data.NonPersistentReplicatorStats
+
+
for non-persistent topic: broker drops msg for replicator if replicator connection is not writable.
+
+
getMsgDropRate() - Method in interface org.apache.pulsar.common.policies.data.NonPersistentSubscriptionStats
+
+
for non-persistent topic: broker drops msg for subscription if none of the consumer available for message + delivery.
+
+
getMsgDropRate() - Method in interface org.apache.pulsar.common.policies.data.NonPersistentTopicStats
+
+
for non-persistent topic: broker drops msg if publisher publishes messages more than configured max inflight + messages per connection.
+
+
getMsgExpiredCount() - Method in interface org.apache.pulsar.common.policies.data.ReplicatorStats
+
+
Total number of messages expired.
+
+
getMsgInCount() - Method in interface org.apache.pulsar.common.policies.data.ReplicatorStats
+
+
Total number of messages received from the remote cluster.
+
+
getMsgInCounter() - Method in interface org.apache.pulsar.common.policies.data.TopicStats
+
+
Total messages published to the topic (msg).
+
+
getMsgInReplay() - Method in interface org.apache.pulsar.common.policies.data.SubscriptionStats
+
+
Number of messages registered for replay.
+
+
getMsgOutCount() - Method in interface org.apache.pulsar.common.policies.data.ReplicatorStats
+
+
Total number of messages sent to the remote cluster.
+
+
getMsgOutCounter() - Method in interface org.apache.pulsar.common.policies.data.ConsumerStats
+
+
Total messages delivered to consumer (msg).
+
+
getMsgOutCounter() - Method in interface org.apache.pulsar.common.policies.data.SubscriptionStats
+
+
Total messages delivered to consumer (msg).
+
+
getMsgOutCounter() - Method in interface org.apache.pulsar.common.policies.data.TopicStats
+
+
Total messages delivered to consumer (msg).
+
+
getMsgRateExpired() - Method in interface org.apache.pulsar.common.policies.data.ReplicatorStats
+
+
Deprecated.
+
+
getMsgRateExpired() - Method in interface org.apache.pulsar.common.policies.data.SubscriptionStats
+
+
Total rate of messages expired on this subscription (msg/s).
+
+
getMsgRateIn() - Method in interface org.apache.pulsar.common.policies.data.PublisherStats
+
+
Total rate of messages published by this publisher (msg/s).
+
+
getMsgRateIn() - Method in interface org.apache.pulsar.common.policies.data.ReplicatorStats
+
+
Deprecated.
+
+
getMsgRateIn() - Method in interface org.apache.pulsar.common.policies.data.TopicStats
+
+
Total rate of messages published on the topic (msg/s).
+
+
getMsgRateIn() - Method in interface org.apache.pulsar.policies.data.loadbalancer.LoadManagerReport
+
 
+
getMsgRateOut() - Method in interface org.apache.pulsar.common.policies.data.ConsumerStats
+
+
Total rate of messages delivered to the consumer (msg/s).
+
+
getMsgRateOut() - Method in interface org.apache.pulsar.common.policies.data.ReplicatorStats
+
+
Deprecated.
+
+
getMsgRateOut() - Method in interface org.apache.pulsar.common.policies.data.SubscriptionStats
+
+
Total rate of messages delivered on this subscription (msg/s).
+
+
getMsgRateOut() - Method in interface org.apache.pulsar.common.policies.data.TopicStats
+
+
Total rate of messages dispatched for the topic (msg/s).
+
+
getMsgRateOut() - Method in interface org.apache.pulsar.policies.data.loadbalancer.LoadManagerReport
+
 
+
getMsgRateRedeliver() - Method in interface org.apache.pulsar.common.policies.data.ConsumerStats
+
+
Total rate of messages redelivered by this consumer (msg/s).
+
+
getMsgRateRedeliver() - Method in interface org.apache.pulsar.common.policies.data.SubscriptionStats
+
+
Total rate of messages redelivered on this subscription (msg/s).
+
+
getMsgThroughputIn() - Method in interface org.apache.pulsar.common.policies.data.PublisherStats
+
+
Total throughput of messages published by this publisher (byte/s).
+
+
getMsgThroughputIn() - Method in interface org.apache.pulsar.common.policies.data.ReplicatorStats
+
+
Deprecated.
+
+
getMsgThroughputIn() - Method in interface org.apache.pulsar.common.policies.data.TopicStats
+
+
Total throughput of messages published on the topic (byte/s).
+
+
getMsgThroughputIn() - Method in interface org.apache.pulsar.policies.data.loadbalancer.LoadManagerReport
+
 
+
getMsgThroughputOut() - Method in interface org.apache.pulsar.common.policies.data.ConsumerStats
+
+
Total throughput delivered to the consumer (bytes/s).
+
+
getMsgThroughputOut() - Method in interface org.apache.pulsar.common.policies.data.ReplicatorStats
+
+
Deprecated.
+
+
getMsgThroughputOut() - Method in interface org.apache.pulsar.common.policies.data.SubscriptionStats
+
+
Total throughput delivered on this subscription (bytes/s).
+
+
getMsgThroughputOut() - Method in interface org.apache.pulsar.common.policies.data.TopicStats
+
+
Total throughput of messages dispatched for the topic (byte/s).
+
+
getMsgThroughputOut() - Method in interface org.apache.pulsar.policies.data.loadbalancer.LoadManagerReport
+
 
+
getNamespaceAllowedClusters(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get the allowed clusters for a namespace.
+
+
getNamespaceAllowedClustersAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get the allowed clusters for a namespace asynchronously.
+
+
getNamespaceAntiAffinityGroup(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get anti-affinity group name for a namespace.
+
+
getNamespaceAntiAffinityGroupAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get anti-affinity group name for a namespace asynchronously.
+
+
getNamespaceAuthentication() - Method in interface org.apache.pulsar.common.policies.data.AuthPolicies
+
 
+
getNamespaceBundleResourceQuota(String, String) - Method in interface org.apache.pulsar.client.admin.ResourceQuotas
+
+
Get resource quota of a namespace bundle.
+
+
getNamespaceBundleResourceQuotaAsync(String, String) - Method in interface org.apache.pulsar.client.admin.ResourceQuotas
+
+
Get resource quota of a namespace bundle asynchronously.
+
+
getNamespaceEntryFilters(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get entry filters for a namespace.
+
+
getNamespaceEntryFiltersAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get entry filters for a namespace asynchronously.
+
+
getNamespaceIsolationPolicies(String) - Method in interface org.apache.pulsar.client.admin.Clusters
+
+
Get the namespace isolation policies of a cluster.
+
+
getNamespaceIsolationPoliciesAsync(String) - Method in interface org.apache.pulsar.client.admin.Clusters
+
+
Get the namespace isolation policies of a cluster asynchronously.
+
+
getNamespaceIsolationPolicy(String, String) - Method in interface org.apache.pulsar.client.admin.Clusters
+
+
Get a single namespace isolation policy for a cluster.
+
+
getNamespaceIsolationPolicyAsync(String, String) - Method in interface org.apache.pulsar.client.admin.Clusters
+
+
Get a single namespace isolation policy for a cluster asynchronously.
+
+
getNamespaceMessageTTL(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get the message TTL for a namespace.
+
+
getNamespaceMessageTTLAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get the message TTL for a namespace asynchronously.
+
+
getNamespaceRegex() - Method in interface org.apache.pulsar.common.policies.data.BrokerNamespaceIsolationData
+
 
+
getNamespaceReplicationClusters(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get the replication clusters for a namespace.
+
+
getNamespaceReplicationClustersAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get the replication clusters for a namespace asynchronously.
+
+
getNamespaceResourceGroup(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get the ResourceGroup for a namespace.
+
+
getNamespaceResourceGroupAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get the ResourceGroup for a namespace asynchronously.
+
+
getNamespaces() - Method in interface org.apache.pulsar.common.policies.data.NamespaceIsolationData
+
 
+
getNamespaces(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get the list of namespaces.
+
+
getNamespaces(String, String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Deprecated.
+
+
getNamespacesAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get the list of namespaces asynchronously.
+
+
getNonContiguousDeletedMessagesRanges() - Method in interface org.apache.pulsar.common.policies.data.SubscriptionStats
+
+
The number of non-contiguous deleted messages ranges.
+
+
getNonContiguousDeletedMessagesRanges() - Method in interface org.apache.pulsar.common.policies.data.TopicStats
+
+
The number of non-contiguous deleted messages ranges.
+
+
getNonContiguousDeletedMessagesRangesSerializedSize() - Method in interface org.apache.pulsar.common.policies.data.SubscriptionStats
+
+
The serialized size of non-contiguous deleted messages ranges.
+
+
getNonContiguousDeletedMessagesRangesSerializedSize() - Method in interface org.apache.pulsar.common.policies.data.TopicStats
+
+
The serialized size of non-contiguous deleted messages ranges.
+
+
getNumBundles() - Method in interface org.apache.pulsar.common.policies.data.BundlesData
+
 
+
getNumBundles() - Method in interface org.apache.pulsar.policies.data.loadbalancer.LoadManagerReport
+
 
+
getNumConsumers() - Method in interface org.apache.pulsar.policies.data.loadbalancer.LoadManagerReport
+
 
+
getNumProducers() - Method in interface org.apache.pulsar.policies.data.loadbalancer.LoadManagerReport
+
 
+
getNumTopics() - Method in interface org.apache.pulsar.policies.data.loadbalancer.LoadManagerReport
+
 
+
getOffloadDeleteLagMs(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get the offload deletion lag for a namespace, in milliseconds.
+
+
getOffloadDeleteLagMsAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get the offload deletion lag asynchronously for a namespace, in milliseconds.
+
+
getOffloadedStorageSize() - Method in interface org.apache.pulsar.common.policies.data.TopicStats
+
+
Space used to store the offloaded messages for the topic/.
+
+
getOffloadersDirectory() - Method in interface org.apache.pulsar.common.policies.data.OffloadPolicies
+
 
+
getOffloadPolicies(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get the offload configuration for a namespace.
+
+
getOffloadPolicies(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
get offload policies of a topic.
+
+
getOffloadPolicies(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getOffloadPolicies(String) instead.
+
+
+
getOffloadPolicies(String, boolean) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
get applied offload policies of a topic.
+
+
getOffloadPolicies(String, boolean) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getOffloadPolicies(String, boolean) instead.
+
+
+
getOffloadPoliciesAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get the offload configuration for a namespace asynchronously.
+
+
getOffloadPoliciesAsync(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
get offload policies of a topic asynchronously.
+
+
getOffloadPoliciesAsync(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getOffloadPoliciesAsync(String) instead.
+
+
+
getOffloadPoliciesAsync(String, boolean) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
get applied offload policies of a topic asynchronously.
+
+
getOffloadPoliciesAsync(String, boolean) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getOffloadPoliciesAsync(String, boolean) instead.
+
+
+
getOffloadThreshold(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get the offloadThreshold for a namespace.
+
+
getOffloadThresholdAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get the offloadThreshold for a namespace asynchronously.
+
+
getOffloadThresholdInSeconds(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get the offloadThresholdInSeconds for a namespace.
+
+
getOffloadThresholdInSecondsAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get the offloadThresholdInSeconds for a namespace.
+
+
getOldestBacklogMessageAgeSeconds() - Method in interface org.apache.pulsar.common.policies.data.TopicStats
+
+
Age of oldest unacknowledged message, as recorded in last backlog quota check interval.
+
+
getOldestBacklogMessageSubscriptionName() - Method in interface org.apache.pulsar.common.policies.data.TopicStats
+
+
The subscription name containing oldest unacknowledged message as recorded in last backlog quota check.
+
+
getOneMin() - Method in interface org.apache.pulsar.common.policies.data.FunctionInstanceStatsData
+
 
+
getOneMin() - Method in interface org.apache.pulsar.common.policies.data.FunctionStats
+
 
+
getOutboundConnectedSince() - Method in interface org.apache.pulsar.common.policies.data.ReplicatorStats
+
+
Timestamp of outbound connection establishment time.
+
+
getOutboundConnection() - Method in interface org.apache.pulsar.common.policies.data.ReplicatorStats
+
+
Address of outbound replication connection.
+
+
getOwnedNamespaces(String, String) - Method in interface org.apache.pulsar.client.admin.Brokers
+
+
Get the map of owned namespaces and their status from a single broker in the cluster.
+
+
getOwnedNamespacesAsync(String, String) - Method in interface org.apache.pulsar.client.admin.Brokers
+
+
Get the map of owned namespaces and their status from a single broker in the cluster asynchronously.
+
+
getOwnerBroker() - Method in interface org.apache.pulsar.common.policies.data.TopicStats
+
+
The broker that owns this topic.
+
+
getParameters() - Method in interface org.apache.pulsar.common.policies.data.AutoFailoverPolicyData
+
 
+
getPartitionedInternalStats(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Get the stats for the partitioned topic.
+
+
getPartitionedInternalStatsAsync(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Get the stats-internal for the partitioned topic asynchronously.
+
+
getPartitionedStats(String, boolean) - Method in interface org.apache.pulsar.client.admin.Topics
+
 
+
getPartitionedStats(String, boolean, boolean, boolean, boolean) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Get the stats for the partitioned topic
+
+
getPartitionedStats(String, boolean, GetStatsOptions) - Method in interface org.apache.pulsar.client.admin.Topics
+
 
+
getPartitionedStatsAsync(String, boolean) - Method in interface org.apache.pulsar.client.admin.Topics
+
 
+
getPartitionedStatsAsync(String, boolean, boolean, boolean, boolean) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Get the stats for the partitioned topic asynchronously.
+
+
getPartitionedStatsAsync(String, boolean, GetStatsOptions) - Method in interface org.apache.pulsar.client.admin.Topics
+
 
+
getPartitionedTopicList(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Get the list of partitioned topics under a namespace.
+
+
getPartitionedTopicList(String, ListTopicsOptions) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Get the list of partitioned topics under a namespace.
+
+
getPartitionedTopicListAsync(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Get the list of partitioned topics under a namespace asynchronously.
+
+
getPartitionedTopicListAsync(String, ListTopicsOptions) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Get the list of partitioned topics under a namespace asynchronously.
+
+
getPartitionedTopicMetadata(String) - Method in interface org.apache.pulsar.client.admin.NonPersistentTopics
+
+
Deprecated.
+
Get metadata of a partitioned topic.
+
+
getPartitionedTopicMetadata(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Get metadata of a partitioned topic.
+
+
getPartitionedTopicMetadataAsync(String) - Method in interface org.apache.pulsar.client.admin.NonPersistentTopics
+
+
Deprecated.
+
Get metadata of a partitioned topic asynchronously.
+
+
getPartitionedTopicMetadataAsync(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Get metadata of a partitioned topic asynchronously.
+
+
getPartitions() - Method in interface org.apache.pulsar.common.policies.data.NonPersistentPartitionedTopicStats
+
 
+
getPartitions() - Method in interface org.apache.pulsar.common.policies.data.PartitionedTopicStats
+
 
+
getPeerClusterNames() - Method in interface org.apache.pulsar.common.policies.data.ClusterData
+
 
+
getPeerClusterNames(String) - Method in interface org.apache.pulsar.client.admin.Clusters
+
+
Get peer-cluster names.
+
+
getPeerClusterNamesAsync(String) - Method in interface org.apache.pulsar.client.admin.Clusters
+
+
Get peer-cluster names asynchronously.
+
+
getPendingAckInternalStats(String, String, boolean) - Method in interface org.apache.pulsar.client.admin.Transactions
+
+
Get pending ack internal stats.
+
+
getPendingAckInternalStatsAsync(String, String, boolean) - Method in interface org.apache.pulsar.client.admin.Transactions
+
+
Get pending ack internal stats.
+
+
getPendingAckStats(String, String) - Method in interface org.apache.pulsar.client.admin.Transactions
+
+
Get transaction pending ack stats.
+
+
getPendingAckStats(String, String, boolean) - Method in interface org.apache.pulsar.client.admin.Transactions
+
+
Get transaction pending ack stats.
+
+
getPendingAckStatsAsync(String, String) - Method in interface org.apache.pulsar.client.admin.Transactions
+
+
Get transaction pending ack stats.
+
+
getPendingAckStatsAsync(String, String, boolean) - Method in interface org.apache.pulsar.client.admin.Transactions
+
+
Get transaction pending ack stats.
+
+
getPendingBookieOpsStats() - Method in interface org.apache.pulsar.client.admin.BrokerStats
+
+
Get pending bookie client op stats by namespace.
+
+
getPendingBookieOpsStatsAsync() - Method in interface org.apache.pulsar.client.admin.BrokerStats
+
+
Get pending bookie client op stats by namespace asynchronously.
+
+
getPermissionOnSubscription(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get permission to role to access subscription's admin-api.
+
+
getPermissionOnSubscriptionAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get permission to role to access subscription's admin-api asynchronously.
+
+
getPermissions(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get permissions on a namespace.
+
+
getPermissions(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Get permissions on a topic.
+
+
getPermissionsAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get permissions on a namespace asynchronously.
+
+
getPermissionsAsync(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Get permissions on a topic asynchronously.
+
+
getPersistence(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get the persistence configuration for a namespace.
+
+
getPersistence(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Get the configuration of persistence policies for specified topic.
+
+
getPersistence(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getPersistence(String) instead.
+
+
+
getPersistence(String, boolean) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Get the applied configuration of persistence policies for specified topic.
+
+
getPersistence(String, boolean) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getPersistence(String, boolean) instead.
+
+
+
getPersistenceAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get the persistence configuration for a namespace asynchronously.
+
+
getPersistenceAsync(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Get the configuration of persistence policies for specified topic asynchronously.
+
+
getPersistenceAsync(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getPersistenceAsync(String) instead.
+
+
+
getPersistenceAsync(String, boolean) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Get the applied configuration of persistence policies for specified topic asynchronously.
+
+
getPersistenceAsync(String, boolean) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getPersistenceAsync(String, boolean) instead.
+
+
+
getPolicies(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get policies for a namespace.
+
+
getPoliciesAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get policies for a namespace asynchronously.
+
+
getPolicy() - Method in interface org.apache.pulsar.common.policies.data.BacklogQuota
+
 
+
getPolicy() - Method in class org.apache.pulsar.common.policies.data.impl.BacklogQuotaImpl
+
 
+
getPolicyName() - Method in interface org.apache.pulsar.common.policies.data.BrokerNamespaceIsolationData
+
 
+
getPolicyType() - Method in interface org.apache.pulsar.common.policies.data.AutoFailoverPolicyData
+
 
+
getPositionStatsInPendingAck(String, String, Long, Long, Integer) - Method in interface org.apache.pulsar.client.admin.Transactions
+
+
Get the position stats in transaction pending ack.
+
+
getPositionStatsInPendingAckAsync(String, String, Long, Long, Integer) - Method in interface org.apache.pulsar.client.admin.Transactions
+
+
Get the position stats in transaction pending ack.
+
+
getPrimary() - Method in interface org.apache.pulsar.common.policies.data.NamespaceIsolationData
+
 
+
getProcessedSuccessfullyTotal() - Method in interface org.apache.pulsar.common.policies.data.FunctionInstanceStatsDataBase
+
 
+
getProcessedSuccessfullyTotal() - Method in interface org.apache.pulsar.common.policies.data.FunctionStats
+
 
+
getProducerId() - Method in interface org.apache.pulsar.common.policies.data.PublisherStats
+
+
Id of this publisher.
+
+
getProducerName() - Method in interface org.apache.pulsar.common.policies.data.PublisherStats
+
+
Producer name.
+
+
getProperties() - Method in interface org.apache.pulsar.client.admin.Properties
+
+
Deprecated.
+
Get the list of properties.
+
+
getProperties(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get all properties of a namespace.
+
+
getProperties(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Get properties of a topic.
+
+
getPropertiesAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get all properties of a namespace asynchronously.
+
+
getPropertiesAsync(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Get properties of a topic asynchronously.
+
+
getProperty(String, String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get property value for a given key.
+
+
getPropertyAdmin(String) - Method in interface org.apache.pulsar.client.admin.Properties
+
+
Deprecated.
+
Get the config of the property.
+
+
getPropertyAsync(String, String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get property value for a given key.
+
+
getProtocol(String) - Method in interface org.apache.pulsar.policies.data.loadbalancer.ServiceLookupData
+
+
Get the protocol data of the given protocol.
+
+
getProtocols() - Method in interface org.apache.pulsar.policies.data.loadbalancer.ServiceLookupData
+
+
Get all the protocols advertised by the broker.
+
+
getProxyProtocol() - Method in interface org.apache.pulsar.common.policies.data.ClusterData
+
 
+
getProxyServiceUrl() - Method in interface org.apache.pulsar.common.policies.data.ClusterData
+
 
+
getPublishers() - Method in interface org.apache.pulsar.common.policies.data.NonPersistentTopicStats
+
+
List of connected publishers on this topic w/ their stats.
+
+
getPublishers() - Method in interface org.apache.pulsar.common.policies.data.TopicStats
+
+
List of connected publishers on this topic w/ their stats.
+
+
getPublishRate(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get message-publish-rate (topics under this namespace can publish this many messages per second).
+
+
getPublishRate(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Get message-publish-rate (topics can publish this many messages per second).
+
+
getPublishRate(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getPublishRate(String) instead.
+
+
+
getPublishRateAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get message-publish-rate (topics under this namespace can publish this many messages per second) asynchronously.
+
+
getPublishRateAsync(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Get message-publish-rate (topics can publish this many messages per second) asynchronously.
+
+
getPublishRateAsync(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getPublishRateAsync(String) instead.
+
+
+
getPulsarServiceUrl() - Method in interface org.apache.pulsar.policies.data.loadbalancer.ServiceLookupData
+
 
+
getPulsarServiceUrlTls() - Method in interface org.apache.pulsar.policies.data.loadbalancer.ServiceLookupData
+
 
+
getRack() - Method in interface org.apache.pulsar.common.policies.data.BookieInfo
+
 
+
getRatePeriodInSecond() - Method in interface org.apache.pulsar.common.policies.data.DispatchRate
+
 
+
getReadPositionWhenJoining() - Method in interface org.apache.pulsar.common.policies.data.ConsumerStats
+
+
Deprecated.
+
+
getReceivedTotal() - Method in interface org.apache.pulsar.common.policies.data.FunctionInstanceStatsDataBase
+
 
+
getReceivedTotal() - Method in interface org.apache.pulsar.common.policies.data.FunctionStats
+
 
+
getReplicatedSubscriptionStatus(String, String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Get replicated subscription status on a topic.
+
+
getReplicatedSubscriptionStatusAsync(String, String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Get replicated subscription status on a topic asynchronously.
+
+
getReplication() - Method in interface org.apache.pulsar.common.policies.data.NonPersistentTopicStats
+
+
Map of replication statistics by remote cluster context.
+
+
getReplication() - Method in interface org.apache.pulsar.common.policies.data.TopicStats
+
+
Map of replication statistics by remote cluster context.
+
+
getReplicationBacklog() - Method in interface org.apache.pulsar.common.policies.data.ReplicatorStats
+
+
Number of messages pending to be replicated to remote cluster.
+
+
getReplicationClusters(String, boolean) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Get the replication clusters for a topic.
+
+
getReplicationClustersAsync(String, boolean) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Get the replication clusters for a topic asynchronously.
+
+
getReplicationConfigVersion(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get the replication configuration version for a given namespace.
+
+
getReplicationConfigVersionAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get the replication configuration version for a given namespace asynchronously.
+
+
getReplicationDelayInSeconds() - Method in interface org.apache.pulsar.common.policies.data.ReplicatorStats
+
+
Time in seconds from the time a message was produced to the time when it is about to be replicated.
+
+
getReplicatorDispatchRate(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get replicator-message-dispatch-rate.
+
+
getReplicatorDispatchRate(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Get replicatorDispatchRate for the topic.
+
+
getReplicatorDispatchRate(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getReplicatorDispatchRate(String) instead.
+
+
+
getReplicatorDispatchRate(String, boolean) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Get applied replicatorDispatchRate for the topic.
+
+
getReplicatorDispatchRate(String, boolean) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getReplicatorDispatchRate(String, boolean) instead.
+
+
+
getReplicatorDispatchRateAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get replicator-message-dispatch-rate asynchronously.
+
+
getReplicatorDispatchRateAsync(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Get replicatorDispatchRate asynchronously.
+
+
getReplicatorDispatchRateAsync(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getReplicatorDispatchRateAsync(String) instead.
+
+
+
getReplicatorDispatchRateAsync(String, boolean) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Get applied replicatorDispatchRate asynchronously.
+
+
getReplicatorDispatchRateAsync(String, boolean) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getReplicatorDispatchRateAsync(String, boolean) instead.
+
+
+
getResourceGroup(String) - Method in interface org.apache.pulsar.client.admin.ResourceGroups
+
+
Get configuration for a resourcegroup.
+
+
getResourceGroupAsync(String) - Method in interface org.apache.pulsar.client.admin.ResourceGroups
+
+
Get policies for a namespace asynchronously.
+
+
getResourceGroups() - Method in interface org.apache.pulsar.client.admin.ResourceGroups
+
+
Get the list of resourcegroups.
+
+
getResourceGroupsAsync() - Method in interface org.apache.pulsar.client.admin.ResourceGroups
+
+
Get the list of resourcegroups asynchronously.
+
+
getRetention(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get the retention configuration for a namespace.
+
+
getRetention(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Get the retention configuration for a topic.
+
+
getRetention(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getRetention(String) instead.
+
+
+
getRetention(String, boolean) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Get the applied retention configuration for a topic.
+
+
getRetention(String, boolean) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getRetention(String, boolean) instead.
+
+
+
getRetentionAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get the retention configuration for a namespace asynchronously.
+
+
getRetentionAsync(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Get the retention configuration for a topic asynchronously.
+
+
getRetentionAsync(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getRetentionAsync(String) instead.
+
+
+
getRetentionAsync(String, boolean) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Get the applied retention configuration for a topic asynchronously.
+
+
getRetentionAsync(String, boolean) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getRetentionAsync(String, boolean) instead.
+
+
+
getRetentionSizeInMB() - Method in class org.apache.pulsar.common.policies.data.RetentionPolicies
+
 
+
getRetentionTimeInMinutes() - Method in class org.apache.pulsar.common.policies.data.RetentionPolicies
+
 
+
getRuntimeConfigurations() - Method in interface org.apache.pulsar.client.admin.Brokers
+
+
Get values of runtime configuration.
+
+
getRuntimeConfigurationsAsync() - Method in interface org.apache.pulsar.client.admin.Brokers
+
+
Get values of runtime configuration asynchronously.
+
+
getS3ManagedLedgerOffloadBucket() - Method in interface org.apache.pulsar.common.policies.data.OffloadPolicies
+
 
+
getS3ManagedLedgerOffloadCredentialId() - Method in interface org.apache.pulsar.common.policies.data.OffloadPolicies
+
 
+
getS3ManagedLedgerOffloadCredentialSecret() - Method in interface org.apache.pulsar.common.policies.data.OffloadPolicies
+
 
+
getS3ManagedLedgerOffloadMaxBlockSizeInBytes() - Method in interface org.apache.pulsar.common.policies.data.OffloadPolicies
+
 
+
getS3ManagedLedgerOffloadReadBufferSizeInBytes() - Method in interface org.apache.pulsar.common.policies.data.OffloadPolicies
+
 
+
getS3ManagedLedgerOffloadRegion() - Method in interface org.apache.pulsar.common.policies.data.OffloadPolicies
+
 
+
getS3ManagedLedgerOffloadRole() - Method in interface org.apache.pulsar.common.policies.data.OffloadPolicies
+
 
+
getS3ManagedLedgerOffloadRoleSessionName() - Method in interface org.apache.pulsar.common.policies.data.OffloadPolicies
+
 
+
getS3ManagedLedgerOffloadServiceEndpoint() - Method in interface org.apache.pulsar.common.policies.data.OffloadPolicies
+
 
+
getSchemaAutoUpdateCompatibilityStrategy(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Deprecated.
+
+
getSchemaCompatibilityStrategy(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get the strategy used to check the a new schema provided by a producer is compatible with the current schema + before it is installed.
+
+
getSchemaCompatibilityStrategy(String, boolean) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Get schema compatibility strategy on a topic.
+
+
getSchemaCompatibilityStrategyAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get the strategy used to check the a new schema provided by a producer is compatible with the current schema + before it is installed asynchronously.
+
+
getSchemaCompatibilityStrategyAsync(String, boolean) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Get schema compatibility strategy on a topic asynchronously.
+
+
getSchemaInfo(String) - Method in interface org.apache.pulsar.client.admin.Schemas
+
+
Retrieve the latest schema of a topic.
+
+
getSchemaInfo(String, long) - Method in interface org.apache.pulsar.client.admin.Schemas
+
+
Retrieve the schema of a topic at a given version.
+
+
getSchemaInfoAsync(String) - Method in interface org.apache.pulsar.client.admin.Schemas
+
+
Retrieve the latest schema of a topic asynchronously.
+
+
getSchemaInfoAsync(String, long) - Method in interface org.apache.pulsar.client.admin.Schemas
+
+
Retrieve the schema of a topic at a given version asynchronously.
+
+
getSchemaInfoWithVersion(String) - Method in interface org.apache.pulsar.client.admin.Schemas
+
+
Retrieve the latest schema with verison of a topic.
+
+
getSchemaInfoWithVersionAsync(String) - Method in interface org.apache.pulsar.client.admin.Schemas
+
+
Retrieve the latest schema with verison of a topic asynchronously.
+
+
getSchemaMetadata(String) - Method in interface org.apache.pulsar.client.admin.Schemas
+
+
Get schema metadata of the topic.
+
+
getSchemaMetadataAsync(String) - Method in interface org.apache.pulsar.client.admin.Schemas
+
+
Get schema metadata of the topic asynchronously.
+
+
getSchemaValidationEnforced(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get schema validation enforced for namespace.
+
+
getSchemaValidationEnforced(String, boolean) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get schema validation enforced for namespace.
+
+
getSchemaValidationEnforced(String, boolean) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Get schema validation enforced for a topic.
+
+
getSchemaValidationEnforcedAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get schema validation enforced for namespace asynchronously.
+
+
getSchemaValidationEnforcedAsync(String, boolean) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get schema validation enforced for namespace asynchronously.
+
+
getSchemaValidationEnforcedAsync(String, boolean) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Get schema validation enforced for a topic asynchronously.
+
+
getSecondary() - Method in interface org.apache.pulsar.common.policies.data.NamespaceIsolationData
+
 
+
getServiceUrl() - Method in interface org.apache.pulsar.client.admin.PulsarAdmin
+
 
+
getServiceUrl() - Method in interface org.apache.pulsar.common.policies.data.BrokerInfo
+
 
+
getServiceUrl() - Method in interface org.apache.pulsar.common.policies.data.ClusterData
+
 
+
getServiceUrlTls() - Method in interface org.apache.pulsar.common.policies.data.ClusterData
+
 
+
getShadowSource(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Get the shadow source topic name of the given shadow topic.
+
+
getShadowSourceAsync(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Get the shadow source topic name of the given shadow topic asynchronously.
+
+
getShadowTopics(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Get shadow topic list of the source topic.
+
+
getShadowTopicsAsync(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Get shadow topic list of the source topic asynchronously.
+
+
getSink(String, String, String) - Method in interface org.apache.pulsar.client.admin.Sinks
+
+
Get the configuration for the specified sink.
+
+
getSinkAsync(String, String, String) - Method in interface org.apache.pulsar.client.admin.Sinks
+
+
Get the configuration for the specified sink asynchronously.
+
+
getSinks() - Method in interface org.apache.pulsar.client.admin.Functions
+
+
Deprecated.
+
+
getSinkStatus(String, String, String) - Method in interface org.apache.pulsar.client.admin.Sinks
+
+
Gets the current status of a sink.
+
+
getSinkStatus(String, String, String, int) - Method in interface org.apache.pulsar.client.admin.Sinks
+
+
Gets the current status of a sink instance.
+
+
getSinkStatusAsync(String, String, String) - Method in interface org.apache.pulsar.client.admin.Sinks
+
+
Gets the current status of a sink asynchronously.
+
+
getSinkStatusAsync(String, String, String, int) - Method in interface org.apache.pulsar.client.admin.Sinks
+
+
Gets the current status of a sink instance asynchronously.
+
+
getSlowTransactions(long, TimeUnit) - Method in interface org.apache.pulsar.client.admin.Transactions
+
+
Get slow transactions.
+
+
getSlowTransactionsAsync(long, TimeUnit) - Method in interface org.apache.pulsar.client.admin.Transactions
+
+
Get slow transactions.
+
+
getSlowTransactionsByCoordinatorId(Integer, long, TimeUnit) - Method in interface org.apache.pulsar.client.admin.Transactions
+
+
Get slow transactions by coordinator id.
+
+
getSlowTransactionsByCoordinatorIdAsync(Integer, long, TimeUnit) - Method in interface org.apache.pulsar.client.admin.Transactions
+
+
Get slow transactions by coordinator id.
+
+
getSource(String, String, String) - Method in interface org.apache.pulsar.client.admin.Sources
+
+
Get the configuration for the specified source.
+
+
getSourceAsync(String, String, String) - Method in interface org.apache.pulsar.client.admin.Sources
+
+
Get the configuration for the specified source asynchronously.
+
+
getSources() - Method in interface org.apache.pulsar.client.admin.Functions
+
+
Deprecated.
+
+
getSourceStatus(String, String, String) - Method in interface org.apache.pulsar.client.admin.Sources
+
+
Gets the current status of a source.
+
+
getSourceStatus(String, String, String, int) - Method in interface org.apache.pulsar.client.admin.Sources
+
+
Gets the current status of a source instance.
+
+
getSourceStatusAsync(String, String, String) - Method in interface org.apache.pulsar.client.admin.Sources
+
+
Gets the current status of a source asynchronously.
+
+
getSourceStatusAsync(String, String, String, int) - Method in interface org.apache.pulsar.client.admin.Sources
+
+
Gets the current status of a source instance asynchronously.
+
+
getStartTimestamp() - Method in interface org.apache.pulsar.policies.data.loadbalancer.ServiceLookupData
+
 
+
getStateStorageServiceUrl() - Method in class org.apache.pulsar.common.conf.InternalConfigurationData
+
 
+
getStats(String) - Method in interface org.apache.pulsar.client.admin.NonPersistentTopics
+
+
Deprecated.
+
Get the stats for the topic.
+
+
getStats(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
 
+
getStats(String, boolean) - Method in interface org.apache.pulsar.client.admin.Topics
+
 
+
getStats(String, boolean, boolean) - Method in interface org.apache.pulsar.client.admin.Topics
+
 
+
getStats(String, boolean, boolean, boolean) - Method in interface org.apache.pulsar.client.admin.Topics
+
 
+
getStats(String, GetStatsOptions) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Get the stats for the topic.
+
+
getStatsAsync(String) - Method in interface org.apache.pulsar.client.admin.NonPersistentTopics
+
+
Deprecated.
+
Get the stats for the topic asynchronously.
+
+
getStatsAsync(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
 
+
getStatsAsync(String, boolean, boolean, boolean) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Get the stats for the topic asynchronously.
+
+
getStatsAsync(String, GetStatsOptions) - Method in interface org.apache.pulsar.client.admin.Topics
+
 
+
GetStatsOptions - Class in org.apache.pulsar.client.admin
+
 
+
GetStatsOptions() - Constructor for class org.apache.pulsar.client.admin.GetStatsOptions
+
 
+
getStatus() - Method in interface org.apache.pulsar.client.admin.OffloadProcessStatus
+
 
+
getStatusCode() - Method in exception class org.apache.pulsar.client.admin.PulsarAdminException
+
 
+
getStorageSize() - Method in interface org.apache.pulsar.common.policies.data.TopicStats
+
+
Space used to store the messages for the topic (bytes).
+
+
getSubscribeRate(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get namespace-subscribe-rate (topics under this namespace allow subscribe times per consumer in a period).
+
+
getSubscribeRate(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Get topic-subscribe-rate (topics allow subscribe times per consumer in a period).
+
+
getSubscribeRate(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getSubscribeRate(String) instead.
+
+
+
getSubscribeRate(String, boolean) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Get applied topic-subscribe-rate (topics allow subscribe times per consumer in a period).
+
+
getSubscribeRate(String, boolean) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getSubscribeRate(String, boolean) instead.
+
+
+
getSubscribeRateAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get namespace-subscribe-rate asynchronously.
+
+
getSubscribeRateAsync(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Get topic-subscribe-rate asynchronously.
+
+
getSubscribeRateAsync(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getSubscribeRateAsync(String) instead.
+
+
+
getSubscribeRateAsync(String, boolean) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Get applied topic-subscribe-rate asynchronously.
+
+
getSubscribeRateAsync(String, boolean) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getSubscribeRateAsync(String, boolean) instead.
+
+
+
getSubscriptionAuthentication() - Method in interface org.apache.pulsar.common.policies.data.AuthPolicies
+
 
+
getSubscriptionAuthMode(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get the subscriptionAuthMode within a namespace.
+
+
getSubscriptionAuthModeAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get the subscriptionAuthMode within a namespace asynchronously.
+
+
getSubscriptionDispatchRate(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get subscription-message-dispatch-rate.
+
+
getSubscriptionDispatchRate(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Get subscription-message-dispatch-rate for the topic.
+
+
getSubscriptionDispatchRate(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getSubscriptionDispatchRate(String) instead.
+
+
+
getSubscriptionDispatchRate(String, boolean) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Get applied subscription-message-dispatch-rate.
+
+
getSubscriptionDispatchRate(String, boolean) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getSubscriptionDispatchRate(String, boolean) instead.
+
+
+
getSubscriptionDispatchRate(String, String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Get subscription level dispatch rate limiter setting for a specific subscription.
+
+
getSubscriptionDispatchRate(String, String, boolean) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
If applied is true, get dispatch rate limiter for a specific subscription.
+
+
getSubscriptionDispatchRateAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get subscription-message-dispatch-rate asynchronously.
+
+
getSubscriptionDispatchRateAsync(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Get subscription-message-dispatch-rate asynchronously.
+
+
getSubscriptionDispatchRateAsync(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getSubscriptionDispatchRateAsync(String) instead.
+
+
+
getSubscriptionDispatchRateAsync(String, boolean) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Get applied subscription-message-dispatch-rate asynchronously.
+
+
getSubscriptionDispatchRateAsync(String, boolean) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getSubscriptionDispatchRateAsync(String, boolean) instead.
+
+
+
getSubscriptionDispatchRateAsync(String, String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Async version of TopicPolicies.getSubscriptionDispatchRate(String, String).
+
+
getSubscriptionDispatchRateAsync(String, String, boolean) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Async version of TopicPolicies.getSubscriptionDispatchRate(String, String, boolean).
+
+
getSubscriptionExpirationTime(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get the subscription expiration time for a namespace.
+
+
getSubscriptionExpirationTimeAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get the subscription expiration time for a namespace asynchronously.
+
+
getSubscriptionProperties() - Method in interface org.apache.pulsar.common.policies.data.SubscriptionStats
+
+
SubscriptionProperties (key/value strings) associated with this subscribe.
+
+
getSubscriptionProperties(String, String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Get Subscription Properties on a topic subscription.
+
+
getSubscriptionPropertiesAsync(String, String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Get Subscription Properties on a topic subscription.
+
+
getSubscriptions() - Method in interface org.apache.pulsar.common.policies.data.NonPersistentTopicStats
+
+
Map of subscriptions with their individual statistics.
+
+
getSubscriptions() - Method in interface org.apache.pulsar.common.policies.data.TopicStats
+
+
Map of subscriptions with their individual statistics.
+
+
getSubscriptions(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Get the list of subscriptions.
+
+
getSubscriptionsAsync(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Get the list of subscriptions asynchronously.
+
+
getSubscriptionTypesEnabled(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get the subscriptionTypesEnabled policy for a given namespace, overriding broker settings.
+
+
getSubscriptionTypesEnabled(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Get is enable sub types.
+
+
getSubscriptionTypesEnabled(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getSubscriptionTypesEnabled(String) instead.
+
+
+
getSubscriptionTypesEnabledAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get the subscriptionTypesEnabled policy for a given namespace, overriding broker settings.
+
+
getSubscriptionTypesEnabledAsync(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Get is enable sub types asynchronously.
+
+
getSubscriptionTypesEnabledAsync(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.getSubscriptionTypesEnabledAsync(String) instead.
+
+
+
getSystemExceptionsTotal() - Method in interface org.apache.pulsar.common.policies.data.FunctionInstanceStatsDataBase
+
 
+
getSystemExceptionsTotal() - Method in interface org.apache.pulsar.common.policies.data.FunctionStats
+
 
+
getTenantInfo(String) - Method in interface org.apache.pulsar.client.admin.Tenants
+
+
Get the config of the tenant.
+
+
getTenantInfoAsync(String) - Method in interface org.apache.pulsar.client.admin.Tenants
+
+
Get the config of the tenant asynchronously.
+
+
getTenants() - Method in interface org.apache.pulsar.client.admin.Tenants
+
+
Get the list of tenants.
+
+
getTenantsAsync() - Method in interface org.apache.pulsar.client.admin.Tenants
+
+
Get the list of tenants asynchronously.
+
+
getTickTime() - Method in interface org.apache.pulsar.common.policies.data.DelayedDeliveryPolicies
+
 
+
GettingAuthenticationDataException(String) - Constructor for exception class org.apache.pulsar.client.admin.PulsarAdminException.GettingAuthenticationDataException
+
+
Deprecated.
+
+
GettingAuthenticationDataException(Throwable) - Constructor for exception class org.apache.pulsar.client.admin.PulsarAdminException.GettingAuthenticationDataException
+
 
+
getTopicAuthentication() - Method in interface org.apache.pulsar.common.policies.data.AuthPolicies
+
 
+
getTopicEpoch() - Method in interface org.apache.pulsar.common.policies.data.TopicStats
+
+
The topic epoch or empty if not set.
+
+
getTopicHashPositions(String, String, List<String>) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get positions for topic list in a bundle.
+
+
getTopicHashPositionsAsync(String, String, List<String>) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get positions for topic list in a bundle.
+
+
getTopics() - Method in interface org.apache.pulsar.client.admin.BrokerStats
+
+
Returns JSON string topics stats.
+
+
getTopics() - Method in interface org.apache.pulsar.client.admin.ProxyStats
+
+
Returns Topics metrics.
+
+
getTopics(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get the list of topics.
+
+
getTopics(String, ListNamespaceTopicsOptions) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get the list of topics.
+
+
getTopicsAsync() - Method in interface org.apache.pulsar.client.admin.BrokerStats
+
+
Returns JSON string topics stats asynchronously.
+
+
getTopicsAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get the list of topics asynchronously.
+
+
getTopicsAsync(String, ListNamespaceTopicsOptions) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get the list of topics asynchronously.
+
+
getTopicType() - Method in interface org.apache.pulsar.common.policies.data.AutoTopicCreationOverride
+
 
+
getTotalMsgExpired() - Method in interface org.apache.pulsar.common.policies.data.SubscriptionStats
+
+
Total messages expired on this subscription.
+
+
getTransactionBufferInternalStats(String, boolean) - Method in interface org.apache.pulsar.client.admin.Transactions
+
+
Get transaction buffer internal stats.
+
+
getTransactionBufferInternalStatsAsync(String, boolean) - Method in interface org.apache.pulsar.client.admin.Transactions
+
+
Get transaction buffer internal stats asynchronously.
+
+
getTransactionBufferStats(String) - Method in interface org.apache.pulsar.client.admin.Transactions
+
+
Get transaction buffer stats.
+
+
getTransactionBufferStats(String, boolean) - Method in interface org.apache.pulsar.client.admin.Transactions
+
+
Get transaction buffer stats.
+
+
getTransactionBufferStats(String, boolean, boolean) - Method in interface org.apache.pulsar.client.admin.Transactions
+
+
Get transaction buffer stats.
+
+
getTransactionBufferStatsAsync(String) - Method in interface org.apache.pulsar.client.admin.Transactions
+
+
Get transaction buffer stats.
+
+
getTransactionBufferStatsAsync(String, boolean) - Method in interface org.apache.pulsar.client.admin.Transactions
+
+
Get transaction buffer stats.
+
+
getTransactionBufferStatsAsync(String, boolean, boolean) - Method in interface org.apache.pulsar.client.admin.Transactions
+
+
Get transaction buffer stats.
+
+
getTransactionInBufferStats(TxnID, String) - Method in interface org.apache.pulsar.client.admin.Transactions
+
+
Get transaction in buffer stats.
+
+
getTransactionInBufferStatsAsync(TxnID, String) - Method in interface org.apache.pulsar.client.admin.Transactions
+
+
Get transaction in buffer stats.
+
+
getTransactionInPendingAckStats(TxnID, String, String) - Method in interface org.apache.pulsar.client.admin.Transactions
+
+
Get transaction in pending ack stats.
+
+
getTransactionInPendingAckStatsAsync(TxnID, String, String) - Method in interface org.apache.pulsar.client.admin.Transactions
+
+
Get transaction in pending ack stats.
+
+
getTransactionMetadata(TxnID) - Method in interface org.apache.pulsar.client.admin.Transactions
+
+
Get transaction metadata.
+
+
getTransactionMetadataAsync(TxnID) - Method in interface org.apache.pulsar.client.admin.Transactions
+
+
Get transaction metadata.
+
+
getType() - Method in interface org.apache.pulsar.common.policies.data.SubscriptionStats
+
+
The subscription type as defined by SubscriptionType.
+
+
getUnackedMessages() - Method in interface org.apache.pulsar.common.policies.data.ConsumerStats
+
+
Number of unacknowledged messages for the consumer, where an unacknowledged message is one that has been + sent to the consumer but not yet acknowledged.
+
+
getUnackedMessages() - Method in interface org.apache.pulsar.common.policies.data.SubscriptionStats
+
+
Number of unacknowledged messages for the subscription, where an unacknowledged message is one that has been + sent to a consumer but not yet acknowledged.
+
+
getUnackMsgs() - Method in interface org.apache.pulsar.common.policies.data.DrainingHash
+
+
Get number of unacknowledged messages for the draining hash.
+
+
getUnloadScope() - Method in interface org.apache.pulsar.common.policies.data.NamespaceIsolationData
+
 
+
getUserExceptionsTotal() - Method in interface org.apache.pulsar.common.policies.data.FunctionInstanceStatsDataBase
+
 
+
getUserExceptionsTotal() - Method in interface org.apache.pulsar.common.policies.data.FunctionStats
+
 
+
getUserMetrics() - Method in interface org.apache.pulsar.common.policies.data.FunctionInstanceStatsData
+
 
+
getValue() - Method in enum class org.apache.pulsar.client.admin.Mode
+
 
+
getValue() - Method in enum class org.apache.pulsar.common.policies.data.OffloadedReadPriority
+
 
+
getVersion() - Method in interface org.apache.pulsar.client.admin.Brokers
+
+
Get version of broker.
+
+
getVersionBySchema(String, PostSchemaPayload) - Method in interface org.apache.pulsar.client.admin.Schemas
+
+
Find schema version topic.
+
+
getVersionBySchema(String, SchemaInfo) - Method in interface org.apache.pulsar.client.admin.Schemas
+
+
Find schema version topic.
+
+
getVersionBySchemaAsync(String, PostSchemaPayload) - Method in interface org.apache.pulsar.client.admin.Schemas
+
+
Find schema version topic asynchronously.
+
+
getVersionBySchemaAsync(String, SchemaInfo) - Method in interface org.apache.pulsar.client.admin.Schemas
+
+
Find schema version topic asynchronously.
+
+
getWaitingPublishers() - Method in interface org.apache.pulsar.common.policies.data.TopicStats
+
 
+
getWebServiceUrl() - Method in interface org.apache.pulsar.policies.data.loadbalancer.ServiceLookupData
+
 
+
getWebServiceUrlTls() - Method in interface org.apache.pulsar.policies.data.loadbalancer.ServiceLookupData
+
 
+
getZookeeperServers() - Method in class org.apache.pulsar.common.conf.InternalConfigurationData
+
+
Deprecated.
+
+
GO - Enum constant in enum class org.apache.pulsar.common.functions.FunctionConfig.Runtime
+
 
+
grantPermission(String, String, Set<AuthAction>) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Grant permission on a topic.
+
+
grantPermissionAsync(String, String, Set<AuthAction>) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Grant permission on a topic asynchronously.
+
+
grantPermissionOnNamespace(String, String, Set<AuthAction>) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Grant permission on a namespace.
+
+
grantPermissionOnNamespaceAsync(String, String, Set<AuthAction>) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Grant permission on a namespace asynchronously.
+
+
grantPermissionOnSubscription(String, String, Set<String>) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Grant permission to role to access subscription's admin-api.
+
+
grantPermissionOnSubscriptionAsync(String, String, Set<String>) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Grant permission to role to access subscription's admin-api asynchronously.
+
+
grantPermissionOnTopics(List<GrantTopicPermissionOptions>) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Grant permissions on topics.
+
+
grantPermissionOnTopicsAsync(List<GrantTopicPermissionOptions>) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Grant permissions on topics asynchronously.
+
+
GrantTopicPermissionOptions - Class in org.apache.pulsar.client.admin
+
 
+
GrantTopicPermissionOptions() - Constructor for class org.apache.pulsar.client.admin.GrantTopicPermissionOptions
+
 
+
+

H

+
+
hashCode() - Method in class org.apache.pulsar.common.conf.InternalConfigurationData
+
 
+
hashCode() - Method in class org.apache.pulsar.common.policies.data.PersistencePolicies
+
 
+
hashCode() - Method in class org.apache.pulsar.common.policies.data.Policies
+
 
+
hashCode() - Method in class org.apache.pulsar.common.policies.data.PublishRate
+
 
+
hashCode() - Method in class org.apache.pulsar.common.policies.data.RetentionPolicies
+
 
+
hashCode() - Method in class org.apache.pulsar.common.policies.data.SubscribeRate
+
 
+
hashCode() - Method in class org.apache.pulsar.common.stats.Metrics
+
 
+
healthcheck() - Method in interface org.apache.pulsar.client.admin.Brokers
+
+
Deprecated.
+
+
healthcheck(TopicVersion) - Method in interface org.apache.pulsar.client.admin.Brokers
+
+
Run a healthcheck on the broker.
+
+
healthcheck(TopicVersion, Optional<String>) - Method in interface org.apache.pulsar.client.admin.Brokers
+
+
Run a healthcheck on the target broker or on the broker.
+
+
healthcheckAsync() - Method in interface org.apache.pulsar.client.admin.Brokers
+
+
Deprecated.
+
+
healthcheckAsync(TopicVersion, Optional<String>) - Method in interface org.apache.pulsar.client.admin.Brokers
+
+
Run a healthcheck on the broker asynchronously.
+
+
heapArenas - Variable in class org.apache.pulsar.common.stats.AllocatorStats
+
 
+
hostname(String) - Method in interface org.apache.pulsar.common.policies.data.BookieInfo.Builder
+
 
+
hostname(String) - Method in class org.apache.pulsar.common.policies.data.impl.BookieInfoImpl.BookieInfoImplBuilder
+
 
+
HOT - Enum constant in enum class org.apache.pulsar.common.policies.data.Policies.BundleType
+
 
+
HttpErrorException(Exception) - Constructor for exception class org.apache.pulsar.client.admin.PulsarAdminException.HttpErrorException
+
 
+
HttpErrorException(Throwable) - Constructor for exception class org.apache.pulsar.client.admin.PulsarAdminException.HttpErrorException
+
 
+
+

I

+
+
inactive_topic_policies - Variable in class org.apache.pulsar.common.policies.data.Policies
+
 
+
InactiveTopicDeleteMode - Enum Class in org.apache.pulsar.common.policies.data
+
+
Inactive topic deletion mode.
+
+
InactiveTopicPolicies - Class in org.apache.pulsar.common.policies.data
+
+
Definition of the inactive topic policy.
+
+
InactiveTopicPolicies() - Constructor for class org.apache.pulsar.common.policies.data.InactiveTopicPolicies
+
 
+
index - Variable in class org.apache.pulsar.common.policies.data.SchemaMetadata
+
 
+
individuallyDeletedMessages - Variable in class org.apache.pulsar.common.policies.data.ManagedLedgerInternalStats.CursorStats
+
 
+
info - Variable in class org.apache.pulsar.common.policies.data.SchemaMetadata
+
 
+
instanceId - Variable in class org.apache.pulsar.common.policies.data.FunctionStatus.FunctionInstanceStatus
+
 
+
instanceId - Variable in class org.apache.pulsar.common.policies.data.SinkStatus.SinkInstanceStatus
+
 
+
instanceId - Variable in class org.apache.pulsar.common.policies.data.SourceStatus.SourceInstanceStatus
+
 
+
instances - Variable in class org.apache.pulsar.common.policies.data.FunctionStatus
+
 
+
instances - Variable in class org.apache.pulsar.common.policies.data.SinkStatus
+
 
+
instances - Variable in class org.apache.pulsar.common.policies.data.SourceStatus
+
 
+
InternalConfigurationData - Class in org.apache.pulsar.common.conf
+
+
Internal configuration data.
+
+
InternalConfigurationData() - Constructor for class org.apache.pulsar.common.conf.InternalConfigurationData
+
 
+
InternalConfigurationData(String, String, String, String, String) - Constructor for class org.apache.pulsar.common.conf.InternalConfigurationData
+
 
+
InvalidPosition - Enum constant in enum class org.apache.pulsar.common.stats.PositionInPendingAckStats.State
+
 
+
is_active - Variable in class org.apache.pulsar.common.policies.data.NamespaceOwnershipStatus
+
 
+
is_allow_auto_update_schema - Variable in class org.apache.pulsar.common.policies.data.Policies
+
 
+
is_controlled - Variable in class org.apache.pulsar.common.policies.data.NamespaceOwnershipStatus
+
 
+
isActive() - Method in interface org.apache.pulsar.common.policies.data.BrokerStatus
+
 
+
isActive() - Method in interface org.apache.pulsar.common.policies.data.DelayedDeliveryPolicies
+
 
+
isAllowAutoSubscriptionCreation() - Method in interface org.apache.pulsar.common.policies.data.AutoSubscriptionCreationOverride
+
 
+
isAllowAutoTopicCreation() - Method in interface org.apache.pulsar.common.policies.data.AutoTopicCreationOverride
+
 
+
isAllowOutOfOrderDelivery() - Method in interface org.apache.pulsar.common.policies.data.SubscriptionStats
+
+
Whether out of order delivery is allowed on the Key_Shared subscription.
+
+
isBlockedConsumerOnUnackedMsgs() - Method in interface org.apache.pulsar.common.policies.data.ConsumerStats
+
+
Flag to verify if consumer is blocked due to reaching threshold of unacked messages.
+
+
isBlockedSubscriptionOnUnackedMsgs() - Method in interface org.apache.pulsar.common.policies.data.SubscriptionStats
+
+
Flag to verify if subscription is blocked due to reaching threshold of unacked messages.
+
+
isBrokerAvailable(BrokerStatus) - Method in class org.apache.pulsar.common.policies.AutoFailoverPolicy
+
+
Determine whether a broker is considered available or not.
+
+
isBrokerAvailable(BrokerStatus) - Method in class org.apache.pulsar.common.policies.impl.MinAvailablePolicy
+
 
+
isBrokerClientTlsEnabled() - Method in interface org.apache.pulsar.common.policies.data.ClusterData
+
 
+
isBrokerClientTlsEnabledWithKeyStore() - Method in interface org.apache.pulsar.common.policies.data.ClusterData
+
 
+
IsCompatibilityResponse - Class in org.apache.pulsar.common.protocol.schema
+
+
Response defining if a schema is compatible with existing topic's schema.
+
+
IsCompatibilityResponse() - Constructor for class org.apache.pulsar.common.protocol.schema.IsCompatibilityResponse
+
 
+
isConnected() - Method in interface org.apache.pulsar.common.policies.data.ReplicatorStats
+
+
is the replication-subscriber up and running to replicate to remote cluster.
+
+
isDurable() - Method in interface org.apache.pulsar.common.policies.data.SubscriptionStats
+
+
Tells whether this subscription is durable or ephemeral (eg.: from a reader).
+
+
isEmpty() - Method in class org.apache.pulsar.common.policies.data.ClusterPolicies.ClusterUrl
+
 
+
isMigrated() - Method in interface org.apache.pulsar.common.policies.data.ClusterPolicies
+
 
+
isMsgChunkPublished() - Method in interface org.apache.pulsar.common.policies.data.TopicStats
+
+
Topic has chunked message published on it.
+
+
isNonPersistentTopicsEnabled() - Method in interface org.apache.pulsar.policies.data.loadbalancer.LoadManagerReport
+
 
+
isPersistentTopicsEnabled() - Method in interface org.apache.pulsar.policies.data.loadbalancer.LoadManagerReport
+
 
+
isPrimary() - Method in interface org.apache.pulsar.common.policies.data.BrokerNamespaceIsolationData
+
 
+
isRelativeToPublishRate() - Method in interface org.apache.pulsar.common.policies.data.DispatchRate
+
 
+
isReplicated() - Method in interface org.apache.pulsar.common.policies.data.SubscriptionStats
+
+
Mark that the subscription state is kept in sync across different regions.
+
+
isSupportsPartialProducer() - Method in interface org.apache.pulsar.common.policies.data.PublisherStats
+
+
Whether partial producer is supported at client.
+
+
isTlsAllowInsecureConnection() - Method in interface org.apache.pulsar.common.policies.data.ClusterData
+
 
+
isUndefined(SchemaCompatibilityStrategy) - Static method in enum class org.apache.pulsar.common.policies.data.SchemaCompatibilityStrategy
+
 
+
isUpdateAuthData() - Method in interface org.apache.pulsar.common.functions.UpdateOptions
+
 
+
isValidTopicType(String) - Static method in enum class org.apache.pulsar.common.policies.data.TopicType
+
 
+
+

J

+
+
JAVA - Enum constant in enum class org.apache.pulsar.common.functions.FunctionConfig.Runtime
+
 
+
+

L

+
+
LARGEST - Enum constant in enum class org.apache.pulsar.common.policies.data.Policies.BundleType
+
 
+
LAST_BOUNDARY - Static variable in class org.apache.pulsar.common.policies.data.Policies
+
 
+
lastConfirmedEntry - Variable in class org.apache.pulsar.common.policies.data.ManagedLedgerInternalStats
+
+
The ledgerid: entryid of the last message that is written successfully.
+
+
lastError - Variable in class org.apache.pulsar.client.admin.LongRunningProcessStatus
+
 
+
lastInvocationTime - Variable in class org.apache.pulsar.common.policies.data.FunctionStatus.FunctionInstanceStatus.FunctionInstanceStatusData
+
 
+
lastLedgerCreatedTimestamp - Variable in class org.apache.pulsar.common.policies.data.ManagedLedgerInternalStats
+
+
The time when the last ledger is created.
+
+
lastLedgerCreationFailureTimestamp - Variable in class org.apache.pulsar.common.policies.data.ManagedLedgerInternalStats
+
+
The time when the last ledger failed.
+
+
lastLedgerSwitchTimestamp - Variable in class org.apache.pulsar.common.policies.data.ManagedLedgerInternalStats.CursorStats
+
 
+
lastReceivedTime - Variable in class org.apache.pulsar.common.policies.data.SinkStatus.SinkInstanceStatus.SinkInstanceStatusData
+
 
+
lastReceivedTime - Variable in class org.apache.pulsar.common.policies.data.SourceStatus.SourceInstanceStatus.SourceInstanceStatusData
+
 
+
lastSnapshotTimestamps - Variable in class org.apache.pulsar.common.policies.data.TransactionBufferStats
+
+
The last snapshot timestamps of this transaction buffer.
+
+
lastTookSnapshotSegmentTimestamp - Variable in class org.apache.pulsar.common.policies.data.SegmentsStats
+
+
The last snapshot segment timestamps of this transaction buffer.
+
+
lastTxnID - Variable in class org.apache.pulsar.common.policies.data.SegmentStats
+
 
+
latency_stats_sample_rate - Variable in class org.apache.pulsar.common.policies.data.Policies
+
 
+
latestSinkExceptions - Variable in class org.apache.pulsar.common.policies.data.SinkStatus.SinkInstanceStatus.SinkInstanceStatusData
+
 
+
latestSourceExceptions - Variable in class org.apache.pulsar.common.policies.data.SourceStatus.SourceInstanceStatus.SourceInstanceStatusData
+
 
+
latestSystemExceptions - Variable in class org.apache.pulsar.common.policies.data.FunctionStatus.FunctionInstanceStatus.FunctionInstanceStatusData
+
 
+
latestSystemExceptions - Variable in class org.apache.pulsar.common.policies.data.SinkStatus.SinkInstanceStatus.SinkInstanceStatusData
+
 
+
latestSystemExceptions - Variable in class org.apache.pulsar.common.policies.data.SourceStatus.SourceInstanceStatus.SourceInstanceStatusData
+
 
+
latestUserExceptions - Variable in class org.apache.pulsar.common.policies.data.FunctionStatus.FunctionInstanceStatus.FunctionInstanceStatusData
+
 
+
leastSigBits - Variable in class org.apache.pulsar.common.policies.data.TransactionCoordinatorStats
+
+
The sequenceId of transaction metadataStore.
+
+
leastSigBits - Variable in class org.apache.pulsar.common.policies.data.TransactionCoordinatorStatus
+
+
The sequenceId of transaction metadataStore.
+
+
ledgerId - Variable in class org.apache.pulsar.common.policies.data.ManagedLedgerInternalStats.LedgerInfo
+
 
+
LedgerInfo() - Constructor for class org.apache.pulsar.common.policies.data.ManagedLedgerInternalStats.LedgerInfo
+
 
+
ledgers - Variable in class org.apache.pulsar.common.policies.data.ManagedLedgerInternalStats
+
+
The ordered list of all ledgers for this topic holding messages.
+
+
limit - Variable in class org.apache.pulsar.policies.data.loadbalancer.ResourceUsage
+
 
+
limitSize(long) - Method in interface org.apache.pulsar.common.policies.data.BacklogQuota.Builder
+
 
+
limitSize(long) - Method in class org.apache.pulsar.common.policies.data.impl.BacklogQuotaImpl.BacklogQuotaImplBuilder
+
 
+
limitTime(int) - Method in interface org.apache.pulsar.common.policies.data.BacklogQuota.Builder
+
 
+
limitTime(int) - Method in class org.apache.pulsar.common.policies.data.impl.BacklogQuotaImpl.BacklogQuotaImplBuilder
+
 
+
listenerName(String) - Method in interface org.apache.pulsar.common.policies.data.ClusterData.Builder
+
 
+
ListNamespaceTopicsOptions - Class in org.apache.pulsar.client.admin
+
 
+
ListNamespaceTopicsOptions() - Constructor for class org.apache.pulsar.client.admin.ListNamespaceTopicsOptions
+
 
+
listPackages(String, String) - Method in interface org.apache.pulsar.client.admin.Packages
+
+
List all the packages with the given type in a namespace.
+
+
listPackagesAsync(String, String) - Method in interface org.apache.pulsar.client.admin.Packages
+
+
List all the packages with the given type in a namespace asynchronously.
+
+
listPackageVersions(String) - Method in interface org.apache.pulsar.client.admin.Packages
+
+
List all the versions of a package.
+
+
listPackageVersionsAsync(String) - Method in interface org.apache.pulsar.client.admin.Packages
+
+
List all the versions of a package asynchronously.
+
+
listSinks(String, String) - Method in interface org.apache.pulsar.client.admin.Sinks
+
+
Get the list of sinks.
+
+
listSinksAsync(String, String) - Method in interface org.apache.pulsar.client.admin.Sinks
+
+
Get the list of sinks asynchronously.
+
+
listSources(String, String) - Method in interface org.apache.pulsar.client.admin.Sources
+
+
Get the list of sources.
+
+
listSourcesAsync(String, String) - Method in interface org.apache.pulsar.client.admin.Sources
+
+
Get the list of sources asynchronously.
+
+
ListTopicsOptions - Class in org.apache.pulsar.client.admin
+
 
+
ListTopicsOptions() - Constructor for class org.apache.pulsar.client.admin.ListTopicsOptions
+
 
+
listTransactionCoordinators() - Method in interface org.apache.pulsar.client.admin.Transactions
+
+
List transaction coordinators.
+
+
listTransactionCoordinatorsAsync() - Method in interface org.apache.pulsar.client.admin.Transactions
+
+
List transaction coordinators.
+
+
loadConf(Map<String, Object>) - Method in interface org.apache.pulsar.client.admin.PulsarAdminBuilder
+
+
Load the configuration from provided config map.
+
+
loadFactor(int) - Method in interface org.apache.pulsar.common.policies.data.BrokerStatus.Builder
+
 
+
loadFactor(int) - Method in class org.apache.pulsar.common.policies.data.impl.BrokerStatusImpl.BrokerStatusImplBuilder
+
 
+
LoadManagerReport - Interface in org.apache.pulsar.policies.data.loadbalancer
+
+
This class represents the overall load of the broker - it includes overall SystemResourceUsage and Bundle-usage.
+
+
LongRunningProcessStatus - Class in org.apache.pulsar.client.admin
+
+
Status of long running process.
+
+
LongRunningProcessStatus() - Constructor for class org.apache.pulsar.client.admin.LongRunningProcessStatus
+
 
+
LongRunningProcessStatus.Status - Enum Class in org.apache.pulsar.client.admin
+
+
Status code.
+
+
Lookup - Interface in org.apache.pulsar.client.admin
+
+
This is an interface class to allow using command line tool to quickly lookup the broker serving the topic.
+
+
lookupPartitionedTopic(String) - Method in interface org.apache.pulsar.client.admin.Lookup
+
+
Lookup a partitioned topic.
+
+
lookupPartitionedTopicAsync(String) - Method in interface org.apache.pulsar.client.admin.Lookup
+
+
Lookup a partitioned topic.
+
+
lookups() - Method in interface org.apache.pulsar.client.admin.PulsarAdmin
+
 
+
lookupTopic(String) - Method in interface org.apache.pulsar.client.admin.Lookup
+
+
Lookup a topic.
+
+
lookupTopicAsync(String) - Method in interface org.apache.pulsar.client.admin.Lookup
+
+
Lookup a topic asynchronously.
+
+
lowWaterMark - Variable in class org.apache.pulsar.common.policies.data.TransactionCoordinatorStats
+
+
The low water mark of transaction metadataStore.
+
+
lowWaterMark - Variable in class org.apache.pulsar.common.policies.data.TransactionCoordinatorStatus
+
+
The low water mark of transaction metadataStore.
+
+
lowWaterMarks - Variable in class org.apache.pulsar.common.policies.data.TransactionBufferStats
+
+
(Optional) The lowWaterMark details of the transaction buffer.
+
+
lowWaterMarks - Variable in class org.apache.pulsar.common.policies.data.TransactionPendingAckStats
+
+
(Optional) The lowWaterMark details of the transaction pending ack.
+
+
+

M

+
+
managedLedgerInternalStats - Variable in class org.apache.pulsar.common.policies.data.SnapshotSystemTopicInternalStats
+
 
+
managedLedgerInternalStats - Variable in class org.apache.pulsar.common.policies.data.TransactionLogStats
+
+
The manage ledger internal stats.
+
+
ManagedLedgerInternalStats - Class in org.apache.pulsar.common.policies.data
+
+
ManagedLedger internal statistics.
+
+
ManagedLedgerInternalStats() - Constructor for class org.apache.pulsar.common.policies.data.ManagedLedgerInternalStats
+
 
+
ManagedLedgerInternalStats.CursorStats - Class in org.apache.pulsar.common.policies.data
+
+
Pulsar cursor statistics.
+
+
ManagedLedgerInternalStats.LedgerInfo - Class in org.apache.pulsar.common.policies.data
+
+
Ledger information.
+
+
managedLedgerName - Variable in class org.apache.pulsar.common.policies.data.SnapshotSystemTopicInternalStats
+
 
+
managedLedgerName - Variable in class org.apache.pulsar.common.policies.data.TransactionLogStats
+
+
The managed ledger name.
+
+
managedLedgerOffloadBucket(String) - Method in interface org.apache.pulsar.common.policies.data.OffloadPolicies.Builder
+
 
+
managedLedgerOffloadDeletionLagInMillis(Long) - Method in interface org.apache.pulsar.common.policies.data.OffloadPolicies.Builder
+
 
+
managedLedgerOffloadDriver(String) - Method in interface org.apache.pulsar.common.policies.data.OffloadPolicies.Builder
+
 
+
managedLedgerOffloadedReadPriority(OffloadedReadPriority) - Method in interface org.apache.pulsar.common.policies.data.OffloadPolicies.Builder
+
 
+
managedLedgerOffloadMaxBlockSizeInBytes(Integer) - Method in interface org.apache.pulsar.common.policies.data.OffloadPolicies.Builder
+
 
+
managedLedgerOffloadMaxThreads(Integer) - Method in interface org.apache.pulsar.common.policies.data.OffloadPolicies.Builder
+
 
+
managedLedgerOffloadPrefetchRounds(Integer) - Method in interface org.apache.pulsar.common.policies.data.OffloadPolicies.Builder
+
 
+
managedLedgerOffloadReadBufferSizeInBytes(Integer) - Method in interface org.apache.pulsar.common.policies.data.OffloadPolicies.Builder
+
 
+
managedLedgerOffloadRegion(String) - Method in interface org.apache.pulsar.common.policies.data.OffloadPolicies.Builder
+
 
+
managedLedgerOffloadServiceEndpoint(String) - Method in interface org.apache.pulsar.common.policies.data.OffloadPolicies.Builder
+
 
+
managedLedgerOffloadThresholdInBytes(Long) - Method in interface org.apache.pulsar.common.policies.data.OffloadPolicies.Builder
+
 
+
managedLedgerOffloadThresholdInSeconds(Long) - Method in interface org.apache.pulsar.common.policies.data.OffloadPolicies.Builder
+
 
+
MANUAL - Enum constant in enum class org.apache.pulsar.common.functions.FunctionConfig.ProcessingGuarantees
+
 
+
MarkDelete - Enum constant in enum class org.apache.pulsar.common.stats.PositionInPendingAckStats.State
+
 
+
markDeletePosition - Variable in class org.apache.pulsar.common.policies.data.ManagedLedgerInternalStats.CursorStats
+
 
+
max_consumers_per_subscription - Variable in class org.apache.pulsar.common.policies.data.Policies
+
 
+
max_consumers_per_topic - Variable in class org.apache.pulsar.common.policies.data.Policies
+
 
+
max_producers_per_topic - Variable in class org.apache.pulsar.common.policies.data.Policies
+
 
+
max_subscriptions_per_topic - Variable in class org.apache.pulsar.common.policies.data.Policies
+
 
+
max_topics_per_namespace - Variable in class org.apache.pulsar.common.policies.data.Policies
+
 
+
max_unacked_messages_per_consumer - Variable in class org.apache.pulsar.common.policies.data.Policies
+
 
+
max_unacked_messages_per_subscription - Variable in class org.apache.pulsar.common.policies.data.Policies
+
 
+
maxConnectionsPerHost(int) - Method in interface org.apache.pulsar.client.admin.PulsarAdminBuilder
+
+
Configures the maximum number of connections that the client library will establish with a single host.
+
+
maxDeliveryDelayInMillis(long) - Method in interface org.apache.pulsar.common.policies.data.DelayedDeliveryPolicies.Builder
+
 
+
maxDeliveryDelayInMillis(long) - Method in class org.apache.pulsar.common.policies.data.impl.DelayedDeliveryPoliciesImpl.DelayedDeliveryPoliciesImplBuilder
+
 
+
maxNumElements - Variable in class org.apache.pulsar.common.stats.AllocatorStats.PoolSubpageStats
+
 
+
maxReadPosition - Variable in class org.apache.pulsar.common.policies.data.TransactionBufferStats
+
+
The max read position of this transaction buffer.
+
+
maxUsage - Variable in class org.apache.pulsar.common.stats.AllocatorStats.PoolChunkListStats
+
 
+
MEDIA_TYPE - Static variable in class org.apache.pulsar.common.partition.PartitionedTopicMetadata
+
 
+
mergeWithDefault(Resources) - Static method in class org.apache.pulsar.common.functions.Resources
+
 
+
message_age - Enum constant in enum class org.apache.pulsar.common.policies.data.BacklogQuota.BacklogQuotaType
+
 
+
message_ttl_in_seconds - Variable in class org.apache.pulsar.common.policies.data.Policies
+
 
+
messagesConsumedCounter - Variable in class org.apache.pulsar.common.policies.data.ManagedLedgerInternalStats.CursorStats
+
 
+
metadata - Variable in class org.apache.pulsar.common.policies.data.ManagedLedgerInternalStats.LedgerInfo
+
 
+
metadata - Variable in class org.apache.pulsar.common.policies.data.PartitionedTopicInternalStats
+
 
+
MetadataFormatException(String) - Constructor for exception class org.apache.pulsar.packages.management.core.exceptions.PackagesManagementException.MetadataFormatException
+
+
Constructs an MetadataFormatException with the specified detail message.
+
+
MetadataFormatException(String, Throwable) - Constructor for exception class org.apache.pulsar.packages.management.core.exceptions.PackagesManagementException.MetadataFormatException
+
+
Constructs an MetadataFormatException with the specified detail message and the cause.
+
+
metrics - Variable in class org.apache.pulsar.common.policies.data.WorkerFunctionInstanceStats
+
 
+
Metrics - Class in org.apache.pulsar.common.stats
+
+
WARNING : do not add any getters as the Jackson parser will output that getter.
+
+
Metrics() - Constructor for class org.apache.pulsar.common.stats.Metrics
+
 
+
Metrics(Map<String, String>) - Constructor for class org.apache.pulsar.common.stats.Metrics
+
 
+
migrated - Variable in class org.apache.pulsar.common.policies.data.Policies
+
 
+
migrated(boolean) - Method in interface org.apache.pulsar.common.policies.data.ClusterPolicies.Builder
+
 
+
migratedClusterUrl(ClusterPolicies.ClusterUrl) - Method in interface org.apache.pulsar.common.policies.data.ClusterPolicies.Builder
+
 
+
min_available - Enum constant in enum class org.apache.pulsar.common.policies.data.AutoFailoverPolicyType
+
 
+
min_limit - Variable in class org.apache.pulsar.common.policies.impl.MinAvailablePolicy
+
 
+
MinAvailablePolicy - Class in org.apache.pulsar.common.policies.impl
+
+
Implementation of min available policy.
+
+
MinAvailablePolicy(AutoFailoverPolicyData) - Constructor for class org.apache.pulsar.common.policies.impl.MinAvailablePolicy
+
 
+
minUsage - Variable in class org.apache.pulsar.common.stats.AllocatorStats.PoolChunkListStats
+
 
+
Mode - Enum Class in org.apache.pulsar.client.admin
+
 
+
msgRateIn - Variable in class org.apache.pulsar.policies.data.loadbalancer.NamespaceBundleStats
+
 
+
msgRateOut - Variable in class org.apache.pulsar.policies.data.loadbalancer.NamespaceBundleStats
+
 
+
msgThroughputIn - Variable in class org.apache.pulsar.policies.data.loadbalancer.NamespaceBundleStats
+
 
+
msgThroughputOut - Variable in class org.apache.pulsar.policies.data.loadbalancer.NamespaceBundleStats
+
 
+
+

N

+
+
name - Variable in class org.apache.pulsar.common.policies.data.WorkerFunctionInstanceStats
+
+
Fully qualified function instance name.
+
+
namespaceAuthentication(Map<String, Set<AuthAction>>) - Method in interface org.apache.pulsar.common.policies.data.AuthPolicies.Builder
+
 
+
NamespaceBundleStats - Class in org.apache.pulsar.policies.data.loadbalancer
+
 
+
NamespaceBundleStats() - Constructor for class org.apache.pulsar.policies.data.loadbalancer.NamespaceBundleStats
+
 
+
NamespaceIsolationData - Interface in org.apache.pulsar.common.policies.data
+
 
+
NamespaceIsolationData.Builder - Interface in org.apache.pulsar.common.policies.data
+
 
+
NamespaceIsolationPolicyUnloadScope - Enum Class in org.apache.pulsar.common.policies.data
+
+
The type of unload to perform while setting the isolation policy.
+
+
NamespaceOwnershipStatus - Class in org.apache.pulsar.common.policies.data
+
+
Information about the namespace's ownership.
+
+
NamespaceOwnershipStatus() - Constructor for class org.apache.pulsar.common.policies.data.NamespaceOwnershipStatus
+
 
+
NamespaceOwnershipStatus(BrokerAssignment, boolean, boolean) - Constructor for class org.apache.pulsar.common.policies.data.NamespaceOwnershipStatus
+
 
+
namespaceRegex(List<String>) - Method in interface org.apache.pulsar.common.policies.data.BrokerNamespaceIsolationData.Builder
+
 
+
namespaces() - Method in interface org.apache.pulsar.client.admin.PulsarAdmin
+
 
+
namespaces(List<String>) - Method in interface org.apache.pulsar.common.policies.data.NamespaceIsolationData.Builder
+
 
+
Namespaces - Interface in org.apache.pulsar.client.admin
+
+
Admin interface for namespaces management.
+
+
newAdminClientBuilder() - Static method in class org.apache.pulsar.client.admin.utils.DefaultImplementation
+
 
+
newBuilder(String) - Static method in class org.apache.pulsar.client.admin.utils.ReflectionUtils
+
 
+
newOffloadProcessStatus(LongRunningProcessStatus.Status, String, MessageId) - Static method in class org.apache.pulsar.client.admin.utils.DefaultImplementation
+
 
+
NON_PARTITIONED - Enum constant in enum class org.apache.pulsar.common.policies.data.TopicType
+
 
+
NON_PARTITIONED - Static variable in class org.apache.pulsar.common.partition.PartitionedTopicMetadata
+
+
A topic with '0' partitions is treated like non-partitioned topic.
+
+
non_persistent - Enum constant in enum class org.apache.pulsar.common.naming.TopicDomain
+
 
+
NON_PERSISTENT - Enum constant in enum class org.apache.pulsar.client.admin.Mode
+
 
+
none - Enum constant in enum class org.apache.pulsar.common.policies.data.NamespaceIsolationPolicyUnloadScope
+
 
+
None - Enum constant in enum class org.apache.pulsar.common.policies.data.SubscriptionAuthMode
+
+
Every subscription name can be used by every role.
+
+
NonPersistentPartitionedTopicStats - Interface in org.apache.pulsar.common.policies.data
+
+
Statistics for a non-persistent partitioned topic.
+
+
NonPersistentPublisherStats - Interface in org.apache.pulsar.common.policies.data
+
+
Non-persistent publisher statistics.
+
+
NonPersistentReplicatorStats - Interface in org.apache.pulsar.common.policies.data
+
+
Statistics for a non-persistent replicator.
+
+
NonPersistentSubscriptionStats - Interface in org.apache.pulsar.common.policies.data
+
+
Statistics for subscription to non-persistent topics.
+
+
nonPersistentTopics() - Method in interface org.apache.pulsar.client.admin.PulsarAdmin
+
+
Deprecated. +
Since 2.0. See PulsarAdmin.topics()
+
+
+
NonPersistentTopics - Interface in org.apache.pulsar.client.admin
+
+
Deprecated. +
since 2.0. See Topics
+
+
+
NonPersistentTopicStats - Interface in org.apache.pulsar.common.policies.data
+
+
Statistics for a non-persistent topic.
+
+
normalCacheSize - Variable in class org.apache.pulsar.common.stats.AllocatorStats
+
 
+
normalize(DispatchRateImpl) - Static method in class org.apache.pulsar.common.policies.data.impl.DispatchRateImpl
+
 
+
normalize(PublishRate) - Static method in class org.apache.pulsar.common.policies.data.PublishRate
+
 
+
normalize(SubscribeRate) - Static method in class org.apache.pulsar.common.policies.data.SubscribeRate
+
 
+
NOT_RUN - Enum constant in enum class org.apache.pulsar.client.admin.LongRunningProcessStatus.Status
+
 
+
NotAllowedException(Throwable, String, int) - Constructor for exception class org.apache.pulsar.client.admin.PulsarAdminException.NotAllowedException
+
 
+
NotAuthorizedException(Throwable, String, int) - Constructor for exception class org.apache.pulsar.client.admin.PulsarAdminException.NotAuthorizedException
+
 
+
NotFoundException(String) - Constructor for exception class org.apache.pulsar.packages.management.core.exceptions.PackagesManagementException.NotFoundException
+
+
Constructs an NotFoundException with the specified detail message.
+
+
NotFoundException(String, Throwable) - Constructor for exception class org.apache.pulsar.packages.management.core.exceptions.PackagesManagementException.NotFoundException
+
+
Constructs an NotFoundException with the specified detail message and the cause.
+
+
NotFoundException(Throwable) - Constructor for exception class org.apache.pulsar.packages.management.core.exceptions.PackagesManagementException.NotFoundException
+
+
Constructs an NotFoundException with the specified cause.
+
+
NotFoundException(Throwable, String, int) - Constructor for exception class org.apache.pulsar.client.admin.PulsarAdminException.NotFoundException
+
 
+
NotInPendingAck - Enum constant in enum class org.apache.pulsar.common.stats.PositionInPendingAckStats.State
+
 
+
numActiveAllocations - Variable in class org.apache.pulsar.common.stats.AllocatorStats.PoolArenaStats
+
 
+
numActiveHugeAllocations - Variable in class org.apache.pulsar.common.stats.AllocatorStats.PoolArenaStats
+
 
+
numActiveNormalAllocations - Variable in class org.apache.pulsar.common.stats.AllocatorStats.PoolArenaStats
+
 
+
numActiveSmallAllocations - Variable in class org.apache.pulsar.common.stats.AllocatorStats.PoolArenaStats
+
 
+
numAllocations - Variable in class org.apache.pulsar.common.stats.AllocatorStats.PoolArenaStats
+
 
+
numAvailable - Variable in class org.apache.pulsar.common.stats.AllocatorStats.PoolSubpageStats
+
 
+
numberOfEntries - Variable in class org.apache.pulsar.common.policies.data.ManagedLedgerInternalStats
+
+
The total number of entries being tracked.
+
+
numberOfEntriesSinceFirstNotAckedMessage - Variable in class org.apache.pulsar.common.policies.data.ManagedLedgerInternalStats.CursorStats
+
 
+
numBundles(int) - Method in interface org.apache.pulsar.common.policies.data.BundlesData.Builder
+
 
+
numBundles(int) - Method in class org.apache.pulsar.common.policies.data.impl.BundlesDataImpl.BundlesDataImplBuilder
+
 
+
numChunkLists - Variable in class org.apache.pulsar.common.stats.AllocatorStats.PoolArenaStats
+
 
+
numDeallocations - Variable in class org.apache.pulsar.common.stats.AllocatorStats.PoolArenaStats
+
 
+
numDirectArenas - Variable in class org.apache.pulsar.common.stats.AllocatorStats
+
 
+
numHeapArenas - Variable in class org.apache.pulsar.common.stats.AllocatorStats
+
 
+
numHugeAllocations - Variable in class org.apache.pulsar.common.stats.AllocatorStats.PoolArenaStats
+
 
+
numHugeDeallocations - Variable in class org.apache.pulsar.common.stats.AllocatorStats.PoolArenaStats
+
 
+
numInstances - Variable in class org.apache.pulsar.common.policies.data.FunctionStatus
+
 
+
numInstances - Variable in class org.apache.pulsar.common.policies.data.SinkStatus
+
 
+
numInstances - Variable in class org.apache.pulsar.common.policies.data.SourceStatus
+
 
+
numNormalAllocations - Variable in class org.apache.pulsar.common.stats.AllocatorStats.PoolArenaStats
+
 
+
numNormalDeallocations - Variable in class org.apache.pulsar.common.stats.AllocatorStats.PoolArenaStats
+
 
+
numReadFromPulsar - Variable in class org.apache.pulsar.common.policies.data.SinkStatus.SinkInstanceStatus.SinkInstanceStatusData
+
 
+
numReceived - Variable in class org.apache.pulsar.common.policies.data.FunctionStatus.FunctionInstanceStatus.FunctionInstanceStatusData
+
 
+
numReceivedFromSource - Variable in class org.apache.pulsar.common.policies.data.SourceStatus.SourceInstanceStatus.SourceInstanceStatusData
+
 
+
numRestarts - Variable in class org.apache.pulsar.common.policies.data.FunctionStatus.FunctionInstanceStatus.FunctionInstanceStatusData
+
 
+
numRestarts - Variable in class org.apache.pulsar.common.policies.data.SinkStatus.SinkInstanceStatus.SinkInstanceStatusData
+
 
+
numRestarts - Variable in class org.apache.pulsar.common.policies.data.SourceStatus.SourceInstanceStatus.SourceInstanceStatusData
+
 
+
numRunning - Variable in class org.apache.pulsar.common.policies.data.FunctionStatus
+
 
+
numRunning - Variable in class org.apache.pulsar.common.policies.data.SinkStatus
+
 
+
numRunning - Variable in class org.apache.pulsar.common.policies.data.SourceStatus
+
 
+
numSinkExceptions - Variable in class org.apache.pulsar.common.policies.data.SinkStatus.SinkInstanceStatus.SinkInstanceStatusData
+
 
+
numSmallAllocations - Variable in class org.apache.pulsar.common.stats.AllocatorStats.PoolArenaStats
+
 
+
numSmallDeallocations - Variable in class org.apache.pulsar.common.stats.AllocatorStats.PoolArenaStats
+
 
+
numSmallSubpages - Variable in class org.apache.pulsar.common.stats.AllocatorStats.PoolArenaStats
+
 
+
numSourceExceptions - Variable in class org.apache.pulsar.common.policies.data.SourceStatus.SourceInstanceStatus.SourceInstanceStatusData
+
 
+
numSuccessfullyProcessed - Variable in class org.apache.pulsar.common.policies.data.FunctionStatus.FunctionInstanceStatus.FunctionInstanceStatusData
+
 
+
numSystemExceptions - Variable in class org.apache.pulsar.common.policies.data.FunctionStatus.FunctionInstanceStatus.FunctionInstanceStatusData
+
 
+
numSystemExceptions - Variable in class org.apache.pulsar.common.policies.data.SinkStatus.SinkInstanceStatus.SinkInstanceStatusData
+
 
+
numSystemExceptions - Variable in class org.apache.pulsar.common.policies.data.SourceStatus.SourceInstanceStatus.SourceInstanceStatusData
+
 
+
numThreadLocalCaches - Variable in class org.apache.pulsar.common.stats.AllocatorStats
+
 
+
numUserExceptions - Variable in class org.apache.pulsar.common.policies.data.FunctionStatus.FunctionInstanceStatus.FunctionInstanceStatusData
+
 
+
numWritten - Variable in class org.apache.pulsar.common.policies.data.SourceStatus.SourceInstanceStatus.SourceInstanceStatusData
+
 
+
numWrittenToSink - Variable in class org.apache.pulsar.common.policies.data.SinkStatus.SinkInstanceStatus.SinkInstanceStatusData
+
 
+
+

O

+
+
of(String, String, int) - Static method in class org.apache.pulsar.common.functions.WorkerInfo
+
 
+
offload_deletion_lag_ms - Variable in class org.apache.pulsar.common.policies.data.Policies
+
 
+
offload_policies - Variable in class org.apache.pulsar.common.policies.data.Policies
+
 
+
offload_threshold - Variable in class org.apache.pulsar.common.policies.data.Policies
+
 
+
offload_threshold_in_seconds - Variable in class org.apache.pulsar.common.policies.data.Policies
+
 
+
offloaded - Variable in class org.apache.pulsar.common.policies.data.ManagedLedgerInternalStats.LedgerInfo
+
 
+
OffloadedReadPriority - Enum Class in org.apache.pulsar.common.policies.data
+
 
+
offloadersDirectory(String) - Method in interface org.apache.pulsar.common.policies.data.OffloadPolicies.Builder
+
 
+
OffloadPolicies - Interface in org.apache.pulsar.common.policies.data
+
 
+
OffloadPolicies.Builder - Interface in org.apache.pulsar.common.policies.data
+
 
+
OffloadProcessStatus - Interface in org.apache.pulsar.client.admin
+
+
interface class of Status of offload process.
+
+
offloadStatus(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Check the status of an ongoing offloading operation for a topic.
+
+
offloadStatusAsync(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Check the status of an ongoing offloading operation for a topic asynchronously.
+
+
ongoingTxnSize - Variable in class org.apache.pulsar.common.policies.data.TransactionBufferStats
+
+
The total number of ongoing transactions in this transaction buffer.
+
+
ongoingTxnSize - Variable in class org.apache.pulsar.common.policies.data.TransactionCoordinatorStats
+
+
The total number of ongoing transactions in this transaction coordinator.
+
+
ongoingTxnSize - Variable in class org.apache.pulsar.common.policies.data.TransactionPendingAckStats
+
+
The total number of ongoing transactions in this transaction pending ack.
+
+
openTimestamp - Variable in class org.apache.pulsar.common.policies.data.TransactionMetadata
+
+
The open time of this transaction.
+
+
org.apache.pulsar.client.admin - package org.apache.pulsar.client.admin
+
 
+
org.apache.pulsar.client.admin.utils - package org.apache.pulsar.client.admin.utils
+
+
Helpers which provide useful functionality for the implementation of Pulsar Client API.
+
+
org.apache.pulsar.common.conf - package org.apache.pulsar.common.conf
+
+
Classes for internal configuration.
+
+
org.apache.pulsar.common.functions - package org.apache.pulsar.common.functions
+
+
Implementation of policies.
+
+
org.apache.pulsar.common.io - package org.apache.pulsar.common.io
+
+
Implementation of policies.
+
+
org.apache.pulsar.common.naming - package org.apache.pulsar.common.naming
+
+
Implementation of policies.
+
+
org.apache.pulsar.common.partition - package org.apache.pulsar.common.partition
+
+
Implementation of policies.
+
+
org.apache.pulsar.common.policies - package org.apache.pulsar.common.policies
+
+
Implementation of policies.
+
+
org.apache.pulsar.common.policies.data - package org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
org.apache.pulsar.common.policies.data.impl - package org.apache.pulsar.common.policies.data.impl
+
 
+
org.apache.pulsar.common.policies.impl - package org.apache.pulsar.common.policies.impl
+
+
Implementation of policies.
+
+
org.apache.pulsar.common.protocol.schema - package org.apache.pulsar.common.protocol.schema
+
+
Implementation of policies.
+
+
org.apache.pulsar.common.stats - package org.apache.pulsar.common.stats
+
+
Implementation of policies.
+
+
org.apache.pulsar.packages.management.core.common - package org.apache.pulsar.packages.management.core.common
+
+
Packages management general classes.
+
+
org.apache.pulsar.packages.management.core.exceptions - package org.apache.pulsar.packages.management.core.exceptions
+
+
Exceptions of the packages management service thrown.
+
+
org.apache.pulsar.policies.data.loadbalancer - package org.apache.pulsar.policies.data.loadbalancer
+
+
Implementation of policies.
+
+
owner - Variable in class org.apache.pulsar.common.policies.data.TransactionMetadata
+
+
The owner of this transaction.
+
+
+

P

+
+
PackageMetadata - Class in org.apache.pulsar.packages.management.core.common
+
+
Package metadata.
+
+
PackageMetadata() - Constructor for class org.apache.pulsar.packages.management.core.common.PackageMetadata
+
 
+
packages - Enum constant in enum class org.apache.pulsar.common.policies.data.AuthAction
+
+
Permissions for packages ops.
+
+
packages() - Method in interface org.apache.pulsar.client.admin.PulsarAdmin
+
 
+
Packages - Interface in org.apache.pulsar.client.admin
+
+
Administration operations of the packages management service.
+
+
PackagesManagementException - Exception Class in org.apache.pulsar.packages.management.core.exceptions
+
+
Packages management related exceptions.
+
+
PackagesManagementException(String) - Constructor for exception class org.apache.pulsar.packages.management.core.exceptions.PackagesManagementException
+
+
Constructs an PackagesManagementException with the specified detail message.
+
+
PackagesManagementException(String, Throwable) - Constructor for exception class org.apache.pulsar.packages.management.core.exceptions.PackagesManagementException
+
+
Constructs an PackagesManagementException with the specified detail message and the cause.
+
+
PackagesManagementException(Throwable) - Constructor for exception class org.apache.pulsar.packages.management.core.exceptions.PackagesManagementException
+
+
Constructs an PackagesManagementException with the specified cause.
+
+
PackagesManagementException.MetadataFormatException - Exception Class in org.apache.pulsar.packages.management.core.exceptions
+
 
+
PackagesManagementException.NotFoundException - Exception Class in org.apache.pulsar.packages.management.core.exceptions
+
 
+
PackageType - Enum Class in org.apache.pulsar.packages.management.core.common
+
+
PackageType used to identify the package type.
+
+
pageSize - Variable in class org.apache.pulsar.common.stats.AllocatorStats.PoolSubpageStats
+
 
+
parameters(Map<String, String>) - Method in interface org.apache.pulsar.common.policies.data.AutoFailoverPolicyData.Builder
+
 
+
parseFrom(String) - Static method in class org.apache.pulsar.common.functions.WorkerInfo
+
 
+
PARTITIONED - Enum constant in enum class org.apache.pulsar.common.policies.data.TopicType
+
 
+
PartitionedTopicInternalStats - Class in org.apache.pulsar.common.policies.data
+
+
Internal statistics for a partitioned topic.
+
+
PartitionedTopicInternalStats() - Constructor for class org.apache.pulsar.common.policies.data.PartitionedTopicInternalStats
+
 
+
PartitionedTopicInternalStats(PartitionedTopicMetadata) - Constructor for class org.apache.pulsar.common.policies.data.PartitionedTopicInternalStats
+
 
+
PartitionedTopicMetadata - Class in org.apache.pulsar.common.partition
+
+
Metadata of a partitioned topic.
+
+
PartitionedTopicMetadata() - Constructor for class org.apache.pulsar.common.partition.PartitionedTopicMetadata
+
 
+
PartitionedTopicMetadata(int) - Constructor for class org.apache.pulsar.common.partition.PartitionedTopicMetadata
+
 
+
PartitionedTopicMetadata(int, Map<String, String>) - Constructor for class org.apache.pulsar.common.partition.PartitionedTopicMetadata
+
 
+
PartitionedTopicStats - Interface in org.apache.pulsar.common.policies.data
+
+
Statistics for a partitioned topic.
+
+
partitions - Variable in class org.apache.pulsar.common.partition.PartitionedTopicMetadata
+
 
+
partitions - Variable in class org.apache.pulsar.common.policies.data.PartitionedTopicInternalStats
+
 
+
peekMessages(String, String, int) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Peek messages from a topic subscription.
+
+
peekMessages(String, String, int, boolean, TransactionIsolationLevel) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Peek messages from a topic subscription.
+
+
peekMessagesAsync(String, String, int) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Peek messages from a topic subscription asynchronously.
+
+
peekMessagesAsync(String, String, int, boolean, TransactionIsolationLevel) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Peek messages from a topic subscription asynchronously.
+
+
peerClusterNames(LinkedHashSet<String>) - Method in interface org.apache.pulsar.common.policies.data.ClusterData.Builder
+
 
+
PendingAck - Enum constant in enum class org.apache.pulsar.common.stats.PositionInPendingAckStats.State
+
 
+
pendingAckLogStats - Variable in class org.apache.pulsar.common.policies.data.TransactionPendingAckInternalStats
+
+
The transaction pending ack log stats.
+
+
PendingAckNotReady - Enum constant in enum class org.apache.pulsar.common.stats.PositionInPendingAckStats.State
+
 
+
pendingAddEntriesCount - Variable in class org.apache.pulsar.common.policies.data.ManagedLedgerInternalStats
+
+
The number of messages that complete (asynchronous) write requests.
+
+
pendingReadOps - Variable in class org.apache.pulsar.common.policies.data.ManagedLedgerInternalStats.CursorStats
+
 
+
percentUsage() - Method in class org.apache.pulsar.policies.data.loadbalancer.ResourceUsage
+
 
+
persistence - Variable in class org.apache.pulsar.common.policies.data.Policies
+
 
+
PersistencePolicies - Class in org.apache.pulsar.common.policies.data
+
+
Configuration of bookkeeper persistence policies.
+
+
PersistencePolicies() - Constructor for class org.apache.pulsar.common.policies.data.PersistencePolicies
+
 
+
PersistencePolicies(int, int, int, double) - Constructor for class org.apache.pulsar.common.policies.data.PersistencePolicies
+
 
+
PersistencePolicies(int, int, int, double, String) - Constructor for class org.apache.pulsar.common.policies.data.PersistencePolicies
+
 
+
persistent - Enum constant in enum class org.apache.pulsar.common.naming.TopicDomain
+
 
+
PERSISTENT - Enum constant in enum class org.apache.pulsar.client.admin.Mode
+
 
+
persistentPosition - Variable in class org.apache.pulsar.common.policies.data.SegmentStats
+
 
+
PersistentTopicInternalStats - Class in org.apache.pulsar.common.policies.data
+
+
Persistent topic internal statistics.
+
+
PersistentTopicInternalStats() - Constructor for class org.apache.pulsar.common.policies.data.PersistentTopicInternalStats
+
 
+
Policies - Class in org.apache.pulsar.common.policies.data
+
+
Definition of Pulsar policies.
+
+
Policies() - Constructor for class org.apache.pulsar.common.policies.data.Policies
+
 
+
Policies.BundleType - Enum Class in org.apache.pulsar.common.policies.data
+
 
+
policyName(String) - Method in interface org.apache.pulsar.common.policies.data.BrokerNamespaceIsolationData.Builder
+
 
+
policyType(AutoFailoverPolicyType) - Method in interface org.apache.pulsar.common.policies.data.AutoFailoverPolicyData.Builder
+
 
+
PoolArenaStats() - Constructor for class org.apache.pulsar.common.stats.AllocatorStats.PoolArenaStats
+
 
+
PoolChunkListStats() - Constructor for class org.apache.pulsar.common.stats.AllocatorStats.PoolChunkListStats
+
 
+
PoolChunkStats() - Constructor for class org.apache.pulsar.common.stats.AllocatorStats.PoolChunkStats
+
 
+
PoolSubpageStats() - Constructor for class org.apache.pulsar.common.stats.AllocatorStats.PoolSubpageStats
+
 
+
PositionInPendingAckStats - Class in org.apache.pulsar.common.stats
+
 
+
PositionInPendingAckStats() - Constructor for class org.apache.pulsar.common.stats.PositionInPendingAckStats
+
 
+
PositionInPendingAckStats(PositionInPendingAckStats.State) - Constructor for class org.apache.pulsar.common.stats.PositionInPendingAckStats
+
 
+
PositionInPendingAckStats.State - Enum Class in org.apache.pulsar.common.stats
+
 
+
PostSchemaPayload - Class in org.apache.pulsar.common.protocol.schema
+
+
Payload with information about a schema.
+
+
PostSchemaPayload() - Constructor for class org.apache.pulsar.common.protocol.schema.PostSchemaPayload
+
 
+
PreconditionFailedException(Throwable, String, int) - Constructor for exception class org.apache.pulsar.client.admin.PulsarAdminException.PreconditionFailedException
+
 
+
Prefix - Enum constant in enum class org.apache.pulsar.common.policies.data.SubscriptionAuthMode
+
+
Subscription name with auth role prefix can be used by the role.
+
+
primary - Enum constant in enum class org.apache.pulsar.common.policies.data.BrokerAssignment
+
 
+
primary(boolean) - Method in interface org.apache.pulsar.common.policies.data.BrokerNamespaceIsolationData.Builder
+
 
+
primary(List<String>) - Method in interface org.apache.pulsar.common.policies.data.NamespaceIsolationData.Builder
+
 
+
produce - Enum constant in enum class org.apache.pulsar.common.policies.data.AuthAction
+
+
Permission to produce/publish messages.
+
+
producedPartitions - Variable in class org.apache.pulsar.common.policies.data.TransactionMetadata
+
+
The producedPartitions of this transaction.
+
+
producer_exception - Enum constant in enum class org.apache.pulsar.common.policies.data.BacklogQuota.RetentionPolicy
+
+
Policy which throws javax.jms.ResourceAllocationException to the producer.
+
+
producer_request_hold - Enum constant in enum class org.apache.pulsar.common.policies.data.BacklogQuota.RetentionPolicy
+
+
Policy which holds producer's send request until the resource becomes available (or holding times out).
+
+
ProducerConfig - Class in org.apache.pulsar.common.functions
+
+
Configuration of the producer inside the function.
+
+
ProducerConfig() - Constructor for class org.apache.pulsar.common.functions.ProducerConfig
+
 
+
producerCount - Variable in class org.apache.pulsar.policies.data.loadbalancer.NamespaceBundleStats
+
 
+
properties - Variable in class org.apache.pulsar.common.partition.PartitionedTopicMetadata
+
 
+
properties - Variable in class org.apache.pulsar.common.policies.data.ManagedLedgerInternalStats.CursorStats
+
 
+
properties - Variable in class org.apache.pulsar.common.policies.data.Policies
+
 
+
properties() - Method in interface org.apache.pulsar.client.admin.PulsarAdmin
+
+
Deprecated. +
since 2.0. See PulsarAdmin.tenants()
+
+
+
Properties - Interface in org.apache.pulsar.client.admin
+
+
Deprecated. +
see Tenants from PulsarAdmin.tenants()
+
+
+
proxyProtocol(ProxyProtocol) - Method in interface org.apache.pulsar.common.policies.data.ClusterData.Builder
+
 
+
proxyServiceUrl(String) - Method in interface org.apache.pulsar.common.policies.data.ClusterData.Builder
+
 
+
proxyStats() - Method in interface org.apache.pulsar.client.admin.PulsarAdmin
+
 
+
ProxyStats - Interface in org.apache.pulsar.client.admin
+
+
Admin interface for proxy stats management.
+
+
PublisherStats - Interface in org.apache.pulsar.common.policies.data
+
+
Statistics about a publisher.
+
+
publishMaxMessageRate - Variable in class org.apache.pulsar.common.policies.data.Policies
+
 
+
PublishRate - Class in org.apache.pulsar.common.policies.data
+
+
Publish-rate to manage publish throttling.
+
+
PublishRate() - Constructor for class org.apache.pulsar.common.policies.data.PublishRate
+
 
+
PublishRate(int, long) - Constructor for class org.apache.pulsar.common.policies.data.PublishRate
+
 
+
publishThrottlingRateInByte - Variable in class org.apache.pulsar.common.policies.data.PublishRate
+
 
+
publishThrottlingRateInMsg - Variable in class org.apache.pulsar.common.policies.data.PublishRate
+
 
+
PulsarAdmin - Interface in org.apache.pulsar.client.admin
+
 
+
PulsarAdminBuilder - Interface in org.apache.pulsar.client.admin
+
+
Builder class for a PulsarAdmin instance.
+
+
PulsarAdminException - Exception Class in org.apache.pulsar.client.admin
+
+
Pulsar admin exceptions.
+
+
PulsarAdminException(String) - Constructor for exception class org.apache.pulsar.client.admin.PulsarAdminException
+
 
+
PulsarAdminException(String, Throwable) - Constructor for exception class org.apache.pulsar.client.admin.PulsarAdminException
+
 
+
PulsarAdminException(String, Throwable, String, int) - Constructor for exception class org.apache.pulsar.client.admin.PulsarAdminException
+
 
+
PulsarAdminException(Throwable) - Constructor for exception class org.apache.pulsar.client.admin.PulsarAdminException
+
 
+
PulsarAdminException(Throwable, String, int) - Constructor for exception class org.apache.pulsar.client.admin.PulsarAdminException
+
 
+
PulsarAdminException.ConflictException - Exception Class in org.apache.pulsar.client.admin
+
+
Conflict Exception.
+
+
PulsarAdminException.ConnectException - Exception Class in org.apache.pulsar.client.admin
+
+
Connect Exception.
+
+
PulsarAdminException.GettingAuthenticationDataException - Exception Class in org.apache.pulsar.client.admin
+
+
Getting Authentication Data Exception.
+
+
PulsarAdminException.HttpErrorException - Exception Class in org.apache.pulsar.client.admin
+
+
Http Error Exception.
+
+
PulsarAdminException.NotAllowedException - Exception Class in org.apache.pulsar.client.admin
+
+
Not Allowed Exception.
+
+
PulsarAdminException.NotAuthorizedException - Exception Class in org.apache.pulsar.client.admin
+
+
Not Authorized Exception.
+
+
PulsarAdminException.NotFoundException - Exception Class in org.apache.pulsar.client.admin
+
+
Not Found Exception.
+
+
PulsarAdminException.PreconditionFailedException - Exception Class in org.apache.pulsar.client.admin
+
+
Precondition Failed Exception.
+
+
PulsarAdminException.ServerSideErrorException - Exception Class in org.apache.pulsar.client.admin
+
+
Server Side Error Exception.
+
+
PulsarAdminException.TimeoutException - Exception Class in org.apache.pulsar.client.admin
+
+
Timeout Exception.
+
+
put(String, Object) - Method in class org.apache.pulsar.common.stats.Metrics
+
 
+
putAll(Map<String, Object>) - Method in class org.apache.pulsar.common.stats.Metrics
+
 
+
putFunctionState(String, String, String, FunctionState) - Method in interface org.apache.pulsar.client.admin.Functions
+
+
Puts the given state associated with a Pulsar Function.
+
+
putFunctionStateAsync(String, String, String, FunctionState) - Method in interface org.apache.pulsar.client.admin.Functions
+
+
Puts the given state associated with a Pulsar Function asynchronously.
+
+
PYTHON - Enum constant in enum class org.apache.pulsar.common.functions.FunctionConfig.Runtime
+
 
+
+

R

+
+
rack(String) - Method in interface org.apache.pulsar.common.policies.data.BookieInfo.Builder
+
 
+
rack(String) - Method in class org.apache.pulsar.common.policies.data.impl.BookieInfoImpl.BookieInfoImplBuilder
+
 
+
ratePeriodInSecond - Variable in class org.apache.pulsar.common.policies.data.SubscribeRate
+
 
+
ratePeriodInSecond(int) - Method in interface org.apache.pulsar.common.policies.data.DispatchRate.Builder
+
 
+
ratePeriodInSecond(int) - Method in class org.apache.pulsar.common.policies.data.impl.DispatchRateImpl.DispatchRateImplBuilder
+
 
+
RawBookieInfo - Class in org.apache.pulsar.common.policies.data
+
+
Bookie information.
+
+
RawBookieInfo() - Constructor for class org.apache.pulsar.common.policies.data.RawBookieInfo
+
 
+
readPosition - Variable in class org.apache.pulsar.common.policies.data.ManagedLedgerInternalStats.CursorStats
+
 
+
readTimeout(int, TimeUnit) - Method in interface org.apache.pulsar.client.admin.PulsarAdminBuilder
+
+
This sets the server response read time out for the pulsar admin client for any request.
+
+
reason - Variable in class org.apache.pulsar.common.policies.data.ErrorData
+
 
+
rebalance() - Method in interface org.apache.pulsar.client.admin.Worker
+
+
Triggers a rebalance of functions to workers.
+
+
rebalanceAsync() - Method in interface org.apache.pulsar.client.admin.Worker
+
+
Triggers a rebalance of functions to workersasynchronously..
+
+
recoverEndTime - Variable in class org.apache.pulsar.common.policies.data.TransactionBufferStats
+
 
+
recoverEndTime - Variable in class org.apache.pulsar.common.policies.data.TransactionCoordinatorStats
+
 
+
recoverEndTime - Variable in class org.apache.pulsar.common.policies.data.TransactionPendingAckStats
+
 
+
recoverStartTime - Variable in class org.apache.pulsar.common.policies.data.TransactionBufferStats
+
 
+
recoverStartTime - Variable in class org.apache.pulsar.common.policies.data.TransactionCoordinatorStats
+
 
+
recoverStartTime - Variable in class org.apache.pulsar.common.policies.data.TransactionPendingAckStats
+
 
+
ReflectionUtils - Class in org.apache.pulsar.client.admin.utils
+
 
+
ReflectionUtils() - Constructor for class org.apache.pulsar.client.admin.utils.ReflectionUtils
+
 
+
relativeToPublishRate(boolean) - Method in interface org.apache.pulsar.common.policies.data.DispatchRate.Builder
+
 
+
relativeToPublishRate(boolean) - Method in class org.apache.pulsar.common.policies.data.impl.DispatchRateImpl.DispatchRateImplBuilder
+
 
+
reloadBuiltInFunctions() - Method in interface org.apache.pulsar.client.admin.Functions
+
+
Reload the available built-in functions.
+
+
reloadBuiltInFunctionsAsync() - Method in interface org.apache.pulsar.client.admin.Functions
+
+
Reload the available built-in functions.
+
+
reloadBuiltInSinks() - Method in interface org.apache.pulsar.client.admin.Sinks
+
+
Reload the available built-in connectors, include Source and Sink.
+
+
reloadBuiltInSinksAsync() - Method in interface org.apache.pulsar.client.admin.Sinks
+
+
Reload the available built-in connectors, include Source and Sink asynchronously.
+
+
reloadBuiltInSources() - Method in interface org.apache.pulsar.client.admin.Sources
+
+
Reload the available built-in connectors, include Source and Source.
+
+
reloadBuiltInSourcesAsync() - Method in interface org.apache.pulsar.client.admin.Sources
+
+
Reload the available built-in connectors, include Source and Source asynchronously.
+
+
removeAutoSubscriptionCreation(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Removes the autoSubscriptionCreation policy for a given namespace.
+
+
removeAutoSubscriptionCreation(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Removes the autoSubscriptionCreation policy for a given topic.
+
+
removeAutoSubscriptionCreationAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Removes the autoSubscriptionCreation policy for a given namespace asynchronously.
+
+
removeAutoSubscriptionCreationAsync(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Removes the autoSubscriptionCreation policy for a given topic asynchronously.
+
+
removeAutoTopicCreation(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Removes the autoTopicCreation policy for a given namespace.
+
+
removeAutoTopicCreationAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Removes the autoTopicCreation policy for a given namespace asynchronously.
+
+
removeBacklogQuota(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
 
+
removeBacklogQuota(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
 
+
removeBacklogQuota(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.removeBacklogQuota(String) instead.
+
+
+
removeBacklogQuota(String, BacklogQuota.BacklogQuotaType) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Remove a backlog quota policy from a namespace.
+
+
removeBacklogQuota(String, BacklogQuota.BacklogQuotaType) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Remove a backlog quota policy from a topic.
+
+
removeBacklogQuota(String, BacklogQuota.BacklogQuotaType) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.removeBacklogQuota(String, BacklogQuota.BacklogQuotaType) instead.
+
+
+
removeBacklogQuotaAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
 
+
removeBacklogQuotaAsync(String, BacklogQuota.BacklogQuotaType) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Remove a backlog quota policy from a namespace asynchronously.
+
+
removeBookie(String) - Method in class org.apache.pulsar.common.policies.data.BookiesRackConfiguration
+
 
+
removeCompactionThreshold(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Delete the compactionThreshold for a namespace.
+
+
removeCompactionThreshold(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Remove the compactionThreshold for a topic.
+
+
removeCompactionThreshold(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.removeCompactionThreshold(String) instead.
+
+
+
removeCompactionThresholdAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Delete the compactionThreshold for a namespace asynchronously.
+
+
removeCompactionThresholdAsync(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Remove the compactionThreshold for a topic asynchronously.
+
+
removeCompactionThresholdAsync(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.removeCompactionThresholdAsync(String) instead.
+
+
+
removeDeduplicationSnapshotInterval(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Remove the deduplicationSnapshotInterval for a namespace.
+
+
removeDeduplicationSnapshotInterval(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Remove the deduplication snapshot interval for specified topic.
+
+
removeDeduplicationSnapshotInterval(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.removeDeduplicationSnapshotInterval(String) instead.
+
+
+
removeDeduplicationSnapshotIntervalAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Remove the deduplicationSnapshotInterval for a namespace asynchronously.
+
+
removeDeduplicationSnapshotIntervalAsync(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Remove the deduplication snapshot interval for specified topic asynchronously.
+
+
removeDeduplicationSnapshotIntervalAsync(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.removeDeduplicationSnapshotIntervalAsync(String) instead.
+
+
+
removeDeduplicationStatus(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Remove the deduplication status for all topics within a namespace.
+
+
removeDeduplicationStatus(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
remove deduplication enabled of a topic.
+
+
removeDeduplicationStatus(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.removeDeduplicationStatus(String) instead.
+
+
+
removeDeduplicationStatusAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Get the deduplication status for all topics within a namespace asynchronously.
+
+
removeDeduplicationStatusAsync(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
remove deduplication enabled of a topic asynchronously.
+
+
removeDeduplicationStatusAsync(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.removeDeduplicationStatusAsync(String) instead.
+
+
+
removeDelayedDeliveryMessages(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Remove the delayed delivery messages for all topics within a namespace.
+
+
removeDelayedDeliveryMessagesAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Remove the delayed delivery messages for all topics within a namespace asynchronously.
+
+
removeDelayedDeliveryPolicy(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Remove the delayed delivery policy for a specified topic.
+
+
removeDelayedDeliveryPolicy(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.removeDelayedDeliveryPolicy(String) instead.
+
+
+
removeDelayedDeliveryPolicyAsync(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Remove the delayed delivery policy for a specified topic asynchronously.
+
+
removeDelayedDeliveryPolicyAsync(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.removeDelayedDeliveryPolicyAsync(String) instead.
+
+
+
removeDispatcherPauseOnAckStatePersistent(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Removes the dispatcherPauseOnAckStatePersistentEnabled policy for a given namespace.
+
+
removeDispatcherPauseOnAckStatePersistent(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Removes the dispatcherPauseOnAckStatePersistentEnabled policy for a given topic asynchronously.
+
+
removeDispatcherPauseOnAckStatePersistentAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Removes the dispatcherPauseOnAckStatePersistentEnabled policy for a given namespace asynchronously.
+
+
removeDispatchRate(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Remove message-dispatch-rate.
+
+
removeDispatchRate(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Remove message-dispatch-rate.
+
+
removeDispatchRate(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.removeDispatchRate(String) instead.
+
+
+
removeDispatchRateAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Remove message-dispatch-rate asynchronously.
+
+
removeDispatchRateAsync(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Remove message-dispatch-rate asynchronously.
+
+
removeDispatchRateAsync(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.removeDispatchRateAsync(String) instead.
+
+
+
removeEntryFiltersPerTopic(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
remove entry filters of a topic.
+
+
removeEntryFiltersPerTopicAsync(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
remove entry filters of a topic asynchronously.
+
+
removeInactiveTopicPolicies(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Remove inactive topic policies from a namespace.
+
+
removeInactiveTopicPolicies(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
remove inactive topic policies of a topic.
+
+
removeInactiveTopicPolicies(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.removeInactiveTopicPolicies(String) instead.
+
+
+
removeInactiveTopicPoliciesAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
remove InactiveTopicPolicies from a namespace asynchronously.
+
+
removeInactiveTopicPoliciesAsync(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
remove inactive topic policies of a topic asynchronously.
+
+
removeInactiveTopicPoliciesAsync(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.removeInactiveTopicPoliciesAsync(String) instead.
+
+
+
removeMaxConsumers(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Remove the max number of consumer for specified topic.
+
+
removeMaxConsumers(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.removeMaxConsumers(String) instead.
+
+
+
removeMaxConsumersAsync(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Remove the max number of consumer for specified topic asynchronously.
+
+
removeMaxConsumersAsync(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.removeMaxConsumersAsync(String) instead.
+
+
+
removeMaxConsumersPerSubscription(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Remove maxConsumersPerSubscription for a namespace.
+
+
removeMaxConsumersPerSubscription(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Remove the maxConsumersPerSubscription for a topic.
+
+
removeMaxConsumersPerSubscription(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.removeMaxConsumersPerSubscription(String) instead.
+
+
+
removeMaxConsumersPerSubscriptionAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Remove maxConsumersPerSubscription for a namespace asynchronously.
+
+
removeMaxConsumersPerSubscriptionAsync(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Remove the maxConsumersPerSubscription for a topic asynchronously.
+
+
removeMaxConsumersPerSubscriptionAsync(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.removeMaxConsumersPerSubscriptionAsync(String) instead.
+
+
+
removeMaxConsumersPerTopic(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Remove maxConsumersPerTopic for a namespace.
+
+
removeMaxConsumersPerTopicAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Remove maxConsumersPerTopic for a namespace asynchronously.
+
+
removeMaxMessageSize(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Remove the max message size for specified topic.
+
+
removeMaxMessageSize(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.removeMaxMessageSize(String) instead.
+
+
+
removeMaxMessageSizeAsync(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Remove the max message size for specified topic asynchronously.
+
+
removeMaxMessageSizeAsync(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.removeMaxMessageSizeAsync(String) instead.
+
+
+
removeMaxProducers(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Remove the max number of producer for specified topic.
+
+
removeMaxProducers(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.removeMaxProducers(String) instead.
+
+
+
removeMaxProducersAsync(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Remove the max number of producer for specified topic asynchronously.
+
+
removeMaxProducersAsync(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.removeMaxProducersAsync(String) instead.
+
+
+
removeMaxProducersPerTopic(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Remove maxProducersPerTopic for a namespace.
+
+
removeMaxProducersPerTopicAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set maxProducersPerTopic for a namespace asynchronously.
+
+
removeMaxSubscriptionsPerTopic(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Remove the maxSubscriptionsPerTopic for a namespace.
+
+
removeMaxSubscriptionsPerTopic(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Remove the max number of subscriptions for specified topic.
+
+
removeMaxSubscriptionsPerTopic(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.removeMaxSubscriptionsPerTopic(String) instead.
+
+
+
removeMaxSubscriptionsPerTopicAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Remove the maxSubscriptionsPerTopic for a namespace asynchronously.
+
+
removeMaxSubscriptionsPerTopicAsync(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Remove the max number of subscriptions for specified topic asynchronously.
+
+
removeMaxSubscriptionsPerTopicAsync(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.removeMaxSubscriptionsPerTopicAsync(String) instead.
+
+
+
removeMaxTopicsPerNamespace(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
remove maxTopicsPerNamespace for a namespace.
+
+
removeMaxTopicsPerNamespaceAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
remove maxTopicsPerNamespace for a namespace asynchronously.
+
+
removeMaxUnackedMessagesOnConsumer(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
remove max unacked messages on consumer of a topic.
+
+
removeMaxUnackedMessagesOnConsumer(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.removeMaxUnackedMessagesOnConsumer(String) instead.
+
+
+
removeMaxUnackedMessagesOnConsumerAsync(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
remove max unacked messages on consumer of a topic asynchronously.
+
+
removeMaxUnackedMessagesOnConsumerAsync(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.removeMaxUnackedMessagesOnConsumerAsync(String) instead.
+
+
+
removeMaxUnackedMessagesOnSubscription(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
remove max unacked messages on subscription of a topic.
+
+
removeMaxUnackedMessagesOnSubscription(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.removeMaxUnackedMessagesOnSubscription(String) instead.
+
+
+
removeMaxUnackedMessagesOnSubscriptionAsync(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
remove max unacked messages on subscription of a topic asynchronously.
+
+
removeMaxUnackedMessagesOnSubscriptionAsync(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.removeMaxUnackedMessagesOnSubscriptionAsync(String) instead.
+
+
+
removeMaxUnackedMessagesPerConsumer(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Remove maxUnackedMessagesPerConsumer for a namespace.
+
+
removeMaxUnackedMessagesPerConsumerAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Remove maxUnackedMessagesPerConsumer for a namespace asynchronously.
+
+
removeMaxUnackedMessagesPerSubscription(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Remove maxUnackedMessagesPerSubscription for a namespace.
+
+
removeMaxUnackedMessagesPerSubscriptionAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Remove maxUnackedMessagesPerSubscription for a namespace asynchronously.
+
+
removeMessageTTL(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Remove message TTL for a topic.
+
+
removeMessageTTL(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.removeMessageTTL(String) instead.
+
+
+
removeNamespaceEntryFilters(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
remove entry filters of a namespace.
+
+
removeNamespaceEntryFiltersAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
remove entry filters of a namespace asynchronously.
+
+
removeNamespaceMessageTTL(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Remove the messages Time to Live for all the topics within a namespace.
+
+
removeNamespaceMessageTTLAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Remove the messages Time to Live for all the topics within a namespace asynchronously.
+
+
removeNamespaceResourceGroup(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Remove the ResourceGroup on a namespace.
+
+
removeNamespaceResourceGroupAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Remove the ResourceGroup on a namespace asynchronously.
+
+
removeOffloadPolicies(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Remove the offload configuration for a namespace.
+
+
removeOffloadPolicies(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
remove offload policies of a topic.
+
+
removeOffloadPolicies(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.removeOffloadPolicies(String) instead.
+
+
+
removeOffloadPoliciesAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Remove the offload configuration for a namespace asynchronously.
+
+
removeOffloadPoliciesAsync(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
remove offload policies of a topic asynchronously.
+
+
removeOffloadPoliciesAsync(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.removeOffloadPoliciesAsync(String) instead.
+
+
+
removePersistence(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Remove the persistence configuration on a namespace.
+
+
removePersistence(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Remove the configuration of persistence policies for specified topic.
+
+
removePersistence(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.removePersistence(String) instead.
+
+
+
removePersistenceAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Remove the persistence configuration on a namespace asynchronously.
+
+
removePersistenceAsync(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Remove the configuration of persistence policies for specified topic asynchronously.
+
+
removePersistenceAsync(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.removePersistenceAsync(String) instead.
+
+
+
removeProperties(String, String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Remove the key in properties on a topic.
+
+
removePropertiesAsync(String, String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Remove the key in properties on a topic asynchronously.
+
+
removeProperty(String, String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Remove a property for a given key.
+
+
removePropertyAsync(String, String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Remove a property for a given key.
+
+
removePublishRate(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Remove message-publish-rate (topics under this namespace can publish this many messages per second).
+
+
removePublishRate(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Remove message-publish-rate.
+
+
removePublishRate(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.removePublishRate(String) instead.
+
+
+
removePublishRateAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Remove message-publish-rate asynchronously.
+
+
removePublishRateAsync(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Remove message-publish-rate asynchronously.
+
+
removePublishRateAsync(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.removePublishRateAsync(String) instead.
+
+
+
removeReplicationClusters(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Remove the replication clusters for the topic.
+
+
removeReplicationClustersAsync(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Remove the replication clusters for the topic asynchronously.
+
+
removeReplicatorDispatchRate(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Remove replicator-message-dispatch-rate.
+
+
removeReplicatorDispatchRate(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Remove replicatorDispatchRate for a topic.
+
+
removeReplicatorDispatchRate(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.removeReplicatorDispatchRate(String) instead.
+
+
+
removeReplicatorDispatchRateAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set replicator-message-dispatch-rate asynchronously.
+
+
removeReplicatorDispatchRateAsync(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Remove replicatorDispatchRate for a topic asynchronously.
+
+
removeReplicatorDispatchRateAsync(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.removeReplicatorDispatchRateAsync(String) instead.
+
+
+
removeRetention(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Remove the retention configuration for all the topics on a namespace.
+
+
removeRetention(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Remove the retention configuration for all the topics on a topic.
+
+
removeRetention(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.removeRetention(String) instead.
+
+
+
removeRetentionAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Remove the retention configuration for all the topics on a namespace asynchronously.
+
+
removeRetentionAsync(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Remove the retention configuration for all the topics on a topic asynchronously.
+
+
removeRetentionAsync(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.removeRetentionAsync(String) instead.
+
+
+
removeSchemaCompatibilityStrategy(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Remove schema compatibility strategy on a topic.
+
+
removeSchemaCompatibilityStrategyAsync(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Remove schema compatibility strategy on a topic asynchronously.
+
+
removeShadowTopics(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Remove all shadow topics for a source topic.
+
+
removeShadowTopicsAsync(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Remove all shadow topics for a source topic asynchronously.
+
+
removeSubscribeRate(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Remove namespace-subscribe-rate (topics under this namespace will limit by subscribeRate).
+
+
removeSubscribeRate(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Remove topic-subscribe-rate.
+
+
removeSubscribeRate(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.removeSubscribeRate(String) instead.
+
+
+
removeSubscribeRateAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Remove namespace-subscribe-rate (topics under this namespace will limit by subscribeRate) asynchronously.
+
+
removeSubscribeRateAsync(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Remove topic-subscribe-rate asynchronously.
+
+
removeSubscribeRateAsync(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.removeSubscribeRateAsync(String) instead.
+
+
+
removeSubscriptionDispatchRate(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Remove subscription-message-dispatch-rate.
+
+
removeSubscriptionDispatchRate(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Remove subscription-message-dispatch-rate for a topic.
+
+
removeSubscriptionDispatchRate(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.removeSubscriptionDispatchRate(String) instead.
+
+
+
removeSubscriptionDispatchRate(String, String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Remove subscription level dispatch rate limiter setting for a specific subscription.
+
+
removeSubscriptionDispatchRateAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Remove subscription-message-dispatch-rate asynchronously.
+
+
removeSubscriptionDispatchRateAsync(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Remove subscription-message-dispatch-rate for a topic asynchronously.
+
+
removeSubscriptionDispatchRateAsync(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.removeSubscriptionDispatchRateAsync(String) instead.
+
+
+
removeSubscriptionDispatchRateAsync(String, String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Async version of TopicPolicies.removeSubscriptionDispatchRate(String, String).
+
+
removeSubscriptionExpirationTime(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Remove the subscription expiration time for a namespace.
+
+
removeSubscriptionExpirationTimeAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Remove the subscription expiration time for a namespace asynchronously.
+
+
removeSubscriptionTypesEnabled(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Removes the subscriptionTypesEnabled policy for a given namespace.
+
+
removeSubscriptionTypesEnabled(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Remove subscription types enabled for a topic.
+
+
removeSubscriptionTypesEnabled(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.removeSubscriptionTypesEnabled(String) instead.
+
+
+
removeSubscriptionTypesEnabledAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Removes the subscriptionTypesEnabled policy for a given namespace.
+
+
removeSubscriptionTypesEnabledAsync(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Remove subscription types enabled for a topic asynchronously.
+
+
removeSubscriptionTypesEnabledAsync(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.removeSubscriptionTypesEnabledAsync(String) instead.
+
+
+
replication_clusters - Variable in class org.apache.pulsar.common.policies.data.Policies
+
 
+
replicatorDispatchRate - Variable in class org.apache.pulsar.common.policies.data.Policies
+
 
+
ReplicatorStats - Interface in org.apache.pulsar.common.policies.data
+
+
Statistics about a replicator.
+
+
requestTimeout(int, TimeUnit) - Method in interface org.apache.pulsar.client.admin.PulsarAdminBuilder
+
+
This sets the server request time out for the pulsar admin client for any request.
+
+
reset() - Method in class org.apache.pulsar.common.policies.data.PartitionedTopicInternalStats
+
 
+
reset() - Method in class org.apache.pulsar.policies.data.loadbalancer.NamespaceBundleStats
+
 
+
resetCursor(String, String, long) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Reset cursor position on a topic subscription.
+
+
resetCursor(String, String, MessageId) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Reset cursor position on a topic subscription.
+
+
resetCursor(String, String, MessageId, boolean) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Reset cursor position on a topic subscription.
+
+
resetCursorAsync(String, String, long) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Reset cursor position on a topic subscription.
+
+
resetCursorAsync(String, String, MessageId) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Reset cursor position on a topic subscription.
+
+
resetCursorAsync(String, String, MessageId, boolean) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Reset cursor position on a topic subscription.
+
+
resetNamespaceBundleResourceQuota(String, String) - Method in interface org.apache.pulsar.client.admin.ResourceQuotas
+
+
Reset resource quota for a namespace bundle to default value.
+
+
resetNamespaceBundleResourceQuotaAsync(String, String) - Method in interface org.apache.pulsar.client.admin.ResourceQuotas
+
+
Reset resource quota for a namespace bundle to default value asynchronously.
+
+
resource_group_name - Variable in class org.apache.pulsar.common.policies.data.Policies
+
 
+
ResourceGroup - Class in org.apache.pulsar.common.policies.data
+
 
+
ResourceGroup() - Constructor for class org.apache.pulsar.common.policies.data.ResourceGroup
+
 
+
resourcegroups() - Method in interface org.apache.pulsar.client.admin.PulsarAdmin
+
 
+
ResourceGroups - Interface in org.apache.pulsar.client.admin
+
+
Admin interface for ResourceGroups management.
+
+
ResourceQuota - Class in org.apache.pulsar.common.policies.data
+
+
Resource quota for a namespace or namespace bundle.
+
+
ResourceQuota() - Constructor for class org.apache.pulsar.common.policies.data.ResourceQuota
+
 
+
resourceQuotas() - Method in interface org.apache.pulsar.client.admin.PulsarAdmin
+
 
+
ResourceQuotas - Interface in org.apache.pulsar.client.admin
+
+
Admin interface on interacting with resource quotas.
+
+
Resources - Class in org.apache.pulsar.common.functions
+
+
Class representing resources, such as CPU, RAM, and disk size.
+
+
Resources() - Constructor for class org.apache.pulsar.common.functions.Resources
+
 
+
ResourceUsage - Class in org.apache.pulsar.policies.data.loadbalancer
+
+
POJO used to represent any system specific resource usage this is the format that load manager expects it in.
+
+
ResourceUsage() - Constructor for class org.apache.pulsar.policies.data.loadbalancer.ResourceUsage
+
 
+
ResourceUsage(double, double) - Constructor for class org.apache.pulsar.policies.data.loadbalancer.ResourceUsage
+
 
+
restartFunction(String, String, String) - Method in interface org.apache.pulsar.client.admin.Functions
+
+
Restart all function instances.
+
+
restartFunction(String, String, String, int) - Method in interface org.apache.pulsar.client.admin.Functions
+
+
Restart function instance.
+
+
restartFunctionAsync(String, String, String) - Method in interface org.apache.pulsar.client.admin.Functions
+
+
Restart all function instances asynchronously.
+
+
restartFunctionAsync(String, String, String, int) - Method in interface org.apache.pulsar.client.admin.Functions
+
+
Restart function instance asynchronously.
+
+
restartSink(String, String, String) - Method in interface org.apache.pulsar.client.admin.Sinks
+
+
Restart all sink instances.
+
+
restartSink(String, String, String, int) - Method in interface org.apache.pulsar.client.admin.Sinks
+
+
Restart sink instance.
+
+
restartSinkAsync(String, String, String) - Method in interface org.apache.pulsar.client.admin.Sinks
+
+
Restart all sink instances asynchronously.
+
+
restartSinkAsync(String, String, String, int) - Method in interface org.apache.pulsar.client.admin.Sinks
+
+
Restart sink instance asynchronously.
+
+
restartSource(String, String, String) - Method in interface org.apache.pulsar.client.admin.Sources
+
+
Restart all source instances.
+
+
restartSource(String, String, String, int) - Method in interface org.apache.pulsar.client.admin.Sources
+
+
Restart source instance.
+
+
restartSourceAsync(String, String, String) - Method in interface org.apache.pulsar.client.admin.Sources
+
+
Restart all source instances asynchronously.
+
+
restartSourceAsync(String, String, String, int) - Method in interface org.apache.pulsar.client.admin.Sources
+
+
Restart source instance asynchronously.
+
+
retention_policies - Variable in class org.apache.pulsar.common.policies.data.Policies
+
 
+
RetentionPolicies - Class in org.apache.pulsar.common.policies.data
+
+
Definition of the retention policy.
+
+
RetentionPolicies() - Constructor for class org.apache.pulsar.common.policies.data.RetentionPolicies
+
 
+
RetentionPolicies(int, long) - Constructor for class org.apache.pulsar.common.policies.data.RetentionPolicies
+
 
+
retentionPolicy(BacklogQuota.RetentionPolicy) - Method in interface org.apache.pulsar.common.policies.data.BacklogQuota.Builder
+
 
+
retentionPolicy(BacklogQuota.RetentionPolicy) - Method in class org.apache.pulsar.common.policies.data.impl.BacklogQuotaImpl.BacklogQuotaImplBuilder
+
 
+
revokePermissionOnSubscription(String, String, String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Revoke permissions on a subscription's admin-api access.
+
+
revokePermissionOnSubscriptionAsync(String, String, String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Revoke permissions on a subscription's admin-api access asynchronously.
+
+
revokePermissionOnTopics(List<RevokeTopicPermissionOptions>) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Revoke permissions on topics.
+
+
revokePermissionOnTopicsAsync(List<RevokeTopicPermissionOptions>) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Revoke permissions on topics asynchronously.
+
+
revokePermissions(String, String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Revoke permissions on a topic.
+
+
revokePermissionsAsync(String, String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Revoke permissions on a topic asynchronously.
+
+
revokePermissionsOnNamespace(String, String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Revoke permissions on a namespace.
+
+
revokePermissionsOnNamespaceAsync(String, String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Revoke permissions on a namespace asynchronously.
+
+
RevokeTopicPermissionOptions - Class in org.apache.pulsar.client.admin
+
 
+
RevokeTopicPermissionOptions() - Constructor for class org.apache.pulsar.client.admin.RevokeTopicPermissionOptions
+
 
+
running - Variable in class org.apache.pulsar.common.policies.data.FunctionStatus.FunctionInstanceStatus.FunctionInstanceStatusData
+
 
+
running - Variable in class org.apache.pulsar.common.policies.data.SinkStatus.SinkInstanceStatus.SinkInstanceStatusData
+
 
+
running - Variable in class org.apache.pulsar.common.policies.data.SourceStatus.SourceInstanceStatus.SourceInstanceStatusData
+
 
+
RUNNING - Enum constant in enum class org.apache.pulsar.client.admin.LongRunningProcessStatus.Status
+
 
+
+

S

+
+
s3ManagedLedgerOffloadBucket(String) - Method in interface org.apache.pulsar.common.policies.data.OffloadPolicies.Builder
+
 
+
s3ManagedLedgerOffloadCredentialId(String) - Method in interface org.apache.pulsar.common.policies.data.OffloadPolicies.Builder
+
 
+
s3ManagedLedgerOffloadCredentialSecret(String) - Method in interface org.apache.pulsar.common.policies.data.OffloadPolicies.Builder
+
 
+
s3ManagedLedgerOffloadMaxBlockSizeInBytes(Integer) - Method in interface org.apache.pulsar.common.policies.data.OffloadPolicies.Builder
+
 
+
s3ManagedLedgerOffloadReadBufferSizeInBytes(Integer) - Method in interface org.apache.pulsar.common.policies.data.OffloadPolicies.Builder
+
 
+
s3ManagedLedgerOffloadRegion(String) - Method in interface org.apache.pulsar.common.policies.data.OffloadPolicies.Builder
+
 
+
s3ManagedLedgerOffloadRole(String) - Method in interface org.apache.pulsar.common.policies.data.OffloadPolicies.Builder
+
 
+
s3ManagedLedgerOffloadServiceEndpoint(String) - Method in interface org.apache.pulsar.common.policies.data.OffloadPolicies.Builder
+
 
+
scaleTransactionCoordinators(int) - Method in interface org.apache.pulsar.client.admin.Transactions
+
+
Sets the scale of the transaction coordinators.
+
+
scaleTransactionCoordinatorsAsync(int) - Method in interface org.apache.pulsar.client.admin.Transactions
+
+
Asynchronously sets the size of the transaction coordinators.
+
+
schema_auto_update_compatibility_strategy - Variable in class org.apache.pulsar.common.policies.data.Policies
+
+
Deprecated.
+
+
schema_compatibility_strategy - Variable in class org.apache.pulsar.common.policies.data.Policies
+
 
+
schema_validation_enforced - Variable in class org.apache.pulsar.common.policies.data.Policies
+
 
+
SchemaAutoUpdateCompatibilityStrategy - Enum Class in org.apache.pulsar.common.policies.data
+
+
Strategy to use when checking an auto-updated schema for compatibility to the current schema.
+
+
SchemaCompatibilityStrategy - Enum Class in org.apache.pulsar.common.policies.data
+
+
Pulsar Schema compatibility strategy.
+
+
schemaLedgers - Variable in class org.apache.pulsar.common.policies.data.PersistentTopicInternalStats
+
 
+
SchemaMetadata - Class in org.apache.pulsar.common.policies.data
+
+
Schema metadata info.
+
+
SchemaMetadata() - Constructor for class org.apache.pulsar.common.policies.data.SchemaMetadata
+
 
+
SchemaMetadata.Entry - Class in org.apache.pulsar.common.policies.data
+
 
+
schemas() - Method in interface org.apache.pulsar.client.admin.PulsarAdmin
+
 
+
Schemas - Interface in org.apache.pulsar.client.admin
+
+
Admin interface on interacting with schemas.
+
+
secondary - Enum constant in enum class org.apache.pulsar.common.policies.data.BrokerAssignment
+
 
+
secondary(List<String>) - Method in interface org.apache.pulsar.common.policies.data.NamespaceIsolationData.Builder
+
 
+
segmentIndexInternalStats - Variable in class org.apache.pulsar.common.policies.data.TransactionBufferInternalStats
+
 
+
segmentInternalStats - Variable in class org.apache.pulsar.common.policies.data.TransactionBufferInternalStats
+
 
+
segmentsSize - Variable in class org.apache.pulsar.common.policies.data.SegmentsStats
+
 
+
segmentsStats - Variable in class org.apache.pulsar.common.policies.data.TransactionBufferStats
+
 
+
SegmentsStats - Class in org.apache.pulsar.common.policies.data
+
 
+
SegmentsStats() - Constructor for class org.apache.pulsar.common.policies.data.SegmentsStats
+
 
+
segmentStats - Variable in class org.apache.pulsar.common.policies.data.SegmentsStats
+
 
+
SegmentStats - Class in org.apache.pulsar.common.policies.data
+
 
+
SegmentStats() - Constructor for class org.apache.pulsar.common.policies.data.SegmentStats
+
 
+
SegmentStats(String, String) - Constructor for class org.apache.pulsar.common.policies.data.SegmentStats
+
 
+
ServerSideErrorException(Throwable) - Constructor for exception class org.apache.pulsar.client.admin.PulsarAdminException.ServerSideErrorException
+
+
Deprecated.
+
+
ServerSideErrorException(Throwable, String, String, int) - Constructor for exception class org.apache.pulsar.client.admin.PulsarAdminException.ServerSideErrorException
+
 
+
serviceHttpUrl(String) - Method in interface org.apache.pulsar.client.admin.PulsarAdminBuilder
+
+
Set the Pulsar service HTTP URL for the admin endpoint (eg.
+
+
ServiceLookupData - Interface in org.apache.pulsar.policies.data.loadbalancer
+
+
For backwards compatibility purposes.
+
+
serviceUrl(String) - Method in interface org.apache.pulsar.common.policies.data.BrokerInfo.Builder
+
 
+
serviceUrl(String) - Method in interface org.apache.pulsar.common.policies.data.ClusterData.Builder
+
 
+
serviceUrl(String) - Method in class org.apache.pulsar.common.policies.data.impl.BrokerInfoImpl.BrokerInfoImplBuilder
+
 
+
serviceUrlTls(String) - Method in interface org.apache.pulsar.common.policies.data.ClusterData.Builder
+
 
+
setAutoSubscriptionCreation(String, AutoSubscriptionCreationOverride) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Sets the autoSubscriptionCreation policy for a given namespace, overriding broker settings.
+
+
setAutoSubscriptionCreation(String, AutoSubscriptionCreationOverride) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Sets the autoSubscriptionCreation policy for a given topic, overriding namespace settings.
+
+
setAutoSubscriptionCreationAsync(String, AutoSubscriptionCreationOverride) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Sets the autoSubscriptionCreation policy for a given namespace, overriding broker settings asynchronously.
+
+
setAutoSubscriptionCreationAsync(String, AutoSubscriptionCreationOverride) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Sets the autoSubscriptionCreation policy for a given topic, overriding namespace settings asynchronously.
+
+
setAutoTopicCreation(String, AutoTopicCreationOverride) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Sets the autoTopicCreation policy for a given namespace, overriding broker settings.
+
+
setAutoTopicCreationAsync(String, AutoTopicCreationOverride) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Sets the autoTopicCreation policy for a given namespace, overriding broker settings asynchronously.
+
+
setBacklogQuota(String, BacklogQuota) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
 
+
setBacklogQuota(String, BacklogQuota) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
 
+
setBacklogQuota(String, BacklogQuota) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.setBacklogQuota(String, BacklogQuota) instead.
+
+
+
setBacklogQuota(String, BacklogQuota, BacklogQuota.BacklogQuotaType) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set a backlog quota for all the topics on a namespace.
+
+
setBacklogQuota(String, BacklogQuota, BacklogQuota.BacklogQuotaType) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Set a backlog quota for a topic.
+
+
setBacklogQuota(String, BacklogQuota, BacklogQuota.BacklogQuotaType) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.setBacklogQuota(String, BacklogQuota, BacklogQuota.BacklogQuotaType) + instead.
+
+
+
setBacklogQuotaAsync(String, BacklogQuota) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
 
+
setBacklogQuotaAsync(String, BacklogQuota, BacklogQuota.BacklogQuotaType) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set a backlog quota for all the topics on a namespace asynchronously.
+
+
setBookieAffinityGroup(String, BookieAffinityGroupData) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set bookie affinity group for a namespace to isolate namespace write to bookies that are part of given affinity + group.
+
+
setBookieAffinityGroupAsync(String, BookieAffinityGroupData) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set bookie affinity group for a namespace to isolate namespace write to bookies that are part of given affinity + group asynchronously.
+
+
setCompactionThreshold(String, long) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set the compactionThreshold for a namespace.
+
+
setCompactionThreshold(String, long) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Set the compactionThreshold for a topic.
+
+
setCompactionThreshold(String, long) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.setCompactionThreshold(String, long) instead.
+
+
+
setCompactionThresholdAsync(String, long) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set the compactionThreshold for a namespace asynchronously.
+
+
setCompactionThresholdAsync(String, long) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Set the compactionThreshold for a topic asynchronously.
+
+
setCompactionThresholdAsync(String, long) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.setCompactionThresholdAsync(String, long) instead.
+
+
+
setConfigurationStoreServers(String) - Method in class org.apache.pulsar.common.conf.InternalConfigurationData
+
+
Deprecated.
+
+
setContextClassLoader(ClassLoader) - Method in interface org.apache.pulsar.client.admin.PulsarAdminBuilder
+
 
+
setDeduplicationSnapshotInterval(String, int) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Set the deduplication snapshot interval for specified topic.
+
+
setDeduplicationSnapshotInterval(String, int) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.setDeduplicationSnapshotInterval(String, int) instead.
+
+
+
setDeduplicationSnapshotInterval(String, Integer) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set the deduplicationSnapshotInterval for a namespace.
+
+
setDeduplicationSnapshotIntervalAsync(String, int) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Set the deduplication snapshot interval for specified topic asynchronously.
+
+
setDeduplicationSnapshotIntervalAsync(String, int) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.setDeduplicationSnapshotIntervalAsync(String, int) instead.
+
+
+
setDeduplicationSnapshotIntervalAsync(String, Integer) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set the deduplicationSnapshotInterval for a namespace asynchronously.
+
+
setDeduplicationStatus(String, boolean) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set the deduplication status for all topics within a namespace.
+
+
setDeduplicationStatus(String, boolean) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
set deduplication enabled of a topic.
+
+
setDeduplicationStatus(String, boolean) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.setDeduplicationStatus(String, boolean) instead.
+
+
+
setDeduplicationStatusAsync(String, boolean) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set the deduplication status for all topics within a namespace asynchronously.
+
+
setDeduplicationStatusAsync(String, boolean) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
set deduplication enabled of a topic asynchronously.
+
+
setDeduplicationStatusAsync(String, boolean) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.setDeduplicationStatusAsync(String, boolean) instead.
+
+
+
setDefaultResourceQuota(ResourceQuota) - Method in interface org.apache.pulsar.client.admin.ResourceQuotas
+
+
Set default resource quota for new namespace bundles.
+
+
setDefaultResourceQuotaAsync(ResourceQuota) - Method in interface org.apache.pulsar.client.admin.ResourceQuotas
+
+
Set default resource quota for new namespace bundles asynchronously.
+
+
setDelayedDeliveryMessages(String, DelayedDeliveryPolicies) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set the delayed delivery messages for all topics within a namespace.
+
+
setDelayedDeliveryMessagesAsync(String, DelayedDeliveryPolicies) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set the delayed delivery messages for all topics within a namespace asynchronously.
+
+
setDelayedDeliveryPolicy(String, DelayedDeliveryPolicies) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Set the delayed delivery policy for a specified topic.
+
+
setDelayedDeliveryPolicy(String, DelayedDeliveryPolicies) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.setDelayedDeliveryPolicy(String, DelayedDeliveryPolicies) instead.
+
+
+
setDelayedDeliveryPolicyAsync(String, DelayedDeliveryPolicies) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Set the delayed delivery policy for a specified topic asynchronously.
+
+
setDelayedDeliveryPolicyAsync(String, DelayedDeliveryPolicies) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.setDelayedDeliveryPolicyAsync(String, DelayedDeliveryPolicies) instead.
+
+
+
setDispatcherPauseOnAckStatePersistent(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Remove entry filters of a namespace.
+
+
setDispatcherPauseOnAckStatePersistent(String) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
After enabling this feature, Pulsar will stop delivery messages to clients if the cursor metadata is too large to + # persist, it will help to reduce the duplicates caused by the ack state that can not be fully persistent.
+
+
setDispatcherPauseOnAckStatePersistentAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set DispatcherPauseOnAckStatePersistent for a namespace asynchronously.
+
+
setDispatchRate(String, DispatchRate) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set message-dispatch-rate (topics under this namespace can dispatch this many messages per second).
+
+
setDispatchRate(String, DispatchRate) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Set message-dispatch-rate (topic can dispatch this many messages per second).
+
+
setDispatchRate(String, DispatchRate) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.setDispatchRate(String, DispatchRate) instead.
+
+
+
setDispatchRateAsync(String, DispatchRate) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set message-dispatch-rate asynchronously.
+
+
setDispatchRateAsync(String, DispatchRate) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Set message-dispatch-rate asynchronously.
+
+
setDispatchRateAsync(String, DispatchRate) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.setDispatchRateAsync(String, DispatchRate) instead.
+
+
+
setEncryptionRequiredStatus(String, boolean) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set the encryption required status for all topics within a namespace.
+
+
setEncryptionRequiredStatusAsync(String, boolean) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set the encryption required status for all topics within a namespace asynchronously.
+
+
setEntryFiltersPerTopic(String, EntryFilters) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Set entry filters on a topic.
+
+
setEntryFiltersPerTopicAsync(String, EntryFilters) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Set entry filters on a topic asynchronously.
+
+
setInactiveTopicPolicies(String, InactiveTopicPolicies) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
As same as setInactiveTopicPoliciesAsync, but it is synchronous.
+
+
setInactiveTopicPolicies(String, InactiveTopicPolicies) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
set inactive topic policies of a topic.
+
+
setInactiveTopicPolicies(String, InactiveTopicPolicies) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.setInactiveTopicPolicies(String, InactiveTopicPolicies) instead.
+
+
+
setInactiveTopicPoliciesAsync(String, InactiveTopicPolicies) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
You can set the inactive deletion strategy at the namespace level.
+
+
setInactiveTopicPoliciesAsync(String, InactiveTopicPolicies) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
set inactive topic policies of a topic asynchronously.
+
+
setInactiveTopicPoliciesAsync(String, InactiveTopicPolicies) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.setInactiveTopicPoliciesAsync(String, InactiveTopicPolicies) instead.
+
+
+
setIsAllowAutoUpdateSchema(String, boolean) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set whether to allow automatic schema updates.
+
+
setIsAllowAutoUpdateSchemaAsync(String, boolean) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set whether to allow automatic schema updates asynchronously.
+
+
setLimit(long) - Method in class org.apache.pulsar.common.policies.data.impl.BacklogQuotaImpl
+
+
Deprecated.
+
+
setLimitSize(long) - Method in class org.apache.pulsar.common.policies.data.impl.BacklogQuotaImpl
+
 
+
setLimitTime(int) - Method in class org.apache.pulsar.common.policies.data.impl.BacklogQuotaImpl
+
 
+
setMaxConsumers(String, int) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Set the max number of consumer for specified topic.
+
+
setMaxConsumers(String, int) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.setMaxConsumers(String, int) instead.
+
+
+
setMaxConsumersAsync(String, int) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Set the max number of consumer for specified topic asynchronously.
+
+
setMaxConsumersAsync(String, int) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.setMaxConsumers(String, int) instead.
+
+
+
setMaxConsumersPerSubscription(String, int) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set maxConsumersPerSubscription for a namespace.
+
+
setMaxConsumersPerSubscription(String, int) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Set maxConsumersPerSubscription for a topic.
+
+
setMaxConsumersPerSubscription(String, int) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.setMaxConsumersPerSubscription(String, int) instead.
+
+
+
setMaxConsumersPerSubscriptionAsync(String, int) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set maxConsumersPerSubscription for a namespace asynchronously.
+
+
setMaxConsumersPerSubscriptionAsync(String, int) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Set maxConsumersPerSubscription for a topic asynchronously.
+
+
setMaxConsumersPerSubscriptionAsync(String, int) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.setMaxConsumersPerSubscriptionAsync(String, int) instead.
+
+
+
setMaxConsumersPerTopic(String, int) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set maxConsumersPerTopic for a namespace.
+
+
setMaxConsumersPerTopicAsync(String, int) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set maxConsumersPerTopic for a namespace asynchronously.
+
+
setMaxMessageSize(String, int) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Set the max message size for specified topic.
+
+
setMaxMessageSize(String, int) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.setMaxMessageSize(String, int) instead.
+
+
+
setMaxMessageSizeAsync(String, int) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Set the max message size for specified topic asynchronously.0 disables.
+
+
setMaxMessageSizeAsync(String, int) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.setMaxMessageSizeAsync(String, int) instead.
+
+
+
setMaxProducers(String, int) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Set the max number of producer for specified topic.
+
+
setMaxProducers(String, int) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.setMaxProducers(String, int) instead.
+
+
+
setMaxProducersAsync(String, int) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Set the max number of producer for specified topic asynchronously.
+
+
setMaxProducersAsync(String, int) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.setMaxProducersAsync(String, int) instead.
+
+
+
setMaxProducersPerTopic(String, int) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set maxProducersPerTopic for a namespace.
+
+
setMaxProducersPerTopicAsync(String, int) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set maxProducersPerTopic for a namespace asynchronously.
+
+
setMaxSubscriptionsPerTopic(String, int) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set the maxSubscriptionsPerTopic for a namespace.
+
+
setMaxSubscriptionsPerTopic(String, int) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Set the max number of subscriptions for specified topic.
+
+
setMaxSubscriptionsPerTopic(String, int) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.setMaxSubscriptionsPerTopic(String, int) instead.
+
+
+
setMaxSubscriptionsPerTopicAsync(String, int) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set the maxSubscriptionsPerTopic for a namespace asynchronously.
+
+
setMaxSubscriptionsPerTopicAsync(String, int) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Set the max number of subscriptions for specified topic asynchronously.
+
+
setMaxSubscriptionsPerTopicAsync(String, int) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.setMaxSubscriptionsPerTopicAsync(String, int) instead.
+
+
+
setMaxTopicsPerNamespace(String, int) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set maxTopicsPerNamespace for a namespace.
+
+
setMaxTopicsPerNamespaceAsync(String, int) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set maxTopicsPerNamespace for a namespace asynchronously.
+
+
setMaxUnackedMessagesOnConsumer(String, int) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
set max unacked messages on consumer of a topic.
+
+
setMaxUnackedMessagesOnConsumer(String, int) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.setMaxUnackedMessagesOnConsumer(String, int) instead.
+
+
+
setMaxUnackedMessagesOnConsumerAsync(String, int) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
set max unacked messages on consumer of a topic asynchronously.
+
+
setMaxUnackedMessagesOnConsumerAsync(String, int) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.setMaxUnackedMessagesOnConsumerAsync(String, int) instead.
+
+
+
setMaxUnackedMessagesOnSubscription(String, int) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
set max unacked messages on subscription of a topic.
+
+
setMaxUnackedMessagesOnSubscription(String, int) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.setMaxUnackedMessagesOnSubscription(String, int) instead.
+
+
+
setMaxUnackedMessagesOnSubscriptionAsync(String, int) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
set max unacked messages on subscription of a topic asynchronously.
+
+
setMaxUnackedMessagesOnSubscriptionAsync(String, int) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.setMaxUnackedMessagesOnSubscriptionAsync(String, int) instead.
+
+
+
setMaxUnackedMessagesPerConsumer(String, int) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set maxUnackedMessagesPerConsumer for a namespace.
+
+
setMaxUnackedMessagesPerConsumerAsync(String, int) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set maxUnackedMessagesPerConsumer for a namespace asynchronously.
+
+
setMaxUnackedMessagesPerSubscription(String, int) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set maxUnackedMessagesPerSubscription for a namespace.
+
+
setMaxUnackedMessagesPerSubscriptionAsync(String, int) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set maxUnackedMessagesPerSubscription for a namespace asynchronously.
+
+
setMessageTTL(String, int) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Set message TTL for a topic.
+
+
setMessageTTL(String, int) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.setMessageTTL(String, int) instead.
+
+
+
setNamespaceAllowedClusters(String, Set<String>) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set the allowed clusters for a namespace.
+
+
setNamespaceAllowedClustersAsync(String, Set<String>) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set the allowed clusters for a namespace asynchronously.
+
+
setNamespaceAntiAffinityGroup(String, String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set anti-affinity group name for a namespace.
+
+
setNamespaceAntiAffinityGroupAsync(String, String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set anti-affinity group name for a namespace asynchronously.
+
+
setNamespaceBundleResourceQuota(String, String, ResourceQuota) - Method in interface org.apache.pulsar.client.admin.ResourceQuotas
+
+
Set resource quota for a namespace bundle.
+
+
setNamespaceBundleResourceQuotaAsync(String, String, ResourceQuota) - Method in interface org.apache.pulsar.client.admin.ResourceQuotas
+
+
Set resource quota for a namespace bundle asynchronously.
+
+
setNamespaceEntryFilters(String, EntryFilters) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set entry filters on a namespace.
+
+
setNamespaceEntryFiltersAsync(String, EntryFilters) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set entry filters on a namespace asynchronously.
+
+
setNamespaceMessageTTL(String, int) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set the messages Time to Live for all the topics within a namespace.
+
+
setNamespaceMessageTTLAsync(String, int) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set the messages Time to Live for all the topics within a namespace asynchronously.
+
+
setNamespaceReplicationClusters(String, Set<String>) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set the replication clusters for a namespace.
+
+
setNamespaceReplicationClustersAsync(String, Set<String>) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set the replication clusters for a namespace asynchronously.
+
+
setNamespaceResourceGroup(String, String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set the ResourceGroup for a namespace.
+
+
setNamespaceResourceGroupAsync(String, String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set the ResourceGroup for a namespace asynchronously.
+
+
setOffloadDeleteLag(String, long, TimeUnit) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set the offload deletion lag for a namespace.
+
+
setOffloadDeleteLagAsync(String, long, TimeUnit) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set the offload deletion lag for a namespace asynchronously.
+
+
setOffloadPolicies(String, OffloadPolicies) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set the offload configuration for all the topics in a namespace.
+
+
setOffloadPolicies(String, OffloadPolicies) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
set offload policies of a topic.
+
+
setOffloadPolicies(String, OffloadPolicies) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.setOffloadPolicies(String, OffloadPolicies) instead.
+
+
+
setOffloadPoliciesAsync(String, OffloadPolicies) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set the offload configuration for all the topics in a namespace asynchronously.
+
+
setOffloadPoliciesAsync(String, OffloadPolicies) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
set offload policies of a topic asynchronously.
+
+
setOffloadPoliciesAsync(String, OffloadPolicies) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.setOffloadPoliciesAsync(String, OffloadPolicies) instead.
+
+
+
setOffloadThreshold(String, long) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set the offloadThreshold for a namespace.
+
+
setOffloadThresholdAsync(String, long) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set the offloadThreshold for a namespace asynchronously.
+
+
setOffloadThresholdInSeconds(String, long) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set the offloadThresholdInSeconds for a namespace.
+
+
setOffloadThresholdInSecondsAsync(String, long) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set the offloadThresholdInSeconds for a namespace.
+
+
setPersistence(String, PersistencePolicies) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set the persistence configuration for all the topics on a namespace.
+
+
setPersistence(String, PersistencePolicies) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Set the configuration of persistence policies for specified topic.
+
+
setPersistence(String, PersistencePolicies) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.setPersistence(String, PersistencePolicies) (String)} instead.
+
+
+
setPersistenceAsync(String, PersistencePolicies) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set the persistence configuration for all the topics on a namespace asynchronously.
+
+
setPersistenceAsync(String, PersistencePolicies) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Set the configuration of persistence policies for specified topic asynchronously.
+
+
setPersistenceAsync(String, PersistencePolicies) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.setPersistenceAsync(String, PersistencePolicies) (String)} instead.
+
+
+
setPolicy(BacklogQuota.RetentionPolicy) - Method in class org.apache.pulsar.common.policies.data.impl.BacklogQuotaImpl
+
 
+
setProperties(String, Map<String, String>) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set key value pair properties for a namespace.
+
+
setPropertiesAsync(String, Map<String, String>) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set key value pair properties for a namespace asynchronously.
+
+
setProperty(String, String, String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set key value pair property for a namespace.
+
+
setPropertyAsync(String, String, String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set key value pair property for a namespace.
+
+
setPublishRate(String, PublishRate) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set message-publish-rate (topics under this namespace can publish this many messages per second).
+
+
setPublishRate(String, PublishRate) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Set message-publish-rate (topics can publish this many messages per second).
+
+
setPublishRate(String, PublishRate) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.setPublishRate(String, PublishRate) instead.
+
+
+
setPublishRateAsync(String, PublishRate) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set message-publish-rate (topics under this namespace can publish this many messages per second) asynchronously.
+
+
setPublishRateAsync(String, PublishRate) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Set message-publish-rate (topics can publish this many messages per second) asynchronously.
+
+
setPublishRateAsync(String, PublishRate) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.setPublishRateAsync(String, PublishRate) instead.
+
+
+
setReplicatedSubscriptionStatus(String, String, boolean) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Enable or disable a replicated subscription on a topic.
+
+
setReplicatedSubscriptionStatusAsync(String, String, boolean) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Enable or disable a replicated subscription on a topic asynchronously.
+
+
setReplicationClusters(String, List<String>) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Set the replication clusters for the topic.
+
+
setReplicationClustersAsync(String, List<String>) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Set the replication clusters for the topic asynchronously.
+
+
setReplicatorDispatchRate(String, DispatchRate) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set replicator-message-dispatch-rate.
+
+
setReplicatorDispatchRate(String, DispatchRate) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Set replicatorDispatchRate for the topic.
+
+
setReplicatorDispatchRate(String, DispatchRate) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.setReplicatorDispatchRate(String, DispatchRate) instead.
+
+
+
setReplicatorDispatchRateAsync(String, DispatchRate) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set replicator-message-dispatch-rate asynchronously.
+
+
setReplicatorDispatchRateAsync(String, DispatchRate) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Set replicatorDispatchRate for the topic asynchronously.
+
+
setReplicatorDispatchRateAsync(String, DispatchRate) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.setReplicatorDispatchRateAsync(String, DispatchRate) instead.
+
+
+
setRetention(String, RetentionPolicies) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set the retention configuration for all the topics on a namespace.
+
+
setRetention(String, RetentionPolicies) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Set the retention configuration on a topic.
+
+
setRetention(String, RetentionPolicies) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.setRetention(String, RetentionPolicies) instead.
+
+
+
setRetentionAsync(String, RetentionPolicies) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set the retention configuration for all the topics on a namespace asynchronously.
+
+
setRetentionAsync(String, RetentionPolicies) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Set the retention configuration for all the topics on a topic asynchronously.
+
+
setRetentionAsync(String, RetentionPolicies) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.setRetentionAsync(String, RetentionPolicies) instead.
+
+
+
setS3ManagedLedgerOffloadRoleSessionName(String) - Method in interface org.apache.pulsar.common.policies.data.OffloadPolicies.Builder
+
 
+
setSchemaAutoUpdateCompatibilityStrategy(String, SchemaAutoUpdateCompatibilityStrategy) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Deprecated.
+
+
setSchemaCompatibilityStrategy(String, SchemaCompatibilityStrategy) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set the strategy used to check the a new schema provided by a producer is compatible with the current schema + before it is installed.
+
+
setSchemaCompatibilityStrategy(String, SchemaCompatibilityStrategy) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Set schema compatibility strategy on a topic.
+
+
setSchemaCompatibilityStrategyAsync(String, SchemaCompatibilityStrategy) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set the strategy used to check the a new schema provided by a producer is compatible with the current schema + before it is installed asynchronously.
+
+
setSchemaCompatibilityStrategyAsync(String, SchemaCompatibilityStrategy) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Set schema compatibility strategy on a topic asynchronously.
+
+
setSchemaValidationEnforced(String, boolean) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set schema validation enforced for namespace.
+
+
setSchemaValidationEnforced(String, boolean) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Get schema validation enforced for a topic.
+
+
setSchemaValidationEnforcedAsync(String, boolean) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set schema validation enforced for namespace asynchronously.
+
+
setSchemaValidationEnforcedAsync(String, boolean) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Get schema validation enforced for a topic asynchronously.
+
+
setShadowTopics(String, List<String>) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Set shadow topic list for a source topic.
+
+
setShadowTopicsAsync(String, List<String>) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Set shadow topic list for a source topic asynchronously.
+
+
setSubscribeRate(String, SubscribeRate) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set namespace-subscribe-rate (topics under this namespace will limit by subscribeRate).
+
+
setSubscribeRate(String, SubscribeRate) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Set topic-subscribe-rate (topic will limit by subscribeRate).
+
+
setSubscribeRate(String, SubscribeRate) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.setSubscribeRate(String, SubscribeRate) instead.
+
+
+
setSubscribeRateAsync(String, SubscribeRate) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set namespace-subscribe-rate (topics under this namespace will limit by subscribeRate) asynchronously.
+
+
setSubscribeRateAsync(String, SubscribeRate) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Set topic-subscribe-rate (topics will limit by subscribeRate) asynchronously.
+
+
setSubscribeRateAsync(String, SubscribeRate) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.setSubscribeRateAsync(String, SubscribeRate) instead.
+
+
+
setSubscriptionAuthMode(String, SubscriptionAuthMode) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set the given subscription auth mode on all topics on a namespace.
+
+
setSubscriptionAuthModeAsync(String, SubscriptionAuthMode) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set the given subscription auth mode on all topics on a namespace asynchronously.
+
+
setSubscriptionDispatchRate(String, String, DispatchRate) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Set dispatch rate limiter for a specific subscription.
+
+
setSubscriptionDispatchRate(String, DispatchRate) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set subscription-message-dispatch-rate.
+
+
setSubscriptionDispatchRate(String, DispatchRate) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Set subscription-message-dispatch-rate for the topic.
+
+
setSubscriptionDispatchRate(String, DispatchRate) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.setSubscriptionDispatchRate(String, DispatchRate) instead.
+
+
+
setSubscriptionDispatchRateAsync(String, String, DispatchRate) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Async version of TopicPolicies.setSubscriptionDispatchRate(String, String, DispatchRate).
+
+
setSubscriptionDispatchRateAsync(String, DispatchRate) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set subscription-message-dispatch-rate asynchronously.
+
+
setSubscriptionDispatchRateAsync(String, DispatchRate) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Set subscription-message-dispatch-rate for the topic asynchronously.
+
+
setSubscriptionDispatchRateAsync(String, DispatchRate) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.setSubscriptionDispatchRateAsync(String, DispatchRate) instead.
+
+
+
setSubscriptionExpirationTime(String, int) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set the subscription expiration time in minutes for all the topics within a namespace.
+
+
setSubscriptionExpirationTimeAsync(String, int) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Set the subscription expiration time in minutes for all the topics within a namespace asynchronously.
+
+
setSubscriptionTypesEnabled(String, Set<SubscriptionType>) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Sets the subscriptionTypesEnabled policy for a given namespace, overriding broker settings.
+
+
setSubscriptionTypesEnabled(String, Set<SubscriptionType>) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Set is enable sub types.
+
+
setSubscriptionTypesEnabled(String, Set<SubscriptionType>) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.setSubscriptionTypesEnabled(String, Set) instead.
+
+
+
setSubscriptionTypesEnabledAsync(String, Set<SubscriptionType>) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Sets the subscriptionTypesEnabled policy for a given namespace, overriding broker settings.
+
+
setSubscriptionTypesEnabledAsync(String, Set<SubscriptionType>) - Method in interface org.apache.pulsar.client.admin.TopicPolicies
+
+
Set is enable sub types asynchronously.
+
+
setSubscriptionTypesEnabledAsync(String, Set<SubscriptionType>) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Deprecated. +
Use TopicPolicies.setSubscriptionTypesEnabledAsync(String, Set) instead.
+
+
+
setUpdateAuthData(boolean) - Method in interface org.apache.pulsar.common.functions.UpdateOptions
+
 
+
setZookeeperServers(String) - Method in class org.apache.pulsar.common.conf.InternalConfigurationData
+
+
Deprecated.
+
+
shared - Enum constant in enum class org.apache.pulsar.common.policies.data.BrokerAssignment
+
 
+
shouldFailoverToSecondary(int) - Method in class org.apache.pulsar.common.policies.AutoFailoverPolicy
+
 
+
shouldFailoverToSecondary(int) - Method in class org.apache.pulsar.common.policies.impl.MinAvailablePolicy
+
 
+
shouldFailoverToSecondary(SortedSet<BrokerStatus>) - Method in class org.apache.pulsar.common.policies.AutoFailoverPolicy
+
+
Checks to see whether the new namespace ownership should be failed over to the secondary brokers.
+
+
shouldFailoverToSecondary(SortedSet<BrokerStatus>) - Method in class org.apache.pulsar.common.policies.impl.MinAvailablePolicy
+
 
+
shutDownBrokerGracefully(int, boolean) - Method in interface org.apache.pulsar.client.admin.Brokers
+
+
Trigger the current broker to graceful-shutdown asynchronously.
+
+
singleSnapshotSystemTopicInternalStats - Variable in class org.apache.pulsar.common.policies.data.TransactionBufferInternalStats
+
 
+
sink() - Method in interface org.apache.pulsar.client.admin.PulsarAdmin
+
+
Deprecated. +
in favor of PulsarAdmin.sinks()
+
+
+
Sink - Interface in org.apache.pulsar.client.admin
+
+
Deprecated. +
in favor of Sinks
+
+
+
SINK - Enum constant in enum class org.apache.pulsar.packages.management.core.common.PackageType
+
 
+
SinkConfig - Class in org.apache.pulsar.common.io
+
+
Configuration of Pulsar Sink.
+
+
SinkConfig() - Constructor for class org.apache.pulsar.common.io.SinkConfig
+
 
+
SinkInstanceStatus() - Constructor for class org.apache.pulsar.common.policies.data.SinkStatus.SinkInstanceStatus
+
 
+
SinkInstanceStatusData() - Constructor for class org.apache.pulsar.common.policies.data.SinkStatus.SinkInstanceStatus.SinkInstanceStatusData
+
 
+
sinks - Enum constant in enum class org.apache.pulsar.common.policies.data.AuthAction
+
+
Permissions for sinks ops.
+
+
sinks() - Method in interface org.apache.pulsar.client.admin.PulsarAdmin
+
 
+
Sinks - Interface in org.apache.pulsar.client.admin
+
+
Admin interface for Sink management.
+
+
SinkStatus - Class in org.apache.pulsar.common.policies.data
+
+
Status of Pulsar Sink.
+
+
SinkStatus() - Constructor for class org.apache.pulsar.common.policies.data.SinkStatus
+
 
+
SinkStatus.SinkInstanceStatus - Class in org.apache.pulsar.common.policies.data
+
+
Status of a Sink instance.
+
+
SinkStatus.SinkInstanceStatus.SinkInstanceStatusData - Class in org.apache.pulsar.common.policies.data
+
+
Status data of a Sink instance.
+
+
size - Variable in class org.apache.pulsar.common.policies.data.ManagedLedgerInternalStats.LedgerInfo
+
 
+
skipAllMessages(String, String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Skip all messages on a topic subscription.
+
+
skipAllMessagesAsync(String, String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Skip all messages on a topic subscription asynchronously.
+
+
skipMessages(String, String, long) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Skip messages on a topic subscription.
+
+
skipMessagesAsync(String, String, long) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Skip messages on a topic subscription asynchronously.
+
+
smallCacheSize - Variable in class org.apache.pulsar.common.stats.AllocatorStats
+
 
+
smallSubpages - Variable in class org.apache.pulsar.common.stats.AllocatorStats.PoolArenaStats
+
 
+
SnapshotSystemTopicInternalStats - Class in org.apache.pulsar.common.policies.data
+
 
+
SnapshotSystemTopicInternalStats() - Constructor for class org.apache.pulsar.common.policies.data.SnapshotSystemTopicInternalStats
+
 
+
snapshotType - Variable in class org.apache.pulsar.common.policies.data.TransactionBufferInternalStats
+
 
+
snapshotType - Variable in class org.apache.pulsar.common.policies.data.TransactionBufferStats
+
 
+
source() - Method in interface org.apache.pulsar.client.admin.PulsarAdmin
+
+
Deprecated. +
in favor of PulsarAdmin.sources()
+
+
+
Source - Interface in org.apache.pulsar.client.admin
+
+
Deprecated. +
in favor of Sources
+
+
+
SOURCE - Enum constant in enum class org.apache.pulsar.packages.management.core.common.PackageType
+
 
+
SourceConfig - Class in org.apache.pulsar.common.io
+
+
Pulsar source configuration.
+
+
SourceConfig() - Constructor for class org.apache.pulsar.common.io.SourceConfig
+
 
+
SourceInstanceStatus() - Constructor for class org.apache.pulsar.common.policies.data.SourceStatus.SourceInstanceStatus
+
 
+
SourceInstanceStatusData() - Constructor for class org.apache.pulsar.common.policies.data.SourceStatus.SourceInstanceStatus.SourceInstanceStatusData
+
 
+
sources - Enum constant in enum class org.apache.pulsar.common.policies.data.AuthAction
+
+
Permissions for sources ops.
+
+
sources() - Method in interface org.apache.pulsar.client.admin.PulsarAdmin
+
 
+
Sources - Interface in org.apache.pulsar.client.admin
+
+
Admin interface for Source management.
+
+
SourceStatus - Class in org.apache.pulsar.common.policies.data
+
+
Source status.
+
+
SourceStatus() - Constructor for class org.apache.pulsar.common.policies.data.SourceStatus
+
 
+
SourceStatus.SourceInstanceStatus - Class in org.apache.pulsar.common.policies.data
+
+
Source instance status.
+
+
SourceStatus.SourceInstanceStatus.SourceInstanceStatusData - Class in org.apache.pulsar.common.policies.data
+
+
Source instance status data.
+
+
splitNamespaceBundle(String, String, boolean, String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Split namespace bundle.
+
+
splitNamespaceBundle(String, String, boolean, String, List<Long>) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Split namespace bundle.
+
+
splitNamespaceBundleAsync(String, String, boolean, String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Split namespace bundle asynchronously.
+
+
splitNamespaceBundleAsync(String, String, boolean, String, List<Long>) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Split namespace bundle asynchronously.
+
+
sslFactoryPlugin(String) - Method in interface org.apache.pulsar.client.admin.PulsarAdminBuilder
+
+
SSL Factory Plugin used to generate the SSL Context and SSLEngine.
+
+
sslFactoryPluginParams(String) - Method in interface org.apache.pulsar.client.admin.PulsarAdminBuilder
+
+
Parameters used by the SSL Factory Plugin class.
+
+
sslProvider(String) - Method in interface org.apache.pulsar.client.admin.PulsarAdminBuilder
+
+
The name of the security provider used for SSL connections.
+
+
startFunction(String, String, String) - Method in interface org.apache.pulsar.client.admin.Functions
+
+
Start all function instances.
+
+
startFunction(String, String, String, int) - Method in interface org.apache.pulsar.client.admin.Functions
+
+
Start function instance.
+
+
startFunctionAsync(String, String, String) - Method in interface org.apache.pulsar.client.admin.Functions
+
+
Start all function instances asynchronously.
+
+
startFunctionAsync(String, String, String, int) - Method in interface org.apache.pulsar.client.admin.Functions
+
+
Start function instance asynchronously.
+
+
startPosition - Variable in class org.apache.pulsar.common.policies.data.TransactionInBufferStats
+
+
The start position of this transaction in transaction buffer.
+
+
startSink(String, String, String) - Method in interface org.apache.pulsar.client.admin.Sinks
+
+
Start all sink instances.
+
+
startSink(String, String, String, int) - Method in interface org.apache.pulsar.client.admin.Sinks
+
+
Start sink instance.
+
+
startSinkAsync(String, String, String) - Method in interface org.apache.pulsar.client.admin.Sinks
+
+
Start all sink instances asynchronously.
+
+
startSinkAsync(String, String, String, int) - Method in interface org.apache.pulsar.client.admin.Sinks
+
+
Start sink instance asynchronously.
+
+
startSource(String, String, String) - Method in interface org.apache.pulsar.client.admin.Sources
+
+
Start all source instances.
+
+
startSource(String, String, String, int) - Method in interface org.apache.pulsar.client.admin.Sources
+
+
Start source instance.
+
+
startSourceAsync(String, String, String) - Method in interface org.apache.pulsar.client.admin.Sources
+
+
Start all source instances asynchronously.
+
+
startSourceAsync(String, String, String, int) - Method in interface org.apache.pulsar.client.admin.Sources
+
+
Start source instance asynchronously.
+
+
state - Variable in class org.apache.pulsar.common.policies.data.ManagedLedgerInternalStats.CursorStats
+
 
+
state - Variable in class org.apache.pulsar.common.policies.data.ManagedLedgerInternalStats
+
+
The state of this ledger for writing.
+
+
state - Variable in class org.apache.pulsar.common.policies.data.TransactionBufferStats
+
+
The state of this transaction buffer.
+
+
state - Variable in class org.apache.pulsar.common.policies.data.TransactionCoordinatorStats
+
+
The state of this transaction metadataStore.
+
+
state - Variable in class org.apache.pulsar.common.policies.data.TransactionCoordinatorStatus
+
+
The state of this transaction metadataStore.
+
+
state - Variable in class org.apache.pulsar.common.policies.data.TransactionPendingAckStats
+
+
The state of this pending ack.
+
+
state - Variable in class org.apache.pulsar.common.stats.PositionInPendingAckStats
+
 
+
status - Variable in class org.apache.pulsar.client.admin.LongRunningProcessStatus
+
 
+
status - Variable in class org.apache.pulsar.common.policies.data.FunctionStatus.FunctionInstanceStatus
+
 
+
status - Variable in class org.apache.pulsar.common.policies.data.SinkStatus.SinkInstanceStatus
+
 
+
status - Variable in class org.apache.pulsar.common.policies.data.SourceStatus.SourceInstanceStatus
+
 
+
status - Variable in class org.apache.pulsar.common.policies.data.TransactionMetadata
+
+
The status of this transaction.
+
+
stopFunction(String, String, String) - Method in interface org.apache.pulsar.client.admin.Functions
+
+
Stop all function instances.
+
+
stopFunction(String, String, String, int) - Method in interface org.apache.pulsar.client.admin.Functions
+
+
Stop function instance.
+
+
stopFunctionAsync(String, String, String) - Method in interface org.apache.pulsar.client.admin.Functions
+
+
Stop all function instances asynchronously.
+
+
stopFunctionAsync(String, String, String, int) - Method in interface org.apache.pulsar.client.admin.Functions
+
+
Stop function instance asynchronously.
+
+
stopSink(String, String, String) - Method in interface org.apache.pulsar.client.admin.Sinks
+
+
Stop all sink instances.
+
+
stopSink(String, String, String, int) - Method in interface org.apache.pulsar.client.admin.Sinks
+
+
Stop sink instance.
+
+
stopSinkAsync(String, String, String) - Method in interface org.apache.pulsar.client.admin.Sinks
+
+
Stop all sink instances asynchronously.
+
+
stopSinkAsync(String, String, String, int) - Method in interface org.apache.pulsar.client.admin.Sinks
+
+
Stop sink instance asynchronously.
+
+
stopSource(String, String, String) - Method in interface org.apache.pulsar.client.admin.Sources
+
+
Stop all source instances.
+
+
stopSource(String, String, String, int) - Method in interface org.apache.pulsar.client.admin.Sources
+
+
Stop source instance.
+
+
stopSourceAsync(String, String, String) - Method in interface org.apache.pulsar.client.admin.Sources
+
+
Stop all source instances asynchronously.
+
+
stopSourceAsync(String, String, String, int) - Method in interface org.apache.pulsar.client.admin.Sources
+
+
Stop source instance asynchronously.
+
+
SubscribeRate - Class in org.apache.pulsar.common.policies.data
+
+
Information about subscription rate.
+
+
SubscribeRate() - Constructor for class org.apache.pulsar.common.policies.data.SubscribeRate
+
 
+
SubscribeRate(int, int) - Constructor for class org.apache.pulsar.common.policies.data.SubscribeRate
+
 
+
subscribeThrottlingRatePerConsumer - Variable in class org.apache.pulsar.common.policies.data.SubscribeRate
+
 
+
subscription_auth_mode - Variable in class org.apache.pulsar.common.policies.data.Policies
+
 
+
subscription_expiration_time_minutes - Variable in class org.apache.pulsar.common.policies.data.Policies
+
 
+
subscription_types_enabled - Variable in class org.apache.pulsar.common.policies.data.Policies
+
 
+
subscriptionAuthentication(Map<String, Set<String>>) - Method in interface org.apache.pulsar.common.policies.data.AuthPolicies.Builder
+
 
+
SubscriptionAuthMode - Enum Class in org.apache.pulsar.common.policies.data
+
+
Subscription authorization for Pulsar policies.
+
+
subscriptionDispatchRate - Variable in class org.apache.pulsar.common.policies.data.Policies
+
 
+
subscriptionHavePendingRead - Variable in class org.apache.pulsar.common.policies.data.ManagedLedgerInternalStats.CursorStats
+
 
+
subscriptionHavePendingReplayRead - Variable in class org.apache.pulsar.common.policies.data.ManagedLedgerInternalStats.CursorStats
+
 
+
SubscriptionStats - Interface in org.apache.pulsar.common.policies.data
+
+
Statistics about subscription.
+
+
substract(ResourceQuota) - Method in class org.apache.pulsar.common.policies.data.ResourceQuota
+
+
Substract quota.
+
+
success() - Static method in class org.apache.pulsar.common.policies.data.ValidateResult
+
 
+
SUCCESS - Enum constant in enum class org.apache.pulsar.client.admin.LongRunningProcessStatus.Status
+
 
+
+

T

+
+
TenantInfo - Interface in org.apache.pulsar.common.policies.data
+
 
+
TenantInfo.Builder - Interface in org.apache.pulsar.common.policies.data
+
 
+
tenants() - Method in interface org.apache.pulsar.client.admin.PulsarAdmin
+
 
+
Tenants - Interface in org.apache.pulsar.client.admin
+
+
Admin interface for tenants management.
+
+
terminatePartitionedTopic(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Terminate the partitioned topic and prevent any more messages being published on it.
+
+
terminatePartitionedTopicAsync(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Terminate the partitioned topic and prevent any more messages being published on it.
+
+
terminateTopic(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Terminate the topic and prevent any more messages being published on it.
+
+
terminateTopicAsync(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Terminate the topic and prevent any more messages being published on it.
+
+
testCompatibility(String, PostSchemaPayload) - Method in interface org.apache.pulsar.client.admin.Schemas
+
+
Judge schema compatibility topic.
+
+
testCompatibility(String, SchemaInfo) - Method in interface org.apache.pulsar.client.admin.Schemas
+
+
Judge schema compatibility topic.
+
+
testCompatibilityAsync(String, PostSchemaPayload) - Method in interface org.apache.pulsar.client.admin.Schemas
+
+
Judge schema compatibility topic asynchronously.
+
+
testCompatibilityAsync(String, SchemaInfo) - Method in interface org.apache.pulsar.client.admin.Schemas
+
+
Judge schema compatibility topic asynchronously.
+
+
tickTime(long) - Method in interface org.apache.pulsar.common.policies.data.DelayedDeliveryPolicies.Builder
+
 
+
tickTime(long) - Method in class org.apache.pulsar.common.policies.data.impl.DelayedDeliveryPoliciesImpl.DelayedDeliveryPoliciesImplBuilder
+
 
+
TIERED_STORAGE_FIRST - Enum constant in enum class org.apache.pulsar.common.policies.data.OffloadedReadPriority
+
+
For offloaded messages, readers will try to read from offloaded storage first, + even they are still exist in bookkeeper.
+
+
timeoutAt - Variable in class org.apache.pulsar.common.policies.data.TransactionMetadata
+
+
The timeout of this transaction.
+
+
TimeoutException(Throwable) - Constructor for exception class org.apache.pulsar.client.admin.PulsarAdminException.TimeoutException
+
 
+
tlsAllowInsecureConnection(boolean) - Method in interface org.apache.pulsar.common.policies.data.ClusterData.Builder
+
 
+
tlsCertificateFilePath(String) - Method in interface org.apache.pulsar.client.admin.PulsarAdminBuilder
+
+
Set the path to the TLS certificate file.
+
+
tlsCiphers(Set<String>) - Method in interface org.apache.pulsar.client.admin.PulsarAdminBuilder
+
+
A list of cipher suites.
+
+
tlsKeyFilePath(String) - Method in interface org.apache.pulsar.client.admin.PulsarAdminBuilder
+
+
Set the path to the TLS key file.
+
+
tlsKeyStorePassword(String) - Method in interface org.apache.pulsar.client.admin.PulsarAdminBuilder
+
+
The store password for the key store file.
+
+
tlsKeyStorePath(String) - Method in interface org.apache.pulsar.client.admin.PulsarAdminBuilder
+
+
The location of the key store file.
+
+
tlsKeyStoreType(String) - Method in interface org.apache.pulsar.client.admin.PulsarAdminBuilder
+
+
The file format of the key store file.
+
+
tlsProtocols(Set<String>) - Method in interface org.apache.pulsar.client.admin.PulsarAdminBuilder
+
+
The SSL protocol used to generate the SSLContext.
+
+
tlsTrustCertsFilePath(String) - Method in interface org.apache.pulsar.client.admin.PulsarAdminBuilder
+
+
Set the path to the trusted TLS certificate file.
+
+
tlsTrustStorePassword(String) - Method in interface org.apache.pulsar.client.admin.PulsarAdminBuilder
+
+
The store password for the key store file.
+
+
tlsTrustStorePath(String) - Method in interface org.apache.pulsar.client.admin.PulsarAdminBuilder
+
+
The location of the trust store file.
+
+
tlsTrustStoreType(String) - Method in interface org.apache.pulsar.client.admin.PulsarAdminBuilder
+
+
The file format of the trust store file.
+
+
topicAuthentication(Map<String, Map<String, Set<AuthAction>>>) - Method in interface org.apache.pulsar.common.policies.data.AuthPolicies.Builder
+
 
+
topicDispatchRate - Variable in class org.apache.pulsar.common.policies.data.Policies
+
 
+
TopicDomain - Enum Class in org.apache.pulsar.common.naming
+
+
Enumeration showing if a topic is persistent.
+
+
TopicHashPositions - Class in org.apache.pulsar.common.policies.data
+
 
+
TopicHashPositions() - Constructor for class org.apache.pulsar.common.policies.data.TopicHashPositions
+
 
+
topicPolicies() - Method in interface org.apache.pulsar.client.admin.PulsarAdmin
+
+
Get the topic policies management object.
+
+
topicPolicies(boolean) - Method in interface org.apache.pulsar.client.admin.PulsarAdmin
+
+
Get the local/global topic policies management object.
+
+
TopicPolicies - Interface in org.apache.pulsar.client.admin
+
+
Admin interface for topic policies management.
+
+
topics - Variable in class org.apache.pulsar.policies.data.loadbalancer.NamespaceBundleStats
+
 
+
topics() - Method in interface org.apache.pulsar.client.admin.PulsarAdmin
+
 
+
Topics - Interface in org.apache.pulsar.client.admin
+
+
Admin interface for Topics management.
+
+
Topics.QueryParam - Enum Class in org.apache.pulsar.client.admin
+
 
+
TopicStats - Interface in org.apache.pulsar.common.policies.data
+
+
Statistics for a Pulsar topic.
+
+
topicType(String) - Method in interface org.apache.pulsar.common.policies.data.AutoTopicCreationOverride.Builder
+
 
+
topicType(String) - Method in class org.apache.pulsar.common.policies.data.impl.AutoTopicCreationOverrideImpl.AutoTopicCreationOverrideImplBuilder
+
 
+
TopicType - Enum Class in org.apache.pulsar.common.policies.data
+
+
Topic types -- partitioned or non-partitioned.
+
+
TopicVersion - Enum Class in org.apache.pulsar.common.naming
+
 
+
toString() - Method in enum class org.apache.pulsar.common.naming.TopicDomain
+
 
+
toString() - Method in class org.apache.pulsar.common.policies.data.NamespaceOwnershipStatus
+
 
+
toString() - Method in enum class org.apache.pulsar.common.policies.data.OffloadedReadPriority
+
 
+
toString() - Method in class org.apache.pulsar.common.policies.data.RetentionPolicies
+
 
+
toString() - Method in class org.apache.pulsar.common.policies.data.SchemaMetadata.Entry
+
 
+
toString() - Method in enum class org.apache.pulsar.common.policies.data.TopicType
+
 
+
toString() - Method in class org.apache.pulsar.common.stats.Metrics
+
 
+
toString() - Method in enum class org.apache.pulsar.packages.management.core.common.PackageType
+
 
+
totalAbortedTransactions - Variable in class org.apache.pulsar.common.policies.data.TransactionBufferStats
+
 
+
totalNonContiguousDeletedMessagesRange - Variable in class org.apache.pulsar.common.policies.data.ManagedLedgerInternalStats.CursorStats
+
 
+
totalSize - Variable in class org.apache.pulsar.common.policies.data.ManagedLedgerInternalStats
+
+
The total storage size of all messages (in bytes).
+
+
TransactionBufferInternalStats - Class in org.apache.pulsar.common.policies.data
+
 
+
TransactionBufferInternalStats() - Constructor for class org.apache.pulsar.common.policies.data.TransactionBufferInternalStats
+
 
+
TransactionBufferStats - Class in org.apache.pulsar.common.policies.data
+
 
+
TransactionBufferStats() - Constructor for class org.apache.pulsar.common.policies.data.TransactionBufferStats
+
 
+
TransactionCoordinatorInfo - Class in org.apache.pulsar.common.policies.data
+
+
Transaction coordinator information.
+
+
TransactionCoordinatorInfo() - Constructor for class org.apache.pulsar.common.policies.data.TransactionCoordinatorInfo
+
 
+
TransactionCoordinatorInternalStats - Class in org.apache.pulsar.common.policies.data
+
+
Transaction coordinator internal stats.
+
+
TransactionCoordinatorInternalStats() - Constructor for class org.apache.pulsar.common.policies.data.TransactionCoordinatorInternalStats
+
 
+
TransactionCoordinatorStats - Class in org.apache.pulsar.common.policies.data
+
+
Transaction coordinator stats.
+
+
TransactionCoordinatorStats() - Constructor for class org.apache.pulsar.common.policies.data.TransactionCoordinatorStats
+
 
+
TransactionCoordinatorStatus - Class in org.apache.pulsar.common.policies.data
+
+
Transaction coordinator status.
+
+
TransactionCoordinatorStatus() - Constructor for class org.apache.pulsar.common.policies.data.TransactionCoordinatorStatus
+
 
+
TransactionInBufferStats - Class in org.apache.pulsar.common.policies.data
+
 
+
TransactionInBufferStats() - Constructor for class org.apache.pulsar.common.policies.data.TransactionInBufferStats
+
 
+
TransactionInPendingAckStats - Class in org.apache.pulsar.common.policies.data
+
 
+
TransactionInPendingAckStats() - Constructor for class org.apache.pulsar.common.policies.data.TransactionInPendingAckStats
+
 
+
transactionLogStats - Variable in class org.apache.pulsar.common.policies.data.TransactionCoordinatorInternalStats
+
+
The transaction coordinator log stats.
+
+
TransactionLogStats - Class in org.apache.pulsar.common.policies.data
+
+
Transaction log stats.
+
+
TransactionLogStats() - Constructor for class org.apache.pulsar.common.policies.data.TransactionLogStats
+
 
+
TransactionMetadata - Class in org.apache.pulsar.common.policies.data
+
 
+
TransactionMetadata() - Constructor for class org.apache.pulsar.common.policies.data.TransactionMetadata
+
 
+
TransactionPendingAckInternalStats - Class in org.apache.pulsar.common.policies.data
+
+
Transaction pending ack internal stats.
+
+
TransactionPendingAckInternalStats() - Constructor for class org.apache.pulsar.common.policies.data.TransactionPendingAckInternalStats
+
 
+
TransactionPendingAckStats - Class in org.apache.pulsar.common.policies.data
+
 
+
TransactionPendingAckStats() - Constructor for class org.apache.pulsar.common.policies.data.TransactionPendingAckStats
+
 
+
transactions() - Method in interface org.apache.pulsar.client.admin.PulsarAdmin
+
 
+
Transactions - Interface in org.apache.pulsar.client.admin
+
 
+
triggerCompaction(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Trigger compaction to run for a topic.
+
+
triggerCompactionAsync(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Trigger compaction to run for a topic asynchronously.
+
+
triggerFunction(String, String, String, String, String, String) - Method in interface org.apache.pulsar.client.admin.Functions
+
+
Triggers the function by writing to the input topic.
+
+
triggerFunctionAsync(String, String, String, String, String, String) - Method in interface org.apache.pulsar.client.admin.Functions
+
+
Triggers the function by writing to the input topic asynchronously.
+
+
triggerOffload(String, MessageId) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Trigger offloading messages in topic to longterm storage.
+
+
triggerOffloadAsync(String, MessageId) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Trigger offloading messages in topic to longterm storage asynchronously.
+
+
trimTopic(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Trigger topic trimming.
+
+
trimTopicAsync(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Trigger topic trimming asynchronously.
+
+
truncate(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Truncate a topic.
+
+
truncateAsync(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Truncate a topic asynchronously.
+
+
txnId - Variable in class org.apache.pulsar.common.policies.data.TransactionMetadata
+
+
The txnId of this transaction.
+
+
+

U

+
+
UNDEFINED - Enum constant in enum class org.apache.pulsar.common.policies.data.SchemaCompatibilityStrategy
+
+
Undefined.
+
+
underReplicated - Variable in class org.apache.pulsar.common.policies.data.ManagedLedgerInternalStats.LedgerInfo
+
 
+
unload(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Unload a namespace from the current serving broker.
+
+
unload(String) - Method in interface org.apache.pulsar.client.admin.NonPersistentTopics
+
+
Deprecated.
+
Unload a topic.
+
+
unload(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Unload a topic.
+
+
unloadAsync(String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Unload a namespace from the current serving broker asynchronously.
+
+
unloadAsync(String) - Method in interface org.apache.pulsar.client.admin.NonPersistentTopics
+
+
Deprecated.
+
Unload a topic asynchronously.
+
+
unloadAsync(String) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Unload a topic asynchronously.
+
+
unloadNamespaceBundle(String, String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Unload namespace bundle.
+
+
unloadNamespaceBundle(String, String, String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Unload namespace bundle and assign the bundle to specified broker.
+
+
unloadNamespaceBundleAsync(String, String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Unload namespace bundle asynchronously.
+
+
unloadNamespaceBundleAsync(String, String, String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Unload namespace bundle asynchronously.
+
+
unloadScope(NamespaceIsolationPolicyUnloadScope) - Method in interface org.apache.pulsar.common.policies.data.NamespaceIsolationData.Builder
+
 
+
unsealedAbortTxnIDSize - Variable in class org.apache.pulsar.common.policies.data.SegmentsStats
+
 
+
unsubscribeNamespace(String, String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Unsubscribe the given subscription on all topics on a namespace.
+
+
unsubscribeNamespaceAsync(String, String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Unsubscribe the given subscription on all topics on a namespace asynchronously.
+
+
unsubscribeNamespaceBundle(String, String, String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Unsubscribe the given subscription on all topics on a namespace bundle.
+
+
unsubscribeNamespaceBundleAsync(String, String, String) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Unsubscribe the given subscription on all topics on a namespace bundle asynchronously.
+
+
updateBookie(String, String, BookieInfo) - Method in class org.apache.pulsar.common.policies.data.BookiesRackConfiguration
+
 
+
updateBookieRackInfo(String, String, BookieInfo) - Method in interface org.apache.pulsar.client.admin.Bookies
+
+
Updates the rack placement information for a specific bookie in the cluster.
+
+
updateBookieRackInfoAsync(String, String, BookieInfo) - Method in interface org.apache.pulsar.client.admin.Bookies
+
+
Updates the rack placement information for a specific bookie in the cluster asynchronously.
+
+
updateCluster(String, ClusterData) - Method in interface org.apache.pulsar.client.admin.Clusters
+
+
Update the configuration for a cluster.
+
+
updateClusterAsync(String, ClusterData) - Method in interface org.apache.pulsar.client.admin.Clusters
+
+
Update the configuration for a cluster asynchronously.
+
+
updateClusterMigration(String, boolean, ClusterPolicies.ClusterUrl) - Method in interface org.apache.pulsar.client.admin.Clusters
+
+
Update the configuration for a cluster migration.
+
+
updateClusterMigrationAsync(String, boolean, ClusterPolicies.ClusterUrl) - Method in interface org.apache.pulsar.client.admin.Clusters
+
+
Update the configuration for a cluster migration asynchronously.
+
+
updateDynamicConfiguration(String, String) - Method in interface org.apache.pulsar.client.admin.Brokers
+
+
Update a dynamic configuration value into ZooKeeper.
+
+
updateDynamicConfigurationAsync(String, String) - Method in interface org.apache.pulsar.client.admin.Brokers
+
+
Update a dynamic configuration value into ZooKeeper asynchronously.
+
+
updateFailureDomain(String, String, FailureDomain) - Method in interface org.apache.pulsar.client.admin.Clusters
+
+
Update a domain into cluster.
+
+
updateFailureDomainAsync(String, String, FailureDomain) - Method in interface org.apache.pulsar.client.admin.Clusters
+
+
Update a domain into cluster asynchronously.
+
+
updateFunction(FunctionConfig, String) - Method in interface org.apache.pulsar.client.admin.Functions
+
+
Update the configuration for a function.
+
+
updateFunction(FunctionConfig, String, UpdateOptions) - Method in interface org.apache.pulsar.client.admin.Functions
+
+
Update the configuration for a function.
+
+
updateFunctionAsync(FunctionConfig, String) - Method in interface org.apache.pulsar.client.admin.Functions
+
+
Update the configuration for a function asynchronously.
+
+
updateFunctionAsync(FunctionConfig, String, UpdateOptions) - Method in interface org.apache.pulsar.client.admin.Functions
+
+
Update the configuration for a function asynchronously.
+
+
updateFunctionWithUrl(FunctionConfig, String) - Method in interface org.apache.pulsar.client.admin.Functions
+
+
Update the configuration for a function.
+
+
updateFunctionWithUrl(FunctionConfig, String, UpdateOptions) - Method in interface org.apache.pulsar.client.admin.Functions
+
+
Update the configuration for a function.
+
+
updateFunctionWithUrlAsync(FunctionConfig, String) - Method in interface org.apache.pulsar.client.admin.Functions
+
+
Update the configuration for a function asynchronously.
+
+
updateFunctionWithUrlAsync(FunctionConfig, String, UpdateOptions) - Method in interface org.apache.pulsar.client.admin.Functions
+
+
Update the configuration for a function asynchronously.
+
+
updateMetadata(String, PackageMetadata) - Method in interface org.apache.pulsar.client.admin.Packages
+
+
Update a package metadata information.
+
+
updateMetadataAsync(String, PackageMetadata) - Method in interface org.apache.pulsar.client.admin.Packages
+
+
Update a package metadata information asynchronously.
+
+
updateMigrationState(String, boolean) - Method in interface org.apache.pulsar.client.admin.Namespaces
+
+
Enable migration for all topics within a namespace.
+
+
updateNamespaceIsolationPolicy(String, String, NamespaceIsolationData) - Method in interface org.apache.pulsar.client.admin.Clusters
+
+
Update a namespace isolation policy for a cluster.
+
+
updateNamespaceIsolationPolicyAsync(String, String, NamespaceIsolationData) - Method in interface org.apache.pulsar.client.admin.Clusters
+
+
Update a namespace isolation policy for a cluster asynchronously.
+
+
UpdateOptions - Interface in org.apache.pulsar.common.functions
+
 
+
updatePartitionedTopic(String, int) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Update number of partitions of a partitioned topic.
+
+
updatePartitionedTopic(String, int, boolean) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Update number of partitions of a partitioned topic.
+
+
updatePartitionedTopic(String, int, boolean, boolean) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Update number of partitions of a partitioned topic.
+
+
updatePartitionedTopicAsync(String, int) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Update number of partitions of a partitioned topic asynchronously.
+
+
updatePartitionedTopicAsync(String, int, boolean) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Update number of partitions of a partitioned topic asynchronously.
+
+
updatePartitionedTopicAsync(String, int, boolean, boolean) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Update number of partitions of a partitioned topic asynchronously.
+
+
updatePeerClusterNames(String, LinkedHashSet<String>) - Method in interface org.apache.pulsar.client.admin.Clusters
+
+
Update peer cluster names.
+
+
updatePeerClusterNamesAsync(String, LinkedHashSet<String>) - Method in interface org.apache.pulsar.client.admin.Clusters
+
+
Update peer cluster names asynchronously.
+
+
updateProperties(String, Map<String, String>) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Update Topic Properties on a topic.
+
+
updatePropertiesAsync(String, Map<String, String>) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Update Topic Properties on a topic.
+
+
updateProperty(String, TenantInfo) - Method in interface org.apache.pulsar.client.admin.Properties
+
+
Deprecated.
+
Update the admins for a property.
+
+
updateResourceGroup(String, ResourceGroup) - Method in interface org.apache.pulsar.client.admin.ResourceGroups
+
+
Update the configuration for a ResourceGroup.
+
+
updateResourceGroupAsync(String, ResourceGroup) - Method in interface org.apache.pulsar.client.admin.ResourceGroups
+
+
Update the configuration for a ResourceGroup.
+
+
updateSink(SinkConfig, String) - Method in interface org.apache.pulsar.client.admin.Sinks
+
+
Update the configuration for a sink.
+
+
updateSink(SinkConfig, String, UpdateOptions) - Method in interface org.apache.pulsar.client.admin.Sinks
+
+
Update the configuration for a sink.
+
+
updateSinkAsync(SinkConfig, String) - Method in interface org.apache.pulsar.client.admin.Sinks
+
+
Update the configuration for a sink asynchronously.
+
+
updateSinkAsync(SinkConfig, String, UpdateOptions) - Method in interface org.apache.pulsar.client.admin.Sinks
+
+
Update the configuration for a sink asynchronously.
+
+
updateSinkWithUrl(SinkConfig, String) - Method in interface org.apache.pulsar.client.admin.Sinks
+
+
Update the configuration for a sink.
+
+
updateSinkWithUrl(SinkConfig, String, UpdateOptions) - Method in interface org.apache.pulsar.client.admin.Sinks
+
+
Update the configuration for a sink.
+
+
updateSinkWithUrlAsync(SinkConfig, String) - Method in interface org.apache.pulsar.client.admin.Sinks
+
+
Update the configuration for a sink asynchronously.
+
+
updateSinkWithUrlAsync(SinkConfig, String, UpdateOptions) - Method in interface org.apache.pulsar.client.admin.Sinks
+
+
Update the configuration for a sink asynchronously.
+
+
updateSource(SourceConfig, String) - Method in interface org.apache.pulsar.client.admin.Sources
+
+
Update the configuration for a source.
+
+
updateSource(SourceConfig, String, UpdateOptions) - Method in interface org.apache.pulsar.client.admin.Sources
+
+
Update the configuration for a source.
+
+
updateSourceAsync(SourceConfig, String) - Method in interface org.apache.pulsar.client.admin.Sources
+
+
Update the configuration for a source asynchronously.
+
+
updateSourceAsync(SourceConfig, String, UpdateOptions) - Method in interface org.apache.pulsar.client.admin.Sources
+
+
Update the configuration for a source asynchronously.
+
+
updateSourceWithUrl(SourceConfig, String) - Method in interface org.apache.pulsar.client.admin.Sources
+
+
Update the configuration for a source.
+
+
updateSourceWithUrl(SourceConfig, String, UpdateOptions) - Method in interface org.apache.pulsar.client.admin.Sources
+
+
Update the configuration for a source.
+
+
updateSourceWithUrlAsync(SourceConfig, String) - Method in interface org.apache.pulsar.client.admin.Sources
+
+
Update the configuration for a source asynchronously.
+
+
updateSourceWithUrlAsync(SourceConfig, String, UpdateOptions) - Method in interface org.apache.pulsar.client.admin.Sources
+
+
Update the configuration for a source asynchronously.
+
+
updateSubscriptionProperties(String, String, Map<String, String>) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Update Subscription Properties on a topic subscription.
+
+
updateSubscriptionPropertiesAsync(String, String, Map<String, String>) - Method in interface org.apache.pulsar.client.admin.Topics
+
+
Update Subscription Properties on a topic subscription.
+
+
updateTenant(String, TenantInfo) - Method in interface org.apache.pulsar.client.admin.Tenants
+
+
Update the admins for a tenant.
+
+
updateTenantAsync(String, TenantInfo) - Method in interface org.apache.pulsar.client.admin.Tenants
+
+
Update the admins for a tenant asynchronously.
+
+
upload(PackageMetadata, String, String) - Method in interface org.apache.pulsar.client.admin.Packages
+
+
Upload a package to the package management service.
+
+
uploadAsync(PackageMetadata, String, String) - Method in interface org.apache.pulsar.client.admin.Packages
+
+
Upload a package to the package management service asynchronously.
+
+
uploadFunction(String, String) - Method in interface org.apache.pulsar.client.admin.Functions
+
+
Upload Data.
+
+
uploadFunctionAsync(String, String) - Method in interface org.apache.pulsar.client.admin.Functions
+
+
Upload Data asynchronously.
+
+
usage - Variable in class org.apache.pulsar.common.stats.AllocatorStats.PoolChunkStats
+
 
+
usage - Variable in class org.apache.pulsar.policies.data.loadbalancer.ResourceUsage
+
 
+
usage_threshold - Variable in class org.apache.pulsar.common.policies.impl.MinAvailablePolicy
+
 
+
usedDirectMemory - Variable in class org.apache.pulsar.common.stats.AllocatorStats
+
 
+
usedHeapMemory - Variable in class org.apache.pulsar.common.stats.AllocatorStats
+
 
+
useKeyStoreTls(boolean) - Method in interface org.apache.pulsar.client.admin.PulsarAdminBuilder
+
+
If Tls is enabled, whether use KeyStore type as tls configuration parameter.
+
+
+

V

+
+
V1 - Enum constant in enum class org.apache.pulsar.common.naming.TopicVersion
+
 
+
V2 - Enum constant in enum class org.apache.pulsar.common.naming.TopicVersion
+
 
+
validate() - Method in interface org.apache.pulsar.common.policies.data.AutoFailoverPolicyData
+
 
+
validate() - Method in interface org.apache.pulsar.common.policies.data.NamespaceIsolationData
+
 
+
validateOverride(AutoTopicCreationOverride) - Static method in class org.apache.pulsar.common.policies.data.impl.AutoTopicCreationOverrideImpl
+
 
+
ValidateResult - Class in org.apache.pulsar.common.policies.data
+
 
+
value - Variable in enum class org.apache.pulsar.client.admin.Topics.QueryParam
+
 
+
value() - Method in enum class org.apache.pulsar.common.naming.TopicDomain
+
 
+
value() - Method in enum class org.apache.pulsar.packages.management.core.common.PackageType
+
 
+
valueOf(int) - Static method in enum class org.apache.pulsar.client.admin.Mode
+
+
Returns the enum constant of this class with the specified name.
+
+
valueOf(String) - Static method in enum class org.apache.pulsar.client.admin.LongRunningProcessStatus.Status
+
+
Returns the enum constant of this class with the specified name.
+
+
valueOf(String) - Static method in enum class org.apache.pulsar.client.admin.Mode
+
+
Returns the enum constant of this class with the specified name.
+
+
valueOf(String) - Static method in enum class org.apache.pulsar.client.admin.Topics.QueryParam
+
+
Returns the enum constant of this class with the specified name.
+
+
valueOf(String) - Static method in enum class org.apache.pulsar.common.functions.FunctionConfig.ProcessingGuarantees
+
+
Returns the enum constant of this class with the specified name.
+
+
valueOf(String) - Static method in enum class org.apache.pulsar.common.functions.FunctionConfig.Runtime
+
+
Returns the enum constant of this class with the specified name.
+
+
valueOf(String) - Static method in enum class org.apache.pulsar.common.functions.WindowConfig.ProcessingGuarantees
+
+
Returns the enum constant of this class with the specified name.
+
+
valueOf(String) - Static method in enum class org.apache.pulsar.common.naming.TopicDomain
+
+
Returns the enum constant of this class with the specified name.
+
+
valueOf(String) - Static method in enum class org.apache.pulsar.common.naming.TopicVersion
+
+
Returns the enum constant of this class with the specified name.
+
+
valueOf(String) - Static method in enum class org.apache.pulsar.common.policies.data.AuthAction
+
+
Returns the enum constant of this class with the specified name.
+
+
valueOf(String) - Static method in enum class org.apache.pulsar.common.policies.data.AutoFailoverPolicyType
+
+
Returns the enum constant of this class with the specified name.
+
+
valueOf(String) - Static method in enum class org.apache.pulsar.common.policies.data.BacklogQuota.BacklogQuotaType
+
+
Returns the enum constant of this class with the specified name.
+
+
valueOf(String) - Static method in enum class org.apache.pulsar.common.policies.data.BacklogQuota.RetentionPolicy
+
+
Returns the enum constant of this class with the specified name.
+
+
valueOf(String) - Static method in enum class org.apache.pulsar.common.policies.data.BrokerAssignment
+
+
Returns the enum constant of this class with the specified name.
+
+
valueOf(String) - Static method in enum class org.apache.pulsar.common.policies.data.InactiveTopicDeleteMode
+
+
Returns the enum constant of this class with the specified name.
+
+
valueOf(String) - Static method in enum class org.apache.pulsar.common.policies.data.NamespaceIsolationPolicyUnloadScope
+
+
Returns the enum constant of this class with the specified name.
+
+
valueOf(String) - Static method in enum class org.apache.pulsar.common.policies.data.OffloadedReadPriority
+
+
Returns the enum constant of this class with the specified name.
+
+
valueOf(String) - Static method in enum class org.apache.pulsar.common.policies.data.Policies.BundleType
+
+
Returns the enum constant of this class with the specified name.
+
+
valueOf(String) - Static method in enum class org.apache.pulsar.common.policies.data.SchemaAutoUpdateCompatibilityStrategy
+
+
Returns the enum constant of this class with the specified name.
+
+
valueOf(String) - Static method in enum class org.apache.pulsar.common.policies.data.SchemaCompatibilityStrategy
+
+
Returns the enum constant of this class with the specified name.
+
+
valueOf(String) - Static method in enum class org.apache.pulsar.common.policies.data.SubscriptionAuthMode
+
+
Returns the enum constant of this class with the specified name.
+
+
valueOf(String) - Static method in enum class org.apache.pulsar.common.policies.data.TopicType
+
+
Returns the enum constant of this class with the specified name.
+
+
valueOf(String) - Static method in enum class org.apache.pulsar.common.stats.PositionInPendingAckStats.State
+
+
Returns the enum constant of this class with the specified name.
+
+
valueOf(String) - Static method in enum class org.apache.pulsar.packages.management.core.common.PackageType
+
+
Returns the enum constant of this class with the specified name.
+
+
values() - Static method in enum class org.apache.pulsar.client.admin.LongRunningProcessStatus.Status
+
+
Returns an array containing the constants of this enum class, in +the order they are declared.
+
+
values() - Static method in enum class org.apache.pulsar.client.admin.Mode
+
+
Returns an array containing the constants of this enum class, in +the order they are declared.
+
+
values() - Static method in enum class org.apache.pulsar.client.admin.Topics.QueryParam
+
+
Returns an array containing the constants of this enum class, in +the order they are declared.
+
+
values() - Static method in enum class org.apache.pulsar.common.functions.FunctionConfig.ProcessingGuarantees
+
+
Returns an array containing the constants of this enum class, in +the order they are declared.
+
+
values() - Static method in enum class org.apache.pulsar.common.functions.FunctionConfig.Runtime
+
+
Returns an array containing the constants of this enum class, in +the order they are declared.
+
+
values() - Static method in enum class org.apache.pulsar.common.functions.WindowConfig.ProcessingGuarantees
+
+
Returns an array containing the constants of this enum class, in +the order they are declared.
+
+
values() - Static method in enum class org.apache.pulsar.common.naming.TopicDomain
+
+
Returns an array containing the constants of this enum class, in +the order they are declared.
+
+
values() - Static method in enum class org.apache.pulsar.common.naming.TopicVersion
+
+
Returns an array containing the constants of this enum class, in +the order they are declared.
+
+
values() - Static method in enum class org.apache.pulsar.common.policies.data.AuthAction
+
+
Returns an array containing the constants of this enum class, in +the order they are declared.
+
+
values() - Static method in enum class org.apache.pulsar.common.policies.data.AutoFailoverPolicyType
+
+
Returns an array containing the constants of this enum class, in +the order they are declared.
+
+
values() - Static method in enum class org.apache.pulsar.common.policies.data.BacklogQuota.BacklogQuotaType
+
+
Returns an array containing the constants of this enum class, in +the order they are declared.
+
+
values() - Static method in enum class org.apache.pulsar.common.policies.data.BacklogQuota.RetentionPolicy
+
+
Returns an array containing the constants of this enum class, in +the order they are declared.
+
+
values() - Static method in enum class org.apache.pulsar.common.policies.data.BrokerAssignment
+
+
Returns an array containing the constants of this enum class, in +the order they are declared.
+
+
values() - Static method in enum class org.apache.pulsar.common.policies.data.InactiveTopicDeleteMode
+
+
Returns an array containing the constants of this enum class, in +the order they are declared.
+
+
values() - Static method in enum class org.apache.pulsar.common.policies.data.NamespaceIsolationPolicyUnloadScope
+
+
Returns an array containing the constants of this enum class, in +the order they are declared.
+
+
values() - Static method in enum class org.apache.pulsar.common.policies.data.OffloadedReadPriority
+
+
Returns an array containing the constants of this enum class, in +the order they are declared.
+
+
values() - Static method in enum class org.apache.pulsar.common.policies.data.Policies.BundleType
+
+
Returns an array containing the constants of this enum class, in +the order they are declared.
+
+
values() - Static method in enum class org.apache.pulsar.common.policies.data.SchemaAutoUpdateCompatibilityStrategy
+
+
Returns an array containing the constants of this enum class, in +the order they are declared.
+
+
values() - Static method in enum class org.apache.pulsar.common.policies.data.SchemaCompatibilityStrategy
+
+
Returns an array containing the constants of this enum class, in +the order they are declared.
+
+
values() - Static method in enum class org.apache.pulsar.common.policies.data.SubscriptionAuthMode
+
+
Returns an array containing the constants of this enum class, in +the order they are declared.
+
+
values() - Static method in enum class org.apache.pulsar.common.policies.data.TopicType
+
+
Returns an array containing the constants of this enum class, in +the order they are declared.
+
+
values() - Static method in enum class org.apache.pulsar.common.stats.PositionInPendingAckStats.State
+
+
Returns an array containing the constants of this enum class, in +the order they are declared.
+
+
values() - Static method in enum class org.apache.pulsar.packages.management.core.common.PackageType
+
+
Returns an array containing the constants of this enum class, in +the order they are declared.
+
+
+

W

+
+
waitingCursorsCount - Variable in class org.apache.pulsar.common.policies.data.ManagedLedgerInternalStats
+
+
The number of cursors that are "caught up" and waiting for a new message to be published.
+
+
waitingReadOp - Variable in class org.apache.pulsar.common.policies.data.ManagedLedgerInternalStats.CursorStats
+
 
+
WINDOW_CONFIG_KEY - Static variable in class org.apache.pulsar.common.functions.WindowConfig
+
 
+
WindowConfig - Class in org.apache.pulsar.common.functions
+
+
Configuration of a windowing function.
+
+
WindowConfig() - Constructor for class org.apache.pulsar.common.functions.WindowConfig
+
 
+
WindowConfig.ProcessingGuarantees - Enum Class in org.apache.pulsar.common.functions
+
+
This is a semantic option that windows can provide, + forcing the semantics of the FunctionConfig.ProcessingGuarantees to be equal to MANUAL, + and then letting the windows function handle the semantic timing by itself.
+
+
worker() - Method in interface org.apache.pulsar.client.admin.PulsarAdmin
+
 
+
Worker - Interface in org.apache.pulsar.client.admin
+
+
Admin interface for worker stats management.
+
+
WorkerFunctionInstanceStats - Class in org.apache.pulsar.common.policies.data
+
+
Data class holding statistics about a function.
+
+
WorkerFunctionInstanceStats() - Constructor for class org.apache.pulsar.common.policies.data.WorkerFunctionInstanceStats
+
 
+
workerId - Variable in class org.apache.pulsar.common.policies.data.FunctionStatus.FunctionInstanceStatus.FunctionInstanceStatusData
+
 
+
workerId - Variable in class org.apache.pulsar.common.policies.data.SinkStatus.SinkInstanceStatus.SinkInstanceStatusData
+
 
+
workerId - Variable in class org.apache.pulsar.common.policies.data.SourceStatus.SourceInstanceStatus.SourceInstanceStatusData
+
 
+
WorkerInfo - Class in org.apache.pulsar.common.functions
+
+
Worker information.
+
+
WorkerInfo() - Constructor for class org.apache.pulsar.common.functions.WorkerInfo
+
 
+
wrap(PulsarAdminException) - Static method in exception class org.apache.pulsar.client.admin.PulsarAdminException
+
+
Clone the exception and grab the current stacktrace.
+
+
+A B C D E F G H I J L M N O P R S T U V W 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
+ +
+
+ + diff --git a/static/api/admin/4.0.x/index.html b/static/api/admin/4.0.x/index.html new file mode 100644 index 000000000000..f0cd1bb116c5 --- /dev/null +++ b/static/api/admin/4.0.x/index.html @@ -0,0 +1,129 @@ + + + + +Overview (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Pulsar Client Admin :: API 4.0.0 API

+
+
+
Packages
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
org.apache.pulsar.client.admin.utils
+
+
Helpers which provide useful functionality for the implementation of Pulsar Client API.
+
+
org.apache.pulsar.common.conf
+
+
Classes for internal configuration.
+
+
org.apache.pulsar.common.functions
+
+
Implementation of policies.
+
+
org.apache.pulsar.common.io
+
+
Implementation of policies.
+
+
org.apache.pulsar.common.naming
+
+
Implementation of policies.
+
+
org.apache.pulsar.common.partition
+
+
Implementation of policies.
+
+
org.apache.pulsar.common.policies
+
+
Implementation of policies.
+
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
org.apache.pulsar.common.policies.data.impl
+
 
+
org.apache.pulsar.common.policies.impl
+
+
Implementation of policies.
+
+
org.apache.pulsar.common.protocol.schema
+
+
Implementation of policies.
+
+
org.apache.pulsar.common.stats
+
+
Implementation of policies.
+
+
org.apache.pulsar.packages.management.core.common
+
+
Packages management general classes.
+
+
org.apache.pulsar.packages.management.core.exceptions
+
+
Exceptions of the packages management service thrown.
+
+
org.apache.pulsar.policies.data.loadbalancer
+
+
Implementation of policies.
+
+
+
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/legal/ADDITIONAL_LICENSE_INFO b/static/api/admin/4.0.x/legal/ADDITIONAL_LICENSE_INFO new file mode 100644 index 000000000000..ff700cd09f6e --- /dev/null +++ b/static/api/admin/4.0.x/legal/ADDITIONAL_LICENSE_INFO @@ -0,0 +1,37 @@ + ADDITIONAL INFORMATION ABOUT LICENSING + +Certain files distributed by Oracle America, Inc. and/or its affiliates are +subject to the following clarification and special exception to the GPLv2, +based on the GNU Project exception for its Classpath libraries, known as the +GNU Classpath Exception. + +Note that Oracle includes multiple, independent programs in this software +package. Some of those programs are provided under licenses deemed +incompatible with the GPLv2 by the Free Software Foundation and others. +For example, the package includes programs licensed under the Apache +License, Version 2.0 and may include FreeType. Such programs are licensed +to you under their original licenses. + +Oracle facilitates your further distribution of this package by adding the +Classpath Exception to the necessary parts of its GPLv2 code, which permits +you to use that code in combination with other independent modules not +licensed under the GPLv2. However, note that this would not permit you to +commingle code under an incompatible license with Oracle's GPLv2 licensed +code by, for example, cutting and pasting such code into a file also +containing Oracle's GPLv2 licensed code and then distributing the result. + +Additionally, if you were to remove the Classpath Exception from any of the +files to which it applies and distribute the result, you would likely be +required to license some or all of the other code in that distribution under +the GPLv2 as well, and since the GPLv2 is incompatible with the license terms +of some items included in the distribution by Oracle, removing the Classpath +Exception could therefore effectively compromise your ability to further +distribute the package. + +Failing to distribute notices associated with some files may also create +unexpected legal consequences. + +Proceed with caution and we recommend that you obtain the advice of a lawyer +skilled in open source matters before removing the Classpath Exception or +making modifications to this package which may subsequently be redistributed +and/or involve the use of third party software. diff --git a/static/api/admin/4.0.x/legal/ASSEMBLY_EXCEPTION b/static/api/admin/4.0.x/legal/ASSEMBLY_EXCEPTION new file mode 100644 index 000000000000..429666664e9f --- /dev/null +++ b/static/api/admin/4.0.x/legal/ASSEMBLY_EXCEPTION @@ -0,0 +1,27 @@ + +OPENJDK ASSEMBLY EXCEPTION + +The OpenJDK source code made available by Oracle America, Inc. (Oracle) at +openjdk.org ("OpenJDK Code") is distributed under the terms of the GNU +General Public License version 2 +only ("GPL2"), with the following clarification and special exception. + + Linking this OpenJDK Code statically or dynamically with other code + is making a combined work based on this library. Thus, the terms + and conditions of GPL2 cover the whole combination. + + As a special exception, Oracle gives you permission to link this + OpenJDK Code with certain code licensed by Oracle as indicated at + https://openjdk.org/legal/exception-modules-2007-05-08.html + ("Designated Exception Modules") to produce an executable, + regardless of the license terms of the Designated Exception Modules, + and to copy and distribute the resulting executable under GPL2, + provided that the Designated Exception Modules continue to be + governed by the licenses under which they were offered by Oracle. + +As such, it allows licensees and sublicensees of Oracle's GPL2 OpenJDK Code +to build an executable that includes those portions of necessary code that +Oracle could not provide under GPL2 (or that Oracle has provided under GPL2 +with the Classpath exception). If you modify or add to the OpenJDK code, +that new GPL2 code may still be combined with Designated Exception Modules +if the new code is made subject to this exception by its copyright holder. diff --git a/static/api/admin/4.0.x/legal/LICENSE b/static/api/admin/4.0.x/legal/LICENSE new file mode 100644 index 000000000000..8b400c7ab81b --- /dev/null +++ b/static/api/admin/4.0.x/legal/LICENSE @@ -0,0 +1,347 @@ +The GNU General Public License (GPL) + +Version 2, June 1991 + +Copyright (C) 1989, 1991 Free Software Foundation, Inc. +51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + +Everyone is permitted to copy and distribute verbatim copies of this license +document, but changing it is not allowed. + +Preamble + +The licenses for most software are designed to take away your freedom to share +and change it. By contrast, the GNU General Public License is intended to +guarantee your freedom to share and change free software--to make sure the +software is free for all its users. This General Public License applies to +most of the Free Software Foundation's software and to any other program whose +authors commit to using it. (Some other Free Software Foundation software is +covered by the GNU Library General Public License instead.) You can apply it to +your programs, too. + +When we speak of free software, we are referring to freedom, not price. Our +General Public Licenses are designed to make sure that you have the freedom to +distribute copies of free software (and charge for this service if you wish), +that you receive source code or can get it if you want it, that you can change +the software or use pieces of it in new free programs; and that you know you +can do these things. + +To protect your rights, we need to make restrictions that forbid anyone to deny +you these rights or to ask you to surrender the rights. These restrictions +translate to certain responsibilities for you if you distribute copies of the +software, or if you modify it. + +For example, if you distribute copies of such a program, whether gratis or for +a fee, you must give the recipients all the rights that you have. You must +make sure that they, too, receive or can get the source code. And you must +show them these terms so they know their rights. + +We protect your rights with two steps: (1) copyright the software, and (2) +offer you this license which gives you legal permission to copy, distribute +and/or modify the software. + +Also, for each author's protection and ours, we want to make certain that +everyone understands that there is no warranty for this free software. If the +software is modified by someone else and passed on, we want its recipients to +know that what they have is not the original, so that any problems introduced +by others will not reflect on the original authors' reputations. + +Finally, any free program is threatened constantly by software patents. We +wish to avoid the danger that redistributors of a free program will +individually obtain patent licenses, in effect making the program proprietary. +To prevent this, we have made it clear that any patent must be licensed for +everyone's free use or not licensed at all. + +The precise terms and conditions for copying, distribution and modification +follow. + +TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + +0. This License applies to any program or other work which contains a notice +placed by the copyright holder saying it may be distributed under the terms of +this General Public License. The "Program", below, refers to any such program +or work, and a "work based on the Program" means either the Program or any +derivative work under copyright law: that is to say, a work containing the +Program or a portion of it, either verbatim or with modifications and/or +translated into another language. (Hereinafter, translation is included +without limitation in the term "modification".) Each licensee is addressed as +"you". + +Activities other than copying, distribution and modification are not covered by +this License; they are outside its scope. The act of running the Program is +not restricted, and the output from the Program is covered only if its contents +constitute a work based on the Program (independent of having been made by +running the Program). Whether that is true depends on what the Program does. + +1. You may copy and distribute verbatim copies of the Program's source code as +you receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice and +disclaimer of warranty; keep intact all the notices that refer to this License +and to the absence of any warranty; and give any other recipients of the +Program a copy of this License along with the Program. + +You may charge a fee for the physical act of transferring a copy, and you may +at your option offer warranty protection in exchange for a fee. + +2. You may modify your copy or copies of the Program or any portion of it, thus +forming a work based on the Program, and copy and distribute such modifications +or work under the terms of Section 1 above, provided that you also meet all of +these conditions: + + a) You must cause the modified files to carry prominent notices stating + that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in whole or + in part contains or is derived from the Program or any part thereof, to be + licensed as a whole at no charge to all third parties under the terms of + this License. + + c) If the modified program normally reads commands interactively when run, + you must cause it, when started running for such interactive use in the + most ordinary way, to print or display an announcement including an + appropriate copyright notice and a notice that there is no warranty (or + else, saying that you provide a warranty) and that users may redistribute + the program under these conditions, and telling the user how to view a copy + of this License. (Exception: if the Program itself is interactive but does + not normally print such an announcement, your work based on the Program is + not required to print an announcement.) + +These requirements apply to the modified work as a whole. If identifiable +sections of that work are not derived from the Program, and can be reasonably +considered independent and separate works in themselves, then this License, and +its terms, do not apply to those sections when you distribute them as separate +works. But when you distribute the same sections as part of a whole which is a +work based on the Program, the distribution of the whole must be on the terms +of this License, whose permissions for other licensees extend to the entire +whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest your +rights to work written entirely by you; rather, the intent is to exercise the +right to control the distribution of derivative or collective works based on +the Program. + +In addition, mere aggregation of another work not based on the Program with the +Program (or with a work based on the Program) on a volume of a storage or +distribution medium does not bring the other work under the scope of this +License. + +3. You may copy and distribute the Program (or a work based on it, under +Section 2) in object code or executable form under the terms of Sections 1 and +2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable source + code, which must be distributed under the terms of Sections 1 and 2 above + on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three years, to + give any third party, for a charge no more than your cost of physically + performing source distribution, a complete machine-readable copy of the + corresponding source code, to be distributed under the terms of Sections 1 + and 2 above on a medium customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer to + distribute corresponding source code. (This alternative is allowed only + for noncommercial distribution and only if you received the program in + object code or executable form with such an offer, in accord with + Subsection b above.) + +The source code for a work means the preferred form of the work for making +modifications to it. For an executable work, complete source code means all +the source code for all modules it contains, plus any associated interface +definition files, plus the scripts used to control compilation and installation +of the executable. However, as a special exception, the source code +distributed need not include anything that is normally distributed (in either +source or binary form) with the major components (compiler, kernel, and so on) +of the operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering access to copy +from a designated place, then offering equivalent access to copy the source +code from the same place counts as distribution of the source code, even though +third parties are not compelled to copy the source along with the object code. + +4. You may not copy, modify, sublicense, or distribute the Program except as +expressly provided under this License. Any attempt otherwise to copy, modify, +sublicense or distribute the Program is void, and will automatically terminate +your rights under this License. However, parties who have received copies, or +rights, from you under this License will not have their licenses terminated so +long as such parties remain in full compliance. + +5. You are not required to accept this License, since you have not signed it. +However, nothing else grants you permission to modify or distribute the Program +or its derivative works. These actions are prohibited by law if you do not +accept this License. Therefore, by modifying or distributing the Program (or +any work based on the Program), you indicate your acceptance of this License to +do so, and all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + +6. Each time you redistribute the Program (or any work based on the Program), +the recipient automatically receives a license from the original licensor to +copy, distribute or modify the Program subject to these terms and conditions. +You may not impose any further restrictions on the recipients' exercise of the +rights granted herein. You are not responsible for enforcing compliance by +third parties to this License. + +7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), conditions +are imposed on you (whether by court order, agreement or otherwise) that +contradict the conditions of this License, they do not excuse you from the +conditions of this License. If you cannot distribute so as to satisfy +simultaneously your obligations under this License and any other pertinent +obligations, then as a consequence you may not distribute the Program at all. +For example, if a patent license would not permit royalty-free redistribution +of the Program by all those who receive copies directly or indirectly through +you, then the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under any +particular circumstance, the balance of the section is intended to apply and +the section as a whole is intended to apply in other circumstances. + +It is not the purpose of this section to induce you to infringe any patents or +other property right claims or to contest validity of any such claims; this +section has the sole purpose of protecting the integrity of the free software +distribution system, which is implemented by public license practices. Many +people have made generous contributions to the wide range of software +distributed through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing to +distribute software through any other system and a licensee cannot impose that +choice. + +This section is intended to make thoroughly clear what is believed to be a +consequence of the rest of this License. + +8. If the distribution and/or use of the Program is restricted in certain +countries either by patents or by copyrighted interfaces, the original +copyright holder who places the Program under this License may add an explicit +geographical distribution limitation excluding those countries, so that +distribution is permitted only in or among countries not thus excluded. In +such case, this License incorporates the limitation as if written in the body +of this License. + +9. The Free Software Foundation may publish revised and/or new versions of the +General Public License from time to time. Such new versions will be similar in +spirit to the present version, but may differ in detail to address new problems +or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any later +version", you have the option of following the terms and conditions either of +that version or of any later version published by the Free Software Foundation. +If the Program does not specify a version number of this License, you may +choose any version ever published by the Free Software Foundation. + +10. If you wish to incorporate parts of the Program into other free programs +whose distribution conditions are different, write to the author to ask for +permission. For software which is copyrighted by the Free Software Foundation, +write to the Free Software Foundation; we sometimes make exceptions for this. +Our decision will be guided by the two goals of preserving the free status of +all derivatives of our free software and of promoting the sharing and reuse of +software generally. + +NO WARRANTY + +11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR +THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE +STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE +PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, +INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND +FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND +PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, +YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + +12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL +ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE +PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR +INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA +BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A +FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER +OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. + +END OF TERMS AND CONDITIONS + +How to Apply These Terms to Your New Programs + +If you develop a new program, and you want it to be of the greatest possible +use to the public, the best way to achieve this is to make it free software +which everyone can redistribute and change under these terms. + +To do so, attach the following notices to the program. It is safest to attach +them to the start of each source file to most effectively convey the exclusion +of warranty; and each file should have at least the "copyright" line and a +pointer to where the full notice is found. + + One line to give the program's name and a brief idea of what it does. + + Copyright (C) + + This program is free software; you can redistribute it and/or modify it + under the terms of the GNU General Public License as published by the Free + Software Foundation; either version 2 of the License, or (at your option) + any later version. + + This program is distributed in the hope that it will be useful, but WITHOUT + ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for + more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this when it +starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author Gnomovision comes + with ABSOLUTELY NO WARRANTY; for details type 'show w'. This is free + software, and you are welcome to redistribute it under certain conditions; + type 'show c' for details. + +The hypothetical commands 'show w' and 'show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may be +called something other than 'show w' and 'show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your school, +if any, to sign a "copyright disclaimer" for the program, if necessary. Here +is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + 'Gnomovision' (which makes passes at compilers) written by James Hacker. + + signature of Ty Coon, 1 April 1989 + + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Library General Public +License instead of this License. + + +"CLASSPATH" EXCEPTION TO THE GPL + +Certain source files distributed by Oracle America and/or its affiliates are +subject to the following clarification and special exception to the GPL, but +only where Oracle has expressly included in the particular source file's header +the words "Oracle designates this particular file as subject to the "Classpath" +exception as provided by Oracle in the LICENSE file that accompanied this code." + + Linking this library statically or dynamically with other modules is making + a combined work based on this library. Thus, the terms and conditions of + the GNU General Public License cover the whole combination. + + As a special exception, the copyright holders of this library give you + permission to link this library with independent modules to produce an + executable, regardless of the license terms of these independent modules, + and to copy and distribute the resulting executable under terms of your + choice, provided that you also meet, for each linked independent module, + the terms and conditions of the license of that module. An independent + module is a module which is not derived from or based on this library. If + you modify this library, you may extend this exception to your version of + the library, but you are not obligated to do so. If you do not wish to do + so, delete this exception statement from your version. diff --git a/static/api/admin/4.0.x/legal/jquery.md b/static/api/admin/4.0.x/legal/jquery.md new file mode 100644 index 000000000000..d468b3183a70 --- /dev/null +++ b/static/api/admin/4.0.x/legal/jquery.md @@ -0,0 +1,72 @@ +## jQuery v3.6.1 + +### jQuery License +``` +jQuery v 3.6.1 +Copyright OpenJS Foundation and other contributors, https://openjsf.org/ + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +****************************************** + +The jQuery JavaScript Library v3.6.1 also includes Sizzle.js + +Sizzle.js includes the following license: + +Copyright JS Foundation and other contributors, https://js.foundation/ + +This software consists of voluntary contributions made by many +individuals. For exact contribution history, see the revision history +available at https://github.com/jquery/sizzle + +The following license applies to all parts of this software except as +documented below: + +==== + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +==== + +All files located in the node_modules and external directories are +externally maintained libraries used by this software which have their +own licenses; we recommend you read them, as their terms may differ from +the terms above. + +********************* + +``` diff --git a/static/api/admin/4.0.x/legal/jqueryUI.md b/static/api/admin/4.0.x/legal/jqueryUI.md new file mode 100644 index 000000000000..8bda9d7a85e8 --- /dev/null +++ b/static/api/admin/4.0.x/legal/jqueryUI.md @@ -0,0 +1,49 @@ +## jQuery UI v1.13.2 + +### jQuery UI License +``` +Copyright jQuery Foundation and other contributors, https://jquery.org/ + +This software consists of voluntary contributions made by many +individuals. For exact contribution history, see the revision history +available at https://github.com/jquery/jquery-ui + +The following license applies to all parts of this software except as +documented below: + +==== + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +==== + +Copyright and related rights for sample code are waived via CC0. Sample +code is defined as all source code contained within the demos directory. + +CC0: http://creativecommons.org/publicdomain/zero/1.0/ + +==== + +All files located in the node_modules and external directories are +externally maintained libraries used by this software which have their +own licenses; we recommend you read them, as their terms may differ from +the terms above. + +``` diff --git a/static/api/admin/4.0.x/link.svg b/static/api/admin/4.0.x/link.svg new file mode 100644 index 000000000000..7ccc5ed08cbf --- /dev/null +++ b/static/api/admin/4.0.x/link.svg @@ -0,0 +1,31 @@ + + + + + + + + diff --git a/static/api/admin/4.0.x/member-search-index.js b/static/api/admin/4.0.x/member-search-index.js new file mode 100644 index 000000000000..3bf734813030 --- /dev/null +++ b/static/api/admin/4.0.x/member-search-index.js @@ -0,0 +1 @@ +memberSearchIndex = [{"p":"org.apache.pulsar.common.policies.data","c":"TransactionInBufferStats","l":"aborted"},{"p":"org.apache.pulsar.client.admin","c":"Transactions","l":"abortTransaction(TxnID)","u":"abortTransaction(org.apache.pulsar.client.api.transaction.TxnID)"},{"p":"org.apache.pulsar.client.admin","c":"Transactions","l":"abortTransactionAsync(TxnID)","u":"abortTransactionAsync(org.apache.pulsar.client.api.transaction.TxnID)"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdminBuilder","l":"acceptGzipCompression(boolean)"},{"p":"org.apache.pulsar.common.policies.data","c":"TransactionMetadata","l":"ackedPartitions"},{"p":"org.apache.pulsar.common.policies.data","c":"ManagedLedgerInternalStats.CursorStats","l":"active"},{"p":"org.apache.pulsar.common.policies.data","c":"BrokerStatus.Builder","l":"active(boolean)"},{"p":"org.apache.pulsar.common.policies.data","c":"DelayedDeliveryPolicies.Builder","l":"active(boolean)"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"BrokerStatusImpl.BrokerStatusImplBuilder","l":"active(boolean)"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"DelayedDeliveryPoliciesImpl.DelayedDeliveryPoliciesImplBuilder","l":"active(boolean)"},{"p":"org.apache.pulsar.common.policies.data","c":"NonPersistentPartitionedTopicStats","l":"add(NonPersistentTopicStats)","u":"add(org.apache.pulsar.common.policies.data.NonPersistentTopicStats)"},{"p":"org.apache.pulsar.common.policies.data","c":"ResourceQuota","l":"add(ResourceQuota)","u":"add(org.apache.pulsar.common.policies.data.ResourceQuota)"},{"p":"org.apache.pulsar.common.policies.data","c":"PartitionedTopicStats","l":"add(TopicStats)","u":"add(org.apache.pulsar.common.policies.data.TopicStats)"},{"p":"org.apache.pulsar.common.policies.data","c":"FunctionStatus","l":"addInstance(FunctionStatus.FunctionInstanceStatus)","u":"addInstance(org.apache.pulsar.common.policies.data.FunctionStatus.FunctionInstanceStatus)"},{"p":"org.apache.pulsar.common.policies.data","c":"SinkStatus","l":"addInstance(SinkStatus.SinkInstanceStatus)","u":"addInstance(org.apache.pulsar.common.policies.data.SinkStatus.SinkInstanceStatus)"},{"p":"org.apache.pulsar.common.policies.data","c":"SourceStatus","l":"addInstance(SourceStatus.SourceInstanceStatus)","u":"addInstance(org.apache.pulsar.common.policies.data.SourceStatus.SourceInstanceStatus)"},{"p":"org.apache.pulsar.common.policies.data","c":"TenantInfo.Builder","l":"adminRoles(Set)","u":"adminRoles(java.util.Set)"},{"p":"org.apache.pulsar.client.admin","c":"Mode","l":"ALL"},{"p":"org.apache.pulsar.common.policies.data","c":"NamespaceIsolationPolicyUnloadScope","l":"all_matching"},{"p":"org.apache.pulsar.common.stats","c":"AllocatorStats","l":"AllocatorStats()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data","c":"AutoSubscriptionCreationOverride.Builder","l":"allowAutoSubscriptionCreation(boolean)"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"AutoSubscriptionCreationOverrideImpl.AutoSubscriptionCreationOverrideImplBuilder","l":"allowAutoSubscriptionCreation(boolean)"},{"p":"org.apache.pulsar.common.policies.data","c":"AutoTopicCreationOverride.Builder","l":"allowAutoTopicCreation(boolean)"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"AutoTopicCreationOverrideImpl.AutoTopicCreationOverrideImplBuilder","l":"allowAutoTopicCreation(boolean)"},{"p":"org.apache.pulsar.common.policies.data","c":"Policies","l":"allowed_clusters"},{"p":"org.apache.pulsar.common.policies.data","c":"TenantInfo.Builder","l":"allowedClusters(Set)","u":"allowedClusters(java.util.Set)"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdminBuilder","l":"allowTlsInsecureConnection(boolean)"},{"p":"org.apache.pulsar.common.policies.data","c":"SchemaCompatibilityStrategy","l":"ALWAYS_COMPATIBLE"},{"p":"org.apache.pulsar.common.policies.data","c":"SchemaCompatibilityStrategy","l":"ALWAYS_INCOMPATIBLE"},{"p":"org.apache.pulsar.common.policies.data","c":"SchemaAutoUpdateCompatibilityStrategy","l":"AlwaysCompatible"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"analyzeSubscriptionBacklog(String, String, Optional)","u":"analyzeSubscriptionBacklog(java.lang.String,java.lang.String,java.util.Optional)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"analyzeSubscriptionBacklogAsync(String, String, Optional)","u":"analyzeSubscriptionBacklogAsync(java.lang.String,java.lang.String,java.util.Optional)"},{"p":"org.apache.pulsar.common.stats","c":"AnalyzeSubscriptionBacklogResult","l":"AnalyzeSubscriptionBacklogResult()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.functions","c":"FunctionConfig.ProcessingGuarantees","l":"ATLEAST_ONCE"},{"p":"org.apache.pulsar.common.functions","c":"WindowConfig.ProcessingGuarantees","l":"ATLEAST_ONCE"},{"p":"org.apache.pulsar.common.functions","c":"FunctionConfig.ProcessingGuarantees","l":"ATMOST_ONCE"},{"p":"org.apache.pulsar.common.functions","c":"WindowConfig.ProcessingGuarantees","l":"ATMOST_ONCE"},{"p":"org.apache.pulsar.common.policies.data","c":"Policies","l":"auth_policies"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdminBuilder","l":"authentication(Authentication)","u":"authentication(org.apache.pulsar.client.api.Authentication)"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdminBuilder","l":"authentication(String, Map)","u":"authentication(java.lang.String,java.util.Map)"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdminBuilder","l":"authentication(String, String)","u":"authentication(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.common.functions","c":"AuthenticationConfig","l":"AuthenticationConfig()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data","c":"ClusterData.Builder","l":"authenticationParameters(String)","u":"authenticationParameters(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"ClusterData.Builder","l":"authenticationPlugin(String)","u":"authenticationPlugin(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdminBuilder","l":"autoCertRefreshTime(int, TimeUnit)","u":"autoCertRefreshTime(int,java.util.concurrent.TimeUnit)"},{"p":"org.apache.pulsar.common.policies","c":"AutoFailoverPolicy","l":"AutoFailoverPolicy()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data","c":"NamespaceIsolationData.Builder","l":"autoFailoverPolicy(AutoFailoverPolicyData)","u":"autoFailoverPolicy(org.apache.pulsar.common.policies.data.AutoFailoverPolicyData)"},{"p":"org.apache.pulsar.common.policies.impl","c":"AutoFailoverPolicyFactory","l":"AutoFailoverPolicyFactory()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data","c":"Policies","l":"autoSubscriptionCreationOverride"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"AutoSubscriptionCreationOverrideImpl","l":"AutoSubscriptionCreationOverrideImpl()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"AutoSubscriptionCreationOverrideImpl.AutoSubscriptionCreationOverrideImplBuilder","l":"AutoSubscriptionCreationOverrideImplBuilder()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data","c":"Policies","l":"autoTopicCreationOverride"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"AutoTopicCreationOverrideImpl","l":"AutoTopicCreationOverrideImpl()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"AutoTopicCreationOverrideImpl.AutoTopicCreationOverrideImplBuilder","l":"AutoTopicCreationOverrideImplBuilder()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data","c":"SchemaAutoUpdateCompatibilityStrategy","l":"AutoUpdateDisabled"},{"p":"org.apache.pulsar.common.policies.data","c":"FunctionStatus.FunctionInstanceStatus.FunctionInstanceStatusData","l":"averageLatency"},{"p":"org.apache.pulsar.common.policies.data","c":"Policies","l":"backlog_quota_map"},{"p":"org.apache.pulsar.client.admin","c":"Brokers","l":"backlogQuotaCheck()"},{"p":"org.apache.pulsar.client.admin","c":"Brokers","l":"backlogQuotaCheckAsync()"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"BacklogQuotaImpl","l":"BacklogQuotaImpl(long, int, BacklogQuota.RetentionPolicy)","u":"%3Cinit%3E(long,int,org.apache.pulsar.common.policies.data.BacklogQuota.RetentionPolicy)"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"BacklogQuotaImpl.BacklogQuotaImplBuilder","l":"BacklogQuotaImplBuilder()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data","c":"SchemaAutoUpdateCompatibilityStrategy","l":"Backward"},{"p":"org.apache.pulsar.common.policies.data","c":"SchemaCompatibilityStrategy","l":"BACKWARD"},{"p":"org.apache.pulsar.common.policies.data","c":"SchemaCompatibilityStrategy","l":"BACKWARD_TRANSITIVE"},{"p":"org.apache.pulsar.common.policies.data","c":"SchemaAutoUpdateCompatibilityStrategy","l":"BackwardTransitive"},{"p":"org.apache.pulsar.common.io","c":"BatchSourceConfig","l":"BATCHSOURCE_CLASSNAME_KEY"},{"p":"org.apache.pulsar.common.io","c":"BatchSourceConfig","l":"BATCHSOURCE_CONFIG_KEY"},{"p":"org.apache.pulsar.common.io","c":"BatchSourceConfig","l":"BatchSourceConfig()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"BookieAffinityGroupDataImpl","l":"BookieAffinityGroupDataImpl()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"BookieAffinityGroupDataImpl.BookieAffinityGroupDataImplBuilder","l":"BookieAffinityGroupDataImplBuilder()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"BookieInfoImpl","l":"BookieInfoImpl()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"BookieInfoImpl.BookieInfoImplBuilder","l":"BookieInfoImplBuilder()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdmin","l":"bookies()"},{"p":"org.apache.pulsar.common.policies.data","c":"BookiesClusterInfo.Builder","l":"bookies(List)","u":"bookies(java.util.List)"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"BookiesClusterInfoImpl.BookiesClusterInfoImplBuilder","l":"bookies(List)","u":"bookies(java.util.List)"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"BookiesClusterInfoImpl","l":"BookiesClusterInfoImpl()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"BookiesClusterInfoImpl.BookiesClusterInfoImplBuilder","l":"BookiesClusterInfoImplBuilder()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data","c":"BookiesRackConfiguration","l":"BookiesRackConfiguration()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data","c":"OffloadedReadPriority","l":"BOOKKEEPER_FIRST"},{"p":"org.apache.pulsar.common.policies.data","c":"BookieAffinityGroupData.Builder","l":"bookkeeperAffinityGroupPrimary(String)","u":"bookkeeperAffinityGroupPrimary(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"BookieAffinityGroupDataImpl.BookieAffinityGroupDataImplBuilder","l":"bookkeeperAffinityGroupPrimary(String)","u":"bookkeeperAffinityGroupPrimary(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"BookieAffinityGroupData.Builder","l":"bookkeeperAffinityGroupSecondary(String)","u":"bookkeeperAffinityGroupSecondary(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"BookieAffinityGroupDataImpl.BookieAffinityGroupDataImplBuilder","l":"bookkeeperAffinityGroupSecondary(String)","u":"bookkeeperAffinityGroupSecondary(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"BundlesData.Builder","l":"boundaries(List)","u":"boundaries(java.util.List)"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"BundlesDataImpl.BundlesDataImplBuilder","l":"boundaries(List)","u":"boundaries(java.util.List)"},{"p":"org.apache.pulsar.common.policies.data","c":"NamespaceOwnershipStatus","l":"broker_assignment"},{"p":"org.apache.pulsar.common.policies.data","c":"BrokerStatus.Builder","l":"brokerAddress(String)","u":"brokerAddress(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"BrokerStatusImpl.BrokerStatusImplBuilder","l":"brokerAddress(String)","u":"brokerAddress(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"ClusterData.Builder","l":"brokerClientCertificateFilePath(String)","u":"brokerClientCertificateFilePath(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"ClusterData.Builder","l":"brokerClientKeyFilePath(String)","u":"brokerClientKeyFilePath(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"ClusterData.Builder","l":"brokerClientSslFactoryPlugin(String)","u":"brokerClientSslFactoryPlugin(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"ClusterData.Builder","l":"brokerClientSslFactoryPluginParams(String)","u":"brokerClientSslFactoryPluginParams(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"ClusterData.Builder","l":"brokerClientTlsEnabled(boolean)"},{"p":"org.apache.pulsar.common.policies.data","c":"ClusterData.Builder","l":"brokerClientTlsEnabledWithKeyStore(boolean)"},{"p":"org.apache.pulsar.common.policies.data","c":"ClusterData.Builder","l":"brokerClientTlsKeyStore(String)","u":"brokerClientTlsKeyStore(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"ClusterData.Builder","l":"brokerClientTlsKeyStorePassword(String)","u":"brokerClientTlsKeyStorePassword(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"ClusterData.Builder","l":"brokerClientTlsKeyStoreType(String)","u":"brokerClientTlsKeyStoreType(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"ClusterData.Builder","l":"brokerClientTlsTrustStore(String)","u":"brokerClientTlsTrustStore(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"ClusterData.Builder","l":"brokerClientTlsTrustStorePassword(String)","u":"brokerClientTlsTrustStorePassword(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"ClusterData.Builder","l":"brokerClientTlsTrustStoreType(String)","u":"brokerClientTlsTrustStoreType(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"ClusterData.Builder","l":"brokerClientTrustCertsFilePath(String)","u":"brokerClientTrustCertsFilePath(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"BrokerInfo.Builder","l":"brokerId(String)","u":"brokerId(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"BrokerInfoImpl.BrokerInfoImplBuilder","l":"brokerId(String)","u":"brokerId(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"BrokerInfoImpl","l":"BrokerInfoImpl()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"BrokerInfoImpl.BrokerInfoImplBuilder","l":"BrokerInfoImplBuilder()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data","c":"BrokerNamespaceIsolationData.Builder","l":"brokerName(String)","u":"brokerName(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdmin","l":"brokers()"},{"p":"org.apache.pulsar.common.policies.data","c":"FailureDomain.Builder","l":"brokers(Set)","u":"brokers(java.util.Set)"},{"p":"org.apache.pulsar.common.policies.data","c":"ClusterData.Builder","l":"brokerServiceUrl(String)","u":"brokerServiceUrl(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"ClusterData.Builder","l":"brokerServiceUrlTls(String)","u":"brokerServiceUrlTls(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdmin","l":"brokerStats()"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"BrokerStatusImpl","l":"BrokerStatusImpl()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"BrokerStatusImpl.BrokerStatusImplBuilder","l":"BrokerStatusImplBuilder()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdminBuilder","l":"build()"},{"p":"org.apache.pulsar.common.policies.data","c":"AuthPolicies.Builder","l":"build()"},{"p":"org.apache.pulsar.common.policies.data","c":"AutoFailoverPolicyData.Builder","l":"build()"},{"p":"org.apache.pulsar.common.policies.data","c":"AutoSubscriptionCreationOverride.Builder","l":"build()"},{"p":"org.apache.pulsar.common.policies.data","c":"AutoTopicCreationOverride.Builder","l":"build()"},{"p":"org.apache.pulsar.common.policies.data","c":"BacklogQuota.Builder","l":"build()"},{"p":"org.apache.pulsar.common.policies.data","c":"BookieAffinityGroupData.Builder","l":"build()"},{"p":"org.apache.pulsar.common.policies.data","c":"BookieInfo.Builder","l":"build()"},{"p":"org.apache.pulsar.common.policies.data","c":"BookiesClusterInfo.Builder","l":"build()"},{"p":"org.apache.pulsar.common.policies.data","c":"BrokerInfo.Builder","l":"build()"},{"p":"org.apache.pulsar.common.policies.data","c":"BrokerNamespaceIsolationData.Builder","l":"build()"},{"p":"org.apache.pulsar.common.policies.data","c":"BrokerStatus.Builder","l":"build()"},{"p":"org.apache.pulsar.common.policies.data","c":"BundlesData.Builder","l":"build()"},{"p":"org.apache.pulsar.common.policies.data","c":"ClusterData.Builder","l":"build()"},{"p":"org.apache.pulsar.common.policies.data","c":"ClusterPolicies.Builder","l":"build()"},{"p":"org.apache.pulsar.common.policies.data","c":"DelayedDeliveryPolicies.Builder","l":"build()"},{"p":"org.apache.pulsar.common.policies.data","c":"DispatchRate.Builder","l":"build()"},{"p":"org.apache.pulsar.common.policies.data","c":"FailureDomain.Builder","l":"build()"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"AutoSubscriptionCreationOverrideImpl.AutoSubscriptionCreationOverrideImplBuilder","l":"build()"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"AutoTopicCreationOverrideImpl.AutoTopicCreationOverrideImplBuilder","l":"build()"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"BacklogQuotaImpl.BacklogQuotaImplBuilder","l":"build()"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"BookieAffinityGroupDataImpl.BookieAffinityGroupDataImplBuilder","l":"build()"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"BookieInfoImpl.BookieInfoImplBuilder","l":"build()"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"BookiesClusterInfoImpl.BookiesClusterInfoImplBuilder","l":"build()"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"BrokerInfoImpl.BrokerInfoImplBuilder","l":"build()"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"BrokerStatusImpl.BrokerStatusImplBuilder","l":"build()"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"BundlesDataImpl.BundlesDataImplBuilder","l":"build()"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"DelayedDeliveryPoliciesImpl.DelayedDeliveryPoliciesImplBuilder","l":"build()"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"DispatchRateImpl.DispatchRateImplBuilder","l":"build()"},{"p":"org.apache.pulsar.common.policies.data","c":"NamespaceIsolationData.Builder","l":"build()"},{"p":"org.apache.pulsar.common.policies.data","c":"OffloadPolicies.Builder","l":"build()"},{"p":"org.apache.pulsar.common.policies.data","c":"TenantInfo.Builder","l":"build()"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdmin","l":"builder()"},{"p":"org.apache.pulsar.common.policies.data","c":"AuthPolicies","l":"builder()"},{"p":"org.apache.pulsar.common.policies.data","c":"AutoFailoverPolicyData","l":"builder()"},{"p":"org.apache.pulsar.common.policies.data","c":"AutoSubscriptionCreationOverride","l":"builder()"},{"p":"org.apache.pulsar.common.policies.data","c":"AutoTopicCreationOverride","l":"builder()"},{"p":"org.apache.pulsar.common.policies.data","c":"BacklogQuota","l":"builder()"},{"p":"org.apache.pulsar.common.policies.data","c":"BookieAffinityGroupData","l":"builder()"},{"p":"org.apache.pulsar.common.policies.data","c":"BookieInfo","l":"builder()"},{"p":"org.apache.pulsar.common.policies.data","c":"BookiesClusterInfo","l":"builder()"},{"p":"org.apache.pulsar.common.policies.data","c":"BrokerInfo","l":"builder()"},{"p":"org.apache.pulsar.common.policies.data","c":"BrokerNamespaceIsolationData","l":"builder()"},{"p":"org.apache.pulsar.common.policies.data","c":"BrokerStatus","l":"builder()"},{"p":"org.apache.pulsar.common.policies.data","c":"BundlesData","l":"builder()"},{"p":"org.apache.pulsar.common.policies.data","c":"ClusterData","l":"builder()"},{"p":"org.apache.pulsar.common.policies.data","c":"ClusterPolicies","l":"builder()"},{"p":"org.apache.pulsar.common.policies.data","c":"DelayedDeliveryPolicies","l":"builder()"},{"p":"org.apache.pulsar.common.policies.data","c":"DispatchRate","l":"builder()"},{"p":"org.apache.pulsar.common.policies.data","c":"FailureDomain","l":"builder()"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"AutoSubscriptionCreationOverrideImpl","l":"builder()"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"AutoTopicCreationOverrideImpl","l":"builder()"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"BacklogQuotaImpl","l":"builder()"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"BookieAffinityGroupDataImpl","l":"builder()"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"BookieInfoImpl","l":"builder()"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"BookiesClusterInfoImpl","l":"builder()"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"BrokerInfoImpl","l":"builder()"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"BrokerStatusImpl","l":"builder()"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"BundlesDataImpl","l":"builder()"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"DelayedDeliveryPoliciesImpl","l":"builder()"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"DispatchRateImpl","l":"builder()"},{"p":"org.apache.pulsar.common.policies.data","c":"NamespaceIsolationData","l":"builder()"},{"p":"org.apache.pulsar.common.policies.data","c":"OffloadPolicies","l":"builder()"},{"p":"org.apache.pulsar.common.policies.data","c":"TenantInfo","l":"builder()"},{"p":"org.apache.pulsar.client.admin","c":"Topics.QueryParam","l":"Bundle"},{"p":"org.apache.pulsar.common.policies.data","c":"Policies","l":"bundles"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"BundlesDataImpl","l":"BundlesDataImpl()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"BundlesDataImpl.BundlesDataImplBuilder","l":"BundlesDataImplBuilder()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"BacklogQuotaImpl","l":"BYTES_IN_GIGABYTE"},{"p":"org.apache.pulsar.policies.data.loadbalancer","c":"NamespaceBundleStats","l":"cacheSize"},{"p":"org.apache.pulsar.common.policies.data","c":"FunctionStats","l":"calculateOverall()"},{"p":"org.apache.pulsar.common.policies.data","c":"NamespaceIsolationPolicyUnloadScope","l":"changed"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"BookieInfoImpl.BookieInfoImplBuilder","l":"checkArgument(boolean, Object)","u":"checkArgument(boolean,java.lang.Object)"},{"p":"org.apache.pulsar.common.stats","c":"AllocatorStats.PoolArenaStats","l":"chunkLists"},{"p":"org.apache.pulsar.common.stats","c":"AllocatorStats.PoolChunkListStats","l":"chunks"},{"p":"org.apache.pulsar.common.stats","c":"AllocatorStats.PoolChunkStats","l":"chunkSize"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"clearNamespaceBacklog(String)","u":"clearNamespaceBacklog(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"clearNamespaceBacklogAsync(String)","u":"clearNamespaceBacklogAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"clearNamespaceBacklogForSubscription(String, String)","u":"clearNamespaceBacklogForSubscription(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"clearNamespaceBacklogForSubscriptionAsync(String, String)","u":"clearNamespaceBacklogForSubscriptionAsync(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"clearNamespaceBundleBacklog(String, String)","u":"clearNamespaceBundleBacklog(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"clearNamespaceBundleBacklogAsync(String, String)","u":"clearNamespaceBundleBacklogAsync(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"clearNamespaceBundleBacklogForSubscription(String, String, String)","u":"clearNamespaceBundleBacklogForSubscription(java.lang.String,java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"clearNamespaceBundleBacklogForSubscriptionAsync(String, String, String)","u":"clearNamespaceBundleBacklogForSubscriptionAsync(java.lang.String,java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"clearOffloadDeleteLag(String)","u":"clearOffloadDeleteLag(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"clearOffloadDeleteLagAsync(String)","u":"clearOffloadDeleteLagAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"clearProperties(String)","u":"clearProperties(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"clearPropertiesAsync(String)","u":"clearPropertiesAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdminBuilder","l":"clone()"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdminException","l":"clone()"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdminException.ConflictException","l":"clone()"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdminException.ConnectException","l":"clone()"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdminException.GettingAuthenticationDataException","l":"clone()"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdminException.HttpErrorException","l":"clone()"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdminException.NotAllowedException","l":"clone()"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdminException.NotAuthorizedException","l":"clone()"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdminException.NotFoundException","l":"clone()"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdminException.PreconditionFailedException","l":"clone()"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdminException.ServerSideErrorException","l":"clone()"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdminException.TimeoutException","l":"clone()"},{"p":"org.apache.pulsar.common.policies.data","c":"ClusterData","l":"clone()"},{"p":"org.apache.pulsar.common.policies.data","c":"ClusterPolicies","l":"clone()"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdmin","l":"close()"},{"p":"org.apache.pulsar.common.policies.data","c":"Policies","l":"clusterDispatchRate"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdmin","l":"clusters()"},{"p":"org.apache.pulsar.common.policies.data","c":"Policies","l":"clusterSubscribeRate"},{"p":"org.apache.pulsar.common.policies.data","c":"ClusterPolicies.ClusterUrl","l":"ClusterUrl()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data","c":"PersistentTopicInternalStats","l":"compactedLedger"},{"p":"org.apache.pulsar.common.policies.data","c":"Policies","l":"compaction_threshold"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"compactionStatus(String)","u":"compactionStatus(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"compactionStatusAsync(String)","u":"compactionStatusAsync(java.lang.String)"},{"p":"org.apache.pulsar.policies.data.loadbalancer","c":"NamespaceBundleStats","l":"compareByBandwidthIn(NamespaceBundleStats)","u":"compareByBandwidthIn(org.apache.pulsar.policies.data.loadbalancer.NamespaceBundleStats)"},{"p":"org.apache.pulsar.policies.data.loadbalancer","c":"NamespaceBundleStats","l":"compareByBandwidthOut(NamespaceBundleStats)","u":"compareByBandwidthOut(org.apache.pulsar.policies.data.loadbalancer.NamespaceBundleStats)"},{"p":"org.apache.pulsar.policies.data.loadbalancer","c":"NamespaceBundleStats","l":"compareByCacheSize(NamespaceBundleStats)","u":"compareByCacheSize(org.apache.pulsar.policies.data.loadbalancer.NamespaceBundleStats)"},{"p":"org.apache.pulsar.policies.data.loadbalancer","c":"NamespaceBundleStats","l":"compareByMsgRate(NamespaceBundleStats)","u":"compareByMsgRate(org.apache.pulsar.policies.data.loadbalancer.NamespaceBundleStats)"},{"p":"org.apache.pulsar.policies.data.loadbalancer","c":"NamespaceBundleStats","l":"compareByTopicConnections(NamespaceBundleStats)","u":"compareByTopicConnections(org.apache.pulsar.policies.data.loadbalancer.NamespaceBundleStats)"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"BrokerStatusImpl","l":"compareTo(BrokerStatus)","u":"compareTo(org.apache.pulsar.common.policies.data.BrokerStatus)"},{"p":"org.apache.pulsar.policies.data.loadbalancer","c":"NamespaceBundleStats","l":"compareTo(NamespaceBundleStats)","u":"compareTo(org.apache.pulsar.policies.data.loadbalancer.NamespaceBundleStats)"},{"p":"org.apache.pulsar.policies.data.loadbalancer","c":"ResourceUsage","l":"compareTo(ResourceUsage)","u":"compareTo(org.apache.pulsar.policies.data.loadbalancer.ResourceUsage)"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdminException.ConflictException","l":"ConflictException(Throwable, String, int)","u":"%3Cinit%3E(java.lang.Throwable,java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdminException.ConnectException","l":"ConnectException(String, Throwable)","u":"%3Cinit%3E(java.lang.String,java.lang.Throwable)"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdminException.ConnectException","l":"ConnectException(Throwable)","u":"%3Cinit%3E(java.lang.Throwable)"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdminBuilder","l":"connectionMaxIdleSeconds(int)"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdminBuilder","l":"connectionTimeout(int, TimeUnit)","u":"connectionTimeout(int,java.util.concurrent.TimeUnit)"},{"p":"org.apache.pulsar.common.io","c":"ConnectorDefinition","l":"ConnectorDefinition()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data","c":"AuthAction","l":"consume"},{"p":"org.apache.pulsar.common.policies.data","c":"BacklogQuota.RetentionPolicy","l":"consumer_backlog_eviction"},{"p":"org.apache.pulsar.common.functions","c":"ConsumerConfig","l":"ConsumerConfig(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"org.apache.pulsar.policies.data.loadbalancer","c":"NamespaceBundleStats","l":"consumerCount"},{"p":"org.apache.pulsar.common.policies.impl","c":"AutoFailoverPolicyFactory","l":"create(AutoFailoverPolicyData)","u":"create(org.apache.pulsar.common.policies.data.AutoFailoverPolicyData)"},{"p":"org.apache.pulsar.common.stats","c":"Metrics","l":"create(Map)","u":"create(java.util.Map)"},{"p":"org.apache.pulsar.client.admin","c":"Clusters","l":"createCluster(String, ClusterData)","u":"createCluster(java.lang.String,org.apache.pulsar.common.policies.data.ClusterData)"},{"p":"org.apache.pulsar.client.admin","c":"Clusters","l":"createClusterAsync(String, ClusterData)","u":"createClusterAsync(java.lang.String,org.apache.pulsar.common.policies.data.ClusterData)"},{"p":"org.apache.pulsar.client.admin","c":"Clusters","l":"createFailureDomain(String, String, FailureDomain)","u":"createFailureDomain(java.lang.String,java.lang.String,org.apache.pulsar.common.policies.data.FailureDomain)"},{"p":"org.apache.pulsar.client.admin","c":"Clusters","l":"createFailureDomainAsync(String, String, FailureDomain)","u":"createFailureDomainAsync(java.lang.String,java.lang.String,org.apache.pulsar.common.policies.data.FailureDomain)"},{"p":"org.apache.pulsar.client.admin","c":"Functions","l":"createFunction(FunctionConfig, String)","u":"createFunction(org.apache.pulsar.common.functions.FunctionConfig,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Functions","l":"createFunctionAsync(FunctionConfig, String)","u":"createFunctionAsync(org.apache.pulsar.common.functions.FunctionConfig,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Functions","l":"createFunctionWithUrl(FunctionConfig, String)","u":"createFunctionWithUrl(org.apache.pulsar.common.functions.FunctionConfig,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Functions","l":"createFunctionWithUrlAsync(FunctionConfig, String)","u":"createFunctionWithUrlAsync(org.apache.pulsar.common.functions.FunctionConfig,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"createMissedPartitions(String)","u":"createMissedPartitions(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"createMissedPartitionsAsync(String)","u":"createMissedPartitionsAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"createNamespace(String)","u":"createNamespace(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"createNamespace(String, BundlesData)","u":"createNamespace(java.lang.String,org.apache.pulsar.common.policies.data.BundlesData)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"createNamespace(String, int)","u":"createNamespace(java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"createNamespace(String, Policies)","u":"createNamespace(java.lang.String,org.apache.pulsar.common.policies.data.Policies)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"createNamespace(String, Set)","u":"createNamespace(java.lang.String,java.util.Set)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"createNamespaceAsync(String)","u":"createNamespaceAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"createNamespaceAsync(String, BundlesData)","u":"createNamespaceAsync(java.lang.String,org.apache.pulsar.common.policies.data.BundlesData)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"createNamespaceAsync(String, int)","u":"createNamespaceAsync(java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"createNamespaceAsync(String, Policies)","u":"createNamespaceAsync(java.lang.String,org.apache.pulsar.common.policies.data.Policies)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"createNamespaceAsync(String, Set)","u":"createNamespaceAsync(java.lang.String,java.util.Set)"},{"p":"org.apache.pulsar.client.admin","c":"Clusters","l":"createNamespaceIsolationPolicy(String, String, NamespaceIsolationData)","u":"createNamespaceIsolationPolicy(java.lang.String,java.lang.String,org.apache.pulsar.common.policies.data.NamespaceIsolationData)"},{"p":"org.apache.pulsar.client.admin","c":"Clusters","l":"createNamespaceIsolationPolicyAsync(String, String, NamespaceIsolationData)","u":"createNamespaceIsolationPolicyAsync(java.lang.String,java.lang.String,org.apache.pulsar.common.policies.data.NamespaceIsolationData)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"createNonPartitionedTopic(String)","u":"createNonPartitionedTopic(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"createNonPartitionedTopic(String, Map)","u":"createNonPartitionedTopic(java.lang.String,java.util.Map)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"createNonPartitionedTopicAsync(String)","u":"createNonPartitionedTopicAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"createNonPartitionedTopicAsync(String, Map)","u":"createNonPartitionedTopicAsync(java.lang.String,java.util.Map)"},{"p":"org.apache.pulsar.client.admin","c":"NonPersistentTopics","l":"createPartitionedTopic(String, int)","u":"createPartitionedTopic(java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"createPartitionedTopic(String, int)","u":"createPartitionedTopic(java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"createPartitionedTopic(String, int, Map)","u":"createPartitionedTopic(java.lang.String,int,java.util.Map)"},{"p":"org.apache.pulsar.client.admin","c":"NonPersistentTopics","l":"createPartitionedTopicAsync(String, int)","u":"createPartitionedTopicAsync(java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"createPartitionedTopicAsync(String, int)","u":"createPartitionedTopicAsync(java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"createPartitionedTopicAsync(String, int, Map)","u":"createPartitionedTopicAsync(java.lang.String,int,java.util.Map)"},{"p":"org.apache.pulsar.client.admin","c":"Properties","l":"createProperty(String, TenantInfo)","u":"createProperty(java.lang.String,org.apache.pulsar.common.policies.data.TenantInfo)"},{"p":"org.apache.pulsar.client.admin","c":"ResourceGroups","l":"createResourceGroup(String, ResourceGroup)","u":"createResourceGroup(java.lang.String,org.apache.pulsar.common.policies.data.ResourceGroup)"},{"p":"org.apache.pulsar.client.admin","c":"ResourceGroups","l":"createResourceGroupAsync(String, ResourceGroup)","u":"createResourceGroupAsync(java.lang.String,org.apache.pulsar.common.policies.data.ResourceGroup)"},{"p":"org.apache.pulsar.client.admin","c":"Schemas","l":"createSchema(String, PostSchemaPayload)","u":"createSchema(java.lang.String,org.apache.pulsar.common.protocol.schema.PostSchemaPayload)"},{"p":"org.apache.pulsar.client.admin","c":"Schemas","l":"createSchema(String, SchemaInfo)","u":"createSchema(java.lang.String,org.apache.pulsar.common.schema.SchemaInfo)"},{"p":"org.apache.pulsar.client.admin","c":"Schemas","l":"createSchemaAsync(String, PostSchemaPayload)","u":"createSchemaAsync(java.lang.String,org.apache.pulsar.common.protocol.schema.PostSchemaPayload)"},{"p":"org.apache.pulsar.client.admin","c":"Schemas","l":"createSchemaAsync(String, SchemaInfo)","u":"createSchemaAsync(java.lang.String,org.apache.pulsar.common.schema.SchemaInfo)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"createShadowTopic(String, String)","u":"createShadowTopic(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"createShadowTopic(String, String, Map)","u":"createShadowTopic(java.lang.String,java.lang.String,java.util.Map)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"createShadowTopicAsync(String, String)","u":"createShadowTopicAsync(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"createShadowTopicAsync(String, String, Map)","u":"createShadowTopicAsync(java.lang.String,java.lang.String,java.util.Map)"},{"p":"org.apache.pulsar.client.admin","c":"Sinks","l":"createSink(SinkConfig, String)","u":"createSink(org.apache.pulsar.common.io.SinkConfig,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Sinks","l":"createSinkAsync(SinkConfig, String)","u":"createSinkAsync(org.apache.pulsar.common.io.SinkConfig,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Sinks","l":"createSinkWithUrl(SinkConfig, String)","u":"createSinkWithUrl(org.apache.pulsar.common.io.SinkConfig,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Sinks","l":"createSinkWithUrlAsync(SinkConfig, String)","u":"createSinkWithUrlAsync(org.apache.pulsar.common.io.SinkConfig,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Sources","l":"createSource(SourceConfig, String)","u":"createSource(org.apache.pulsar.common.io.SourceConfig,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Sources","l":"createSourceAsync(SourceConfig, String)","u":"createSourceAsync(org.apache.pulsar.common.io.SourceConfig,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Sources","l":"createSourceWithUrl(SourceConfig, String)","u":"createSourceWithUrl(org.apache.pulsar.common.io.SourceConfig,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Sources","l":"createSourceWithUrlAsync(SourceConfig, String)","u":"createSourceWithUrlAsync(org.apache.pulsar.common.io.SourceConfig,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"createSubscription(String, String, MessageId)","u":"createSubscription(java.lang.String,java.lang.String,org.apache.pulsar.client.api.MessageId)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"createSubscription(String, String, MessageId, boolean)","u":"createSubscription(java.lang.String,java.lang.String,org.apache.pulsar.client.api.MessageId,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"createSubscription(String, String, MessageId, boolean, Map)","u":"createSubscription(java.lang.String,java.lang.String,org.apache.pulsar.client.api.MessageId,boolean,java.util.Map)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"createSubscriptionAsync(String, String, MessageId)","u":"createSubscriptionAsync(java.lang.String,java.lang.String,org.apache.pulsar.client.api.MessageId)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"createSubscriptionAsync(String, String, MessageId, boolean)","u":"createSubscriptionAsync(java.lang.String,java.lang.String,org.apache.pulsar.client.api.MessageId,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"createSubscriptionAsync(String, String, MessageId, boolean, Map)","u":"createSubscriptionAsync(java.lang.String,java.lang.String,org.apache.pulsar.client.api.MessageId,boolean,java.util.Map)"},{"p":"org.apache.pulsar.client.admin","c":"Tenants","l":"createTenant(String, TenantInfo)","u":"createTenant(java.lang.String,org.apache.pulsar.common.policies.data.TenantInfo)"},{"p":"org.apache.pulsar.client.admin","c":"Tenants","l":"createTenantAsync(String, TenantInfo)","u":"createTenantAsync(java.lang.String,org.apache.pulsar.common.policies.data.TenantInfo)"},{"p":"org.apache.pulsar.common.functions","c":"CryptoConfig","l":"CryptoConfig()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data","c":"TransactionInPendingAckStats","l":"cumulativeAckPosition"},{"p":"org.apache.pulsar.common.policies.data","c":"ManagedLedgerInternalStats","l":"currentLedgerEntries"},{"p":"org.apache.pulsar.common.policies.data","c":"ManagedLedgerInternalStats","l":"currentLedgerSize"},{"p":"org.apache.pulsar.common.policies.data","c":"SegmentsStats","l":"currentSegmentCapacity"},{"p":"org.apache.pulsar.common.policies.data","c":"ManagedLedgerInternalStats.CursorStats","l":"cursorLedger"},{"p":"org.apache.pulsar.common.policies.data","c":"ManagedLedgerInternalStats.CursorStats","l":"cursorLedgerLastEntry"},{"p":"org.apache.pulsar.common.policies.data","c":"ManagedLedgerInternalStats","l":"cursors"},{"p":"org.apache.pulsar.common.policies.data","c":"ManagedLedgerInternalStats.CursorStats","l":"CursorStats()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data","c":"Policies","l":"deduplicationEnabled"},{"p":"org.apache.pulsar.common.policies.data","c":"Policies","l":"deduplicationSnapshotIntervalSeconds"},{"p":"org.apache.pulsar.client.admin.utils","c":"DefaultImplementation","l":"DefaultImplementation()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data","c":"AutoTopicCreationOverride.Builder","l":"defaultNumPartitions(Integer)","u":"defaultNumPartitions(java.lang.Integer)"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"AutoTopicCreationOverrideImpl.AutoTopicCreationOverrideImplBuilder","l":"defaultNumPartitions(Integer)","u":"defaultNumPartitions(java.lang.Integer)"},{"p":"org.apache.pulsar.common.policies.data","c":"Policies","l":"delayed_delivery_policies"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"DelayedDeliveryPoliciesImpl","l":"DelayedDeliveryPoliciesImpl()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"DelayedDeliveryPoliciesImpl.DelayedDeliveryPoliciesImplBuilder","l":"DelayedDeliveryPoliciesImplBuilder()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data","c":"InactiveTopicDeleteMode","l":"delete_when_no_subscriptions"},{"p":"org.apache.pulsar.common.policies.data","c":"InactiveTopicDeleteMode","l":"delete_when_subscriptions_caught_up"},{"p":"org.apache.pulsar.client.admin","c":"Packages","l":"delete(String)","u":"delete(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"delete(String)","u":"delete(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"delete(String, boolean)","u":"delete(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"delete(String, boolean, boolean)","u":"delete(java.lang.String,boolean,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Packages","l":"deleteAsync(String)","u":"deleteAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"deleteAsync(String)","u":"deleteAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"deleteAsync(String, boolean)","u":"deleteAsync(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"deleteAsync(String, boolean, boolean)","u":"deleteAsync(java.lang.String,boolean,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"deleteBookieAffinityGroup(String)","u":"deleteBookieAffinityGroup(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"deleteBookieAffinityGroupAsync(String)","u":"deleteBookieAffinityGroupAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Bookies","l":"deleteBookieRackInfo(String)","u":"deleteBookieRackInfo(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Bookies","l":"deleteBookieRackInfoAsync(String)","u":"deleteBookieRackInfoAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Clusters","l":"deleteCluster(String)","u":"deleteCluster(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Clusters","l":"deleteClusterAsync(String)","u":"deleteClusterAsync(java.lang.String)"},{"p":"org.apache.pulsar.common.partition","c":"PartitionedTopicMetadata","l":"deleted"},{"p":"org.apache.pulsar.common.policies.data","c":"Policies","l":"deleted"},{"p":"org.apache.pulsar.client.admin","c":"Brokers","l":"deleteDynamicConfiguration(String)","u":"deleteDynamicConfiguration(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Brokers","l":"deleteDynamicConfigurationAsync(String)","u":"deleteDynamicConfigurationAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Clusters","l":"deleteFailureDomain(String, String)","u":"deleteFailureDomain(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Clusters","l":"deleteFailureDomainAsync(String, String)","u":"deleteFailureDomainAsync(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Functions","l":"deleteFunction(String, String, String)","u":"deleteFunction(java.lang.String,java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Functions","l":"deleteFunctionAsync(String, String, String)","u":"deleteFunctionAsync(java.lang.String,java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"deleteNamespace(String)","u":"deleteNamespace(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"deleteNamespace(String, boolean)","u":"deleteNamespace(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"deleteNamespaceAntiAffinityGroup(String)","u":"deleteNamespaceAntiAffinityGroup(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"deleteNamespaceAntiAffinityGroupAsync(String)","u":"deleteNamespaceAntiAffinityGroupAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"deleteNamespaceAsync(String)","u":"deleteNamespaceAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"deleteNamespaceAsync(String, boolean)","u":"deleteNamespaceAsync(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"deleteNamespaceBundle(String, String)","u":"deleteNamespaceBundle(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"deleteNamespaceBundle(String, String, boolean)","u":"deleteNamespaceBundle(java.lang.String,java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"deleteNamespaceBundleAsync(String, String)","u":"deleteNamespaceBundleAsync(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"deleteNamespaceBundleAsync(String, String, boolean)","u":"deleteNamespaceBundleAsync(java.lang.String,java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Clusters","l":"deleteNamespaceIsolationPolicy(String, String)","u":"deleteNamespaceIsolationPolicy(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Clusters","l":"deleteNamespaceIsolationPolicyAsync(String, String)","u":"deleteNamespaceIsolationPolicyAsync(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"deletePartitionedTopic(String)","u":"deletePartitionedTopic(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"deletePartitionedTopic(String, boolean)","u":"deletePartitionedTopic(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"deletePartitionedTopic(String, boolean, boolean)","u":"deletePartitionedTopic(java.lang.String,boolean,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"deletePartitionedTopicAsync(String)","u":"deletePartitionedTopicAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"deletePartitionedTopicAsync(String, boolean)","u":"deletePartitionedTopicAsync(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"deletePartitionedTopicAsync(String, boolean, boolean)","u":"deletePartitionedTopicAsync(java.lang.String,boolean,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Properties","l":"deleteProperty(String)","u":"deleteProperty(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"ResourceGroups","l":"deleteResourceGroup(String)","u":"deleteResourceGroup(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"ResourceGroups","l":"deleteResourceGroupAsync(String)","u":"deleteResourceGroupAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Schemas","l":"deleteSchema(String)","u":"deleteSchema(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Schemas","l":"deleteSchema(String, boolean)","u":"deleteSchema(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Schemas","l":"deleteSchemaAsync(String)","u":"deleteSchemaAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Schemas","l":"deleteSchemaAsync(String, boolean)","u":"deleteSchemaAsync(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Sinks","l":"deleteSink(String, String, String)","u":"deleteSink(java.lang.String,java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Sinks","l":"deleteSinkAsync(String, String, String)","u":"deleteSinkAsync(java.lang.String,java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Sources","l":"deleteSource(String, String, String)","u":"deleteSource(java.lang.String,java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Sources","l":"deleteSourceAsync(String, String, String)","u":"deleteSourceAsync(java.lang.String,java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"deleteSubscription(String, String)","u":"deleteSubscription(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"deleteSubscription(String, String, boolean)","u":"deleteSubscription(java.lang.String,java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"deleteSubscriptionAsync(String, String)","u":"deleteSubscriptionAsync(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"deleteSubscriptionAsync(String, String, boolean)","u":"deleteSubscriptionAsync(java.lang.String,java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Tenants","l":"deleteTenant(String)","u":"deleteTenant(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Tenants","l":"deleteTenant(String, boolean)","u":"deleteTenant(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Tenants","l":"deleteTenantAsync(String)","u":"deleteTenantAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Tenants","l":"deleteTenantAsync(String, boolean)","u":"deleteTenantAsync(java.lang.String,boolean)"},{"p":"org.apache.pulsar.common.policies.data","c":"BacklogQuota.BacklogQuotaType","l":"destination_storage"},{"p":"org.apache.pulsar.common.stats","c":"AllocatorStats","l":"directArenas"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"disableDeduplication(String)","u":"disableDeduplication(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"disableDeduplicationAsync(String)","u":"disableDeduplicationAsync(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"Policies","l":"dispatcherPauseOnAckStatePersistentEnabled"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"DispatchRateImpl","l":"DispatchRateImpl()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"DispatchRateImpl.DispatchRateImplBuilder","l":"DispatchRateImplBuilder()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data","c":"DispatchRate.Builder","l":"dispatchThrottlingRateInByte(long)"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"DispatchRateImpl.DispatchRateImplBuilder","l":"dispatchThrottlingRateInByte(long)"},{"p":"org.apache.pulsar.common.policies.data","c":"DispatchRate.Builder","l":"dispatchThrottlingRateInMsg(int)"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"DispatchRateImpl.DispatchRateImplBuilder","l":"dispatchThrottlingRateInMsg(int)"},{"p":"org.apache.pulsar.client.admin","c":"Packages","l":"download(String, String)","u":"download(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Packages","l":"downloadAsync(String, String)","u":"downloadAsync(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Functions","l":"downloadFunction(String, String)","u":"downloadFunction(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Functions","l":"downloadFunction(String, String, String, String)","u":"downloadFunction(java.lang.String,java.lang.String,java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Functions","l":"downloadFunction(String, String, String, String, boolean)","u":"downloadFunction(java.lang.String,java.lang.String,java.lang.String,java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Functions","l":"downloadFunctionAsync(String, String)","u":"downloadFunctionAsync(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Functions","l":"downloadFunctionAsync(String, String, String, String)","u":"downloadFunctionAsync(java.lang.String,java.lang.String,java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Functions","l":"downloadFunctionAsync(String, String, String, String, boolean)","u":"downloadFunctionAsync(java.lang.String,java.lang.String,java.lang.String,java.lang.String,boolean)"},{"p":"org.apache.pulsar.common.functions","c":"FunctionConfig.ProcessingGuarantees","l":"EFFECTIVELY_ONCE"},{"p":"org.apache.pulsar.common.stats","c":"AllocatorStats.PoolSubpageStats","l":"elementSize"},{"p":"org.apache.pulsar.client.admin","c":"ListNamespaceTopicsOptions","l":"EMPTY"},{"p":"org.apache.pulsar.client.admin","c":"ListTopicsOptions","l":"EMPTY"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"enableDeduplication(String, boolean)","u":"enableDeduplication(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"enableDeduplicationAsync(String, boolean)","u":"enableDeduplicationAsync(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdminBuilder","l":"enableTlsHostnameVerification(boolean)"},{"p":"org.apache.pulsar.common.policies.data","c":"Policies","l":"encryption_required"},{"p":"org.apache.pulsar.common.policies.data","c":"ManagedLedgerInternalStats.LedgerInfo","l":"entries"},{"p":"org.apache.pulsar.common.policies.data","c":"ManagedLedgerInternalStats","l":"entriesAddedCounter"},{"p":"org.apache.pulsar.common.policies.data","c":"SchemaMetadata.Entry","l":"Entry()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data","c":"Policies","l":"entryFilters"},{"p":"org.apache.pulsar.common.policies.data","c":"EntryFilters","l":"EntryFilters()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.conf","c":"InternalConfigurationData","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"org.apache.pulsar.common.policies.data","c":"PersistencePolicies","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"org.apache.pulsar.common.policies.data","c":"Policies","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"org.apache.pulsar.common.policies.data","c":"PublishRate","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"org.apache.pulsar.common.policies.data","c":"RetentionPolicies","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"org.apache.pulsar.common.policies.data","c":"SubscribeRate","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"org.apache.pulsar.common.stats","c":"Metrics","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"org.apache.pulsar.common.policies.data","c":"OffloadedReadPriority","l":"equalsName(String)","u":"equalsName(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"FunctionStatus.FunctionInstanceStatus.FunctionInstanceStatusData","l":"error"},{"p":"org.apache.pulsar.common.policies.data","c":"SinkStatus.SinkInstanceStatus.SinkInstanceStatusData","l":"error"},{"p":"org.apache.pulsar.common.policies.data","c":"SourceStatus.SourceInstanceStatus.SourceInstanceStatusData","l":"error"},{"p":"org.apache.pulsar.client.admin","c":"LongRunningProcessStatus.Status","l":"ERROR"},{"p":"org.apache.pulsar.common.policies.data","c":"ErrorData","l":"ErrorData()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data","c":"ErrorData","l":"ErrorData(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"examineMessage(String, String, long)","u":"examineMessage(java.lang.String,java.lang.String,long)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"examineMessageAsync(String, String, long)","u":"examineMessageAsync(java.lang.String,java.lang.String,long)"},{"p":"org.apache.pulsar.common.policies.data","c":"ExceptionInformation","l":"ExceptionInformation()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"expireMessages(String, String, long)","u":"expireMessages(java.lang.String,java.lang.String,long)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"expireMessages(String, String, MessageId, boolean)","u":"expireMessages(java.lang.String,java.lang.String,org.apache.pulsar.client.api.MessageId,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"expireMessagesAsync(String, String, long)","u":"expireMessagesAsync(java.lang.String,java.lang.String,long)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"expireMessagesAsync(String, String, MessageId, boolean)","u":"expireMessagesAsync(java.lang.String,java.lang.String,org.apache.pulsar.client.api.MessageId,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"expireMessagesForAllSubscriptions(String, long)","u":"expireMessagesForAllSubscriptions(java.lang.String,long)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"expireMessagesForAllSubscriptionsAsync(String, long)","u":"expireMessagesForAllSubscriptionsAsync(java.lang.String,long)"},{"p":"org.apache.pulsar.common.policies.data","c":"ValidateResult","l":"fail(String)","u":"fail(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"OffloadPolicies.Builder","l":"fileSystemProfilePath(String)","u":"fileSystemProfilePath(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"OffloadPolicies.Builder","l":"fileSystemURI(String)","u":"fileSystemURI(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"Policies","l":"FIRST_BOUNDARY"},{"p":"org.apache.pulsar.client.admin","c":"LongRunningProcessStatus","l":"forError(String)","u":"forError(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"OffloadProcessStatus","l":"forError(String)","u":"forError(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"LongRunningProcessStatus","l":"forStatus(LongRunningProcessStatus.Status)","u":"forStatus(org.apache.pulsar.client.admin.LongRunningProcessStatus.Status)"},{"p":"org.apache.pulsar.client.admin","c":"OffloadProcessStatus","l":"forStatus(LongRunningProcessStatus.Status)","u":"forStatus(org.apache.pulsar.client.admin.LongRunningProcessStatus.Status)"},{"p":"org.apache.pulsar.client.admin","c":"OffloadProcessStatus","l":"forSuccess(MessageId)","u":"forSuccess(org.apache.pulsar.client.api.MessageId)"},{"p":"org.apache.pulsar.common.policies.data","c":"SchemaAutoUpdateCompatibilityStrategy","l":"Forward"},{"p":"org.apache.pulsar.common.policies.data","c":"SchemaCompatibilityStrategy","l":"FORWARD"},{"p":"org.apache.pulsar.common.policies.data","c":"SchemaCompatibilityStrategy","l":"FORWARD_TRANSITIVE"},{"p":"org.apache.pulsar.common.policies.data","c":"SchemaAutoUpdateCompatibilityStrategy","l":"ForwardTransitive"},{"p":"org.apache.pulsar.common.stats","c":"AllocatorStats.PoolChunkStats","l":"freeBytes"},{"p":"org.apache.pulsar.common.policies.data","c":"SchemaCompatibilityStrategy","l":"fromAutoUpdatePolicy(SchemaAutoUpdateCompatibilityStrategy)","u":"fromAutoUpdatePolicy(org.apache.pulsar.common.policies.data.SchemaAutoUpdateCompatibilityStrategy)"},{"p":"org.apache.pulsar.common.policies.data","c":"AutoFailoverPolicyType","l":"fromString(String)","u":"fromString(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"NamespaceIsolationPolicyUnloadScope","l":"fromString(String)","u":"fromString(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"OffloadedReadPriority","l":"fromString(String)","u":"fromString(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"SchemaAutoUpdateCompatibilityStrategy","l":"Full"},{"p":"org.apache.pulsar.common.policies.data","c":"SchemaCompatibilityStrategy","l":"FULL"},{"p":"org.apache.pulsar.common.policies.data","c":"SchemaCompatibilityStrategy","l":"FULL_TRANSITIVE"},{"p":"org.apache.pulsar.common.policies.data","c":"SchemaAutoUpdateCompatibilityStrategy","l":"FullTransitive"},{"p":"org.apache.pulsar.packages.management.core.common","c":"PackageType","l":"FUNCTION"},{"p":"org.apache.pulsar.common.functions","c":"FunctionConfig","l":"FunctionConfig()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.functions","c":"FunctionDefinition","l":"FunctionDefinition()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data","c":"FunctionStatus.FunctionInstanceStatus","l":"FunctionInstanceStatus()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data","c":"FunctionStatus.FunctionInstanceStatus.FunctionInstanceStatusData","l":"FunctionInstanceStatusData()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data","c":"AuthAction","l":"functions"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdmin","l":"functions()"},{"p":"org.apache.pulsar.common.functions","c":"FunctionState","l":"FunctionState()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data","c":"FunctionStatus","l":"FunctionStatus()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data","c":"OffloadPolicies.Builder","l":"gcsManagedLedgerOffloadBucket(String)","u":"gcsManagedLedgerOffloadBucket(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"OffloadPolicies.Builder","l":"gcsManagedLedgerOffloadMaxBlockSizeInBytes(Integer)","u":"gcsManagedLedgerOffloadMaxBlockSizeInBytes(java.lang.Integer)"},{"p":"org.apache.pulsar.common.policies.data","c":"OffloadPolicies.Builder","l":"gcsManagedLedgerOffloadReadBufferSizeInBytes(Integer)","u":"gcsManagedLedgerOffloadReadBufferSizeInBytes(java.lang.Integer)"},{"p":"org.apache.pulsar.common.policies.data","c":"OffloadPolicies.Builder","l":"gcsManagedLedgerOffloadRegion(String)","u":"gcsManagedLedgerOffloadRegion(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"OffloadPolicies.Builder","l":"gcsManagedLedgerOffloadServiceAccountKeyFile(String)","u":"gcsManagedLedgerOffloadServiceAccountKeyFile(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"PublisherStats","l":"getAccessMode()"},{"p":"org.apache.pulsar.client.admin","c":"Brokers","l":"getActiveBrokers()"},{"p":"org.apache.pulsar.client.admin","c":"Brokers","l":"getActiveBrokers(String)","u":"getActiveBrokers(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Brokers","l":"getActiveBrokersAsync()"},{"p":"org.apache.pulsar.client.admin","c":"Brokers","l":"getActiveBrokersAsync(String)","u":"getActiveBrokersAsync(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"SubscriptionStats","l":"getActiveConsumerName()"},{"p":"org.apache.pulsar.common.policies.data","c":"ConsumerStats","l":"getAddress()"},{"p":"org.apache.pulsar.common.policies.data","c":"PublisherStats","l":"getAddress()"},{"p":"org.apache.pulsar.common.policies.data","c":"TenantInfo","l":"getAdminRoles()"},{"p":"org.apache.pulsar.client.admin","c":"Brokers","l":"getAllDynamicConfigurations()"},{"p":"org.apache.pulsar.client.admin","c":"Brokers","l":"getAllDynamicConfigurationsAsync()"},{"p":"org.apache.pulsar.client.admin","c":"BrokerStats","l":"getAllocatorStats(String)","u":"getAllocatorStats(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"BrokerStats","l":"getAllocatorStatsAsync(String)","u":"getAllocatorStatsAsync(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"TenantInfo","l":"getAllowedClusters()"},{"p":"org.apache.pulsar.client.admin","c":"Schemas","l":"getAllSchemas(String)","u":"getAllSchemas(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Schemas","l":"getAllSchemasAsync(String)","u":"getAllSchemasAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getAntiAffinityNamespaces(String, String, String)","u":"getAntiAffinityNamespaces(java.lang.String,java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getAntiAffinityNamespacesAsync(String, String, String)","u":"getAntiAffinityNamespacesAsync(java.lang.String,java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"ConsumerStats","l":"getAppId()"},{"p":"org.apache.pulsar.client.admin","c":"Worker","l":"getAssignments()"},{"p":"org.apache.pulsar.client.admin","c":"Worker","l":"getAssignmentsAsync()"},{"p":"org.apache.pulsar.common.policies.data","c":"ClusterData","l":"getAuthenticationParameters()"},{"p":"org.apache.pulsar.common.policies.data","c":"ClusterData","l":"getAuthenticationPlugin()"},{"p":"org.apache.pulsar.common.policies.data","c":"NamespaceIsolationData","l":"getAutoFailoverPolicy()"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getAutoSubscriptionCreation(String)","u":"getAutoSubscriptionCreation(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getAutoSubscriptionCreation(String, boolean)","u":"getAutoSubscriptionCreation(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getAutoSubscriptionCreationAsync(String)","u":"getAutoSubscriptionCreationAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getAutoSubscriptionCreationAsync(String, boolean)","u":"getAutoSubscriptionCreationAsync(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getAutoTopicCreation(String)","u":"getAutoTopicCreation(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getAutoTopicCreationAsync(String)","u":"getAutoTopicCreationAsync(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"ConsumerStats","l":"getAvailablePermits()"},{"p":"org.apache.pulsar.common.policies.data","c":"PublisherStats","l":"getAverageMsgSize()"},{"p":"org.apache.pulsar.common.policies.data","c":"TopicStats","l":"getAverageMsgSize()"},{"p":"org.apache.pulsar.common.policies.data","c":"ConsumerStats","l":"getAvgMessagesPerEntry()"},{"p":"org.apache.pulsar.common.policies.data","c":"FunctionInstanceStatsDataBase","l":"getAvgProcessLatency()"},{"p":"org.apache.pulsar.common.policies.data","c":"FunctionStats","l":"getAvgProcessLatency()"},{"p":"org.apache.pulsar.common.policies.data","c":"TopicStats","l":"getBacklogQuotaLimitSize()"},{"p":"org.apache.pulsar.common.policies.data","c":"TopicStats","l":"getBacklogQuotaLimitTime()"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getBacklogQuotaMap(String)","u":"getBacklogQuotaMap(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getBacklogQuotaMap(String)","u":"getBacklogQuotaMap(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getBacklogQuotaMap(String)","u":"getBacklogQuotaMap(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getBacklogQuotaMap(String, boolean)","u":"getBacklogQuotaMap(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getBacklogQuotaMap(String, boolean)","u":"getBacklogQuotaMap(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getBacklogQuotaMapAsync(String)","u":"getBacklogQuotaMapAsync(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"SubscriptionStats","l":"getBacklogSize()"},{"p":"org.apache.pulsar.common.policies.data","c":"TopicStats","l":"getBacklogSize()"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getBacklogSizeByMessageId(String, MessageId)","u":"getBacklogSizeByMessageId(java.lang.String,org.apache.pulsar.client.api.MessageId)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getBacklogSizeByMessageIdAsync(String, MessageId)","u":"getBacklogSizeByMessageIdAsync(java.lang.String,org.apache.pulsar.client.api.MessageId)"},{"p":"org.apache.pulsar.policies.data.loadbalancer","c":"LoadManagerReport","l":"getBandwidthIn()"},{"p":"org.apache.pulsar.policies.data.loadbalancer","c":"LoadManagerReport","l":"getBandwidthOut()"},{"p":"org.apache.pulsar.common.policies.data","c":"DrainingHash","l":"getBlockedAttempts()"},{"p":"org.apache.pulsar.common.policies.data","c":"BookiesRackConfiguration","l":"getBookie(String)","u":"getBookie(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getBookieAffinityGroup(String)","u":"getBookieAffinityGroup(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getBookieAffinityGroupAsync(String)","u":"getBookieAffinityGroupAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Bookies","l":"getBookieRackInfo(String)","u":"getBookieRackInfo(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Bookies","l":"getBookieRackInfoAsync(String)","u":"getBookieRackInfoAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Bookies","l":"getBookies()"},{"p":"org.apache.pulsar.common.policies.data","c":"BookiesClusterInfo","l":"getBookies()"},{"p":"org.apache.pulsar.client.admin","c":"Bookies","l":"getBookiesAsync()"},{"p":"org.apache.pulsar.client.admin","c":"Bookies","l":"getBookiesRackInfo()"},{"p":"org.apache.pulsar.client.admin","c":"Bookies","l":"getBookiesRackInfoAsync()"},{"p":"org.apache.pulsar.common.policies.data","c":"PersistencePolicies","l":"getBookkeeperAckQuorum()"},{"p":"org.apache.pulsar.common.policies.data","c":"BookieAffinityGroupData","l":"getBookkeeperAffinityGroupPrimary()"},{"p":"org.apache.pulsar.common.policies.data","c":"BookieAffinityGroupData","l":"getBookkeeperAffinityGroupSecondary()"},{"p":"org.apache.pulsar.common.policies.data","c":"PersistencePolicies","l":"getBookkeeperEnsemble()"},{"p":"org.apache.pulsar.common.conf","c":"InternalConfigurationData","l":"getBookkeeperMetadataServiceUri()"},{"p":"org.apache.pulsar.common.policies.data","c":"PersistencePolicies","l":"getBookkeeperWriteQuorum()"},{"p":"org.apache.pulsar.common.policies.data","c":"BundlesData","l":"getBoundaries()"},{"p":"org.apache.pulsar.common.policies.data","c":"BrokerStatus","l":"getBrokerAddress()"},{"p":"org.apache.pulsar.common.policies.data","c":"ClusterData","l":"getBrokerClientCertificateFilePath()"},{"p":"org.apache.pulsar.common.policies.data","c":"ClusterData","l":"getBrokerClientKeyFilePath()"},{"p":"org.apache.pulsar.common.policies.data","c":"ClusterData","l":"getBrokerClientSslFactoryPlugin()"},{"p":"org.apache.pulsar.common.policies.data","c":"ClusterData","l":"getBrokerClientSslFactoryPluginParams()"},{"p":"org.apache.pulsar.common.policies.data","c":"ClusterData","l":"getBrokerClientTlsKeyStore()"},{"p":"org.apache.pulsar.common.policies.data","c":"ClusterData","l":"getBrokerClientTlsKeyStorePassword()"},{"p":"org.apache.pulsar.common.policies.data","c":"ClusterData","l":"getBrokerClientTlsKeyStoreType()"},{"p":"org.apache.pulsar.common.policies.data","c":"ClusterData","l":"getBrokerClientTlsTrustStore()"},{"p":"org.apache.pulsar.common.policies.data","c":"ClusterData","l":"getBrokerClientTlsTrustStorePassword()"},{"p":"org.apache.pulsar.common.policies.data","c":"ClusterData","l":"getBrokerClientTlsTrustStoreType()"},{"p":"org.apache.pulsar.common.policies.data","c":"ClusterData","l":"getBrokerClientTrustCertsFilePath()"},{"p":"org.apache.pulsar.common.policies.data","c":"BrokerInfo","l":"getBrokerId()"},{"p":"org.apache.pulsar.common.policies.data","c":"BrokerNamespaceIsolationData","l":"getBrokerName()"},{"p":"org.apache.pulsar.common.policies.data","c":"FailureDomain","l":"getBrokers()"},{"p":"org.apache.pulsar.common.policies.data","c":"ClusterData","l":"getBrokerServiceUrl()"},{"p":"org.apache.pulsar.common.policies.data","c":"ClusterData","l":"getBrokerServiceUrlTls()"},{"p":"org.apache.pulsar.client.admin","c":"Clusters","l":"getBrokersWithNamespaceIsolationPolicy(String)","u":"getBrokersWithNamespaceIsolationPolicy(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Clusters","l":"getBrokersWithNamespaceIsolationPolicyAsync(String)","u":"getBrokersWithNamespaceIsolationPolicyAsync(java.lang.String)"},{"p":"org.apache.pulsar.policies.data.loadbalancer","c":"LoadManagerReport","l":"getBrokerVersionString()"},{"p":"org.apache.pulsar.client.admin","c":"Clusters","l":"getBrokerWithNamespaceIsolationPolicy(String, String)","u":"getBrokerWithNamespaceIsolationPolicy(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Clusters","l":"getBrokerWithNamespaceIsolationPolicyAsync(String, String)","u":"getBrokerWithNamespaceIsolationPolicyAsync(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Functions","l":"getBuiltInFunctions()"},{"p":"org.apache.pulsar.client.admin","c":"Functions","l":"getBuiltInFunctionsAsync()"},{"p":"org.apache.pulsar.client.admin","c":"Sinks","l":"getBuiltInSinks()"},{"p":"org.apache.pulsar.client.admin","c":"Sinks","l":"getBuiltInSinksAsync()"},{"p":"org.apache.pulsar.client.admin","c":"Sources","l":"getBuiltInSources()"},{"p":"org.apache.pulsar.client.admin","c":"Sources","l":"getBuiltInSourcesAsync()"},{"p":"org.apache.pulsar.client.admin","c":"Lookup","l":"getBundleRange(String)","u":"getBundleRange(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Lookup","l":"getBundleRangeAsync(String)","u":"getBundleRangeAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getBundles(String)","u":"getBundles(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getBundlesAsync(String)","u":"getBundlesAsync(java.lang.String)"},{"p":"org.apache.pulsar.policies.data.loadbalancer","c":"LoadManagerReport","l":"getBundleStats()"},{"p":"org.apache.pulsar.common.policies.data","c":"ReplicatorStats","l":"getBytesInCount()"},{"p":"org.apache.pulsar.common.policies.data","c":"TopicStats","l":"getBytesInCounter()"},{"p":"org.apache.pulsar.common.policies.data","c":"ReplicatorStats","l":"getBytesOutCount()"},{"p":"org.apache.pulsar.common.policies.data","c":"ConsumerStats","l":"getBytesOutCounter()"},{"p":"org.apache.pulsar.common.policies.data","c":"SubscriptionStats","l":"getBytesOutCounter()"},{"p":"org.apache.pulsar.common.policies.data","c":"TopicStats","l":"getBytesOutCounter()"},{"p":"org.apache.pulsar.common.policies.data","c":"ConsumerStats","l":"getChunkedMessageRate()"},{"p":"org.apache.pulsar.common.policies.data","c":"PublisherStats","l":"getChunkedMessageRate()"},{"p":"org.apache.pulsar.common.policies.data","c":"SubscriptionStats","l":"getChunkedMessageRate()"},{"p":"org.apache.pulsar.common.policies.data","c":"ConsumerStats","l":"getClientVersion()"},{"p":"org.apache.pulsar.common.policies.data","c":"PublisherStats","l":"getClientVersion()"},{"p":"org.apache.pulsar.client.admin","c":"Worker","l":"getCluster()"},{"p":"org.apache.pulsar.client.admin","c":"Clusters","l":"getCluster(String)","u":"getCluster(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Worker","l":"getClusterAsync()"},{"p":"org.apache.pulsar.client.admin","c":"Clusters","l":"getClusterAsync(String)","u":"getClusterAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Worker","l":"getClusterLeader()"},{"p":"org.apache.pulsar.client.admin","c":"Worker","l":"getClusterLeaderAsync()"},{"p":"org.apache.pulsar.client.admin","c":"Clusters","l":"getClusterMigration(String)","u":"getClusterMigration(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Clusters","l":"getClusterMigrationAsync(String)","u":"getClusterMigrationAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Clusters","l":"getClusters()"},{"p":"org.apache.pulsar.client.admin","c":"Clusters","l":"getClustersAsync()"},{"p":"org.apache.pulsar.common.policies.data","c":"TopicStats","l":"getCompaction()"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getCompactionThreshold(String)","u":"getCompactionThreshold(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getCompactionThreshold(String)","u":"getCompactionThreshold(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getCompactionThreshold(String)","u":"getCompactionThreshold(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getCompactionThreshold(String, boolean)","u":"getCompactionThreshold(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getCompactionThreshold(String, boolean)","u":"getCompactionThreshold(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getCompactionThresholdAsync(String)","u":"getCompactionThresholdAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getCompactionThresholdAsync(String)","u":"getCompactionThresholdAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getCompactionThresholdAsync(String)","u":"getCompactionThresholdAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getCompactionThresholdAsync(String, boolean)","u":"getCompactionThresholdAsync(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getCompactionThresholdAsync(String, boolean)","u":"getCompactionThresholdAsync(java.lang.String,boolean)"},{"p":"org.apache.pulsar.common.conf","c":"InternalConfigurationData","l":"getConfigurationMetadataStoreUrl()"},{"p":"org.apache.pulsar.common.conf","c":"InternalConfigurationData","l":"getConfigurationStoreServers()"},{"p":"org.apache.pulsar.common.policies.data","c":"ConsumerStats","l":"getConnectedSince()"},{"p":"org.apache.pulsar.common.policies.data","c":"PublisherStats","l":"getConnectedSince()"},{"p":"org.apache.pulsar.client.admin","c":"ProxyStats","l":"getConnections()"},{"p":"org.apache.pulsar.client.admin","c":"Functions","l":"getConnectorsList()"},{"p":"org.apache.pulsar.common.policies.data","c":"ConsumerStats","l":"getConsumerName()"},{"p":"org.apache.pulsar.common.policies.data","c":"SubscriptionStats","l":"getConsumers()"},{"p":"org.apache.pulsar.common.policies.data","c":"SubscriptionStats","l":"getConsumersAfterMarkDeletePosition()"},{"p":"org.apache.pulsar.client.admin","c":"Transactions","l":"getCoordinatorInternalStats(int, boolean)","u":"getCoordinatorInternalStats(int,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Transactions","l":"getCoordinatorInternalStatsAsync(int, boolean)","u":"getCoordinatorInternalStatsAsync(int,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Transactions","l":"getCoordinatorStats()"},{"p":"org.apache.pulsar.client.admin","c":"Transactions","l":"getCoordinatorStatsAsync()"},{"p":"org.apache.pulsar.client.admin","c":"Transactions","l":"getCoordinatorStatsById(int)"},{"p":"org.apache.pulsar.client.admin","c":"Transactions","l":"getCoordinatorStatsByIdAsync(int)"},{"p":"org.apache.pulsar.policies.data.loadbalancer","c":"LoadManagerReport","l":"getCpu()"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getDeduplicationEnabled(String)","u":"getDeduplicationEnabled(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getDeduplicationEnabledAsync(String)","u":"getDeduplicationEnabledAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getDeduplicationSnapshotInterval(String)","u":"getDeduplicationSnapshotInterval(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getDeduplicationSnapshotInterval(String)","u":"getDeduplicationSnapshotInterval(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getDeduplicationSnapshotInterval(String)","u":"getDeduplicationSnapshotInterval(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getDeduplicationSnapshotIntervalAsync(String)","u":"getDeduplicationSnapshotIntervalAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getDeduplicationSnapshotIntervalAsync(String)","u":"getDeduplicationSnapshotIntervalAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getDeduplicationSnapshotIntervalAsync(String)","u":"getDeduplicationSnapshotIntervalAsync(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"TopicStats","l":"getDeduplicationStatus()"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getDeduplicationStatus(String)","u":"getDeduplicationStatus(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getDeduplicationStatus(String)","u":"getDeduplicationStatus(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getDeduplicationStatus(String)","u":"getDeduplicationStatus(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getDeduplicationStatus(String, boolean)","u":"getDeduplicationStatus(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getDeduplicationStatus(String, boolean)","u":"getDeduplicationStatus(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getDeduplicationStatusAsync(String)","u":"getDeduplicationStatusAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getDeduplicationStatusAsync(String)","u":"getDeduplicationStatusAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getDeduplicationStatusAsync(String)","u":"getDeduplicationStatusAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getDeduplicationStatusAsync(String, boolean)","u":"getDeduplicationStatusAsync(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getDeduplicationStatusAsync(String, boolean)","u":"getDeduplicationStatusAsync(java.lang.String,boolean)"},{"p":"org.apache.pulsar.common.policies.data","c":"AutoTopicCreationOverride","l":"getDefaultNumPartitions()"},{"p":"org.apache.pulsar.client.admin","c":"ResourceQuotas","l":"getDefaultResourceQuota()"},{"p":"org.apache.pulsar.client.admin","c":"ResourceQuotas","l":"getDefaultResourceQuotaAsync()"},{"p":"org.apache.pulsar.common.functions","c":"Resources","l":"getDefaultResources()"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getDelayedDelivery(String)","u":"getDelayedDelivery(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getDelayedDeliveryAsync(String)","u":"getDelayedDeliveryAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getDelayedDeliveryPolicy(String)","u":"getDelayedDeliveryPolicy(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getDelayedDeliveryPolicy(String)","u":"getDelayedDeliveryPolicy(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getDelayedDeliveryPolicy(String, boolean)","u":"getDelayedDeliveryPolicy(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getDelayedDeliveryPolicy(String, boolean)","u":"getDelayedDeliveryPolicy(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getDelayedDeliveryPolicyAsync(String)","u":"getDelayedDeliveryPolicyAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getDelayedDeliveryPolicyAsync(String)","u":"getDelayedDeliveryPolicyAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getDelayedDeliveryPolicyAsync(String, boolean)","u":"getDelayedDeliveryPolicyAsync(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getDelayedDeliveryPolicyAsync(String, boolean)","u":"getDelayedDeliveryPolicyAsync(java.lang.String,boolean)"},{"p":"org.apache.pulsar.common.policies.data","c":"SubscriptionStats","l":"getDelayedMessageIndexSizeInBytes()"},{"p":"org.apache.pulsar.common.policies.data","c":"TopicStats","l":"getDelayedMessageIndexSizeInBytes()"},{"p":"org.apache.pulsar.common.stats","c":"Metrics","l":"getDimension(String)","u":"getDimension(java.lang.String)"},{"p":"org.apache.pulsar.common.stats","c":"Metrics","l":"getDimensions()"},{"p":"org.apache.pulsar.policies.data.loadbalancer","c":"LoadManagerReport","l":"getDirectMemory()"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getDispatcherPauseOnAckStatePersistent(String)","u":"getDispatcherPauseOnAckStatePersistent(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getDispatcherPauseOnAckStatePersistent(String, boolean)","u":"getDispatcherPauseOnAckStatePersistent(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getDispatcherPauseOnAckStatePersistentAsync(String)","u":"getDispatcherPauseOnAckStatePersistentAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getDispatchRate(String)","u":"getDispatchRate(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getDispatchRate(String)","u":"getDispatchRate(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getDispatchRate(String)","u":"getDispatchRate(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getDispatchRate(String, boolean)","u":"getDispatchRate(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getDispatchRate(String, boolean)","u":"getDispatchRate(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getDispatchRateAsync(String)","u":"getDispatchRateAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getDispatchRateAsync(String)","u":"getDispatchRateAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getDispatchRateAsync(String)","u":"getDispatchRateAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getDispatchRateAsync(String, boolean)","u":"getDispatchRateAsync(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getDispatchRateAsync(String, boolean)","u":"getDispatchRateAsync(java.lang.String,boolean)"},{"p":"org.apache.pulsar.common.policies.data","c":"DispatchRate","l":"getDispatchThrottlingRateInByte()"},{"p":"org.apache.pulsar.common.policies.data","c":"DispatchRate","l":"getDispatchThrottlingRateInMsg()"},{"p":"org.apache.pulsar.common.policies.data","c":"ConsumerStats","l":"getDrainingHashes()"},{"p":"org.apache.pulsar.common.policies.data","c":"ConsumerStats","l":"getDrainingHashesClearedTotal()"},{"p":"org.apache.pulsar.common.policies.data","c":"SubscriptionStats","l":"getDrainingHashesClearedTotal()"},{"p":"org.apache.pulsar.common.policies.data","c":"ConsumerStats","l":"getDrainingHashesCount()"},{"p":"org.apache.pulsar.common.policies.data","c":"SubscriptionStats","l":"getDrainingHashesCount()"},{"p":"org.apache.pulsar.common.policies.data","c":"ConsumerStats","l":"getDrainingHashesUnackedMessages()"},{"p":"org.apache.pulsar.common.policies.data","c":"SubscriptionStats","l":"getDrainingHashesUnackedMessages()"},{"p":"org.apache.pulsar.common.policies.data","c":"ResourceQuota","l":"getDynamic()"},{"p":"org.apache.pulsar.client.admin","c":"Brokers","l":"getDynamicConfigurationNames()"},{"p":"org.apache.pulsar.client.admin","c":"Brokers","l":"getDynamicConfigurationNamesAsync()"},{"p":"org.apache.pulsar.common.policies.data","c":"SubscriptionStats","l":"getEarliestMsgPublishTimeInBacklog()"},{"p":"org.apache.pulsar.common.policies.data","c":"TopicStats","l":"getEarliestMsgPublishTimeInBacklogs()"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getEncryptionRequiredStatus(String)","u":"getEncryptionRequiredStatus(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getEncryptionRequiredStatusAsync(String)","u":"getEncryptionRequiredStatusAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getEntryFiltersPerTopic(String, boolean)","u":"getEntryFiltersPerTopic(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getEntryFiltersPerTopicAsync(String, boolean)","u":"getEntryFiltersPerTopicAsync(java.lang.String,boolean)"},{"p":"org.apache.pulsar.common.naming","c":"TopicDomain","l":"getEnum(String)","u":"getEnum(java.lang.String)"},{"p":"org.apache.pulsar.packages.management.core.common","c":"PackageType","l":"getEnum(String)","u":"getEnum(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Clusters","l":"getFailureDomain(String, String)","u":"getFailureDomain(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Clusters","l":"getFailureDomainAsync(String, String)","u":"getFailureDomainAsync(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Clusters","l":"getFailureDomains(String)","u":"getFailureDomains(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Clusters","l":"getFailureDomainsAsync(String)","u":"getFailureDomainsAsync(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"OffloadPolicies","l":"getFileSystemProfilePath()"},{"p":"org.apache.pulsar.common.policies.data","c":"OffloadPolicies","l":"getFileSystemURI()"},{"p":"org.apache.pulsar.common.policies.data","c":"SubscriptionStats","l":"getFilterAcceptedMsgCount()"},{"p":"org.apache.pulsar.common.policies.data","c":"SubscriptionStats","l":"getFilterProcessedMsgCount()"},{"p":"org.apache.pulsar.common.policies.data","c":"SubscriptionStats","l":"getFilterRejectedMsgCount()"},{"p":"org.apache.pulsar.common.policies.data","c":"SubscriptionStats","l":"getFilterRescheduledMsgCount()"},{"p":"org.apache.pulsar.client.admin","c":"OffloadProcessStatus","l":"getFirstUnoffloadedMessage()"},{"p":"org.apache.pulsar.client.admin","c":"Functions","l":"getFunction(String, String, String)","u":"getFunction(java.lang.String,java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Functions","l":"getFunctionAsync(String, String, String)","u":"getFunctionAsync(java.lang.String,java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Functions","l":"getFunctions(String, String)","u":"getFunctions(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Functions","l":"getFunctionsAsync(String, String)","u":"getFunctionsAsync(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Worker","l":"getFunctionsStats()"},{"p":"org.apache.pulsar.client.admin","c":"Worker","l":"getFunctionsStatsAsync()"},{"p":"org.apache.pulsar.client.admin","c":"Functions","l":"getFunctionState(String, String, String, String)","u":"getFunctionState(java.lang.String,java.lang.String,java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Functions","l":"getFunctionStateAsync(String, String, String, String)","u":"getFunctionStateAsync(java.lang.String,java.lang.String,java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Functions","l":"getFunctionStats(String, String, String)","u":"getFunctionStats(java.lang.String,java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Functions","l":"getFunctionStats(String, String, String, int)","u":"getFunctionStats(java.lang.String,java.lang.String,java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"Functions","l":"getFunctionStatsAsync(String, String, String)","u":"getFunctionStatsAsync(java.lang.String,java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Functions","l":"getFunctionStatsAsync(String, String, String, int)","u":"getFunctionStatsAsync(java.lang.String,java.lang.String,java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"Functions","l":"getFunctionStatus(String, String, String)","u":"getFunctionStatus(java.lang.String,java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Functions","l":"getFunctionStatus(String, String, String, int)","u":"getFunctionStatus(java.lang.String,java.lang.String,java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"Functions","l":"getFunctionStatusAsync(String, String, String)","u":"getFunctionStatusAsync(java.lang.String,java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Functions","l":"getFunctionStatusAsync(String, String, String, int)","u":"getFunctionStatusAsync(java.lang.String,java.lang.String,java.lang.String,int)"},{"p":"org.apache.pulsar.common.policies.data","c":"OffloadPolicies","l":"getGcsManagedLedgerOffloadBucket()"},{"p":"org.apache.pulsar.common.policies.data","c":"OffloadPolicies","l":"getGcsManagedLedgerOffloadMaxBlockSizeInBytes()"},{"p":"org.apache.pulsar.common.policies.data","c":"OffloadPolicies","l":"getGcsManagedLedgerOffloadReadBufferSizeInBytes()"},{"p":"org.apache.pulsar.common.policies.data","c":"OffloadPolicies","l":"getGcsManagedLedgerOffloadRegion()"},{"p":"org.apache.pulsar.common.policies.data","c":"OffloadPolicies","l":"getGcsManagedLedgerOffloadServiceAccountKeyFile()"},{"p":"org.apache.pulsar.common.policies.data","c":"DrainingHash","l":"getHash()"},{"p":"org.apache.pulsar.common.policies.data","c":"BookieInfo","l":"getHostname()"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdminException","l":"getHttpError()"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getInactiveTopicPolicies(String)","u":"getInactiveTopicPolicies(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getInactiveTopicPolicies(String)","u":"getInactiveTopicPolicies(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getInactiveTopicPolicies(String)","u":"getInactiveTopicPolicies(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getInactiveTopicPolicies(String, boolean)","u":"getInactiveTopicPolicies(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getInactiveTopicPolicies(String, boolean)","u":"getInactiveTopicPolicies(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getInactiveTopicPoliciesAsync(String)","u":"getInactiveTopicPoliciesAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getInactiveTopicPoliciesAsync(String)","u":"getInactiveTopicPoliciesAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getInactiveTopicPoliciesAsync(String)","u":"getInactiveTopicPoliciesAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getInactiveTopicPoliciesAsync(String, boolean)","u":"getInactiveTopicPoliciesAsync(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getInactiveTopicPoliciesAsync(String, boolean)","u":"getInactiveTopicPoliciesAsync(java.lang.String,boolean)"},{"p":"org.apache.pulsar.common.policies.data","c":"ReplicatorStats","l":"getInboundConnectedSince()"},{"p":"org.apache.pulsar.common.policies.data","c":"ReplicatorStats","l":"getInboundConnection()"},{"p":"org.apache.pulsar.common.policies.data","c":"FunctionInstanceStats","l":"getInstanceId()"},{"p":"org.apache.pulsar.common.policies.data","c":"FunctionStats","l":"getInstances()"},{"p":"org.apache.pulsar.client.admin","c":"Brokers","l":"getInternalConfigurationData()"},{"p":"org.apache.pulsar.client.admin","c":"Brokers","l":"getInternalConfigurationDataAsync()"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getInternalInfo(String)","u":"getInternalInfo(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getInternalInfoAsync(String)","u":"getInternalInfoAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"NonPersistentTopics","l":"getInternalStats(String)","u":"getInternalStats(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getInternalStats(String)","u":"getInternalStats(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getInternalStats(String, boolean)","u":"getInternalStats(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"NonPersistentTopics","l":"getInternalStatsAsync(String)","u":"getInternalStatsAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getInternalStatsAsync(String)","u":"getInternalStatsAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getInternalStatsAsync(String, boolean)","u":"getInternalStatsAsync(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getIsAllowAutoUpdateSchema(String)","u":"getIsAllowAutoUpdateSchema(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getIsAllowAutoUpdateSchemaAsync(String)","u":"getIsAllowAutoUpdateSchemaAsync(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"ConsumerStats","l":"getKeyHashRangeArrays()"},{"p":"org.apache.pulsar.common.policies.data","c":"ConsumerStats","l":"getKeyHashRanges()"},{"p":"org.apache.pulsar.common.policies.data","c":"SubscriptionStats","l":"getKeySharedMode()"},{"p":"org.apache.pulsar.common.policies.data","c":"ConsumerStats","l":"getLastAckedTimestamp()"},{"p":"org.apache.pulsar.common.policies.data","c":"SubscriptionStats","l":"getLastAckedTimestamp()"},{"p":"org.apache.pulsar.common.policies.data","c":"CompactionStats","l":"getLastCompactionDurationTimeInMills()"},{"p":"org.apache.pulsar.common.policies.data","c":"CompactionStats","l":"getLastCompactionFailedTimestamp()"},{"p":"org.apache.pulsar.common.policies.data","c":"CompactionStats","l":"getLastCompactionRemovedEventCount()"},{"p":"org.apache.pulsar.common.policies.data","c":"CompactionStats","l":"getLastCompactionSucceedTimestamp()"},{"p":"org.apache.pulsar.common.policies.data","c":"ConsumerStats","l":"getLastConsumedFlowTimestamp()"},{"p":"org.apache.pulsar.common.policies.data","c":"SubscriptionStats","l":"getLastConsumedFlowTimestamp()"},{"p":"org.apache.pulsar.common.policies.data","c":"ConsumerStats","l":"getLastConsumedTimestamp()"},{"p":"org.apache.pulsar.common.policies.data","c":"SubscriptionStats","l":"getLastConsumedTimestamp()"},{"p":"org.apache.pulsar.client.admin","c":"OffloadProcessStatus","l":"getLastError()"},{"p":"org.apache.pulsar.common.policies.data","c":"SubscriptionStats","l":"getLastExpireTimestamp()"},{"p":"org.apache.pulsar.common.policies.data","c":"FunctionInstanceStatsData","l":"getLastInvocation()"},{"p":"org.apache.pulsar.common.policies.data","c":"FunctionStats","l":"getLastInvocation()"},{"p":"org.apache.pulsar.common.policies.data","c":"SubscriptionStats","l":"getLastMarkDeleteAdvancedTimestamp()"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getLastMessageId(String)","u":"getLastMessageId(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getLastMessageIdAsync(String)","u":"getLastMessageIdAsync(java.lang.String)"},{"p":"org.apache.pulsar.policies.data.loadbalancer","c":"LoadManagerReport","l":"getLastUpdate()"},{"p":"org.apache.pulsar.client.admin","c":"Brokers","l":"getLeaderBroker()"},{"p":"org.apache.pulsar.client.admin","c":"Brokers","l":"getLeaderBrokerAsync()"},{"p":"org.apache.pulsar.common.conf","c":"InternalConfigurationData","l":"getLedgersRootPath()"},{"p":"org.apache.pulsar.common.policies.data","c":"BacklogQuota","l":"getLimit()"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"BacklogQuotaImpl","l":"getLimit()"},{"p":"org.apache.pulsar.common.policies.data","c":"BacklogQuota","l":"getLimitSize()"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"BacklogQuotaImpl","l":"getLimitSize()"},{"p":"org.apache.pulsar.common.policies.data","c":"BacklogQuota","l":"getLimitTime()"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"BacklogQuotaImpl","l":"getLimitTime()"},{"p":"org.apache.pulsar.client.admin","c":"NonPersistentTopics","l":"getList(String)","u":"getList(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getList(String)","u":"getList(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getList(String, TopicDomain)","u":"getList(java.lang.String,org.apache.pulsar.common.naming.TopicDomain)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getList(String, TopicDomain, ListTopicsOptions)","u":"getList(java.lang.String,org.apache.pulsar.common.naming.TopicDomain,org.apache.pulsar.client.admin.ListTopicsOptions)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getList(String, TopicDomain, Map)","u":"getList(java.lang.String,org.apache.pulsar.common.naming.TopicDomain,java.util.Map)"},{"p":"org.apache.pulsar.client.admin","c":"NonPersistentTopics","l":"getListAsync(String)","u":"getListAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getListAsync(String)","u":"getListAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getListAsync(String, TopicDomain)","u":"getListAsync(java.lang.String,org.apache.pulsar.common.naming.TopicDomain)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getListAsync(String, TopicDomain, ListTopicsOptions)","u":"getListAsync(java.lang.String,org.apache.pulsar.common.naming.TopicDomain,org.apache.pulsar.client.admin.ListTopicsOptions)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getListAsync(String, TopicDomain, Map)","u":"getListAsync(java.lang.String,org.apache.pulsar.common.naming.TopicDomain,java.util.Map)"},{"p":"org.apache.pulsar.common.policies.data","c":"ClusterData","l":"getListenerName()"},{"p":"org.apache.pulsar.client.admin","c":"NonPersistentTopics","l":"getListInBundle(String, String)","u":"getListInBundle(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getListInBundle(String, String)","u":"getListInBundle(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"NonPersistentTopics","l":"getListInBundleAsync(String, String)","u":"getListInBundleAsync(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getListInBundleAsync(String, String)","u":"getListInBundleAsync(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"BrokerStatus","l":"getLoadFactor()"},{"p":"org.apache.pulsar.policies.data.loadbalancer","c":"ServiceLookupData","l":"getLoadManagerClassName()"},{"p":"org.apache.pulsar.client.admin","c":"BrokerStats","l":"getLoadReport()"},{"p":"org.apache.pulsar.client.admin","c":"BrokerStats","l":"getLoadReportAsync()"},{"p":"org.apache.pulsar.common.policies.data","c":"PersistencePolicies","l":"getManagedLedgerMaxMarkDeleteRate()"},{"p":"org.apache.pulsar.common.policies.data","c":"OffloadPolicies","l":"getManagedLedgerOffloadBucket()"},{"p":"org.apache.pulsar.common.policies.data","c":"OffloadPolicies","l":"getManagedLedgerOffloadDeletionLagInMillis()"},{"p":"org.apache.pulsar.common.policies.data","c":"OffloadPolicies","l":"getManagedLedgerOffloadDriver()"},{"p":"org.apache.pulsar.common.policies.data","c":"OffloadPolicies","l":"getManagedLedgerOffloadedReadPriority()"},{"p":"org.apache.pulsar.common.policies.data","c":"OffloadPolicies","l":"getManagedLedgerOffloadMaxBlockSizeInBytes()"},{"p":"org.apache.pulsar.common.policies.data","c":"OffloadPolicies","l":"getManagedLedgerOffloadMaxThreads()"},{"p":"org.apache.pulsar.common.policies.data","c":"OffloadPolicies","l":"getManagedLedgerOffloadPrefetchRounds()"},{"p":"org.apache.pulsar.common.policies.data","c":"OffloadPolicies","l":"getManagedLedgerOffloadReadBufferSizeInBytes()"},{"p":"org.apache.pulsar.common.policies.data","c":"OffloadPolicies","l":"getManagedLedgerOffloadRegion()"},{"p":"org.apache.pulsar.common.policies.data","c":"OffloadPolicies","l":"getManagedLedgerOffloadServiceEndpoint()"},{"p":"org.apache.pulsar.common.policies.data","c":"OffloadPolicies","l":"getManagedLedgerOffloadThresholdInBytes()"},{"p":"org.apache.pulsar.common.policies.data","c":"OffloadPolicies","l":"getManagedLedgerOffloadThresholdInSeconds()"},{"p":"org.apache.pulsar.common.policies.data","c":"PersistencePolicies","l":"getManagedLedgerStorageClassName()"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getMaxConsumers(String)","u":"getMaxConsumers(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getMaxConsumers(String)","u":"getMaxConsumers(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getMaxConsumers(String, boolean)","u":"getMaxConsumers(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getMaxConsumers(String, boolean)","u":"getMaxConsumers(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getMaxConsumersAsync(String)","u":"getMaxConsumersAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getMaxConsumersAsync(String)","u":"getMaxConsumersAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getMaxConsumersAsync(String, boolean)","u":"getMaxConsumersAsync(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getMaxConsumersAsync(String, boolean)","u":"getMaxConsumersAsync(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getMaxConsumersPerSubscription(String)","u":"getMaxConsumersPerSubscription(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getMaxConsumersPerSubscription(String)","u":"getMaxConsumersPerSubscription(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getMaxConsumersPerSubscription(String)","u":"getMaxConsumersPerSubscription(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getMaxConsumersPerSubscriptionAsync(String)","u":"getMaxConsumersPerSubscriptionAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getMaxConsumersPerSubscriptionAsync(String)","u":"getMaxConsumersPerSubscriptionAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getMaxConsumersPerSubscriptionAsync(String)","u":"getMaxConsumersPerSubscriptionAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getMaxConsumersPerTopic(String)","u":"getMaxConsumersPerTopic(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getMaxConsumersPerTopicAsync(String)","u":"getMaxConsumersPerTopicAsync(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"DelayedDeliveryPolicies","l":"getMaxDeliveryDelayInMillis()"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getMaxMessageSize(String)","u":"getMaxMessageSize(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getMaxMessageSize(String)","u":"getMaxMessageSize(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getMaxMessageSizeAsync(String)","u":"getMaxMessageSizeAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getMaxMessageSizeAsync(String)","u":"getMaxMessageSizeAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getMaxProducers(String)","u":"getMaxProducers(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getMaxProducers(String)","u":"getMaxProducers(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getMaxProducers(String, boolean)","u":"getMaxProducers(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getMaxProducers(String, boolean)","u":"getMaxProducers(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getMaxProducersAsync(String)","u":"getMaxProducersAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getMaxProducersAsync(String)","u":"getMaxProducersAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getMaxProducersAsync(String, boolean)","u":"getMaxProducersAsync(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getMaxProducersAsync(String, boolean)","u":"getMaxProducersAsync(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getMaxProducersPerTopic(String)","u":"getMaxProducersPerTopic(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getMaxProducersPerTopicAsync(String)","u":"getMaxProducersPerTopicAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getMaxSubscriptionsPerTopic(String)","u":"getMaxSubscriptionsPerTopic(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getMaxSubscriptionsPerTopic(String)","u":"getMaxSubscriptionsPerTopic(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getMaxSubscriptionsPerTopic(String)","u":"getMaxSubscriptionsPerTopic(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getMaxSubscriptionsPerTopicAsync(String)","u":"getMaxSubscriptionsPerTopicAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getMaxSubscriptionsPerTopicAsync(String)","u":"getMaxSubscriptionsPerTopicAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getMaxSubscriptionsPerTopicAsync(String)","u":"getMaxSubscriptionsPerTopicAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getMaxTopicsPerNamespace(String)","u":"getMaxTopicsPerNamespace(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getMaxTopicsPerNamespaceAsync(String)","u":"getMaxTopicsPerNamespaceAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getMaxUnackedMessagesOnConsumer(String)","u":"getMaxUnackedMessagesOnConsumer(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getMaxUnackedMessagesOnConsumer(String)","u":"getMaxUnackedMessagesOnConsumer(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getMaxUnackedMessagesOnConsumer(String, boolean)","u":"getMaxUnackedMessagesOnConsumer(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getMaxUnackedMessagesOnConsumer(String, boolean)","u":"getMaxUnackedMessagesOnConsumer(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getMaxUnackedMessagesOnConsumerAsync(String)","u":"getMaxUnackedMessagesOnConsumerAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getMaxUnackedMessagesOnConsumerAsync(String)","u":"getMaxUnackedMessagesOnConsumerAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getMaxUnackedMessagesOnConsumerAsync(String, boolean)","u":"getMaxUnackedMessagesOnConsumerAsync(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getMaxUnackedMessagesOnConsumerAsync(String, boolean)","u":"getMaxUnackedMessagesOnConsumerAsync(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getMaxUnackedMessagesOnSubscription(String)","u":"getMaxUnackedMessagesOnSubscription(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getMaxUnackedMessagesOnSubscription(String)","u":"getMaxUnackedMessagesOnSubscription(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getMaxUnackedMessagesOnSubscription(String, boolean)","u":"getMaxUnackedMessagesOnSubscription(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getMaxUnackedMessagesOnSubscription(String, boolean)","u":"getMaxUnackedMessagesOnSubscription(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getMaxUnackedMessagesOnSubscriptionAsync(String)","u":"getMaxUnackedMessagesOnSubscriptionAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getMaxUnackedMessagesOnSubscriptionAsync(String)","u":"getMaxUnackedMessagesOnSubscriptionAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getMaxUnackedMessagesOnSubscriptionAsync(String, boolean)","u":"getMaxUnackedMessagesOnSubscriptionAsync(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getMaxUnackedMessagesOnSubscriptionAsync(String, boolean)","u":"getMaxUnackedMessagesOnSubscriptionAsync(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getMaxUnackedMessagesPerConsumer(String)","u":"getMaxUnackedMessagesPerConsumer(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getMaxUnackedMessagesPerConsumerAsync(String)","u":"getMaxUnackedMessagesPerConsumerAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getMaxUnackedMessagesPerSubscription(String)","u":"getMaxUnackedMessagesPerSubscription(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getMaxUnackedMessagesPerSubscriptionAsync(String)","u":"getMaxUnackedMessagesPerSubscriptionAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"BrokerStats","l":"getMBeans()"},{"p":"org.apache.pulsar.client.admin","c":"BrokerStats","l":"getMBeansAsync()"},{"p":"org.apache.pulsar.policies.data.loadbalancer","c":"LoadManagerReport","l":"getMemory()"},{"p":"org.apache.pulsar.common.policies.data","c":"ConsumerStats","l":"getMessageAckRate()"},{"p":"org.apache.pulsar.common.policies.data","c":"SubscriptionStats","l":"getMessageAckRate()"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getMessageById(String, long, long)","u":"getMessageById(java.lang.String,long,long)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getMessageByIdAsync(String, long, long)","u":"getMessageByIdAsync(java.lang.String,long,long)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getMessageIdByTimestamp(String, long)","u":"getMessageIdByTimestamp(java.lang.String,long)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getMessageIdByTimestampAsync(String, long)","u":"getMessageIdByTimestampAsync(java.lang.String,long)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getMessagesById(String, long, long)","u":"getMessagesById(java.lang.String,long,long)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getMessagesByIdAsync(String, long, long)","u":"getMessagesByIdAsync(java.lang.String,long,long)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getMessageTTL(String)","u":"getMessageTTL(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getMessageTTL(String)","u":"getMessageTTL(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getMessageTTL(String, boolean)","u":"getMessageTTL(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getMessageTTL(String, boolean)","u":"getMessageTTL(java.lang.String,boolean)"},{"p":"org.apache.pulsar.common.policies.data","c":"ConsumerStats","l":"getMetadata()"},{"p":"org.apache.pulsar.common.policies.data","c":"PartitionedTopicStats","l":"getMetadata()"},{"p":"org.apache.pulsar.common.policies.data","c":"PublisherStats","l":"getMetadata()"},{"p":"org.apache.pulsar.client.admin","c":"Packages","l":"getMetadata(String)","u":"getMetadata(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Packages","l":"getMetadataAsync(String)","u":"getMetadataAsync(java.lang.String)"},{"p":"org.apache.pulsar.common.conf","c":"InternalConfigurationData","l":"getMetadataStoreUrl()"},{"p":"org.apache.pulsar.client.admin","c":"BrokerStats","l":"getMetrics()"},{"p":"org.apache.pulsar.client.admin","c":"Worker","l":"getMetrics()"},{"p":"org.apache.pulsar.common.policies.data","c":"FunctionInstanceStats","l":"getMetrics()"},{"p":"org.apache.pulsar.common.stats","c":"Metrics","l":"getMetrics()"},{"p":"org.apache.pulsar.client.admin","c":"BrokerStats","l":"getMetricsAsync()"},{"p":"org.apache.pulsar.client.admin","c":"Worker","l":"getMetricsAsync()"},{"p":"org.apache.pulsar.common.policies.data","c":"ClusterPolicies","l":"getMigratedClusterUrl()"},{"p":"org.apache.pulsar.common.policies.data","c":"SubscriptionStats","l":"getMsgBacklog()"},{"p":"org.apache.pulsar.common.policies.data","c":"SubscriptionStats","l":"getMsgBacklogNoDelayed()"},{"p":"org.apache.pulsar.common.policies.data","c":"SubscriptionStats","l":"getMsgDelayed()"},{"p":"org.apache.pulsar.common.policies.data","c":"NonPersistentReplicatorStats","l":"getMsgDropCount()"},{"p":"org.apache.pulsar.common.policies.data","c":"NonPersistentPublisherStats","l":"getMsgDropRate()"},{"p":"org.apache.pulsar.common.policies.data","c":"NonPersistentReplicatorStats","l":"getMsgDropRate()"},{"p":"org.apache.pulsar.common.policies.data","c":"NonPersistentSubscriptionStats","l":"getMsgDropRate()"},{"p":"org.apache.pulsar.common.policies.data","c":"NonPersistentTopicStats","l":"getMsgDropRate()"},{"p":"org.apache.pulsar.common.policies.data","c":"ReplicatorStats","l":"getMsgExpiredCount()"},{"p":"org.apache.pulsar.common.policies.data","c":"ReplicatorStats","l":"getMsgInCount()"},{"p":"org.apache.pulsar.common.policies.data","c":"TopicStats","l":"getMsgInCounter()"},{"p":"org.apache.pulsar.common.policies.data","c":"SubscriptionStats","l":"getMsgInReplay()"},{"p":"org.apache.pulsar.common.policies.data","c":"ReplicatorStats","l":"getMsgOutCount()"},{"p":"org.apache.pulsar.common.policies.data","c":"ConsumerStats","l":"getMsgOutCounter()"},{"p":"org.apache.pulsar.common.policies.data","c":"SubscriptionStats","l":"getMsgOutCounter()"},{"p":"org.apache.pulsar.common.policies.data","c":"TopicStats","l":"getMsgOutCounter()"},{"p":"org.apache.pulsar.common.policies.data","c":"ReplicatorStats","l":"getMsgRateExpired()"},{"p":"org.apache.pulsar.common.policies.data","c":"SubscriptionStats","l":"getMsgRateExpired()"},{"p":"org.apache.pulsar.common.policies.data","c":"PublisherStats","l":"getMsgRateIn()"},{"p":"org.apache.pulsar.common.policies.data","c":"ReplicatorStats","l":"getMsgRateIn()"},{"p":"org.apache.pulsar.common.policies.data","c":"TopicStats","l":"getMsgRateIn()"},{"p":"org.apache.pulsar.policies.data.loadbalancer","c":"LoadManagerReport","l":"getMsgRateIn()"},{"p":"org.apache.pulsar.common.policies.data","c":"ConsumerStats","l":"getMsgRateOut()"},{"p":"org.apache.pulsar.common.policies.data","c":"ReplicatorStats","l":"getMsgRateOut()"},{"p":"org.apache.pulsar.common.policies.data","c":"SubscriptionStats","l":"getMsgRateOut()"},{"p":"org.apache.pulsar.common.policies.data","c":"TopicStats","l":"getMsgRateOut()"},{"p":"org.apache.pulsar.policies.data.loadbalancer","c":"LoadManagerReport","l":"getMsgRateOut()"},{"p":"org.apache.pulsar.common.policies.data","c":"ConsumerStats","l":"getMsgRateRedeliver()"},{"p":"org.apache.pulsar.common.policies.data","c":"SubscriptionStats","l":"getMsgRateRedeliver()"},{"p":"org.apache.pulsar.common.policies.data","c":"PublisherStats","l":"getMsgThroughputIn()"},{"p":"org.apache.pulsar.common.policies.data","c":"ReplicatorStats","l":"getMsgThroughputIn()"},{"p":"org.apache.pulsar.common.policies.data","c":"TopicStats","l":"getMsgThroughputIn()"},{"p":"org.apache.pulsar.policies.data.loadbalancer","c":"LoadManagerReport","l":"getMsgThroughputIn()"},{"p":"org.apache.pulsar.common.policies.data","c":"ConsumerStats","l":"getMsgThroughputOut()"},{"p":"org.apache.pulsar.common.policies.data","c":"ReplicatorStats","l":"getMsgThroughputOut()"},{"p":"org.apache.pulsar.common.policies.data","c":"SubscriptionStats","l":"getMsgThroughputOut()"},{"p":"org.apache.pulsar.common.policies.data","c":"TopicStats","l":"getMsgThroughputOut()"},{"p":"org.apache.pulsar.policies.data.loadbalancer","c":"LoadManagerReport","l":"getMsgThroughputOut()"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getNamespaceAllowedClusters(String)","u":"getNamespaceAllowedClusters(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getNamespaceAllowedClustersAsync(String)","u":"getNamespaceAllowedClustersAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getNamespaceAntiAffinityGroup(String)","u":"getNamespaceAntiAffinityGroup(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getNamespaceAntiAffinityGroupAsync(String)","u":"getNamespaceAntiAffinityGroupAsync(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"AuthPolicies","l":"getNamespaceAuthentication()"},{"p":"org.apache.pulsar.client.admin","c":"ResourceQuotas","l":"getNamespaceBundleResourceQuota(String, String)","u":"getNamespaceBundleResourceQuota(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"ResourceQuotas","l":"getNamespaceBundleResourceQuotaAsync(String, String)","u":"getNamespaceBundleResourceQuotaAsync(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getNamespaceEntryFilters(String)","u":"getNamespaceEntryFilters(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getNamespaceEntryFiltersAsync(String)","u":"getNamespaceEntryFiltersAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Clusters","l":"getNamespaceIsolationPolicies(String)","u":"getNamespaceIsolationPolicies(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Clusters","l":"getNamespaceIsolationPoliciesAsync(String)","u":"getNamespaceIsolationPoliciesAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Clusters","l":"getNamespaceIsolationPolicy(String, String)","u":"getNamespaceIsolationPolicy(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Clusters","l":"getNamespaceIsolationPolicyAsync(String, String)","u":"getNamespaceIsolationPolicyAsync(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getNamespaceMessageTTL(String)","u":"getNamespaceMessageTTL(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getNamespaceMessageTTLAsync(String)","u":"getNamespaceMessageTTLAsync(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"BrokerNamespaceIsolationData","l":"getNamespaceRegex()"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getNamespaceReplicationClusters(String)","u":"getNamespaceReplicationClusters(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getNamespaceReplicationClustersAsync(String)","u":"getNamespaceReplicationClustersAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getNamespaceResourceGroup(String)","u":"getNamespaceResourceGroup(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getNamespaceResourceGroupAsync(String)","u":"getNamespaceResourceGroupAsync(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"NamespaceIsolationData","l":"getNamespaces()"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getNamespaces(String)","u":"getNamespaces(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getNamespaces(String, String)","u":"getNamespaces(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getNamespacesAsync(String)","u":"getNamespacesAsync(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"SubscriptionStats","l":"getNonContiguousDeletedMessagesRanges()"},{"p":"org.apache.pulsar.common.policies.data","c":"TopicStats","l":"getNonContiguousDeletedMessagesRanges()"},{"p":"org.apache.pulsar.common.policies.data","c":"SubscriptionStats","l":"getNonContiguousDeletedMessagesRangesSerializedSize()"},{"p":"org.apache.pulsar.common.policies.data","c":"TopicStats","l":"getNonContiguousDeletedMessagesRangesSerializedSize()"},{"p":"org.apache.pulsar.common.policies.data","c":"BundlesData","l":"getNumBundles()"},{"p":"org.apache.pulsar.policies.data.loadbalancer","c":"LoadManagerReport","l":"getNumBundles()"},{"p":"org.apache.pulsar.policies.data.loadbalancer","c":"LoadManagerReport","l":"getNumConsumers()"},{"p":"org.apache.pulsar.policies.data.loadbalancer","c":"LoadManagerReport","l":"getNumProducers()"},{"p":"org.apache.pulsar.policies.data.loadbalancer","c":"LoadManagerReport","l":"getNumTopics()"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getOffloadDeleteLagMs(String)","u":"getOffloadDeleteLagMs(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getOffloadDeleteLagMsAsync(String)","u":"getOffloadDeleteLagMsAsync(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"TopicStats","l":"getOffloadedStorageSize()"},{"p":"org.apache.pulsar.common.policies.data","c":"OffloadPolicies","l":"getOffloadersDirectory()"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getOffloadPolicies(String)","u":"getOffloadPolicies(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getOffloadPolicies(String)","u":"getOffloadPolicies(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getOffloadPolicies(String)","u":"getOffloadPolicies(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getOffloadPolicies(String, boolean)","u":"getOffloadPolicies(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getOffloadPolicies(String, boolean)","u":"getOffloadPolicies(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getOffloadPoliciesAsync(String)","u":"getOffloadPoliciesAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getOffloadPoliciesAsync(String)","u":"getOffloadPoliciesAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getOffloadPoliciesAsync(String)","u":"getOffloadPoliciesAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getOffloadPoliciesAsync(String, boolean)","u":"getOffloadPoliciesAsync(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getOffloadPoliciesAsync(String, boolean)","u":"getOffloadPoliciesAsync(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getOffloadThreshold(String)","u":"getOffloadThreshold(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getOffloadThresholdAsync(String)","u":"getOffloadThresholdAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getOffloadThresholdInSeconds(String)","u":"getOffloadThresholdInSeconds(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getOffloadThresholdInSecondsAsync(String)","u":"getOffloadThresholdInSecondsAsync(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"TopicStats","l":"getOldestBacklogMessageAgeSeconds()"},{"p":"org.apache.pulsar.common.policies.data","c":"TopicStats","l":"getOldestBacklogMessageSubscriptionName()"},{"p":"org.apache.pulsar.common.policies.data","c":"FunctionInstanceStatsData","l":"getOneMin()"},{"p":"org.apache.pulsar.common.policies.data","c":"FunctionStats","l":"getOneMin()"},{"p":"org.apache.pulsar.common.policies.data","c":"ReplicatorStats","l":"getOutboundConnectedSince()"},{"p":"org.apache.pulsar.common.policies.data","c":"ReplicatorStats","l":"getOutboundConnection()"},{"p":"org.apache.pulsar.client.admin","c":"Brokers","l":"getOwnedNamespaces(String, String)","u":"getOwnedNamespaces(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Brokers","l":"getOwnedNamespacesAsync(String, String)","u":"getOwnedNamespacesAsync(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"TopicStats","l":"getOwnerBroker()"},{"p":"org.apache.pulsar.common.policies.data","c":"AutoFailoverPolicyData","l":"getParameters()"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getPartitionedInternalStats(String)","u":"getPartitionedInternalStats(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getPartitionedInternalStatsAsync(String)","u":"getPartitionedInternalStatsAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getPartitionedStats(String, boolean)","u":"getPartitionedStats(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getPartitionedStats(String, boolean, boolean, boolean, boolean)","u":"getPartitionedStats(java.lang.String,boolean,boolean,boolean,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getPartitionedStats(String, boolean, GetStatsOptions)","u":"getPartitionedStats(java.lang.String,boolean,org.apache.pulsar.client.admin.GetStatsOptions)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getPartitionedStatsAsync(String, boolean)","u":"getPartitionedStatsAsync(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getPartitionedStatsAsync(String, boolean, boolean, boolean, boolean)","u":"getPartitionedStatsAsync(java.lang.String,boolean,boolean,boolean,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getPartitionedStatsAsync(String, boolean, GetStatsOptions)","u":"getPartitionedStatsAsync(java.lang.String,boolean,org.apache.pulsar.client.admin.GetStatsOptions)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getPartitionedTopicList(String)","u":"getPartitionedTopicList(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getPartitionedTopicList(String, ListTopicsOptions)","u":"getPartitionedTopicList(java.lang.String,org.apache.pulsar.client.admin.ListTopicsOptions)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getPartitionedTopicListAsync(String)","u":"getPartitionedTopicListAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getPartitionedTopicListAsync(String, ListTopicsOptions)","u":"getPartitionedTopicListAsync(java.lang.String,org.apache.pulsar.client.admin.ListTopicsOptions)"},{"p":"org.apache.pulsar.client.admin","c":"NonPersistentTopics","l":"getPartitionedTopicMetadata(String)","u":"getPartitionedTopicMetadata(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getPartitionedTopicMetadata(String)","u":"getPartitionedTopicMetadata(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"NonPersistentTopics","l":"getPartitionedTopicMetadataAsync(String)","u":"getPartitionedTopicMetadataAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getPartitionedTopicMetadataAsync(String)","u":"getPartitionedTopicMetadataAsync(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"NonPersistentPartitionedTopicStats","l":"getPartitions()"},{"p":"org.apache.pulsar.common.policies.data","c":"PartitionedTopicStats","l":"getPartitions()"},{"p":"org.apache.pulsar.common.policies.data","c":"ClusterData","l":"getPeerClusterNames()"},{"p":"org.apache.pulsar.client.admin","c":"Clusters","l":"getPeerClusterNames(String)","u":"getPeerClusterNames(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Clusters","l":"getPeerClusterNamesAsync(String)","u":"getPeerClusterNamesAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Transactions","l":"getPendingAckInternalStats(String, String, boolean)","u":"getPendingAckInternalStats(java.lang.String,java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Transactions","l":"getPendingAckInternalStatsAsync(String, String, boolean)","u":"getPendingAckInternalStatsAsync(java.lang.String,java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Transactions","l":"getPendingAckStats(String, String)","u":"getPendingAckStats(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Transactions","l":"getPendingAckStats(String, String, boolean)","u":"getPendingAckStats(java.lang.String,java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Transactions","l":"getPendingAckStatsAsync(String, String)","u":"getPendingAckStatsAsync(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Transactions","l":"getPendingAckStatsAsync(String, String, boolean)","u":"getPendingAckStatsAsync(java.lang.String,java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"BrokerStats","l":"getPendingBookieOpsStats()"},{"p":"org.apache.pulsar.client.admin","c":"BrokerStats","l":"getPendingBookieOpsStatsAsync()"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getPermissionOnSubscription(String)","u":"getPermissionOnSubscription(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getPermissionOnSubscriptionAsync(String)","u":"getPermissionOnSubscriptionAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getPermissions(String)","u":"getPermissions(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getPermissions(String)","u":"getPermissions(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getPermissionsAsync(String)","u":"getPermissionsAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getPermissionsAsync(String)","u":"getPermissionsAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getPersistence(String)","u":"getPersistence(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getPersistence(String)","u":"getPersistence(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getPersistence(String)","u":"getPersistence(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getPersistence(String, boolean)","u":"getPersistence(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getPersistence(String, boolean)","u":"getPersistence(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getPersistenceAsync(String)","u":"getPersistenceAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getPersistenceAsync(String)","u":"getPersistenceAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getPersistenceAsync(String)","u":"getPersistenceAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getPersistenceAsync(String, boolean)","u":"getPersistenceAsync(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getPersistenceAsync(String, boolean)","u":"getPersistenceAsync(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getPolicies(String)","u":"getPolicies(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getPoliciesAsync(String)","u":"getPoliciesAsync(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"BacklogQuota","l":"getPolicy()"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"BacklogQuotaImpl","l":"getPolicy()"},{"p":"org.apache.pulsar.common.policies.data","c":"BrokerNamespaceIsolationData","l":"getPolicyName()"},{"p":"org.apache.pulsar.common.policies.data","c":"AutoFailoverPolicyData","l":"getPolicyType()"},{"p":"org.apache.pulsar.client.admin","c":"Transactions","l":"getPositionStatsInPendingAck(String, String, Long, Long, Integer)","u":"getPositionStatsInPendingAck(java.lang.String,java.lang.String,java.lang.Long,java.lang.Long,java.lang.Integer)"},{"p":"org.apache.pulsar.client.admin","c":"Transactions","l":"getPositionStatsInPendingAckAsync(String, String, Long, Long, Integer)","u":"getPositionStatsInPendingAckAsync(java.lang.String,java.lang.String,java.lang.Long,java.lang.Long,java.lang.Integer)"},{"p":"org.apache.pulsar.common.policies.data","c":"NamespaceIsolationData","l":"getPrimary()"},{"p":"org.apache.pulsar.common.policies.data","c":"FunctionInstanceStatsDataBase","l":"getProcessedSuccessfullyTotal()"},{"p":"org.apache.pulsar.common.policies.data","c":"FunctionStats","l":"getProcessedSuccessfullyTotal()"},{"p":"org.apache.pulsar.common.policies.data","c":"PublisherStats","l":"getProducerId()"},{"p":"org.apache.pulsar.common.policies.data","c":"PublisherStats","l":"getProducerName()"},{"p":"org.apache.pulsar.client.admin","c":"Properties","l":"getProperties()"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getProperties(String)","u":"getProperties(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getProperties(String)","u":"getProperties(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getPropertiesAsync(String)","u":"getPropertiesAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getPropertiesAsync(String)","u":"getPropertiesAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getProperty(String, String)","u":"getProperty(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Properties","l":"getPropertyAdmin(String)","u":"getPropertyAdmin(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getPropertyAsync(String, String)","u":"getPropertyAsync(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.policies.data.loadbalancer","c":"ServiceLookupData","l":"getProtocol(String)","u":"getProtocol(java.lang.String)"},{"p":"org.apache.pulsar.policies.data.loadbalancer","c":"ServiceLookupData","l":"getProtocols()"},{"p":"org.apache.pulsar.common.policies.data","c":"ClusterData","l":"getProxyProtocol()"},{"p":"org.apache.pulsar.common.policies.data","c":"ClusterData","l":"getProxyServiceUrl()"},{"p":"org.apache.pulsar.common.policies.data","c":"NonPersistentTopicStats","l":"getPublishers()"},{"p":"org.apache.pulsar.common.policies.data","c":"TopicStats","l":"getPublishers()"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getPublishRate(String)","u":"getPublishRate(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getPublishRate(String)","u":"getPublishRate(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getPublishRate(String)","u":"getPublishRate(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getPublishRateAsync(String)","u":"getPublishRateAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getPublishRateAsync(String)","u":"getPublishRateAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getPublishRateAsync(String)","u":"getPublishRateAsync(java.lang.String)"},{"p":"org.apache.pulsar.policies.data.loadbalancer","c":"ServiceLookupData","l":"getPulsarServiceUrl()"},{"p":"org.apache.pulsar.policies.data.loadbalancer","c":"ServiceLookupData","l":"getPulsarServiceUrlTls()"},{"p":"org.apache.pulsar.common.policies.data","c":"BookieInfo","l":"getRack()"},{"p":"org.apache.pulsar.common.policies.data","c":"DispatchRate","l":"getRatePeriodInSecond()"},{"p":"org.apache.pulsar.common.policies.data","c":"ConsumerStats","l":"getReadPositionWhenJoining()"},{"p":"org.apache.pulsar.common.policies.data","c":"FunctionInstanceStatsDataBase","l":"getReceivedTotal()"},{"p":"org.apache.pulsar.common.policies.data","c":"FunctionStats","l":"getReceivedTotal()"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getReplicatedSubscriptionStatus(String, String)","u":"getReplicatedSubscriptionStatus(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getReplicatedSubscriptionStatusAsync(String, String)","u":"getReplicatedSubscriptionStatusAsync(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"NonPersistentTopicStats","l":"getReplication()"},{"p":"org.apache.pulsar.common.policies.data","c":"TopicStats","l":"getReplication()"},{"p":"org.apache.pulsar.common.policies.data","c":"ReplicatorStats","l":"getReplicationBacklog()"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getReplicationClusters(String, boolean)","u":"getReplicationClusters(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getReplicationClustersAsync(String, boolean)","u":"getReplicationClustersAsync(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getReplicationConfigVersion(String)","u":"getReplicationConfigVersion(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getReplicationConfigVersionAsync(String)","u":"getReplicationConfigVersionAsync(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"ReplicatorStats","l":"getReplicationDelayInSeconds()"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getReplicatorDispatchRate(String)","u":"getReplicatorDispatchRate(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getReplicatorDispatchRate(String)","u":"getReplicatorDispatchRate(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getReplicatorDispatchRate(String)","u":"getReplicatorDispatchRate(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getReplicatorDispatchRate(String, boolean)","u":"getReplicatorDispatchRate(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getReplicatorDispatchRate(String, boolean)","u":"getReplicatorDispatchRate(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getReplicatorDispatchRateAsync(String)","u":"getReplicatorDispatchRateAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getReplicatorDispatchRateAsync(String)","u":"getReplicatorDispatchRateAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getReplicatorDispatchRateAsync(String)","u":"getReplicatorDispatchRateAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getReplicatorDispatchRateAsync(String, boolean)","u":"getReplicatorDispatchRateAsync(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getReplicatorDispatchRateAsync(String, boolean)","u":"getReplicatorDispatchRateAsync(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"ResourceGroups","l":"getResourceGroup(String)","u":"getResourceGroup(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"ResourceGroups","l":"getResourceGroupAsync(String)","u":"getResourceGroupAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"ResourceGroups","l":"getResourceGroups()"},{"p":"org.apache.pulsar.client.admin","c":"ResourceGroups","l":"getResourceGroupsAsync()"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getRetention(String)","u":"getRetention(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getRetention(String)","u":"getRetention(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getRetention(String)","u":"getRetention(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getRetention(String, boolean)","u":"getRetention(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getRetention(String, boolean)","u":"getRetention(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getRetentionAsync(String)","u":"getRetentionAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getRetentionAsync(String)","u":"getRetentionAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getRetentionAsync(String)","u":"getRetentionAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getRetentionAsync(String, boolean)","u":"getRetentionAsync(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getRetentionAsync(String, boolean)","u":"getRetentionAsync(java.lang.String,boolean)"},{"p":"org.apache.pulsar.common.policies.data","c":"RetentionPolicies","l":"getRetentionSizeInMB()"},{"p":"org.apache.pulsar.common.policies.data","c":"RetentionPolicies","l":"getRetentionTimeInMinutes()"},{"p":"org.apache.pulsar.client.admin","c":"Brokers","l":"getRuntimeConfigurations()"},{"p":"org.apache.pulsar.client.admin","c":"Brokers","l":"getRuntimeConfigurationsAsync()"},{"p":"org.apache.pulsar.common.policies.data","c":"OffloadPolicies","l":"getS3ManagedLedgerOffloadBucket()"},{"p":"org.apache.pulsar.common.policies.data","c":"OffloadPolicies","l":"getS3ManagedLedgerOffloadCredentialId()"},{"p":"org.apache.pulsar.common.policies.data","c":"OffloadPolicies","l":"getS3ManagedLedgerOffloadCredentialSecret()"},{"p":"org.apache.pulsar.common.policies.data","c":"OffloadPolicies","l":"getS3ManagedLedgerOffloadMaxBlockSizeInBytes()"},{"p":"org.apache.pulsar.common.policies.data","c":"OffloadPolicies","l":"getS3ManagedLedgerOffloadReadBufferSizeInBytes()"},{"p":"org.apache.pulsar.common.policies.data","c":"OffloadPolicies","l":"getS3ManagedLedgerOffloadRegion()"},{"p":"org.apache.pulsar.common.policies.data","c":"OffloadPolicies","l":"getS3ManagedLedgerOffloadRole()"},{"p":"org.apache.pulsar.common.policies.data","c":"OffloadPolicies","l":"getS3ManagedLedgerOffloadRoleSessionName()"},{"p":"org.apache.pulsar.common.policies.data","c":"OffloadPolicies","l":"getS3ManagedLedgerOffloadServiceEndpoint()"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getSchemaAutoUpdateCompatibilityStrategy(String)","u":"getSchemaAutoUpdateCompatibilityStrategy(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getSchemaCompatibilityStrategy(String)","u":"getSchemaCompatibilityStrategy(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getSchemaCompatibilityStrategy(String, boolean)","u":"getSchemaCompatibilityStrategy(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getSchemaCompatibilityStrategyAsync(String)","u":"getSchemaCompatibilityStrategyAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getSchemaCompatibilityStrategyAsync(String, boolean)","u":"getSchemaCompatibilityStrategyAsync(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Schemas","l":"getSchemaInfo(String)","u":"getSchemaInfo(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Schemas","l":"getSchemaInfo(String, long)","u":"getSchemaInfo(java.lang.String,long)"},{"p":"org.apache.pulsar.client.admin","c":"Schemas","l":"getSchemaInfoAsync(String)","u":"getSchemaInfoAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Schemas","l":"getSchemaInfoAsync(String, long)","u":"getSchemaInfoAsync(java.lang.String,long)"},{"p":"org.apache.pulsar.client.admin","c":"Schemas","l":"getSchemaInfoWithVersion(String)","u":"getSchemaInfoWithVersion(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Schemas","l":"getSchemaInfoWithVersionAsync(String)","u":"getSchemaInfoWithVersionAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Schemas","l":"getSchemaMetadata(String)","u":"getSchemaMetadata(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Schemas","l":"getSchemaMetadataAsync(String)","u":"getSchemaMetadataAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getSchemaValidationEnforced(String)","u":"getSchemaValidationEnforced(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getSchemaValidationEnforced(String, boolean)","u":"getSchemaValidationEnforced(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getSchemaValidationEnforced(String, boolean)","u":"getSchemaValidationEnforced(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getSchemaValidationEnforcedAsync(String)","u":"getSchemaValidationEnforcedAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getSchemaValidationEnforcedAsync(String, boolean)","u":"getSchemaValidationEnforcedAsync(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getSchemaValidationEnforcedAsync(String, boolean)","u":"getSchemaValidationEnforcedAsync(java.lang.String,boolean)"},{"p":"org.apache.pulsar.common.policies.data","c":"NamespaceIsolationData","l":"getSecondary()"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdmin","l":"getServiceUrl()"},{"p":"org.apache.pulsar.common.policies.data","c":"BrokerInfo","l":"getServiceUrl()"},{"p":"org.apache.pulsar.common.policies.data","c":"ClusterData","l":"getServiceUrl()"},{"p":"org.apache.pulsar.common.policies.data","c":"ClusterData","l":"getServiceUrlTls()"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getShadowSource(String)","u":"getShadowSource(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getShadowSourceAsync(String)","u":"getShadowSourceAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getShadowTopics(String)","u":"getShadowTopics(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getShadowTopicsAsync(String)","u":"getShadowTopicsAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Sinks","l":"getSink(String, String, String)","u":"getSink(java.lang.String,java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Sinks","l":"getSinkAsync(String, String, String)","u":"getSinkAsync(java.lang.String,java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Functions","l":"getSinks()"},{"p":"org.apache.pulsar.client.admin","c":"Sinks","l":"getSinkStatus(String, String, String)","u":"getSinkStatus(java.lang.String,java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Sinks","l":"getSinkStatus(String, String, String, int)","u":"getSinkStatus(java.lang.String,java.lang.String,java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"Sinks","l":"getSinkStatusAsync(String, String, String)","u":"getSinkStatusAsync(java.lang.String,java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Sinks","l":"getSinkStatusAsync(String, String, String, int)","u":"getSinkStatusAsync(java.lang.String,java.lang.String,java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"Transactions","l":"getSlowTransactions(long, TimeUnit)","u":"getSlowTransactions(long,java.util.concurrent.TimeUnit)"},{"p":"org.apache.pulsar.client.admin","c":"Transactions","l":"getSlowTransactionsAsync(long, TimeUnit)","u":"getSlowTransactionsAsync(long,java.util.concurrent.TimeUnit)"},{"p":"org.apache.pulsar.client.admin","c":"Transactions","l":"getSlowTransactionsByCoordinatorId(Integer, long, TimeUnit)","u":"getSlowTransactionsByCoordinatorId(java.lang.Integer,long,java.util.concurrent.TimeUnit)"},{"p":"org.apache.pulsar.client.admin","c":"Transactions","l":"getSlowTransactionsByCoordinatorIdAsync(Integer, long, TimeUnit)","u":"getSlowTransactionsByCoordinatorIdAsync(java.lang.Integer,long,java.util.concurrent.TimeUnit)"},{"p":"org.apache.pulsar.client.admin","c":"Sources","l":"getSource(String, String, String)","u":"getSource(java.lang.String,java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Sources","l":"getSourceAsync(String, String, String)","u":"getSourceAsync(java.lang.String,java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Functions","l":"getSources()"},{"p":"org.apache.pulsar.client.admin","c":"Sources","l":"getSourceStatus(String, String, String)","u":"getSourceStatus(java.lang.String,java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Sources","l":"getSourceStatus(String, String, String, int)","u":"getSourceStatus(java.lang.String,java.lang.String,java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"Sources","l":"getSourceStatusAsync(String, String, String)","u":"getSourceStatusAsync(java.lang.String,java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Sources","l":"getSourceStatusAsync(String, String, String, int)","u":"getSourceStatusAsync(java.lang.String,java.lang.String,java.lang.String,int)"},{"p":"org.apache.pulsar.policies.data.loadbalancer","c":"ServiceLookupData","l":"getStartTimestamp()"},{"p":"org.apache.pulsar.common.conf","c":"InternalConfigurationData","l":"getStateStorageServiceUrl()"},{"p":"org.apache.pulsar.client.admin","c":"NonPersistentTopics","l":"getStats(String)","u":"getStats(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getStats(String)","u":"getStats(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getStats(String, boolean)","u":"getStats(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getStats(String, boolean, boolean)","u":"getStats(java.lang.String,boolean,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getStats(String, boolean, boolean, boolean)","u":"getStats(java.lang.String,boolean,boolean,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getStats(String, GetStatsOptions)","u":"getStats(java.lang.String,org.apache.pulsar.client.admin.GetStatsOptions)"},{"p":"org.apache.pulsar.client.admin","c":"NonPersistentTopics","l":"getStatsAsync(String)","u":"getStatsAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getStatsAsync(String)","u":"getStatsAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getStatsAsync(String, boolean, boolean, boolean)","u":"getStatsAsync(java.lang.String,boolean,boolean,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getStatsAsync(String, GetStatsOptions)","u":"getStatsAsync(java.lang.String,org.apache.pulsar.client.admin.GetStatsOptions)"},{"p":"org.apache.pulsar.client.admin","c":"GetStatsOptions","l":"GetStatsOptions()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.client.admin","c":"OffloadProcessStatus","l":"getStatus()"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdminException","l":"getStatusCode()"},{"p":"org.apache.pulsar.common.policies.data","c":"TopicStats","l":"getStorageSize()"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getSubscribeRate(String)","u":"getSubscribeRate(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getSubscribeRate(String)","u":"getSubscribeRate(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getSubscribeRate(String)","u":"getSubscribeRate(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getSubscribeRate(String, boolean)","u":"getSubscribeRate(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getSubscribeRate(String, boolean)","u":"getSubscribeRate(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getSubscribeRateAsync(String)","u":"getSubscribeRateAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getSubscribeRateAsync(String)","u":"getSubscribeRateAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getSubscribeRateAsync(String)","u":"getSubscribeRateAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getSubscribeRateAsync(String, boolean)","u":"getSubscribeRateAsync(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getSubscribeRateAsync(String, boolean)","u":"getSubscribeRateAsync(java.lang.String,boolean)"},{"p":"org.apache.pulsar.common.policies.data","c":"AuthPolicies","l":"getSubscriptionAuthentication()"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getSubscriptionAuthMode(String)","u":"getSubscriptionAuthMode(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getSubscriptionAuthModeAsync(String)","u":"getSubscriptionAuthModeAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getSubscriptionDispatchRate(String)","u":"getSubscriptionDispatchRate(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getSubscriptionDispatchRate(String)","u":"getSubscriptionDispatchRate(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getSubscriptionDispatchRate(String)","u":"getSubscriptionDispatchRate(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getSubscriptionDispatchRate(String, boolean)","u":"getSubscriptionDispatchRate(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getSubscriptionDispatchRate(String, boolean)","u":"getSubscriptionDispatchRate(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getSubscriptionDispatchRate(String, String)","u":"getSubscriptionDispatchRate(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getSubscriptionDispatchRate(String, String, boolean)","u":"getSubscriptionDispatchRate(java.lang.String,java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getSubscriptionDispatchRateAsync(String)","u":"getSubscriptionDispatchRateAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getSubscriptionDispatchRateAsync(String)","u":"getSubscriptionDispatchRateAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getSubscriptionDispatchRateAsync(String)","u":"getSubscriptionDispatchRateAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getSubscriptionDispatchRateAsync(String, boolean)","u":"getSubscriptionDispatchRateAsync(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getSubscriptionDispatchRateAsync(String, boolean)","u":"getSubscriptionDispatchRateAsync(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getSubscriptionDispatchRateAsync(String, String)","u":"getSubscriptionDispatchRateAsync(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getSubscriptionDispatchRateAsync(String, String, boolean)","u":"getSubscriptionDispatchRateAsync(java.lang.String,java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getSubscriptionExpirationTime(String)","u":"getSubscriptionExpirationTime(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getSubscriptionExpirationTimeAsync(String)","u":"getSubscriptionExpirationTimeAsync(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"SubscriptionStats","l":"getSubscriptionProperties()"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getSubscriptionProperties(String, String)","u":"getSubscriptionProperties(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getSubscriptionPropertiesAsync(String, String)","u":"getSubscriptionPropertiesAsync(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"NonPersistentTopicStats","l":"getSubscriptions()"},{"p":"org.apache.pulsar.common.policies.data","c":"TopicStats","l":"getSubscriptions()"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getSubscriptions(String)","u":"getSubscriptions(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getSubscriptionsAsync(String)","u":"getSubscriptionsAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getSubscriptionTypesEnabled(String)","u":"getSubscriptionTypesEnabled(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getSubscriptionTypesEnabled(String)","u":"getSubscriptionTypesEnabled(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getSubscriptionTypesEnabled(String)","u":"getSubscriptionTypesEnabled(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getSubscriptionTypesEnabledAsync(String)","u":"getSubscriptionTypesEnabledAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"getSubscriptionTypesEnabledAsync(String)","u":"getSubscriptionTypesEnabledAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"getSubscriptionTypesEnabledAsync(String)","u":"getSubscriptionTypesEnabledAsync(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"FunctionInstanceStatsDataBase","l":"getSystemExceptionsTotal()"},{"p":"org.apache.pulsar.common.policies.data","c":"FunctionStats","l":"getSystemExceptionsTotal()"},{"p":"org.apache.pulsar.client.admin","c":"Tenants","l":"getTenantInfo(String)","u":"getTenantInfo(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Tenants","l":"getTenantInfoAsync(String)","u":"getTenantInfoAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Tenants","l":"getTenants()"},{"p":"org.apache.pulsar.client.admin","c":"Tenants","l":"getTenantsAsync()"},{"p":"org.apache.pulsar.common.policies.data","c":"DelayedDeliveryPolicies","l":"getTickTime()"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdminException.GettingAuthenticationDataException","l":"GettingAuthenticationDataException(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdminException.GettingAuthenticationDataException","l":"GettingAuthenticationDataException(Throwable)","u":"%3Cinit%3E(java.lang.Throwable)"},{"p":"org.apache.pulsar.common.policies.data","c":"AuthPolicies","l":"getTopicAuthentication()"},{"p":"org.apache.pulsar.common.policies.data","c":"TopicStats","l":"getTopicEpoch()"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getTopicHashPositions(String, String, List)","u":"getTopicHashPositions(java.lang.String,java.lang.String,java.util.List)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getTopicHashPositionsAsync(String, String, List)","u":"getTopicHashPositionsAsync(java.lang.String,java.lang.String,java.util.List)"},{"p":"org.apache.pulsar.client.admin","c":"BrokerStats","l":"getTopics()"},{"p":"org.apache.pulsar.client.admin","c":"ProxyStats","l":"getTopics()"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getTopics(String)","u":"getTopics(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getTopics(String, ListNamespaceTopicsOptions)","u":"getTopics(java.lang.String,org.apache.pulsar.client.admin.ListNamespaceTopicsOptions)"},{"p":"org.apache.pulsar.client.admin","c":"BrokerStats","l":"getTopicsAsync()"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getTopicsAsync(String)","u":"getTopicsAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"getTopicsAsync(String, ListNamespaceTopicsOptions)","u":"getTopicsAsync(java.lang.String,org.apache.pulsar.client.admin.ListNamespaceTopicsOptions)"},{"p":"org.apache.pulsar.common.policies.data","c":"AutoTopicCreationOverride","l":"getTopicType()"},{"p":"org.apache.pulsar.common.policies.data","c":"SubscriptionStats","l":"getTotalMsgExpired()"},{"p":"org.apache.pulsar.client.admin","c":"Transactions","l":"getTransactionBufferInternalStats(String, boolean)","u":"getTransactionBufferInternalStats(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Transactions","l":"getTransactionBufferInternalStatsAsync(String, boolean)","u":"getTransactionBufferInternalStatsAsync(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Transactions","l":"getTransactionBufferStats(String)","u":"getTransactionBufferStats(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Transactions","l":"getTransactionBufferStats(String, boolean)","u":"getTransactionBufferStats(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Transactions","l":"getTransactionBufferStats(String, boolean, boolean)","u":"getTransactionBufferStats(java.lang.String,boolean,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Transactions","l":"getTransactionBufferStatsAsync(String)","u":"getTransactionBufferStatsAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Transactions","l":"getTransactionBufferStatsAsync(String, boolean)","u":"getTransactionBufferStatsAsync(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Transactions","l":"getTransactionBufferStatsAsync(String, boolean, boolean)","u":"getTransactionBufferStatsAsync(java.lang.String,boolean,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Transactions","l":"getTransactionInBufferStats(TxnID, String)","u":"getTransactionInBufferStats(org.apache.pulsar.client.api.transaction.TxnID,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Transactions","l":"getTransactionInBufferStatsAsync(TxnID, String)","u":"getTransactionInBufferStatsAsync(org.apache.pulsar.client.api.transaction.TxnID,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Transactions","l":"getTransactionInPendingAckStats(TxnID, String, String)","u":"getTransactionInPendingAckStats(org.apache.pulsar.client.api.transaction.TxnID,java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Transactions","l":"getTransactionInPendingAckStatsAsync(TxnID, String, String)","u":"getTransactionInPendingAckStatsAsync(org.apache.pulsar.client.api.transaction.TxnID,java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Transactions","l":"getTransactionMetadata(TxnID)","u":"getTransactionMetadata(org.apache.pulsar.client.api.transaction.TxnID)"},{"p":"org.apache.pulsar.client.admin","c":"Transactions","l":"getTransactionMetadataAsync(TxnID)","u":"getTransactionMetadataAsync(org.apache.pulsar.client.api.transaction.TxnID)"},{"p":"org.apache.pulsar.common.policies.data","c":"SubscriptionStats","l":"getType()"},{"p":"org.apache.pulsar.common.policies.data","c":"ConsumerStats","l":"getUnackedMessages()"},{"p":"org.apache.pulsar.common.policies.data","c":"SubscriptionStats","l":"getUnackedMessages()"},{"p":"org.apache.pulsar.common.policies.data","c":"DrainingHash","l":"getUnackMsgs()"},{"p":"org.apache.pulsar.common.policies.data","c":"NamespaceIsolationData","l":"getUnloadScope()"},{"p":"org.apache.pulsar.common.policies.data","c":"FunctionInstanceStatsDataBase","l":"getUserExceptionsTotal()"},{"p":"org.apache.pulsar.common.policies.data","c":"FunctionStats","l":"getUserExceptionsTotal()"},{"p":"org.apache.pulsar.common.policies.data","c":"FunctionInstanceStatsData","l":"getUserMetrics()"},{"p":"org.apache.pulsar.client.admin","c":"Mode","l":"getValue()"},{"p":"org.apache.pulsar.common.policies.data","c":"OffloadedReadPriority","l":"getValue()"},{"p":"org.apache.pulsar.client.admin","c":"Brokers","l":"getVersion()"},{"p":"org.apache.pulsar.client.admin","c":"Schemas","l":"getVersionBySchema(String, PostSchemaPayload)","u":"getVersionBySchema(java.lang.String,org.apache.pulsar.common.protocol.schema.PostSchemaPayload)"},{"p":"org.apache.pulsar.client.admin","c":"Schemas","l":"getVersionBySchema(String, SchemaInfo)","u":"getVersionBySchema(java.lang.String,org.apache.pulsar.common.schema.SchemaInfo)"},{"p":"org.apache.pulsar.client.admin","c":"Schemas","l":"getVersionBySchemaAsync(String, PostSchemaPayload)","u":"getVersionBySchemaAsync(java.lang.String,org.apache.pulsar.common.protocol.schema.PostSchemaPayload)"},{"p":"org.apache.pulsar.client.admin","c":"Schemas","l":"getVersionBySchemaAsync(String, SchemaInfo)","u":"getVersionBySchemaAsync(java.lang.String,org.apache.pulsar.common.schema.SchemaInfo)"},{"p":"org.apache.pulsar.common.policies.data","c":"TopicStats","l":"getWaitingPublishers()"},{"p":"org.apache.pulsar.policies.data.loadbalancer","c":"ServiceLookupData","l":"getWebServiceUrl()"},{"p":"org.apache.pulsar.policies.data.loadbalancer","c":"ServiceLookupData","l":"getWebServiceUrlTls()"},{"p":"org.apache.pulsar.common.conf","c":"InternalConfigurationData","l":"getZookeeperServers()"},{"p":"org.apache.pulsar.common.functions","c":"FunctionConfig.Runtime","l":"GO"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"grantPermission(String, String, Set)","u":"grantPermission(java.lang.String,java.lang.String,java.util.Set)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"grantPermissionAsync(String, String, Set)","u":"grantPermissionAsync(java.lang.String,java.lang.String,java.util.Set)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"grantPermissionOnNamespace(String, String, Set)","u":"grantPermissionOnNamespace(java.lang.String,java.lang.String,java.util.Set)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"grantPermissionOnNamespaceAsync(String, String, Set)","u":"grantPermissionOnNamespaceAsync(java.lang.String,java.lang.String,java.util.Set)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"grantPermissionOnSubscription(String, String, Set)","u":"grantPermissionOnSubscription(java.lang.String,java.lang.String,java.util.Set)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"grantPermissionOnSubscriptionAsync(String, String, Set)","u":"grantPermissionOnSubscriptionAsync(java.lang.String,java.lang.String,java.util.Set)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"grantPermissionOnTopics(List)","u":"grantPermissionOnTopics(java.util.List)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"grantPermissionOnTopicsAsync(List)","u":"grantPermissionOnTopicsAsync(java.util.List)"},{"p":"org.apache.pulsar.client.admin","c":"GrantTopicPermissionOptions","l":"GrantTopicPermissionOptions()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.conf","c":"InternalConfigurationData","l":"hashCode()"},{"p":"org.apache.pulsar.common.policies.data","c":"PersistencePolicies","l":"hashCode()"},{"p":"org.apache.pulsar.common.policies.data","c":"Policies","l":"hashCode()"},{"p":"org.apache.pulsar.common.policies.data","c":"PublishRate","l":"hashCode()"},{"p":"org.apache.pulsar.common.policies.data","c":"RetentionPolicies","l":"hashCode()"},{"p":"org.apache.pulsar.common.policies.data","c":"SubscribeRate","l":"hashCode()"},{"p":"org.apache.pulsar.common.stats","c":"Metrics","l":"hashCode()"},{"p":"org.apache.pulsar.client.admin","c":"Brokers","l":"healthcheck()"},{"p":"org.apache.pulsar.client.admin","c":"Brokers","l":"healthcheck(TopicVersion)","u":"healthcheck(org.apache.pulsar.common.naming.TopicVersion)"},{"p":"org.apache.pulsar.client.admin","c":"Brokers","l":"healthcheck(TopicVersion, Optional)","u":"healthcheck(org.apache.pulsar.common.naming.TopicVersion,java.util.Optional)"},{"p":"org.apache.pulsar.client.admin","c":"Brokers","l":"healthcheckAsync()"},{"p":"org.apache.pulsar.client.admin","c":"Brokers","l":"healthcheckAsync(TopicVersion, Optional)","u":"healthcheckAsync(org.apache.pulsar.common.naming.TopicVersion,java.util.Optional)"},{"p":"org.apache.pulsar.common.stats","c":"AllocatorStats","l":"heapArenas"},{"p":"org.apache.pulsar.common.policies.data","c":"BookieInfo.Builder","l":"hostname(String)","u":"hostname(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"BookieInfoImpl.BookieInfoImplBuilder","l":"hostname(String)","u":"hostname(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"Policies.BundleType","l":"HOT"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdminException.HttpErrorException","l":"HttpErrorException(Exception)","u":"%3Cinit%3E(java.lang.Exception)"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdminException.HttpErrorException","l":"HttpErrorException(Throwable)","u":"%3Cinit%3E(java.lang.Throwable)"},{"p":"org.apache.pulsar.common.policies.data","c":"Policies","l":"inactive_topic_policies"},{"p":"org.apache.pulsar.common.policies.data","c":"InactiveTopicPolicies","l":"InactiveTopicPolicies()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data","c":"SchemaMetadata","l":"index"},{"p":"org.apache.pulsar.common.policies.data","c":"ManagedLedgerInternalStats.CursorStats","l":"individuallyDeletedMessages"},{"p":"org.apache.pulsar.common.policies.data","c":"SchemaMetadata","l":"info"},{"p":"org.apache.pulsar.common.policies.data","c":"FunctionStatus.FunctionInstanceStatus","l":"instanceId"},{"p":"org.apache.pulsar.common.policies.data","c":"SinkStatus.SinkInstanceStatus","l":"instanceId"},{"p":"org.apache.pulsar.common.policies.data","c":"SourceStatus.SourceInstanceStatus","l":"instanceId"},{"p":"org.apache.pulsar.common.policies.data","c":"FunctionStatus","l":"instances"},{"p":"org.apache.pulsar.common.policies.data","c":"SinkStatus","l":"instances"},{"p":"org.apache.pulsar.common.policies.data","c":"SourceStatus","l":"instances"},{"p":"org.apache.pulsar.common.conf","c":"InternalConfigurationData","l":"InternalConfigurationData()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.conf","c":"InternalConfigurationData","l":"InternalConfigurationData(String, String, String, String, String)","u":"%3Cinit%3E(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.common.stats","c":"PositionInPendingAckStats.State","l":"InvalidPosition"},{"p":"org.apache.pulsar.common.policies.data","c":"NamespaceOwnershipStatus","l":"is_active"},{"p":"org.apache.pulsar.common.policies.data","c":"Policies","l":"is_allow_auto_update_schema"},{"p":"org.apache.pulsar.common.policies.data","c":"NamespaceOwnershipStatus","l":"is_controlled"},{"p":"org.apache.pulsar.common.policies.data","c":"BrokerStatus","l":"isActive()"},{"p":"org.apache.pulsar.common.policies.data","c":"DelayedDeliveryPolicies","l":"isActive()"},{"p":"org.apache.pulsar.common.policies.data","c":"AutoSubscriptionCreationOverride","l":"isAllowAutoSubscriptionCreation()"},{"p":"org.apache.pulsar.common.policies.data","c":"AutoTopicCreationOverride","l":"isAllowAutoTopicCreation()"},{"p":"org.apache.pulsar.common.policies.data","c":"SubscriptionStats","l":"isAllowOutOfOrderDelivery()"},{"p":"org.apache.pulsar.common.policies.data","c":"ConsumerStats","l":"isBlockedConsumerOnUnackedMsgs()"},{"p":"org.apache.pulsar.common.policies.data","c":"SubscriptionStats","l":"isBlockedSubscriptionOnUnackedMsgs()"},{"p":"org.apache.pulsar.common.policies","c":"AutoFailoverPolicy","l":"isBrokerAvailable(BrokerStatus)","u":"isBrokerAvailable(org.apache.pulsar.common.policies.data.BrokerStatus)"},{"p":"org.apache.pulsar.common.policies.impl","c":"MinAvailablePolicy","l":"isBrokerAvailable(BrokerStatus)","u":"isBrokerAvailable(org.apache.pulsar.common.policies.data.BrokerStatus)"},{"p":"org.apache.pulsar.common.policies.data","c":"ClusterData","l":"isBrokerClientTlsEnabled()"},{"p":"org.apache.pulsar.common.policies.data","c":"ClusterData","l":"isBrokerClientTlsEnabledWithKeyStore()"},{"p":"org.apache.pulsar.common.protocol.schema","c":"IsCompatibilityResponse","l":"IsCompatibilityResponse()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data","c":"ReplicatorStats","l":"isConnected()"},{"p":"org.apache.pulsar.common.policies.data","c":"SubscriptionStats","l":"isDurable()"},{"p":"org.apache.pulsar.common.policies.data","c":"ClusterPolicies.ClusterUrl","l":"isEmpty()"},{"p":"org.apache.pulsar.common.policies.data","c":"ClusterPolicies","l":"isMigrated()"},{"p":"org.apache.pulsar.common.policies.data","c":"TopicStats","l":"isMsgChunkPublished()"},{"p":"org.apache.pulsar.policies.data.loadbalancer","c":"LoadManagerReport","l":"isNonPersistentTopicsEnabled()"},{"p":"org.apache.pulsar.policies.data.loadbalancer","c":"LoadManagerReport","l":"isPersistentTopicsEnabled()"},{"p":"org.apache.pulsar.common.policies.data","c":"BrokerNamespaceIsolationData","l":"isPrimary()"},{"p":"org.apache.pulsar.common.policies.data","c":"DispatchRate","l":"isRelativeToPublishRate()"},{"p":"org.apache.pulsar.common.policies.data","c":"SubscriptionStats","l":"isReplicated()"},{"p":"org.apache.pulsar.common.policies.data","c":"PublisherStats","l":"isSupportsPartialProducer()"},{"p":"org.apache.pulsar.common.policies.data","c":"ClusterData","l":"isTlsAllowInsecureConnection()"},{"p":"org.apache.pulsar.common.policies.data","c":"SchemaCompatibilityStrategy","l":"isUndefined(SchemaCompatibilityStrategy)","u":"isUndefined(org.apache.pulsar.common.policies.data.SchemaCompatibilityStrategy)"},{"p":"org.apache.pulsar.common.functions","c":"UpdateOptions","l":"isUpdateAuthData()"},{"p":"org.apache.pulsar.common.policies.data","c":"TopicType","l":"isValidTopicType(String)","u":"isValidTopicType(java.lang.String)"},{"p":"org.apache.pulsar.common.functions","c":"FunctionConfig.Runtime","l":"JAVA"},{"p":"org.apache.pulsar.common.policies.data","c":"Policies.BundleType","l":"LARGEST"},{"p":"org.apache.pulsar.common.policies.data","c":"Policies","l":"LAST_BOUNDARY"},{"p":"org.apache.pulsar.common.policies.data","c":"ManagedLedgerInternalStats","l":"lastConfirmedEntry"},{"p":"org.apache.pulsar.client.admin","c":"LongRunningProcessStatus","l":"lastError"},{"p":"org.apache.pulsar.common.policies.data","c":"FunctionStatus.FunctionInstanceStatus.FunctionInstanceStatusData","l":"lastInvocationTime"},{"p":"org.apache.pulsar.common.policies.data","c":"ManagedLedgerInternalStats","l":"lastLedgerCreatedTimestamp"},{"p":"org.apache.pulsar.common.policies.data","c":"ManagedLedgerInternalStats","l":"lastLedgerCreationFailureTimestamp"},{"p":"org.apache.pulsar.common.policies.data","c":"ManagedLedgerInternalStats.CursorStats","l":"lastLedgerSwitchTimestamp"},{"p":"org.apache.pulsar.common.policies.data","c":"SinkStatus.SinkInstanceStatus.SinkInstanceStatusData","l":"lastReceivedTime"},{"p":"org.apache.pulsar.common.policies.data","c":"SourceStatus.SourceInstanceStatus.SourceInstanceStatusData","l":"lastReceivedTime"},{"p":"org.apache.pulsar.common.policies.data","c":"TransactionBufferStats","l":"lastSnapshotTimestamps"},{"p":"org.apache.pulsar.common.policies.data","c":"SegmentsStats","l":"lastTookSnapshotSegmentTimestamp"},{"p":"org.apache.pulsar.common.policies.data","c":"SegmentStats","l":"lastTxnID"},{"p":"org.apache.pulsar.common.policies.data","c":"Policies","l":"latency_stats_sample_rate"},{"p":"org.apache.pulsar.common.policies.data","c":"SinkStatus.SinkInstanceStatus.SinkInstanceStatusData","l":"latestSinkExceptions"},{"p":"org.apache.pulsar.common.policies.data","c":"SourceStatus.SourceInstanceStatus.SourceInstanceStatusData","l":"latestSourceExceptions"},{"p":"org.apache.pulsar.common.policies.data","c":"FunctionStatus.FunctionInstanceStatus.FunctionInstanceStatusData","l":"latestSystemExceptions"},{"p":"org.apache.pulsar.common.policies.data","c":"SinkStatus.SinkInstanceStatus.SinkInstanceStatusData","l":"latestSystemExceptions"},{"p":"org.apache.pulsar.common.policies.data","c":"SourceStatus.SourceInstanceStatus.SourceInstanceStatusData","l":"latestSystemExceptions"},{"p":"org.apache.pulsar.common.policies.data","c":"FunctionStatus.FunctionInstanceStatus.FunctionInstanceStatusData","l":"latestUserExceptions"},{"p":"org.apache.pulsar.common.policies.data","c":"TransactionCoordinatorStats","l":"leastSigBits"},{"p":"org.apache.pulsar.common.policies.data","c":"TransactionCoordinatorStatus","l":"leastSigBits"},{"p":"org.apache.pulsar.common.policies.data","c":"ManagedLedgerInternalStats.LedgerInfo","l":"ledgerId"},{"p":"org.apache.pulsar.common.policies.data","c":"ManagedLedgerInternalStats.LedgerInfo","l":"LedgerInfo()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data","c":"ManagedLedgerInternalStats","l":"ledgers"},{"p":"org.apache.pulsar.policies.data.loadbalancer","c":"ResourceUsage","l":"limit"},{"p":"org.apache.pulsar.common.policies.data","c":"BacklogQuota.Builder","l":"limitSize(long)"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"BacklogQuotaImpl.BacklogQuotaImplBuilder","l":"limitSize(long)"},{"p":"org.apache.pulsar.common.policies.data","c":"BacklogQuota.Builder","l":"limitTime(int)"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"BacklogQuotaImpl.BacklogQuotaImplBuilder","l":"limitTime(int)"},{"p":"org.apache.pulsar.common.policies.data","c":"ClusterData.Builder","l":"listenerName(String)","u":"listenerName(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"ListNamespaceTopicsOptions","l":"ListNamespaceTopicsOptions()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.client.admin","c":"Packages","l":"listPackages(String, String)","u":"listPackages(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Packages","l":"listPackagesAsync(String, String)","u":"listPackagesAsync(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Packages","l":"listPackageVersions(String)","u":"listPackageVersions(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Packages","l":"listPackageVersionsAsync(String)","u":"listPackageVersionsAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Sinks","l":"listSinks(String, String)","u":"listSinks(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Sinks","l":"listSinksAsync(String, String)","u":"listSinksAsync(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Sources","l":"listSources(String, String)","u":"listSources(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Sources","l":"listSourcesAsync(String, String)","u":"listSourcesAsync(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"ListTopicsOptions","l":"ListTopicsOptions()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.client.admin","c":"Transactions","l":"listTransactionCoordinators()"},{"p":"org.apache.pulsar.client.admin","c":"Transactions","l":"listTransactionCoordinatorsAsync()"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdminBuilder","l":"loadConf(Map)","u":"loadConf(java.util.Map)"},{"p":"org.apache.pulsar.common.policies.data","c":"BrokerStatus.Builder","l":"loadFactor(int)"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"BrokerStatusImpl.BrokerStatusImplBuilder","l":"loadFactor(int)"},{"p":"org.apache.pulsar.client.admin","c":"LongRunningProcessStatus","l":"LongRunningProcessStatus()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.client.admin","c":"Lookup","l":"lookupPartitionedTopic(String)","u":"lookupPartitionedTopic(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Lookup","l":"lookupPartitionedTopicAsync(String)","u":"lookupPartitionedTopicAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdmin","l":"lookups()"},{"p":"org.apache.pulsar.client.admin","c":"Lookup","l":"lookupTopic(String)","u":"lookupTopic(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Lookup","l":"lookupTopicAsync(String)","u":"lookupTopicAsync(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"TransactionCoordinatorStats","l":"lowWaterMark"},{"p":"org.apache.pulsar.common.policies.data","c":"TransactionCoordinatorStatus","l":"lowWaterMark"},{"p":"org.apache.pulsar.common.policies.data","c":"TransactionBufferStats","l":"lowWaterMarks"},{"p":"org.apache.pulsar.common.policies.data","c":"TransactionPendingAckStats","l":"lowWaterMarks"},{"p":"org.apache.pulsar.common.policies.data","c":"SnapshotSystemTopicInternalStats","l":"managedLedgerInternalStats"},{"p":"org.apache.pulsar.common.policies.data","c":"TransactionLogStats","l":"managedLedgerInternalStats"},{"p":"org.apache.pulsar.common.policies.data","c":"ManagedLedgerInternalStats","l":"ManagedLedgerInternalStats()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data","c":"SnapshotSystemTopicInternalStats","l":"managedLedgerName"},{"p":"org.apache.pulsar.common.policies.data","c":"TransactionLogStats","l":"managedLedgerName"},{"p":"org.apache.pulsar.common.policies.data","c":"OffloadPolicies.Builder","l":"managedLedgerOffloadBucket(String)","u":"managedLedgerOffloadBucket(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"OffloadPolicies.Builder","l":"managedLedgerOffloadDeletionLagInMillis(Long)","u":"managedLedgerOffloadDeletionLagInMillis(java.lang.Long)"},{"p":"org.apache.pulsar.common.policies.data","c":"OffloadPolicies.Builder","l":"managedLedgerOffloadDriver(String)","u":"managedLedgerOffloadDriver(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"OffloadPolicies.Builder","l":"managedLedgerOffloadedReadPriority(OffloadedReadPriority)","u":"managedLedgerOffloadedReadPriority(org.apache.pulsar.common.policies.data.OffloadedReadPriority)"},{"p":"org.apache.pulsar.common.policies.data","c":"OffloadPolicies.Builder","l":"managedLedgerOffloadMaxBlockSizeInBytes(Integer)","u":"managedLedgerOffloadMaxBlockSizeInBytes(java.lang.Integer)"},{"p":"org.apache.pulsar.common.policies.data","c":"OffloadPolicies.Builder","l":"managedLedgerOffloadMaxThreads(Integer)","u":"managedLedgerOffloadMaxThreads(java.lang.Integer)"},{"p":"org.apache.pulsar.common.policies.data","c":"OffloadPolicies.Builder","l":"managedLedgerOffloadPrefetchRounds(Integer)","u":"managedLedgerOffloadPrefetchRounds(java.lang.Integer)"},{"p":"org.apache.pulsar.common.policies.data","c":"OffloadPolicies.Builder","l":"managedLedgerOffloadReadBufferSizeInBytes(Integer)","u":"managedLedgerOffloadReadBufferSizeInBytes(java.lang.Integer)"},{"p":"org.apache.pulsar.common.policies.data","c":"OffloadPolicies.Builder","l":"managedLedgerOffloadRegion(String)","u":"managedLedgerOffloadRegion(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"OffloadPolicies.Builder","l":"managedLedgerOffloadServiceEndpoint(String)","u":"managedLedgerOffloadServiceEndpoint(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"OffloadPolicies.Builder","l":"managedLedgerOffloadThresholdInBytes(Long)","u":"managedLedgerOffloadThresholdInBytes(java.lang.Long)"},{"p":"org.apache.pulsar.common.policies.data","c":"OffloadPolicies.Builder","l":"managedLedgerOffloadThresholdInSeconds(Long)","u":"managedLedgerOffloadThresholdInSeconds(java.lang.Long)"},{"p":"org.apache.pulsar.common.functions","c":"FunctionConfig.ProcessingGuarantees","l":"MANUAL"},{"p":"org.apache.pulsar.common.stats","c":"PositionInPendingAckStats.State","l":"MarkDelete"},{"p":"org.apache.pulsar.common.policies.data","c":"ManagedLedgerInternalStats.CursorStats","l":"markDeletePosition"},{"p":"org.apache.pulsar.common.policies.data","c":"Policies","l":"max_consumers_per_subscription"},{"p":"org.apache.pulsar.common.policies.data","c":"Policies","l":"max_consumers_per_topic"},{"p":"org.apache.pulsar.common.policies.data","c":"Policies","l":"max_producers_per_topic"},{"p":"org.apache.pulsar.common.policies.data","c":"Policies","l":"max_subscriptions_per_topic"},{"p":"org.apache.pulsar.common.policies.data","c":"Policies","l":"max_topics_per_namespace"},{"p":"org.apache.pulsar.common.policies.data","c":"Policies","l":"max_unacked_messages_per_consumer"},{"p":"org.apache.pulsar.common.policies.data","c":"Policies","l":"max_unacked_messages_per_subscription"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdminBuilder","l":"maxConnectionsPerHost(int)"},{"p":"org.apache.pulsar.common.policies.data","c":"DelayedDeliveryPolicies.Builder","l":"maxDeliveryDelayInMillis(long)"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"DelayedDeliveryPoliciesImpl.DelayedDeliveryPoliciesImplBuilder","l":"maxDeliveryDelayInMillis(long)"},{"p":"org.apache.pulsar.common.stats","c":"AllocatorStats.PoolSubpageStats","l":"maxNumElements"},{"p":"org.apache.pulsar.common.policies.data","c":"TransactionBufferStats","l":"maxReadPosition"},{"p":"org.apache.pulsar.common.stats","c":"AllocatorStats.PoolChunkListStats","l":"maxUsage"},{"p":"org.apache.pulsar.common.partition","c":"PartitionedTopicMetadata","l":"MEDIA_TYPE"},{"p":"org.apache.pulsar.common.functions","c":"Resources","l":"mergeWithDefault(Resources)","u":"mergeWithDefault(org.apache.pulsar.common.functions.Resources)"},{"p":"org.apache.pulsar.common.policies.data","c":"BacklogQuota.BacklogQuotaType","l":"message_age"},{"p":"org.apache.pulsar.common.policies.data","c":"Policies","l":"message_ttl_in_seconds"},{"p":"org.apache.pulsar.common.policies.data","c":"ManagedLedgerInternalStats.CursorStats","l":"messagesConsumedCounter"},{"p":"org.apache.pulsar.common.policies.data","c":"ManagedLedgerInternalStats.LedgerInfo","l":"metadata"},{"p":"org.apache.pulsar.common.policies.data","c":"PartitionedTopicInternalStats","l":"metadata"},{"p":"org.apache.pulsar.packages.management.core.exceptions","c":"PackagesManagementException.MetadataFormatException","l":"MetadataFormatException(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"org.apache.pulsar.packages.management.core.exceptions","c":"PackagesManagementException.MetadataFormatException","l":"MetadataFormatException(String, Throwable)","u":"%3Cinit%3E(java.lang.String,java.lang.Throwable)"},{"p":"org.apache.pulsar.common.policies.data","c":"WorkerFunctionInstanceStats","l":"metrics"},{"p":"org.apache.pulsar.common.stats","c":"Metrics","l":"Metrics()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.stats","c":"Metrics","l":"Metrics(Map)","u":"%3Cinit%3E(java.util.Map)"},{"p":"org.apache.pulsar.common.policies.data","c":"Policies","l":"migrated"},{"p":"org.apache.pulsar.common.policies.data","c":"ClusterPolicies.Builder","l":"migrated(boolean)"},{"p":"org.apache.pulsar.common.policies.data","c":"ClusterPolicies.Builder","l":"migratedClusterUrl(ClusterPolicies.ClusterUrl)","u":"migratedClusterUrl(org.apache.pulsar.common.policies.data.ClusterPolicies.ClusterUrl)"},{"p":"org.apache.pulsar.common.policies.data","c":"AutoFailoverPolicyType","l":"min_available"},{"p":"org.apache.pulsar.common.policies.impl","c":"MinAvailablePolicy","l":"min_limit"},{"p":"org.apache.pulsar.common.policies.impl","c":"MinAvailablePolicy","l":"MinAvailablePolicy(AutoFailoverPolicyData)","u":"%3Cinit%3E(org.apache.pulsar.common.policies.data.AutoFailoverPolicyData)"},{"p":"org.apache.pulsar.common.stats","c":"AllocatorStats.PoolChunkListStats","l":"minUsage"},{"p":"org.apache.pulsar.policies.data.loadbalancer","c":"NamespaceBundleStats","l":"msgRateIn"},{"p":"org.apache.pulsar.policies.data.loadbalancer","c":"NamespaceBundleStats","l":"msgRateOut"},{"p":"org.apache.pulsar.policies.data.loadbalancer","c":"NamespaceBundleStats","l":"msgThroughputIn"},{"p":"org.apache.pulsar.policies.data.loadbalancer","c":"NamespaceBundleStats","l":"msgThroughputOut"},{"p":"org.apache.pulsar.common.policies.data","c":"WorkerFunctionInstanceStats","l":"name"},{"p":"org.apache.pulsar.common.policies.data","c":"AuthPolicies.Builder","l":"namespaceAuthentication(Map>)","u":"namespaceAuthentication(java.util.Map)"},{"p":"org.apache.pulsar.policies.data.loadbalancer","c":"NamespaceBundleStats","l":"NamespaceBundleStats()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data","c":"NamespaceOwnershipStatus","l":"NamespaceOwnershipStatus()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data","c":"NamespaceOwnershipStatus","l":"NamespaceOwnershipStatus(BrokerAssignment, boolean, boolean)","u":"%3Cinit%3E(org.apache.pulsar.common.policies.data.BrokerAssignment,boolean,boolean)"},{"p":"org.apache.pulsar.common.policies.data","c":"BrokerNamespaceIsolationData.Builder","l":"namespaceRegex(List)","u":"namespaceRegex(java.util.List)"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdmin","l":"namespaces()"},{"p":"org.apache.pulsar.common.policies.data","c":"NamespaceIsolationData.Builder","l":"namespaces(List)","u":"namespaces(java.util.List)"},{"p":"org.apache.pulsar.client.admin.utils","c":"DefaultImplementation","l":"newAdminClientBuilder()"},{"p":"org.apache.pulsar.client.admin.utils","c":"ReflectionUtils","l":"newBuilder(String)","u":"newBuilder(java.lang.String)"},{"p":"org.apache.pulsar.client.admin.utils","c":"DefaultImplementation","l":"newOffloadProcessStatus(LongRunningProcessStatus.Status, String, MessageId)","u":"newOffloadProcessStatus(org.apache.pulsar.client.admin.LongRunningProcessStatus.Status,java.lang.String,org.apache.pulsar.client.api.MessageId)"},{"p":"org.apache.pulsar.common.policies.data","c":"TopicType","l":"NON_PARTITIONED"},{"p":"org.apache.pulsar.common.partition","c":"PartitionedTopicMetadata","l":"NON_PARTITIONED"},{"p":"org.apache.pulsar.common.naming","c":"TopicDomain","l":"non_persistent"},{"p":"org.apache.pulsar.client.admin","c":"Mode","l":"NON_PERSISTENT"},{"p":"org.apache.pulsar.common.policies.data","c":"NamespaceIsolationPolicyUnloadScope","l":"none"},{"p":"org.apache.pulsar.common.policies.data","c":"SubscriptionAuthMode","l":"None"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdmin","l":"nonPersistentTopics()"},{"p":"org.apache.pulsar.common.stats","c":"AllocatorStats","l":"normalCacheSize"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"DispatchRateImpl","l":"normalize(DispatchRateImpl)","u":"normalize(org.apache.pulsar.common.policies.data.impl.DispatchRateImpl)"},{"p":"org.apache.pulsar.common.policies.data","c":"PublishRate","l":"normalize(PublishRate)","u":"normalize(org.apache.pulsar.common.policies.data.PublishRate)"},{"p":"org.apache.pulsar.common.policies.data","c":"SubscribeRate","l":"normalize(SubscribeRate)","u":"normalize(org.apache.pulsar.common.policies.data.SubscribeRate)"},{"p":"org.apache.pulsar.client.admin","c":"LongRunningProcessStatus.Status","l":"NOT_RUN"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdminException.NotAllowedException","l":"NotAllowedException(Throwable, String, int)","u":"%3Cinit%3E(java.lang.Throwable,java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdminException.NotAuthorizedException","l":"NotAuthorizedException(Throwable, String, int)","u":"%3Cinit%3E(java.lang.Throwable,java.lang.String,int)"},{"p":"org.apache.pulsar.packages.management.core.exceptions","c":"PackagesManagementException.NotFoundException","l":"NotFoundException(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"org.apache.pulsar.packages.management.core.exceptions","c":"PackagesManagementException.NotFoundException","l":"NotFoundException(String, Throwable)","u":"%3Cinit%3E(java.lang.String,java.lang.Throwable)"},{"p":"org.apache.pulsar.packages.management.core.exceptions","c":"PackagesManagementException.NotFoundException","l":"NotFoundException(Throwable)","u":"%3Cinit%3E(java.lang.Throwable)"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdminException.NotFoundException","l":"NotFoundException(Throwable, String, int)","u":"%3Cinit%3E(java.lang.Throwable,java.lang.String,int)"},{"p":"org.apache.pulsar.common.stats","c":"PositionInPendingAckStats.State","l":"NotInPendingAck"},{"p":"org.apache.pulsar.common.stats","c":"AllocatorStats.PoolArenaStats","l":"numActiveAllocations"},{"p":"org.apache.pulsar.common.stats","c":"AllocatorStats.PoolArenaStats","l":"numActiveHugeAllocations"},{"p":"org.apache.pulsar.common.stats","c":"AllocatorStats.PoolArenaStats","l":"numActiveNormalAllocations"},{"p":"org.apache.pulsar.common.stats","c":"AllocatorStats.PoolArenaStats","l":"numActiveSmallAllocations"},{"p":"org.apache.pulsar.common.stats","c":"AllocatorStats.PoolArenaStats","l":"numAllocations"},{"p":"org.apache.pulsar.common.stats","c":"AllocatorStats.PoolSubpageStats","l":"numAvailable"},{"p":"org.apache.pulsar.common.policies.data","c":"ManagedLedgerInternalStats","l":"numberOfEntries"},{"p":"org.apache.pulsar.common.policies.data","c":"ManagedLedgerInternalStats.CursorStats","l":"numberOfEntriesSinceFirstNotAckedMessage"},{"p":"org.apache.pulsar.common.policies.data","c":"BundlesData.Builder","l":"numBundles(int)"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"BundlesDataImpl.BundlesDataImplBuilder","l":"numBundles(int)"},{"p":"org.apache.pulsar.common.stats","c":"AllocatorStats.PoolArenaStats","l":"numChunkLists"},{"p":"org.apache.pulsar.common.stats","c":"AllocatorStats.PoolArenaStats","l":"numDeallocations"},{"p":"org.apache.pulsar.common.stats","c":"AllocatorStats","l":"numDirectArenas"},{"p":"org.apache.pulsar.common.stats","c":"AllocatorStats","l":"numHeapArenas"},{"p":"org.apache.pulsar.common.stats","c":"AllocatorStats.PoolArenaStats","l":"numHugeAllocations"},{"p":"org.apache.pulsar.common.stats","c":"AllocatorStats.PoolArenaStats","l":"numHugeDeallocations"},{"p":"org.apache.pulsar.common.policies.data","c":"FunctionStatus","l":"numInstances"},{"p":"org.apache.pulsar.common.policies.data","c":"SinkStatus","l":"numInstances"},{"p":"org.apache.pulsar.common.policies.data","c":"SourceStatus","l":"numInstances"},{"p":"org.apache.pulsar.common.stats","c":"AllocatorStats.PoolArenaStats","l":"numNormalAllocations"},{"p":"org.apache.pulsar.common.stats","c":"AllocatorStats.PoolArenaStats","l":"numNormalDeallocations"},{"p":"org.apache.pulsar.common.policies.data","c":"SinkStatus.SinkInstanceStatus.SinkInstanceStatusData","l":"numReadFromPulsar"},{"p":"org.apache.pulsar.common.policies.data","c":"FunctionStatus.FunctionInstanceStatus.FunctionInstanceStatusData","l":"numReceived"},{"p":"org.apache.pulsar.common.policies.data","c":"SourceStatus.SourceInstanceStatus.SourceInstanceStatusData","l":"numReceivedFromSource"},{"p":"org.apache.pulsar.common.policies.data","c":"FunctionStatus.FunctionInstanceStatus.FunctionInstanceStatusData","l":"numRestarts"},{"p":"org.apache.pulsar.common.policies.data","c":"SinkStatus.SinkInstanceStatus.SinkInstanceStatusData","l":"numRestarts"},{"p":"org.apache.pulsar.common.policies.data","c":"SourceStatus.SourceInstanceStatus.SourceInstanceStatusData","l":"numRestarts"},{"p":"org.apache.pulsar.common.policies.data","c":"FunctionStatus","l":"numRunning"},{"p":"org.apache.pulsar.common.policies.data","c":"SinkStatus","l":"numRunning"},{"p":"org.apache.pulsar.common.policies.data","c":"SourceStatus","l":"numRunning"},{"p":"org.apache.pulsar.common.policies.data","c":"SinkStatus.SinkInstanceStatus.SinkInstanceStatusData","l":"numSinkExceptions"},{"p":"org.apache.pulsar.common.stats","c":"AllocatorStats.PoolArenaStats","l":"numSmallAllocations"},{"p":"org.apache.pulsar.common.stats","c":"AllocatorStats.PoolArenaStats","l":"numSmallDeallocations"},{"p":"org.apache.pulsar.common.stats","c":"AllocatorStats.PoolArenaStats","l":"numSmallSubpages"},{"p":"org.apache.pulsar.common.policies.data","c":"SourceStatus.SourceInstanceStatus.SourceInstanceStatusData","l":"numSourceExceptions"},{"p":"org.apache.pulsar.common.policies.data","c":"FunctionStatus.FunctionInstanceStatus.FunctionInstanceStatusData","l":"numSuccessfullyProcessed"},{"p":"org.apache.pulsar.common.policies.data","c":"FunctionStatus.FunctionInstanceStatus.FunctionInstanceStatusData","l":"numSystemExceptions"},{"p":"org.apache.pulsar.common.policies.data","c":"SinkStatus.SinkInstanceStatus.SinkInstanceStatusData","l":"numSystemExceptions"},{"p":"org.apache.pulsar.common.policies.data","c":"SourceStatus.SourceInstanceStatus.SourceInstanceStatusData","l":"numSystemExceptions"},{"p":"org.apache.pulsar.common.stats","c":"AllocatorStats","l":"numThreadLocalCaches"},{"p":"org.apache.pulsar.common.policies.data","c":"FunctionStatus.FunctionInstanceStatus.FunctionInstanceStatusData","l":"numUserExceptions"},{"p":"org.apache.pulsar.common.policies.data","c":"SourceStatus.SourceInstanceStatus.SourceInstanceStatusData","l":"numWritten"},{"p":"org.apache.pulsar.common.policies.data","c":"SinkStatus.SinkInstanceStatus.SinkInstanceStatusData","l":"numWrittenToSink"},{"p":"org.apache.pulsar.common.functions","c":"WorkerInfo","l":"of(String, String, int)","u":"of(java.lang.String,java.lang.String,int)"},{"p":"org.apache.pulsar.common.policies.data","c":"Policies","l":"offload_deletion_lag_ms"},{"p":"org.apache.pulsar.common.policies.data","c":"Policies","l":"offload_policies"},{"p":"org.apache.pulsar.common.policies.data","c":"Policies","l":"offload_threshold"},{"p":"org.apache.pulsar.common.policies.data","c":"Policies","l":"offload_threshold_in_seconds"},{"p":"org.apache.pulsar.common.policies.data","c":"ManagedLedgerInternalStats.LedgerInfo","l":"offloaded"},{"p":"org.apache.pulsar.common.policies.data","c":"OffloadPolicies.Builder","l":"offloadersDirectory(String)","u":"offloadersDirectory(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"offloadStatus(String)","u":"offloadStatus(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"offloadStatusAsync(String)","u":"offloadStatusAsync(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"TransactionBufferStats","l":"ongoingTxnSize"},{"p":"org.apache.pulsar.common.policies.data","c":"TransactionCoordinatorStats","l":"ongoingTxnSize"},{"p":"org.apache.pulsar.common.policies.data","c":"TransactionPendingAckStats","l":"ongoingTxnSize"},{"p":"org.apache.pulsar.common.policies.data","c":"TransactionMetadata","l":"openTimestamp"},{"p":"org.apache.pulsar.common.policies.data","c":"TransactionMetadata","l":"owner"},{"p":"org.apache.pulsar.packages.management.core.common","c":"PackageMetadata","l":"PackageMetadata()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data","c":"AuthAction","l":"packages"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdmin","l":"packages()"},{"p":"org.apache.pulsar.packages.management.core.exceptions","c":"PackagesManagementException","l":"PackagesManagementException(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"org.apache.pulsar.packages.management.core.exceptions","c":"PackagesManagementException","l":"PackagesManagementException(String, Throwable)","u":"%3Cinit%3E(java.lang.String,java.lang.Throwable)"},{"p":"org.apache.pulsar.packages.management.core.exceptions","c":"PackagesManagementException","l":"PackagesManagementException(Throwable)","u":"%3Cinit%3E(java.lang.Throwable)"},{"p":"org.apache.pulsar.common.stats","c":"AllocatorStats.PoolSubpageStats","l":"pageSize"},{"p":"org.apache.pulsar.common.policies.data","c":"AutoFailoverPolicyData.Builder","l":"parameters(Map)","u":"parameters(java.util.Map)"},{"p":"org.apache.pulsar.common.functions","c":"WorkerInfo","l":"parseFrom(String)","u":"parseFrom(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"TopicType","l":"PARTITIONED"},{"p":"org.apache.pulsar.common.policies.data","c":"PartitionedTopicInternalStats","l":"PartitionedTopicInternalStats()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data","c":"PartitionedTopicInternalStats","l":"PartitionedTopicInternalStats(PartitionedTopicMetadata)","u":"%3Cinit%3E(org.apache.pulsar.common.partition.PartitionedTopicMetadata)"},{"p":"org.apache.pulsar.common.partition","c":"PartitionedTopicMetadata","l":"PartitionedTopicMetadata()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.partition","c":"PartitionedTopicMetadata","l":"PartitionedTopicMetadata(int)","u":"%3Cinit%3E(int)"},{"p":"org.apache.pulsar.common.partition","c":"PartitionedTopicMetadata","l":"PartitionedTopicMetadata(int, Map)","u":"%3Cinit%3E(int,java.util.Map)"},{"p":"org.apache.pulsar.common.partition","c":"PartitionedTopicMetadata","l":"partitions"},{"p":"org.apache.pulsar.common.policies.data","c":"PartitionedTopicInternalStats","l":"partitions"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"peekMessages(String, String, int)","u":"peekMessages(java.lang.String,java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"peekMessages(String, String, int, boolean, TransactionIsolationLevel)","u":"peekMessages(java.lang.String,java.lang.String,int,boolean,org.apache.pulsar.client.api.TransactionIsolationLevel)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"peekMessagesAsync(String, String, int)","u":"peekMessagesAsync(java.lang.String,java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"peekMessagesAsync(String, String, int, boolean, TransactionIsolationLevel)","u":"peekMessagesAsync(java.lang.String,java.lang.String,int,boolean,org.apache.pulsar.client.api.TransactionIsolationLevel)"},{"p":"org.apache.pulsar.common.policies.data","c":"ClusterData.Builder","l":"peerClusterNames(LinkedHashSet)","u":"peerClusterNames(java.util.LinkedHashSet)"},{"p":"org.apache.pulsar.common.stats","c":"PositionInPendingAckStats.State","l":"PendingAck"},{"p":"org.apache.pulsar.common.policies.data","c":"TransactionPendingAckInternalStats","l":"pendingAckLogStats"},{"p":"org.apache.pulsar.common.stats","c":"PositionInPendingAckStats.State","l":"PendingAckNotReady"},{"p":"org.apache.pulsar.common.policies.data","c":"ManagedLedgerInternalStats","l":"pendingAddEntriesCount"},{"p":"org.apache.pulsar.common.policies.data","c":"ManagedLedgerInternalStats.CursorStats","l":"pendingReadOps"},{"p":"org.apache.pulsar.policies.data.loadbalancer","c":"ResourceUsage","l":"percentUsage()"},{"p":"org.apache.pulsar.common.policies.data","c":"Policies","l":"persistence"},{"p":"org.apache.pulsar.common.policies.data","c":"PersistencePolicies","l":"PersistencePolicies()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data","c":"PersistencePolicies","l":"PersistencePolicies(int, int, int, double)","u":"%3Cinit%3E(int,int,int,double)"},{"p":"org.apache.pulsar.common.policies.data","c":"PersistencePolicies","l":"PersistencePolicies(int, int, int, double, String)","u":"%3Cinit%3E(int,int,int,double,java.lang.String)"},{"p":"org.apache.pulsar.common.naming","c":"TopicDomain","l":"persistent"},{"p":"org.apache.pulsar.client.admin","c":"Mode","l":"PERSISTENT"},{"p":"org.apache.pulsar.common.policies.data","c":"SegmentStats","l":"persistentPosition"},{"p":"org.apache.pulsar.common.policies.data","c":"PersistentTopicInternalStats","l":"PersistentTopicInternalStats()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data","c":"Policies","l":"Policies()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data","c":"BrokerNamespaceIsolationData.Builder","l":"policyName(String)","u":"policyName(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"AutoFailoverPolicyData.Builder","l":"policyType(AutoFailoverPolicyType)","u":"policyType(org.apache.pulsar.common.policies.data.AutoFailoverPolicyType)"},{"p":"org.apache.pulsar.common.stats","c":"AllocatorStats.PoolArenaStats","l":"PoolArenaStats()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.stats","c":"AllocatorStats.PoolChunkListStats","l":"PoolChunkListStats()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.stats","c":"AllocatorStats.PoolChunkStats","l":"PoolChunkStats()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.stats","c":"AllocatorStats.PoolSubpageStats","l":"PoolSubpageStats()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.stats","c":"PositionInPendingAckStats","l":"PositionInPendingAckStats()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.stats","c":"PositionInPendingAckStats","l":"PositionInPendingAckStats(PositionInPendingAckStats.State)","u":"%3Cinit%3E(org.apache.pulsar.common.stats.PositionInPendingAckStats.State)"},{"p":"org.apache.pulsar.common.protocol.schema","c":"PostSchemaPayload","l":"PostSchemaPayload()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdminException.PreconditionFailedException","l":"PreconditionFailedException(Throwable, String, int)","u":"%3Cinit%3E(java.lang.Throwable,java.lang.String,int)"},{"p":"org.apache.pulsar.common.policies.data","c":"SubscriptionAuthMode","l":"Prefix"},{"p":"org.apache.pulsar.common.policies.data","c":"BrokerAssignment","l":"primary"},{"p":"org.apache.pulsar.common.policies.data","c":"BrokerNamespaceIsolationData.Builder","l":"primary(boolean)"},{"p":"org.apache.pulsar.common.policies.data","c":"NamespaceIsolationData.Builder","l":"primary(List)","u":"primary(java.util.List)"},{"p":"org.apache.pulsar.common.policies.data","c":"AuthAction","l":"produce"},{"p":"org.apache.pulsar.common.policies.data","c":"TransactionMetadata","l":"producedPartitions"},{"p":"org.apache.pulsar.common.policies.data","c":"BacklogQuota.RetentionPolicy","l":"producer_exception"},{"p":"org.apache.pulsar.common.policies.data","c":"BacklogQuota.RetentionPolicy","l":"producer_request_hold"},{"p":"org.apache.pulsar.common.functions","c":"ProducerConfig","l":"ProducerConfig()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.policies.data.loadbalancer","c":"NamespaceBundleStats","l":"producerCount"},{"p":"org.apache.pulsar.common.partition","c":"PartitionedTopicMetadata","l":"properties"},{"p":"org.apache.pulsar.common.policies.data","c":"ManagedLedgerInternalStats.CursorStats","l":"properties"},{"p":"org.apache.pulsar.common.policies.data","c":"Policies","l":"properties"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdmin","l":"properties()"},{"p":"org.apache.pulsar.common.policies.data","c":"ClusterData.Builder","l":"proxyProtocol(ProxyProtocol)","u":"proxyProtocol(org.apache.pulsar.client.api.ProxyProtocol)"},{"p":"org.apache.pulsar.common.policies.data","c":"ClusterData.Builder","l":"proxyServiceUrl(String)","u":"proxyServiceUrl(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdmin","l":"proxyStats()"},{"p":"org.apache.pulsar.common.policies.data","c":"Policies","l":"publishMaxMessageRate"},{"p":"org.apache.pulsar.common.policies.data","c":"PublishRate","l":"PublishRate()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data","c":"PublishRate","l":"PublishRate(int, long)","u":"%3Cinit%3E(int,long)"},{"p":"org.apache.pulsar.common.policies.data","c":"PublishRate","l":"publishThrottlingRateInByte"},{"p":"org.apache.pulsar.common.policies.data","c":"PublishRate","l":"publishThrottlingRateInMsg"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdminException","l":"PulsarAdminException(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdminException","l":"PulsarAdminException(String, Throwable)","u":"%3Cinit%3E(java.lang.String,java.lang.Throwable)"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdminException","l":"PulsarAdminException(String, Throwable, String, int)","u":"%3Cinit%3E(java.lang.String,java.lang.Throwable,java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdminException","l":"PulsarAdminException(Throwable)","u":"%3Cinit%3E(java.lang.Throwable)"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdminException","l":"PulsarAdminException(Throwable, String, int)","u":"%3Cinit%3E(java.lang.Throwable,java.lang.String,int)"},{"p":"org.apache.pulsar.common.stats","c":"Metrics","l":"put(String, Object)","u":"put(java.lang.String,java.lang.Object)"},{"p":"org.apache.pulsar.common.stats","c":"Metrics","l":"putAll(Map)","u":"putAll(java.util.Map)"},{"p":"org.apache.pulsar.client.admin","c":"Functions","l":"putFunctionState(String, String, String, FunctionState)","u":"putFunctionState(java.lang.String,java.lang.String,java.lang.String,org.apache.pulsar.common.functions.FunctionState)"},{"p":"org.apache.pulsar.client.admin","c":"Functions","l":"putFunctionStateAsync(String, String, String, FunctionState)","u":"putFunctionStateAsync(java.lang.String,java.lang.String,java.lang.String,org.apache.pulsar.common.functions.FunctionState)"},{"p":"org.apache.pulsar.common.functions","c":"FunctionConfig.Runtime","l":"PYTHON"},{"p":"org.apache.pulsar.common.policies.data","c":"BookieInfo.Builder","l":"rack(String)","u":"rack(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"BookieInfoImpl.BookieInfoImplBuilder","l":"rack(String)","u":"rack(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"SubscribeRate","l":"ratePeriodInSecond"},{"p":"org.apache.pulsar.common.policies.data","c":"DispatchRate.Builder","l":"ratePeriodInSecond(int)"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"DispatchRateImpl.DispatchRateImplBuilder","l":"ratePeriodInSecond(int)"},{"p":"org.apache.pulsar.common.policies.data","c":"RawBookieInfo","l":"RawBookieInfo()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data","c":"ManagedLedgerInternalStats.CursorStats","l":"readPosition"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdminBuilder","l":"readTimeout(int, TimeUnit)","u":"readTimeout(int,java.util.concurrent.TimeUnit)"},{"p":"org.apache.pulsar.common.policies.data","c":"ErrorData","l":"reason"},{"p":"org.apache.pulsar.client.admin","c":"Worker","l":"rebalance()"},{"p":"org.apache.pulsar.client.admin","c":"Worker","l":"rebalanceAsync()"},{"p":"org.apache.pulsar.common.policies.data","c":"TransactionBufferStats","l":"recoverEndTime"},{"p":"org.apache.pulsar.common.policies.data","c":"TransactionCoordinatorStats","l":"recoverEndTime"},{"p":"org.apache.pulsar.common.policies.data","c":"TransactionPendingAckStats","l":"recoverEndTime"},{"p":"org.apache.pulsar.common.policies.data","c":"TransactionBufferStats","l":"recoverStartTime"},{"p":"org.apache.pulsar.common.policies.data","c":"TransactionCoordinatorStats","l":"recoverStartTime"},{"p":"org.apache.pulsar.common.policies.data","c":"TransactionPendingAckStats","l":"recoverStartTime"},{"p":"org.apache.pulsar.client.admin.utils","c":"ReflectionUtils","l":"ReflectionUtils()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data","c":"DispatchRate.Builder","l":"relativeToPublishRate(boolean)"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"DispatchRateImpl.DispatchRateImplBuilder","l":"relativeToPublishRate(boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Functions","l":"reloadBuiltInFunctions()"},{"p":"org.apache.pulsar.client.admin","c":"Functions","l":"reloadBuiltInFunctionsAsync()"},{"p":"org.apache.pulsar.client.admin","c":"Sinks","l":"reloadBuiltInSinks()"},{"p":"org.apache.pulsar.client.admin","c":"Sinks","l":"reloadBuiltInSinksAsync()"},{"p":"org.apache.pulsar.client.admin","c":"Sources","l":"reloadBuiltInSources()"},{"p":"org.apache.pulsar.client.admin","c":"Sources","l":"reloadBuiltInSourcesAsync()"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"removeAutoSubscriptionCreation(String)","u":"removeAutoSubscriptionCreation(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"removeAutoSubscriptionCreation(String)","u":"removeAutoSubscriptionCreation(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"removeAutoSubscriptionCreationAsync(String)","u":"removeAutoSubscriptionCreationAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"removeAutoSubscriptionCreationAsync(String)","u":"removeAutoSubscriptionCreationAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"removeAutoTopicCreation(String)","u":"removeAutoTopicCreation(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"removeAutoTopicCreationAsync(String)","u":"removeAutoTopicCreationAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"removeBacklogQuota(String)","u":"removeBacklogQuota(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"removeBacklogQuota(String)","u":"removeBacklogQuota(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"removeBacklogQuota(String)","u":"removeBacklogQuota(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"removeBacklogQuota(String, BacklogQuota.BacklogQuotaType)","u":"removeBacklogQuota(java.lang.String,org.apache.pulsar.common.policies.data.BacklogQuota.BacklogQuotaType)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"removeBacklogQuota(String, BacklogQuota.BacklogQuotaType)","u":"removeBacklogQuota(java.lang.String,org.apache.pulsar.common.policies.data.BacklogQuota.BacklogQuotaType)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"removeBacklogQuota(String, BacklogQuota.BacklogQuotaType)","u":"removeBacklogQuota(java.lang.String,org.apache.pulsar.common.policies.data.BacklogQuota.BacklogQuotaType)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"removeBacklogQuotaAsync(String)","u":"removeBacklogQuotaAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"removeBacklogQuotaAsync(String, BacklogQuota.BacklogQuotaType)","u":"removeBacklogQuotaAsync(java.lang.String,org.apache.pulsar.common.policies.data.BacklogQuota.BacklogQuotaType)"},{"p":"org.apache.pulsar.common.policies.data","c":"BookiesRackConfiguration","l":"removeBookie(String)","u":"removeBookie(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"removeCompactionThreshold(String)","u":"removeCompactionThreshold(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"removeCompactionThreshold(String)","u":"removeCompactionThreshold(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"removeCompactionThreshold(String)","u":"removeCompactionThreshold(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"removeCompactionThresholdAsync(String)","u":"removeCompactionThresholdAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"removeCompactionThresholdAsync(String)","u":"removeCompactionThresholdAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"removeCompactionThresholdAsync(String)","u":"removeCompactionThresholdAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"removeDeduplicationSnapshotInterval(String)","u":"removeDeduplicationSnapshotInterval(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"removeDeduplicationSnapshotInterval(String)","u":"removeDeduplicationSnapshotInterval(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"removeDeduplicationSnapshotInterval(String)","u":"removeDeduplicationSnapshotInterval(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"removeDeduplicationSnapshotIntervalAsync(String)","u":"removeDeduplicationSnapshotIntervalAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"removeDeduplicationSnapshotIntervalAsync(String)","u":"removeDeduplicationSnapshotIntervalAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"removeDeduplicationSnapshotIntervalAsync(String)","u":"removeDeduplicationSnapshotIntervalAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"removeDeduplicationStatus(String)","u":"removeDeduplicationStatus(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"removeDeduplicationStatus(String)","u":"removeDeduplicationStatus(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"removeDeduplicationStatus(String)","u":"removeDeduplicationStatus(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"removeDeduplicationStatusAsync(String)","u":"removeDeduplicationStatusAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"removeDeduplicationStatusAsync(String)","u":"removeDeduplicationStatusAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"removeDeduplicationStatusAsync(String)","u":"removeDeduplicationStatusAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"removeDelayedDeliveryMessages(String)","u":"removeDelayedDeliveryMessages(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"removeDelayedDeliveryMessagesAsync(String)","u":"removeDelayedDeliveryMessagesAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"removeDelayedDeliveryPolicy(String)","u":"removeDelayedDeliveryPolicy(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"removeDelayedDeliveryPolicy(String)","u":"removeDelayedDeliveryPolicy(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"removeDelayedDeliveryPolicyAsync(String)","u":"removeDelayedDeliveryPolicyAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"removeDelayedDeliveryPolicyAsync(String)","u":"removeDelayedDeliveryPolicyAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"removeDispatcherPauseOnAckStatePersistent(String)","u":"removeDispatcherPauseOnAckStatePersistent(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"removeDispatcherPauseOnAckStatePersistent(String)","u":"removeDispatcherPauseOnAckStatePersistent(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"removeDispatcherPauseOnAckStatePersistentAsync(String)","u":"removeDispatcherPauseOnAckStatePersistentAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"removeDispatchRate(String)","u":"removeDispatchRate(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"removeDispatchRate(String)","u":"removeDispatchRate(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"removeDispatchRate(String)","u":"removeDispatchRate(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"removeDispatchRateAsync(String)","u":"removeDispatchRateAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"removeDispatchRateAsync(String)","u":"removeDispatchRateAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"removeDispatchRateAsync(String)","u":"removeDispatchRateAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"removeEntryFiltersPerTopic(String)","u":"removeEntryFiltersPerTopic(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"removeEntryFiltersPerTopicAsync(String)","u":"removeEntryFiltersPerTopicAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"removeInactiveTopicPolicies(String)","u":"removeInactiveTopicPolicies(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"removeInactiveTopicPolicies(String)","u":"removeInactiveTopicPolicies(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"removeInactiveTopicPolicies(String)","u":"removeInactiveTopicPolicies(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"removeInactiveTopicPoliciesAsync(String)","u":"removeInactiveTopicPoliciesAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"removeInactiveTopicPoliciesAsync(String)","u":"removeInactiveTopicPoliciesAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"removeInactiveTopicPoliciesAsync(String)","u":"removeInactiveTopicPoliciesAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"removeMaxConsumers(String)","u":"removeMaxConsumers(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"removeMaxConsumers(String)","u":"removeMaxConsumers(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"removeMaxConsumersAsync(String)","u":"removeMaxConsumersAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"removeMaxConsumersAsync(String)","u":"removeMaxConsumersAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"removeMaxConsumersPerSubscription(String)","u":"removeMaxConsumersPerSubscription(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"removeMaxConsumersPerSubscription(String)","u":"removeMaxConsumersPerSubscription(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"removeMaxConsumersPerSubscription(String)","u":"removeMaxConsumersPerSubscription(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"removeMaxConsumersPerSubscriptionAsync(String)","u":"removeMaxConsumersPerSubscriptionAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"removeMaxConsumersPerSubscriptionAsync(String)","u":"removeMaxConsumersPerSubscriptionAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"removeMaxConsumersPerSubscriptionAsync(String)","u":"removeMaxConsumersPerSubscriptionAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"removeMaxConsumersPerTopic(String)","u":"removeMaxConsumersPerTopic(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"removeMaxConsumersPerTopicAsync(String)","u":"removeMaxConsumersPerTopicAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"removeMaxMessageSize(String)","u":"removeMaxMessageSize(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"removeMaxMessageSize(String)","u":"removeMaxMessageSize(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"removeMaxMessageSizeAsync(String)","u":"removeMaxMessageSizeAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"removeMaxMessageSizeAsync(String)","u":"removeMaxMessageSizeAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"removeMaxProducers(String)","u":"removeMaxProducers(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"removeMaxProducers(String)","u":"removeMaxProducers(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"removeMaxProducersAsync(String)","u":"removeMaxProducersAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"removeMaxProducersAsync(String)","u":"removeMaxProducersAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"removeMaxProducersPerTopic(String)","u":"removeMaxProducersPerTopic(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"removeMaxProducersPerTopicAsync(String)","u":"removeMaxProducersPerTopicAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"removeMaxSubscriptionsPerTopic(String)","u":"removeMaxSubscriptionsPerTopic(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"removeMaxSubscriptionsPerTopic(String)","u":"removeMaxSubscriptionsPerTopic(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"removeMaxSubscriptionsPerTopic(String)","u":"removeMaxSubscriptionsPerTopic(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"removeMaxSubscriptionsPerTopicAsync(String)","u":"removeMaxSubscriptionsPerTopicAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"removeMaxSubscriptionsPerTopicAsync(String)","u":"removeMaxSubscriptionsPerTopicAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"removeMaxSubscriptionsPerTopicAsync(String)","u":"removeMaxSubscriptionsPerTopicAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"removeMaxTopicsPerNamespace(String)","u":"removeMaxTopicsPerNamespace(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"removeMaxTopicsPerNamespaceAsync(String)","u":"removeMaxTopicsPerNamespaceAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"removeMaxUnackedMessagesOnConsumer(String)","u":"removeMaxUnackedMessagesOnConsumer(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"removeMaxUnackedMessagesOnConsumer(String)","u":"removeMaxUnackedMessagesOnConsumer(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"removeMaxUnackedMessagesOnConsumerAsync(String)","u":"removeMaxUnackedMessagesOnConsumerAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"removeMaxUnackedMessagesOnConsumerAsync(String)","u":"removeMaxUnackedMessagesOnConsumerAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"removeMaxUnackedMessagesOnSubscription(String)","u":"removeMaxUnackedMessagesOnSubscription(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"removeMaxUnackedMessagesOnSubscription(String)","u":"removeMaxUnackedMessagesOnSubscription(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"removeMaxUnackedMessagesOnSubscriptionAsync(String)","u":"removeMaxUnackedMessagesOnSubscriptionAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"removeMaxUnackedMessagesOnSubscriptionAsync(String)","u":"removeMaxUnackedMessagesOnSubscriptionAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"removeMaxUnackedMessagesPerConsumer(String)","u":"removeMaxUnackedMessagesPerConsumer(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"removeMaxUnackedMessagesPerConsumerAsync(String)","u":"removeMaxUnackedMessagesPerConsumerAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"removeMaxUnackedMessagesPerSubscription(String)","u":"removeMaxUnackedMessagesPerSubscription(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"removeMaxUnackedMessagesPerSubscriptionAsync(String)","u":"removeMaxUnackedMessagesPerSubscriptionAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"removeMessageTTL(String)","u":"removeMessageTTL(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"removeMessageTTL(String)","u":"removeMessageTTL(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"removeNamespaceEntryFilters(String)","u":"removeNamespaceEntryFilters(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"removeNamespaceEntryFiltersAsync(String)","u":"removeNamespaceEntryFiltersAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"removeNamespaceMessageTTL(String)","u":"removeNamespaceMessageTTL(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"removeNamespaceMessageTTLAsync(String)","u":"removeNamespaceMessageTTLAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"removeNamespaceResourceGroup(String)","u":"removeNamespaceResourceGroup(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"removeNamespaceResourceGroupAsync(String)","u":"removeNamespaceResourceGroupAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"removeOffloadPolicies(String)","u":"removeOffloadPolicies(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"removeOffloadPolicies(String)","u":"removeOffloadPolicies(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"removeOffloadPolicies(String)","u":"removeOffloadPolicies(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"removeOffloadPoliciesAsync(String)","u":"removeOffloadPoliciesAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"removeOffloadPoliciesAsync(String)","u":"removeOffloadPoliciesAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"removeOffloadPoliciesAsync(String)","u":"removeOffloadPoliciesAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"removePersistence(String)","u":"removePersistence(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"removePersistence(String)","u":"removePersistence(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"removePersistence(String)","u":"removePersistence(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"removePersistenceAsync(String)","u":"removePersistenceAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"removePersistenceAsync(String)","u":"removePersistenceAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"removePersistenceAsync(String)","u":"removePersistenceAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"removeProperties(String, String)","u":"removeProperties(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"removePropertiesAsync(String, String)","u":"removePropertiesAsync(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"removeProperty(String, String)","u":"removeProperty(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"removePropertyAsync(String, String)","u":"removePropertyAsync(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"removePublishRate(String)","u":"removePublishRate(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"removePublishRate(String)","u":"removePublishRate(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"removePublishRate(String)","u":"removePublishRate(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"removePublishRateAsync(String)","u":"removePublishRateAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"removePublishRateAsync(String)","u":"removePublishRateAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"removePublishRateAsync(String)","u":"removePublishRateAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"removeReplicationClusters(String)","u":"removeReplicationClusters(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"removeReplicationClustersAsync(String)","u":"removeReplicationClustersAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"removeReplicatorDispatchRate(String)","u":"removeReplicatorDispatchRate(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"removeReplicatorDispatchRate(String)","u":"removeReplicatorDispatchRate(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"removeReplicatorDispatchRate(String)","u":"removeReplicatorDispatchRate(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"removeReplicatorDispatchRateAsync(String)","u":"removeReplicatorDispatchRateAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"removeReplicatorDispatchRateAsync(String)","u":"removeReplicatorDispatchRateAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"removeReplicatorDispatchRateAsync(String)","u":"removeReplicatorDispatchRateAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"removeRetention(String)","u":"removeRetention(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"removeRetention(String)","u":"removeRetention(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"removeRetention(String)","u":"removeRetention(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"removeRetentionAsync(String)","u":"removeRetentionAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"removeRetentionAsync(String)","u":"removeRetentionAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"removeRetentionAsync(String)","u":"removeRetentionAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"removeSchemaCompatibilityStrategy(String)","u":"removeSchemaCompatibilityStrategy(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"removeSchemaCompatibilityStrategyAsync(String)","u":"removeSchemaCompatibilityStrategyAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"removeShadowTopics(String)","u":"removeShadowTopics(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"removeShadowTopicsAsync(String)","u":"removeShadowTopicsAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"removeSubscribeRate(String)","u":"removeSubscribeRate(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"removeSubscribeRate(String)","u":"removeSubscribeRate(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"removeSubscribeRate(String)","u":"removeSubscribeRate(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"removeSubscribeRateAsync(String)","u":"removeSubscribeRateAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"removeSubscribeRateAsync(String)","u":"removeSubscribeRateAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"removeSubscribeRateAsync(String)","u":"removeSubscribeRateAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"removeSubscriptionDispatchRate(String)","u":"removeSubscriptionDispatchRate(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"removeSubscriptionDispatchRate(String)","u":"removeSubscriptionDispatchRate(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"removeSubscriptionDispatchRate(String)","u":"removeSubscriptionDispatchRate(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"removeSubscriptionDispatchRate(String, String)","u":"removeSubscriptionDispatchRate(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"removeSubscriptionDispatchRateAsync(String)","u":"removeSubscriptionDispatchRateAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"removeSubscriptionDispatchRateAsync(String)","u":"removeSubscriptionDispatchRateAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"removeSubscriptionDispatchRateAsync(String)","u":"removeSubscriptionDispatchRateAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"removeSubscriptionDispatchRateAsync(String, String)","u":"removeSubscriptionDispatchRateAsync(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"removeSubscriptionExpirationTime(String)","u":"removeSubscriptionExpirationTime(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"removeSubscriptionExpirationTimeAsync(String)","u":"removeSubscriptionExpirationTimeAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"removeSubscriptionTypesEnabled(String)","u":"removeSubscriptionTypesEnabled(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"removeSubscriptionTypesEnabled(String)","u":"removeSubscriptionTypesEnabled(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"removeSubscriptionTypesEnabled(String)","u":"removeSubscriptionTypesEnabled(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"removeSubscriptionTypesEnabledAsync(String)","u":"removeSubscriptionTypesEnabledAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"removeSubscriptionTypesEnabledAsync(String)","u":"removeSubscriptionTypesEnabledAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"removeSubscriptionTypesEnabledAsync(String)","u":"removeSubscriptionTypesEnabledAsync(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"Policies","l":"replication_clusters"},{"p":"org.apache.pulsar.common.policies.data","c":"Policies","l":"replicatorDispatchRate"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdminBuilder","l":"requestTimeout(int, TimeUnit)","u":"requestTimeout(int,java.util.concurrent.TimeUnit)"},{"p":"org.apache.pulsar.common.policies.data","c":"PartitionedTopicInternalStats","l":"reset()"},{"p":"org.apache.pulsar.policies.data.loadbalancer","c":"NamespaceBundleStats","l":"reset()"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"resetCursor(String, String, long)","u":"resetCursor(java.lang.String,java.lang.String,long)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"resetCursor(String, String, MessageId)","u":"resetCursor(java.lang.String,java.lang.String,org.apache.pulsar.client.api.MessageId)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"resetCursor(String, String, MessageId, boolean)","u":"resetCursor(java.lang.String,java.lang.String,org.apache.pulsar.client.api.MessageId,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"resetCursorAsync(String, String, long)","u":"resetCursorAsync(java.lang.String,java.lang.String,long)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"resetCursorAsync(String, String, MessageId)","u":"resetCursorAsync(java.lang.String,java.lang.String,org.apache.pulsar.client.api.MessageId)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"resetCursorAsync(String, String, MessageId, boolean)","u":"resetCursorAsync(java.lang.String,java.lang.String,org.apache.pulsar.client.api.MessageId,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"ResourceQuotas","l":"resetNamespaceBundleResourceQuota(String, String)","u":"resetNamespaceBundleResourceQuota(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"ResourceQuotas","l":"resetNamespaceBundleResourceQuotaAsync(String, String)","u":"resetNamespaceBundleResourceQuotaAsync(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"Policies","l":"resource_group_name"},{"p":"org.apache.pulsar.common.policies.data","c":"ResourceGroup","l":"ResourceGroup()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdmin","l":"resourcegroups()"},{"p":"org.apache.pulsar.common.policies.data","c":"ResourceQuota","l":"ResourceQuota()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdmin","l":"resourceQuotas()"},{"p":"org.apache.pulsar.common.functions","c":"Resources","l":"Resources()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.policies.data.loadbalancer","c":"ResourceUsage","l":"ResourceUsage()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.policies.data.loadbalancer","c":"ResourceUsage","l":"ResourceUsage(double, double)","u":"%3Cinit%3E(double,double)"},{"p":"org.apache.pulsar.client.admin","c":"Functions","l":"restartFunction(String, String, String)","u":"restartFunction(java.lang.String,java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Functions","l":"restartFunction(String, String, String, int)","u":"restartFunction(java.lang.String,java.lang.String,java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"Functions","l":"restartFunctionAsync(String, String, String)","u":"restartFunctionAsync(java.lang.String,java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Functions","l":"restartFunctionAsync(String, String, String, int)","u":"restartFunctionAsync(java.lang.String,java.lang.String,java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"Sinks","l":"restartSink(String, String, String)","u":"restartSink(java.lang.String,java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Sinks","l":"restartSink(String, String, String, int)","u":"restartSink(java.lang.String,java.lang.String,java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"Sinks","l":"restartSinkAsync(String, String, String)","u":"restartSinkAsync(java.lang.String,java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Sinks","l":"restartSinkAsync(String, String, String, int)","u":"restartSinkAsync(java.lang.String,java.lang.String,java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"Sources","l":"restartSource(String, String, String)","u":"restartSource(java.lang.String,java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Sources","l":"restartSource(String, String, String, int)","u":"restartSource(java.lang.String,java.lang.String,java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"Sources","l":"restartSourceAsync(String, String, String)","u":"restartSourceAsync(java.lang.String,java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Sources","l":"restartSourceAsync(String, String, String, int)","u":"restartSourceAsync(java.lang.String,java.lang.String,java.lang.String,int)"},{"p":"org.apache.pulsar.common.policies.data","c":"Policies","l":"retention_policies"},{"p":"org.apache.pulsar.common.policies.data","c":"RetentionPolicies","l":"RetentionPolicies()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data","c":"RetentionPolicies","l":"RetentionPolicies(int, long)","u":"%3Cinit%3E(int,long)"},{"p":"org.apache.pulsar.common.policies.data","c":"BacklogQuota.Builder","l":"retentionPolicy(BacklogQuota.RetentionPolicy)","u":"retentionPolicy(org.apache.pulsar.common.policies.data.BacklogQuota.RetentionPolicy)"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"BacklogQuotaImpl.BacklogQuotaImplBuilder","l":"retentionPolicy(BacklogQuota.RetentionPolicy)","u":"retentionPolicy(org.apache.pulsar.common.policies.data.BacklogQuota.RetentionPolicy)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"revokePermissionOnSubscription(String, String, String)","u":"revokePermissionOnSubscription(java.lang.String,java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"revokePermissionOnSubscriptionAsync(String, String, String)","u":"revokePermissionOnSubscriptionAsync(java.lang.String,java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"revokePermissionOnTopics(List)","u":"revokePermissionOnTopics(java.util.List)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"revokePermissionOnTopicsAsync(List)","u":"revokePermissionOnTopicsAsync(java.util.List)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"revokePermissions(String, String)","u":"revokePermissions(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"revokePermissionsAsync(String, String)","u":"revokePermissionsAsync(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"revokePermissionsOnNamespace(String, String)","u":"revokePermissionsOnNamespace(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"revokePermissionsOnNamespaceAsync(String, String)","u":"revokePermissionsOnNamespaceAsync(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"RevokeTopicPermissionOptions","l":"RevokeTopicPermissionOptions()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data","c":"FunctionStatus.FunctionInstanceStatus.FunctionInstanceStatusData","l":"running"},{"p":"org.apache.pulsar.common.policies.data","c":"SinkStatus.SinkInstanceStatus.SinkInstanceStatusData","l":"running"},{"p":"org.apache.pulsar.common.policies.data","c":"SourceStatus.SourceInstanceStatus.SourceInstanceStatusData","l":"running"},{"p":"org.apache.pulsar.client.admin","c":"LongRunningProcessStatus.Status","l":"RUNNING"},{"p":"org.apache.pulsar.common.policies.data","c":"OffloadPolicies.Builder","l":"s3ManagedLedgerOffloadBucket(String)","u":"s3ManagedLedgerOffloadBucket(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"OffloadPolicies.Builder","l":"s3ManagedLedgerOffloadCredentialId(String)","u":"s3ManagedLedgerOffloadCredentialId(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"OffloadPolicies.Builder","l":"s3ManagedLedgerOffloadCredentialSecret(String)","u":"s3ManagedLedgerOffloadCredentialSecret(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"OffloadPolicies.Builder","l":"s3ManagedLedgerOffloadMaxBlockSizeInBytes(Integer)","u":"s3ManagedLedgerOffloadMaxBlockSizeInBytes(java.lang.Integer)"},{"p":"org.apache.pulsar.common.policies.data","c":"OffloadPolicies.Builder","l":"s3ManagedLedgerOffloadReadBufferSizeInBytes(Integer)","u":"s3ManagedLedgerOffloadReadBufferSizeInBytes(java.lang.Integer)"},{"p":"org.apache.pulsar.common.policies.data","c":"OffloadPolicies.Builder","l":"s3ManagedLedgerOffloadRegion(String)","u":"s3ManagedLedgerOffloadRegion(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"OffloadPolicies.Builder","l":"s3ManagedLedgerOffloadRole(String)","u":"s3ManagedLedgerOffloadRole(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"OffloadPolicies.Builder","l":"s3ManagedLedgerOffloadServiceEndpoint(String)","u":"s3ManagedLedgerOffloadServiceEndpoint(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Transactions","l":"scaleTransactionCoordinators(int)"},{"p":"org.apache.pulsar.client.admin","c":"Transactions","l":"scaleTransactionCoordinatorsAsync(int)"},{"p":"org.apache.pulsar.common.policies.data","c":"Policies","l":"schema_auto_update_compatibility_strategy"},{"p":"org.apache.pulsar.common.policies.data","c":"Policies","l":"schema_compatibility_strategy"},{"p":"org.apache.pulsar.common.policies.data","c":"Policies","l":"schema_validation_enforced"},{"p":"org.apache.pulsar.common.policies.data","c":"PersistentTopicInternalStats","l":"schemaLedgers"},{"p":"org.apache.pulsar.common.policies.data","c":"SchemaMetadata","l":"SchemaMetadata()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdmin","l":"schemas()"},{"p":"org.apache.pulsar.common.policies.data","c":"BrokerAssignment","l":"secondary"},{"p":"org.apache.pulsar.common.policies.data","c":"NamespaceIsolationData.Builder","l":"secondary(List)","u":"secondary(java.util.List)"},{"p":"org.apache.pulsar.common.policies.data","c":"TransactionBufferInternalStats","l":"segmentIndexInternalStats"},{"p":"org.apache.pulsar.common.policies.data","c":"TransactionBufferInternalStats","l":"segmentInternalStats"},{"p":"org.apache.pulsar.common.policies.data","c":"SegmentsStats","l":"segmentsSize"},{"p":"org.apache.pulsar.common.policies.data","c":"TransactionBufferStats","l":"segmentsStats"},{"p":"org.apache.pulsar.common.policies.data","c":"SegmentsStats","l":"SegmentsStats()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data","c":"SegmentsStats","l":"segmentStats"},{"p":"org.apache.pulsar.common.policies.data","c":"SegmentStats","l":"SegmentStats()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data","c":"SegmentStats","l":"SegmentStats(String, String)","u":"%3Cinit%3E(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdminException.ServerSideErrorException","l":"ServerSideErrorException(Throwable)","u":"%3Cinit%3E(java.lang.Throwable)"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdminException.ServerSideErrorException","l":"ServerSideErrorException(Throwable, String, String, int)","u":"%3Cinit%3E(java.lang.Throwable,java.lang.String,java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdminBuilder","l":"serviceHttpUrl(String)","u":"serviceHttpUrl(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"BrokerInfo.Builder","l":"serviceUrl(String)","u":"serviceUrl(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"ClusterData.Builder","l":"serviceUrl(String)","u":"serviceUrl(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"BrokerInfoImpl.BrokerInfoImplBuilder","l":"serviceUrl(String)","u":"serviceUrl(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"ClusterData.Builder","l":"serviceUrlTls(String)","u":"serviceUrlTls(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setAutoSubscriptionCreation(String, AutoSubscriptionCreationOverride)","u":"setAutoSubscriptionCreation(java.lang.String,org.apache.pulsar.common.policies.data.AutoSubscriptionCreationOverride)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"setAutoSubscriptionCreation(String, AutoSubscriptionCreationOverride)","u":"setAutoSubscriptionCreation(java.lang.String,org.apache.pulsar.common.policies.data.AutoSubscriptionCreationOverride)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setAutoSubscriptionCreationAsync(String, AutoSubscriptionCreationOverride)","u":"setAutoSubscriptionCreationAsync(java.lang.String,org.apache.pulsar.common.policies.data.AutoSubscriptionCreationOverride)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"setAutoSubscriptionCreationAsync(String, AutoSubscriptionCreationOverride)","u":"setAutoSubscriptionCreationAsync(java.lang.String,org.apache.pulsar.common.policies.data.AutoSubscriptionCreationOverride)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setAutoTopicCreation(String, AutoTopicCreationOverride)","u":"setAutoTopicCreation(java.lang.String,org.apache.pulsar.common.policies.data.AutoTopicCreationOverride)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setAutoTopicCreationAsync(String, AutoTopicCreationOverride)","u":"setAutoTopicCreationAsync(java.lang.String,org.apache.pulsar.common.policies.data.AutoTopicCreationOverride)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setBacklogQuota(String, BacklogQuota)","u":"setBacklogQuota(java.lang.String,org.apache.pulsar.common.policies.data.BacklogQuota)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"setBacklogQuota(String, BacklogQuota)","u":"setBacklogQuota(java.lang.String,org.apache.pulsar.common.policies.data.BacklogQuota)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"setBacklogQuota(String, BacklogQuota)","u":"setBacklogQuota(java.lang.String,org.apache.pulsar.common.policies.data.BacklogQuota)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setBacklogQuota(String, BacklogQuota, BacklogQuota.BacklogQuotaType)","u":"setBacklogQuota(java.lang.String,org.apache.pulsar.common.policies.data.BacklogQuota,org.apache.pulsar.common.policies.data.BacklogQuota.BacklogQuotaType)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"setBacklogQuota(String, BacklogQuota, BacklogQuota.BacklogQuotaType)","u":"setBacklogQuota(java.lang.String,org.apache.pulsar.common.policies.data.BacklogQuota,org.apache.pulsar.common.policies.data.BacklogQuota.BacklogQuotaType)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"setBacklogQuota(String, BacklogQuota, BacklogQuota.BacklogQuotaType)","u":"setBacklogQuota(java.lang.String,org.apache.pulsar.common.policies.data.BacklogQuota,org.apache.pulsar.common.policies.data.BacklogQuota.BacklogQuotaType)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setBacklogQuotaAsync(String, BacklogQuota)","u":"setBacklogQuotaAsync(java.lang.String,org.apache.pulsar.common.policies.data.BacklogQuota)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setBacklogQuotaAsync(String, BacklogQuota, BacklogQuota.BacklogQuotaType)","u":"setBacklogQuotaAsync(java.lang.String,org.apache.pulsar.common.policies.data.BacklogQuota,org.apache.pulsar.common.policies.data.BacklogQuota.BacklogQuotaType)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setBookieAffinityGroup(String, BookieAffinityGroupData)","u":"setBookieAffinityGroup(java.lang.String,org.apache.pulsar.common.policies.data.BookieAffinityGroupData)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setBookieAffinityGroupAsync(String, BookieAffinityGroupData)","u":"setBookieAffinityGroupAsync(java.lang.String,org.apache.pulsar.common.policies.data.BookieAffinityGroupData)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setCompactionThreshold(String, long)","u":"setCompactionThreshold(java.lang.String,long)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"setCompactionThreshold(String, long)","u":"setCompactionThreshold(java.lang.String,long)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"setCompactionThreshold(String, long)","u":"setCompactionThreshold(java.lang.String,long)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setCompactionThresholdAsync(String, long)","u":"setCompactionThresholdAsync(java.lang.String,long)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"setCompactionThresholdAsync(String, long)","u":"setCompactionThresholdAsync(java.lang.String,long)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"setCompactionThresholdAsync(String, long)","u":"setCompactionThresholdAsync(java.lang.String,long)"},{"p":"org.apache.pulsar.common.conf","c":"InternalConfigurationData","l":"setConfigurationStoreServers(String)","u":"setConfigurationStoreServers(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdminBuilder","l":"setContextClassLoader(ClassLoader)","u":"setContextClassLoader(java.lang.ClassLoader)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"setDeduplicationSnapshotInterval(String, int)","u":"setDeduplicationSnapshotInterval(java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"setDeduplicationSnapshotInterval(String, int)","u":"setDeduplicationSnapshotInterval(java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setDeduplicationSnapshotInterval(String, Integer)","u":"setDeduplicationSnapshotInterval(java.lang.String,java.lang.Integer)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"setDeduplicationSnapshotIntervalAsync(String, int)","u":"setDeduplicationSnapshotIntervalAsync(java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"setDeduplicationSnapshotIntervalAsync(String, int)","u":"setDeduplicationSnapshotIntervalAsync(java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setDeduplicationSnapshotIntervalAsync(String, Integer)","u":"setDeduplicationSnapshotIntervalAsync(java.lang.String,java.lang.Integer)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setDeduplicationStatus(String, boolean)","u":"setDeduplicationStatus(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"setDeduplicationStatus(String, boolean)","u":"setDeduplicationStatus(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"setDeduplicationStatus(String, boolean)","u":"setDeduplicationStatus(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setDeduplicationStatusAsync(String, boolean)","u":"setDeduplicationStatusAsync(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"setDeduplicationStatusAsync(String, boolean)","u":"setDeduplicationStatusAsync(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"setDeduplicationStatusAsync(String, boolean)","u":"setDeduplicationStatusAsync(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"ResourceQuotas","l":"setDefaultResourceQuota(ResourceQuota)","u":"setDefaultResourceQuota(org.apache.pulsar.common.policies.data.ResourceQuota)"},{"p":"org.apache.pulsar.client.admin","c":"ResourceQuotas","l":"setDefaultResourceQuotaAsync(ResourceQuota)","u":"setDefaultResourceQuotaAsync(org.apache.pulsar.common.policies.data.ResourceQuota)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setDelayedDeliveryMessages(String, DelayedDeliveryPolicies)","u":"setDelayedDeliveryMessages(java.lang.String,org.apache.pulsar.common.policies.data.DelayedDeliveryPolicies)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setDelayedDeliveryMessagesAsync(String, DelayedDeliveryPolicies)","u":"setDelayedDeliveryMessagesAsync(java.lang.String,org.apache.pulsar.common.policies.data.DelayedDeliveryPolicies)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"setDelayedDeliveryPolicy(String, DelayedDeliveryPolicies)","u":"setDelayedDeliveryPolicy(java.lang.String,org.apache.pulsar.common.policies.data.DelayedDeliveryPolicies)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"setDelayedDeliveryPolicy(String, DelayedDeliveryPolicies)","u":"setDelayedDeliveryPolicy(java.lang.String,org.apache.pulsar.common.policies.data.DelayedDeliveryPolicies)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"setDelayedDeliveryPolicyAsync(String, DelayedDeliveryPolicies)","u":"setDelayedDeliveryPolicyAsync(java.lang.String,org.apache.pulsar.common.policies.data.DelayedDeliveryPolicies)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"setDelayedDeliveryPolicyAsync(String, DelayedDeliveryPolicies)","u":"setDelayedDeliveryPolicyAsync(java.lang.String,org.apache.pulsar.common.policies.data.DelayedDeliveryPolicies)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setDispatcherPauseOnAckStatePersistent(String)","u":"setDispatcherPauseOnAckStatePersistent(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"setDispatcherPauseOnAckStatePersistent(String)","u":"setDispatcherPauseOnAckStatePersistent(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setDispatcherPauseOnAckStatePersistentAsync(String)","u":"setDispatcherPauseOnAckStatePersistentAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setDispatchRate(String, DispatchRate)","u":"setDispatchRate(java.lang.String,org.apache.pulsar.common.policies.data.DispatchRate)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"setDispatchRate(String, DispatchRate)","u":"setDispatchRate(java.lang.String,org.apache.pulsar.common.policies.data.DispatchRate)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"setDispatchRate(String, DispatchRate)","u":"setDispatchRate(java.lang.String,org.apache.pulsar.common.policies.data.DispatchRate)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setDispatchRateAsync(String, DispatchRate)","u":"setDispatchRateAsync(java.lang.String,org.apache.pulsar.common.policies.data.DispatchRate)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"setDispatchRateAsync(String, DispatchRate)","u":"setDispatchRateAsync(java.lang.String,org.apache.pulsar.common.policies.data.DispatchRate)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"setDispatchRateAsync(String, DispatchRate)","u":"setDispatchRateAsync(java.lang.String,org.apache.pulsar.common.policies.data.DispatchRate)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setEncryptionRequiredStatus(String, boolean)","u":"setEncryptionRequiredStatus(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setEncryptionRequiredStatusAsync(String, boolean)","u":"setEncryptionRequiredStatusAsync(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"setEntryFiltersPerTopic(String, EntryFilters)","u":"setEntryFiltersPerTopic(java.lang.String,org.apache.pulsar.common.policies.data.EntryFilters)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"setEntryFiltersPerTopicAsync(String, EntryFilters)","u":"setEntryFiltersPerTopicAsync(java.lang.String,org.apache.pulsar.common.policies.data.EntryFilters)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setInactiveTopicPolicies(String, InactiveTopicPolicies)","u":"setInactiveTopicPolicies(java.lang.String,org.apache.pulsar.common.policies.data.InactiveTopicPolicies)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"setInactiveTopicPolicies(String, InactiveTopicPolicies)","u":"setInactiveTopicPolicies(java.lang.String,org.apache.pulsar.common.policies.data.InactiveTopicPolicies)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"setInactiveTopicPolicies(String, InactiveTopicPolicies)","u":"setInactiveTopicPolicies(java.lang.String,org.apache.pulsar.common.policies.data.InactiveTopicPolicies)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setInactiveTopicPoliciesAsync(String, InactiveTopicPolicies)","u":"setInactiveTopicPoliciesAsync(java.lang.String,org.apache.pulsar.common.policies.data.InactiveTopicPolicies)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"setInactiveTopicPoliciesAsync(String, InactiveTopicPolicies)","u":"setInactiveTopicPoliciesAsync(java.lang.String,org.apache.pulsar.common.policies.data.InactiveTopicPolicies)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"setInactiveTopicPoliciesAsync(String, InactiveTopicPolicies)","u":"setInactiveTopicPoliciesAsync(java.lang.String,org.apache.pulsar.common.policies.data.InactiveTopicPolicies)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setIsAllowAutoUpdateSchema(String, boolean)","u":"setIsAllowAutoUpdateSchema(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setIsAllowAutoUpdateSchemaAsync(String, boolean)","u":"setIsAllowAutoUpdateSchemaAsync(java.lang.String,boolean)"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"BacklogQuotaImpl","l":"setLimit(long)"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"BacklogQuotaImpl","l":"setLimitSize(long)"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"BacklogQuotaImpl","l":"setLimitTime(int)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"setMaxConsumers(String, int)","u":"setMaxConsumers(java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"setMaxConsumers(String, int)","u":"setMaxConsumers(java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"setMaxConsumersAsync(String, int)","u":"setMaxConsumersAsync(java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"setMaxConsumersAsync(String, int)","u":"setMaxConsumersAsync(java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setMaxConsumersPerSubscription(String, int)","u":"setMaxConsumersPerSubscription(java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"setMaxConsumersPerSubscription(String, int)","u":"setMaxConsumersPerSubscription(java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"setMaxConsumersPerSubscription(String, int)","u":"setMaxConsumersPerSubscription(java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setMaxConsumersPerSubscriptionAsync(String, int)","u":"setMaxConsumersPerSubscriptionAsync(java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"setMaxConsumersPerSubscriptionAsync(String, int)","u":"setMaxConsumersPerSubscriptionAsync(java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"setMaxConsumersPerSubscriptionAsync(String, int)","u":"setMaxConsumersPerSubscriptionAsync(java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setMaxConsumersPerTopic(String, int)","u":"setMaxConsumersPerTopic(java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setMaxConsumersPerTopicAsync(String, int)","u":"setMaxConsumersPerTopicAsync(java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"setMaxMessageSize(String, int)","u":"setMaxMessageSize(java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"setMaxMessageSize(String, int)","u":"setMaxMessageSize(java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"setMaxMessageSizeAsync(String, int)","u":"setMaxMessageSizeAsync(java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"setMaxMessageSizeAsync(String, int)","u":"setMaxMessageSizeAsync(java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"setMaxProducers(String, int)","u":"setMaxProducers(java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"setMaxProducers(String, int)","u":"setMaxProducers(java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"setMaxProducersAsync(String, int)","u":"setMaxProducersAsync(java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"setMaxProducersAsync(String, int)","u":"setMaxProducersAsync(java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setMaxProducersPerTopic(String, int)","u":"setMaxProducersPerTopic(java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setMaxProducersPerTopicAsync(String, int)","u":"setMaxProducersPerTopicAsync(java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setMaxSubscriptionsPerTopic(String, int)","u":"setMaxSubscriptionsPerTopic(java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"setMaxSubscriptionsPerTopic(String, int)","u":"setMaxSubscriptionsPerTopic(java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"setMaxSubscriptionsPerTopic(String, int)","u":"setMaxSubscriptionsPerTopic(java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setMaxSubscriptionsPerTopicAsync(String, int)","u":"setMaxSubscriptionsPerTopicAsync(java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"setMaxSubscriptionsPerTopicAsync(String, int)","u":"setMaxSubscriptionsPerTopicAsync(java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"setMaxSubscriptionsPerTopicAsync(String, int)","u":"setMaxSubscriptionsPerTopicAsync(java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setMaxTopicsPerNamespace(String, int)","u":"setMaxTopicsPerNamespace(java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setMaxTopicsPerNamespaceAsync(String, int)","u":"setMaxTopicsPerNamespaceAsync(java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"setMaxUnackedMessagesOnConsumer(String, int)","u":"setMaxUnackedMessagesOnConsumer(java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"setMaxUnackedMessagesOnConsumer(String, int)","u":"setMaxUnackedMessagesOnConsumer(java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"setMaxUnackedMessagesOnConsumerAsync(String, int)","u":"setMaxUnackedMessagesOnConsumerAsync(java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"setMaxUnackedMessagesOnConsumerAsync(String, int)","u":"setMaxUnackedMessagesOnConsumerAsync(java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"setMaxUnackedMessagesOnSubscription(String, int)","u":"setMaxUnackedMessagesOnSubscription(java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"setMaxUnackedMessagesOnSubscription(String, int)","u":"setMaxUnackedMessagesOnSubscription(java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"setMaxUnackedMessagesOnSubscriptionAsync(String, int)","u":"setMaxUnackedMessagesOnSubscriptionAsync(java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"setMaxUnackedMessagesOnSubscriptionAsync(String, int)","u":"setMaxUnackedMessagesOnSubscriptionAsync(java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setMaxUnackedMessagesPerConsumer(String, int)","u":"setMaxUnackedMessagesPerConsumer(java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setMaxUnackedMessagesPerConsumerAsync(String, int)","u":"setMaxUnackedMessagesPerConsumerAsync(java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setMaxUnackedMessagesPerSubscription(String, int)","u":"setMaxUnackedMessagesPerSubscription(java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setMaxUnackedMessagesPerSubscriptionAsync(String, int)","u":"setMaxUnackedMessagesPerSubscriptionAsync(java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"setMessageTTL(String, int)","u":"setMessageTTL(java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"setMessageTTL(String, int)","u":"setMessageTTL(java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setNamespaceAllowedClusters(String, Set)","u":"setNamespaceAllowedClusters(java.lang.String,java.util.Set)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setNamespaceAllowedClustersAsync(String, Set)","u":"setNamespaceAllowedClustersAsync(java.lang.String,java.util.Set)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setNamespaceAntiAffinityGroup(String, String)","u":"setNamespaceAntiAffinityGroup(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setNamespaceAntiAffinityGroupAsync(String, String)","u":"setNamespaceAntiAffinityGroupAsync(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"ResourceQuotas","l":"setNamespaceBundleResourceQuota(String, String, ResourceQuota)","u":"setNamespaceBundleResourceQuota(java.lang.String,java.lang.String,org.apache.pulsar.common.policies.data.ResourceQuota)"},{"p":"org.apache.pulsar.client.admin","c":"ResourceQuotas","l":"setNamespaceBundleResourceQuotaAsync(String, String, ResourceQuota)","u":"setNamespaceBundleResourceQuotaAsync(java.lang.String,java.lang.String,org.apache.pulsar.common.policies.data.ResourceQuota)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setNamespaceEntryFilters(String, EntryFilters)","u":"setNamespaceEntryFilters(java.lang.String,org.apache.pulsar.common.policies.data.EntryFilters)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setNamespaceEntryFiltersAsync(String, EntryFilters)","u":"setNamespaceEntryFiltersAsync(java.lang.String,org.apache.pulsar.common.policies.data.EntryFilters)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setNamespaceMessageTTL(String, int)","u":"setNamespaceMessageTTL(java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setNamespaceMessageTTLAsync(String, int)","u":"setNamespaceMessageTTLAsync(java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setNamespaceReplicationClusters(String, Set)","u":"setNamespaceReplicationClusters(java.lang.String,java.util.Set)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setNamespaceReplicationClustersAsync(String, Set)","u":"setNamespaceReplicationClustersAsync(java.lang.String,java.util.Set)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setNamespaceResourceGroup(String, String)","u":"setNamespaceResourceGroup(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setNamespaceResourceGroupAsync(String, String)","u":"setNamespaceResourceGroupAsync(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setOffloadDeleteLag(String, long, TimeUnit)","u":"setOffloadDeleteLag(java.lang.String,long,java.util.concurrent.TimeUnit)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setOffloadDeleteLagAsync(String, long, TimeUnit)","u":"setOffloadDeleteLagAsync(java.lang.String,long,java.util.concurrent.TimeUnit)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setOffloadPolicies(String, OffloadPolicies)","u":"setOffloadPolicies(java.lang.String,org.apache.pulsar.common.policies.data.OffloadPolicies)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"setOffloadPolicies(String, OffloadPolicies)","u":"setOffloadPolicies(java.lang.String,org.apache.pulsar.common.policies.data.OffloadPolicies)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"setOffloadPolicies(String, OffloadPolicies)","u":"setOffloadPolicies(java.lang.String,org.apache.pulsar.common.policies.data.OffloadPolicies)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setOffloadPoliciesAsync(String, OffloadPolicies)","u":"setOffloadPoliciesAsync(java.lang.String,org.apache.pulsar.common.policies.data.OffloadPolicies)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"setOffloadPoliciesAsync(String, OffloadPolicies)","u":"setOffloadPoliciesAsync(java.lang.String,org.apache.pulsar.common.policies.data.OffloadPolicies)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"setOffloadPoliciesAsync(String, OffloadPolicies)","u":"setOffloadPoliciesAsync(java.lang.String,org.apache.pulsar.common.policies.data.OffloadPolicies)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setOffloadThreshold(String, long)","u":"setOffloadThreshold(java.lang.String,long)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setOffloadThresholdAsync(String, long)","u":"setOffloadThresholdAsync(java.lang.String,long)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setOffloadThresholdInSeconds(String, long)","u":"setOffloadThresholdInSeconds(java.lang.String,long)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setOffloadThresholdInSecondsAsync(String, long)","u":"setOffloadThresholdInSecondsAsync(java.lang.String,long)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setPersistence(String, PersistencePolicies)","u":"setPersistence(java.lang.String,org.apache.pulsar.common.policies.data.PersistencePolicies)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"setPersistence(String, PersistencePolicies)","u":"setPersistence(java.lang.String,org.apache.pulsar.common.policies.data.PersistencePolicies)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"setPersistence(String, PersistencePolicies)","u":"setPersistence(java.lang.String,org.apache.pulsar.common.policies.data.PersistencePolicies)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setPersistenceAsync(String, PersistencePolicies)","u":"setPersistenceAsync(java.lang.String,org.apache.pulsar.common.policies.data.PersistencePolicies)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"setPersistenceAsync(String, PersistencePolicies)","u":"setPersistenceAsync(java.lang.String,org.apache.pulsar.common.policies.data.PersistencePolicies)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"setPersistenceAsync(String, PersistencePolicies)","u":"setPersistenceAsync(java.lang.String,org.apache.pulsar.common.policies.data.PersistencePolicies)"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"BacklogQuotaImpl","l":"setPolicy(BacklogQuota.RetentionPolicy)","u":"setPolicy(org.apache.pulsar.common.policies.data.BacklogQuota.RetentionPolicy)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setProperties(String, Map)","u":"setProperties(java.lang.String,java.util.Map)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setPropertiesAsync(String, Map)","u":"setPropertiesAsync(java.lang.String,java.util.Map)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setProperty(String, String, String)","u":"setProperty(java.lang.String,java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setPropertyAsync(String, String, String)","u":"setPropertyAsync(java.lang.String,java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setPublishRate(String, PublishRate)","u":"setPublishRate(java.lang.String,org.apache.pulsar.common.policies.data.PublishRate)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"setPublishRate(String, PublishRate)","u":"setPublishRate(java.lang.String,org.apache.pulsar.common.policies.data.PublishRate)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"setPublishRate(String, PublishRate)","u":"setPublishRate(java.lang.String,org.apache.pulsar.common.policies.data.PublishRate)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setPublishRateAsync(String, PublishRate)","u":"setPublishRateAsync(java.lang.String,org.apache.pulsar.common.policies.data.PublishRate)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"setPublishRateAsync(String, PublishRate)","u":"setPublishRateAsync(java.lang.String,org.apache.pulsar.common.policies.data.PublishRate)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"setPublishRateAsync(String, PublishRate)","u":"setPublishRateAsync(java.lang.String,org.apache.pulsar.common.policies.data.PublishRate)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"setReplicatedSubscriptionStatus(String, String, boolean)","u":"setReplicatedSubscriptionStatus(java.lang.String,java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"setReplicatedSubscriptionStatusAsync(String, String, boolean)","u":"setReplicatedSubscriptionStatusAsync(java.lang.String,java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"setReplicationClusters(String, List)","u":"setReplicationClusters(java.lang.String,java.util.List)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"setReplicationClustersAsync(String, List)","u":"setReplicationClustersAsync(java.lang.String,java.util.List)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setReplicatorDispatchRate(String, DispatchRate)","u":"setReplicatorDispatchRate(java.lang.String,org.apache.pulsar.common.policies.data.DispatchRate)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"setReplicatorDispatchRate(String, DispatchRate)","u":"setReplicatorDispatchRate(java.lang.String,org.apache.pulsar.common.policies.data.DispatchRate)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"setReplicatorDispatchRate(String, DispatchRate)","u":"setReplicatorDispatchRate(java.lang.String,org.apache.pulsar.common.policies.data.DispatchRate)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setReplicatorDispatchRateAsync(String, DispatchRate)","u":"setReplicatorDispatchRateAsync(java.lang.String,org.apache.pulsar.common.policies.data.DispatchRate)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"setReplicatorDispatchRateAsync(String, DispatchRate)","u":"setReplicatorDispatchRateAsync(java.lang.String,org.apache.pulsar.common.policies.data.DispatchRate)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"setReplicatorDispatchRateAsync(String, DispatchRate)","u":"setReplicatorDispatchRateAsync(java.lang.String,org.apache.pulsar.common.policies.data.DispatchRate)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setRetention(String, RetentionPolicies)","u":"setRetention(java.lang.String,org.apache.pulsar.common.policies.data.RetentionPolicies)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"setRetention(String, RetentionPolicies)","u":"setRetention(java.lang.String,org.apache.pulsar.common.policies.data.RetentionPolicies)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"setRetention(String, RetentionPolicies)","u":"setRetention(java.lang.String,org.apache.pulsar.common.policies.data.RetentionPolicies)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setRetentionAsync(String, RetentionPolicies)","u":"setRetentionAsync(java.lang.String,org.apache.pulsar.common.policies.data.RetentionPolicies)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"setRetentionAsync(String, RetentionPolicies)","u":"setRetentionAsync(java.lang.String,org.apache.pulsar.common.policies.data.RetentionPolicies)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"setRetentionAsync(String, RetentionPolicies)","u":"setRetentionAsync(java.lang.String,org.apache.pulsar.common.policies.data.RetentionPolicies)"},{"p":"org.apache.pulsar.common.policies.data","c":"OffloadPolicies.Builder","l":"setS3ManagedLedgerOffloadRoleSessionName(String)","u":"setS3ManagedLedgerOffloadRoleSessionName(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setSchemaAutoUpdateCompatibilityStrategy(String, SchemaAutoUpdateCompatibilityStrategy)","u":"setSchemaAutoUpdateCompatibilityStrategy(java.lang.String,org.apache.pulsar.common.policies.data.SchemaAutoUpdateCompatibilityStrategy)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setSchemaCompatibilityStrategy(String, SchemaCompatibilityStrategy)","u":"setSchemaCompatibilityStrategy(java.lang.String,org.apache.pulsar.common.policies.data.SchemaCompatibilityStrategy)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"setSchemaCompatibilityStrategy(String, SchemaCompatibilityStrategy)","u":"setSchemaCompatibilityStrategy(java.lang.String,org.apache.pulsar.common.policies.data.SchemaCompatibilityStrategy)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setSchemaCompatibilityStrategyAsync(String, SchemaCompatibilityStrategy)","u":"setSchemaCompatibilityStrategyAsync(java.lang.String,org.apache.pulsar.common.policies.data.SchemaCompatibilityStrategy)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"setSchemaCompatibilityStrategyAsync(String, SchemaCompatibilityStrategy)","u":"setSchemaCompatibilityStrategyAsync(java.lang.String,org.apache.pulsar.common.policies.data.SchemaCompatibilityStrategy)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setSchemaValidationEnforced(String, boolean)","u":"setSchemaValidationEnforced(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"setSchemaValidationEnforced(String, boolean)","u":"setSchemaValidationEnforced(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setSchemaValidationEnforcedAsync(String, boolean)","u":"setSchemaValidationEnforcedAsync(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"setSchemaValidationEnforcedAsync(String, boolean)","u":"setSchemaValidationEnforcedAsync(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"setShadowTopics(String, List)","u":"setShadowTopics(java.lang.String,java.util.List)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"setShadowTopicsAsync(String, List)","u":"setShadowTopicsAsync(java.lang.String,java.util.List)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setSubscribeRate(String, SubscribeRate)","u":"setSubscribeRate(java.lang.String,org.apache.pulsar.common.policies.data.SubscribeRate)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"setSubscribeRate(String, SubscribeRate)","u":"setSubscribeRate(java.lang.String,org.apache.pulsar.common.policies.data.SubscribeRate)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"setSubscribeRate(String, SubscribeRate)","u":"setSubscribeRate(java.lang.String,org.apache.pulsar.common.policies.data.SubscribeRate)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setSubscribeRateAsync(String, SubscribeRate)","u":"setSubscribeRateAsync(java.lang.String,org.apache.pulsar.common.policies.data.SubscribeRate)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"setSubscribeRateAsync(String, SubscribeRate)","u":"setSubscribeRateAsync(java.lang.String,org.apache.pulsar.common.policies.data.SubscribeRate)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"setSubscribeRateAsync(String, SubscribeRate)","u":"setSubscribeRateAsync(java.lang.String,org.apache.pulsar.common.policies.data.SubscribeRate)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setSubscriptionAuthMode(String, SubscriptionAuthMode)","u":"setSubscriptionAuthMode(java.lang.String,org.apache.pulsar.common.policies.data.SubscriptionAuthMode)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setSubscriptionAuthModeAsync(String, SubscriptionAuthMode)","u":"setSubscriptionAuthModeAsync(java.lang.String,org.apache.pulsar.common.policies.data.SubscriptionAuthMode)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setSubscriptionDispatchRate(String, DispatchRate)","u":"setSubscriptionDispatchRate(java.lang.String,org.apache.pulsar.common.policies.data.DispatchRate)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"setSubscriptionDispatchRate(String, DispatchRate)","u":"setSubscriptionDispatchRate(java.lang.String,org.apache.pulsar.common.policies.data.DispatchRate)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"setSubscriptionDispatchRate(String, DispatchRate)","u":"setSubscriptionDispatchRate(java.lang.String,org.apache.pulsar.common.policies.data.DispatchRate)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"setSubscriptionDispatchRate(String, String, DispatchRate)","u":"setSubscriptionDispatchRate(java.lang.String,java.lang.String,org.apache.pulsar.common.policies.data.DispatchRate)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setSubscriptionDispatchRateAsync(String, DispatchRate)","u":"setSubscriptionDispatchRateAsync(java.lang.String,org.apache.pulsar.common.policies.data.DispatchRate)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"setSubscriptionDispatchRateAsync(String, DispatchRate)","u":"setSubscriptionDispatchRateAsync(java.lang.String,org.apache.pulsar.common.policies.data.DispatchRate)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"setSubscriptionDispatchRateAsync(String, DispatchRate)","u":"setSubscriptionDispatchRateAsync(java.lang.String,org.apache.pulsar.common.policies.data.DispatchRate)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"setSubscriptionDispatchRateAsync(String, String, DispatchRate)","u":"setSubscriptionDispatchRateAsync(java.lang.String,java.lang.String,org.apache.pulsar.common.policies.data.DispatchRate)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setSubscriptionExpirationTime(String, int)","u":"setSubscriptionExpirationTime(java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setSubscriptionExpirationTimeAsync(String, int)","u":"setSubscriptionExpirationTimeAsync(java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setSubscriptionTypesEnabled(String, Set)","u":"setSubscriptionTypesEnabled(java.lang.String,java.util.Set)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"setSubscriptionTypesEnabled(String, Set)","u":"setSubscriptionTypesEnabled(java.lang.String,java.util.Set)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"setSubscriptionTypesEnabled(String, Set)","u":"setSubscriptionTypesEnabled(java.lang.String,java.util.Set)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"setSubscriptionTypesEnabledAsync(String, Set)","u":"setSubscriptionTypesEnabledAsync(java.lang.String,java.util.Set)"},{"p":"org.apache.pulsar.client.admin","c":"TopicPolicies","l":"setSubscriptionTypesEnabledAsync(String, Set)","u":"setSubscriptionTypesEnabledAsync(java.lang.String,java.util.Set)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"setSubscriptionTypesEnabledAsync(String, Set)","u":"setSubscriptionTypesEnabledAsync(java.lang.String,java.util.Set)"},{"p":"org.apache.pulsar.common.functions","c":"UpdateOptions","l":"setUpdateAuthData(boolean)"},{"p":"org.apache.pulsar.common.conf","c":"InternalConfigurationData","l":"setZookeeperServers(String)","u":"setZookeeperServers(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"BrokerAssignment","l":"shared"},{"p":"org.apache.pulsar.common.policies","c":"AutoFailoverPolicy","l":"shouldFailoverToSecondary(int)"},{"p":"org.apache.pulsar.common.policies.impl","c":"MinAvailablePolicy","l":"shouldFailoverToSecondary(int)"},{"p":"org.apache.pulsar.common.policies","c":"AutoFailoverPolicy","l":"shouldFailoverToSecondary(SortedSet)","u":"shouldFailoverToSecondary(java.util.SortedSet)"},{"p":"org.apache.pulsar.common.policies.impl","c":"MinAvailablePolicy","l":"shouldFailoverToSecondary(SortedSet)","u":"shouldFailoverToSecondary(java.util.SortedSet)"},{"p":"org.apache.pulsar.client.admin","c":"Brokers","l":"shutDownBrokerGracefully(int, boolean)","u":"shutDownBrokerGracefully(int,boolean)"},{"p":"org.apache.pulsar.common.policies.data","c":"TransactionBufferInternalStats","l":"singleSnapshotSystemTopicInternalStats"},{"p":"org.apache.pulsar.packages.management.core.common","c":"PackageType","l":"SINK"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdmin","l":"sink()"},{"p":"org.apache.pulsar.common.io","c":"SinkConfig","l":"SinkConfig()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data","c":"SinkStatus.SinkInstanceStatus","l":"SinkInstanceStatus()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data","c":"SinkStatus.SinkInstanceStatus.SinkInstanceStatusData","l":"SinkInstanceStatusData()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data","c":"AuthAction","l":"sinks"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdmin","l":"sinks()"},{"p":"org.apache.pulsar.common.policies.data","c":"SinkStatus","l":"SinkStatus()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data","c":"ManagedLedgerInternalStats.LedgerInfo","l":"size"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"skipAllMessages(String, String)","u":"skipAllMessages(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"skipAllMessagesAsync(String, String)","u":"skipAllMessagesAsync(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"skipMessages(String, String, long)","u":"skipMessages(java.lang.String,java.lang.String,long)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"skipMessagesAsync(String, String, long)","u":"skipMessagesAsync(java.lang.String,java.lang.String,long)"},{"p":"org.apache.pulsar.common.stats","c":"AllocatorStats","l":"smallCacheSize"},{"p":"org.apache.pulsar.common.stats","c":"AllocatorStats.PoolArenaStats","l":"smallSubpages"},{"p":"org.apache.pulsar.common.policies.data","c":"SnapshotSystemTopicInternalStats","l":"SnapshotSystemTopicInternalStats()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data","c":"TransactionBufferInternalStats","l":"snapshotType"},{"p":"org.apache.pulsar.common.policies.data","c":"TransactionBufferStats","l":"snapshotType"},{"p":"org.apache.pulsar.packages.management.core.common","c":"PackageType","l":"SOURCE"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdmin","l":"source()"},{"p":"org.apache.pulsar.common.io","c":"SourceConfig","l":"SourceConfig()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data","c":"SourceStatus.SourceInstanceStatus","l":"SourceInstanceStatus()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data","c":"SourceStatus.SourceInstanceStatus.SourceInstanceStatusData","l":"SourceInstanceStatusData()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data","c":"AuthAction","l":"sources"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdmin","l":"sources()"},{"p":"org.apache.pulsar.common.policies.data","c":"SourceStatus","l":"SourceStatus()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"splitNamespaceBundle(String, String, boolean, String)","u":"splitNamespaceBundle(java.lang.String,java.lang.String,boolean,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"splitNamespaceBundle(String, String, boolean, String, List)","u":"splitNamespaceBundle(java.lang.String,java.lang.String,boolean,java.lang.String,java.util.List)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"splitNamespaceBundleAsync(String, String, boolean, String)","u":"splitNamespaceBundleAsync(java.lang.String,java.lang.String,boolean,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"splitNamespaceBundleAsync(String, String, boolean, String, List)","u":"splitNamespaceBundleAsync(java.lang.String,java.lang.String,boolean,java.lang.String,java.util.List)"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdminBuilder","l":"sslFactoryPlugin(String)","u":"sslFactoryPlugin(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdminBuilder","l":"sslFactoryPluginParams(String)","u":"sslFactoryPluginParams(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdminBuilder","l":"sslProvider(String)","u":"sslProvider(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Functions","l":"startFunction(String, String, String)","u":"startFunction(java.lang.String,java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Functions","l":"startFunction(String, String, String, int)","u":"startFunction(java.lang.String,java.lang.String,java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"Functions","l":"startFunctionAsync(String, String, String)","u":"startFunctionAsync(java.lang.String,java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Functions","l":"startFunctionAsync(String, String, String, int)","u":"startFunctionAsync(java.lang.String,java.lang.String,java.lang.String,int)"},{"p":"org.apache.pulsar.common.policies.data","c":"TransactionInBufferStats","l":"startPosition"},{"p":"org.apache.pulsar.client.admin","c":"Sinks","l":"startSink(String, String, String)","u":"startSink(java.lang.String,java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Sinks","l":"startSink(String, String, String, int)","u":"startSink(java.lang.String,java.lang.String,java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"Sinks","l":"startSinkAsync(String, String, String)","u":"startSinkAsync(java.lang.String,java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Sinks","l":"startSinkAsync(String, String, String, int)","u":"startSinkAsync(java.lang.String,java.lang.String,java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"Sources","l":"startSource(String, String, String)","u":"startSource(java.lang.String,java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Sources","l":"startSource(String, String, String, int)","u":"startSource(java.lang.String,java.lang.String,java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"Sources","l":"startSourceAsync(String, String, String)","u":"startSourceAsync(java.lang.String,java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Sources","l":"startSourceAsync(String, String, String, int)","u":"startSourceAsync(java.lang.String,java.lang.String,java.lang.String,int)"},{"p":"org.apache.pulsar.common.policies.data","c":"ManagedLedgerInternalStats.CursorStats","l":"state"},{"p":"org.apache.pulsar.common.policies.data","c":"ManagedLedgerInternalStats","l":"state"},{"p":"org.apache.pulsar.common.policies.data","c":"TransactionBufferStats","l":"state"},{"p":"org.apache.pulsar.common.policies.data","c":"TransactionCoordinatorStats","l":"state"},{"p":"org.apache.pulsar.common.policies.data","c":"TransactionCoordinatorStatus","l":"state"},{"p":"org.apache.pulsar.common.policies.data","c":"TransactionPendingAckStats","l":"state"},{"p":"org.apache.pulsar.common.stats","c":"PositionInPendingAckStats","l":"state"},{"p":"org.apache.pulsar.client.admin","c":"LongRunningProcessStatus","l":"status"},{"p":"org.apache.pulsar.common.policies.data","c":"FunctionStatus.FunctionInstanceStatus","l":"status"},{"p":"org.apache.pulsar.common.policies.data","c":"SinkStatus.SinkInstanceStatus","l":"status"},{"p":"org.apache.pulsar.common.policies.data","c":"SourceStatus.SourceInstanceStatus","l":"status"},{"p":"org.apache.pulsar.common.policies.data","c":"TransactionMetadata","l":"status"},{"p":"org.apache.pulsar.client.admin","c":"Functions","l":"stopFunction(String, String, String)","u":"stopFunction(java.lang.String,java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Functions","l":"stopFunction(String, String, String, int)","u":"stopFunction(java.lang.String,java.lang.String,java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"Functions","l":"stopFunctionAsync(String, String, String)","u":"stopFunctionAsync(java.lang.String,java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Functions","l":"stopFunctionAsync(String, String, String, int)","u":"stopFunctionAsync(java.lang.String,java.lang.String,java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"Sinks","l":"stopSink(String, String, String)","u":"stopSink(java.lang.String,java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Sinks","l":"stopSink(String, String, String, int)","u":"stopSink(java.lang.String,java.lang.String,java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"Sinks","l":"stopSinkAsync(String, String, String)","u":"stopSinkAsync(java.lang.String,java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Sinks","l":"stopSinkAsync(String, String, String, int)","u":"stopSinkAsync(java.lang.String,java.lang.String,java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"Sources","l":"stopSource(String, String, String)","u":"stopSource(java.lang.String,java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Sources","l":"stopSource(String, String, String, int)","u":"stopSource(java.lang.String,java.lang.String,java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"Sources","l":"stopSourceAsync(String, String, String)","u":"stopSourceAsync(java.lang.String,java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Sources","l":"stopSourceAsync(String, String, String, int)","u":"stopSourceAsync(java.lang.String,java.lang.String,java.lang.String,int)"},{"p":"org.apache.pulsar.common.policies.data","c":"SubscribeRate","l":"SubscribeRate()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data","c":"SubscribeRate","l":"SubscribeRate(int, int)","u":"%3Cinit%3E(int,int)"},{"p":"org.apache.pulsar.common.policies.data","c":"SubscribeRate","l":"subscribeThrottlingRatePerConsumer"},{"p":"org.apache.pulsar.common.policies.data","c":"Policies","l":"subscription_auth_mode"},{"p":"org.apache.pulsar.common.policies.data","c":"Policies","l":"subscription_expiration_time_minutes"},{"p":"org.apache.pulsar.common.policies.data","c":"Policies","l":"subscription_types_enabled"},{"p":"org.apache.pulsar.common.policies.data","c":"AuthPolicies.Builder","l":"subscriptionAuthentication(Map>)","u":"subscriptionAuthentication(java.util.Map)"},{"p":"org.apache.pulsar.common.policies.data","c":"Policies","l":"subscriptionDispatchRate"},{"p":"org.apache.pulsar.common.policies.data","c":"ManagedLedgerInternalStats.CursorStats","l":"subscriptionHavePendingRead"},{"p":"org.apache.pulsar.common.policies.data","c":"ManagedLedgerInternalStats.CursorStats","l":"subscriptionHavePendingReplayRead"},{"p":"org.apache.pulsar.common.policies.data","c":"ResourceQuota","l":"substract(ResourceQuota)","u":"substract(org.apache.pulsar.common.policies.data.ResourceQuota)"},{"p":"org.apache.pulsar.client.admin","c":"LongRunningProcessStatus.Status","l":"SUCCESS"},{"p":"org.apache.pulsar.common.policies.data","c":"ValidateResult","l":"success()"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdmin","l":"tenants()"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"terminatePartitionedTopic(String)","u":"terminatePartitionedTopic(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"terminatePartitionedTopicAsync(String)","u":"terminatePartitionedTopicAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"terminateTopic(String)","u":"terminateTopic(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"terminateTopicAsync(String)","u":"terminateTopicAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Schemas","l":"testCompatibility(String, PostSchemaPayload)","u":"testCompatibility(java.lang.String,org.apache.pulsar.common.protocol.schema.PostSchemaPayload)"},{"p":"org.apache.pulsar.client.admin","c":"Schemas","l":"testCompatibility(String, SchemaInfo)","u":"testCompatibility(java.lang.String,org.apache.pulsar.common.schema.SchemaInfo)"},{"p":"org.apache.pulsar.client.admin","c":"Schemas","l":"testCompatibilityAsync(String, PostSchemaPayload)","u":"testCompatibilityAsync(java.lang.String,org.apache.pulsar.common.protocol.schema.PostSchemaPayload)"},{"p":"org.apache.pulsar.client.admin","c":"Schemas","l":"testCompatibilityAsync(String, SchemaInfo)","u":"testCompatibilityAsync(java.lang.String,org.apache.pulsar.common.schema.SchemaInfo)"},{"p":"org.apache.pulsar.common.policies.data","c":"DelayedDeliveryPolicies.Builder","l":"tickTime(long)"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"DelayedDeliveryPoliciesImpl.DelayedDeliveryPoliciesImplBuilder","l":"tickTime(long)"},{"p":"org.apache.pulsar.common.policies.data","c":"OffloadedReadPriority","l":"TIERED_STORAGE_FIRST"},{"p":"org.apache.pulsar.common.policies.data","c":"TransactionMetadata","l":"timeoutAt"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdminException.TimeoutException","l":"TimeoutException(Throwable)","u":"%3Cinit%3E(java.lang.Throwable)"},{"p":"org.apache.pulsar.common.policies.data","c":"ClusterData.Builder","l":"tlsAllowInsecureConnection(boolean)"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdminBuilder","l":"tlsCertificateFilePath(String)","u":"tlsCertificateFilePath(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdminBuilder","l":"tlsCiphers(Set)","u":"tlsCiphers(java.util.Set)"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdminBuilder","l":"tlsKeyFilePath(String)","u":"tlsKeyFilePath(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdminBuilder","l":"tlsKeyStorePassword(String)","u":"tlsKeyStorePassword(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdminBuilder","l":"tlsKeyStorePath(String)","u":"tlsKeyStorePath(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdminBuilder","l":"tlsKeyStoreType(String)","u":"tlsKeyStoreType(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdminBuilder","l":"tlsProtocols(Set)","u":"tlsProtocols(java.util.Set)"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdminBuilder","l":"tlsTrustCertsFilePath(String)","u":"tlsTrustCertsFilePath(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdminBuilder","l":"tlsTrustStorePassword(String)","u":"tlsTrustStorePassword(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdminBuilder","l":"tlsTrustStorePath(String)","u":"tlsTrustStorePath(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdminBuilder","l":"tlsTrustStoreType(String)","u":"tlsTrustStoreType(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"AuthPolicies.Builder","l":"topicAuthentication(Map>>)","u":"topicAuthentication(java.util.Map)"},{"p":"org.apache.pulsar.common.policies.data","c":"Policies","l":"topicDispatchRate"},{"p":"org.apache.pulsar.common.policies.data","c":"TopicHashPositions","l":"TopicHashPositions()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdmin","l":"topicPolicies()"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdmin","l":"topicPolicies(boolean)"},{"p":"org.apache.pulsar.policies.data.loadbalancer","c":"NamespaceBundleStats","l":"topics"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdmin","l":"topics()"},{"p":"org.apache.pulsar.common.policies.data","c":"AutoTopicCreationOverride.Builder","l":"topicType(String)","u":"topicType(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"AutoTopicCreationOverrideImpl.AutoTopicCreationOverrideImplBuilder","l":"topicType(String)","u":"topicType(java.lang.String)"},{"p":"org.apache.pulsar.common.naming","c":"TopicDomain","l":"toString()"},{"p":"org.apache.pulsar.common.policies.data","c":"NamespaceOwnershipStatus","l":"toString()"},{"p":"org.apache.pulsar.common.policies.data","c":"OffloadedReadPriority","l":"toString()"},{"p":"org.apache.pulsar.common.policies.data","c":"RetentionPolicies","l":"toString()"},{"p":"org.apache.pulsar.common.policies.data","c":"SchemaMetadata.Entry","l":"toString()"},{"p":"org.apache.pulsar.common.policies.data","c":"TopicType","l":"toString()"},{"p":"org.apache.pulsar.common.stats","c":"Metrics","l":"toString()"},{"p":"org.apache.pulsar.packages.management.core.common","c":"PackageType","l":"toString()"},{"p":"org.apache.pulsar.common.policies.data","c":"TransactionBufferStats","l":"totalAbortedTransactions"},{"p":"org.apache.pulsar.common.policies.data","c":"ManagedLedgerInternalStats.CursorStats","l":"totalNonContiguousDeletedMessagesRange"},{"p":"org.apache.pulsar.common.policies.data","c":"ManagedLedgerInternalStats","l":"totalSize"},{"p":"org.apache.pulsar.common.policies.data","c":"TransactionBufferInternalStats","l":"TransactionBufferInternalStats()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data","c":"TransactionBufferStats","l":"TransactionBufferStats()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data","c":"TransactionCoordinatorInfo","l":"TransactionCoordinatorInfo()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data","c":"TransactionCoordinatorInternalStats","l":"TransactionCoordinatorInternalStats()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data","c":"TransactionCoordinatorStats","l":"TransactionCoordinatorStats()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data","c":"TransactionCoordinatorStatus","l":"TransactionCoordinatorStatus()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data","c":"TransactionInBufferStats","l":"TransactionInBufferStats()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data","c":"TransactionInPendingAckStats","l":"TransactionInPendingAckStats()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data","c":"TransactionCoordinatorInternalStats","l":"transactionLogStats"},{"p":"org.apache.pulsar.common.policies.data","c":"TransactionLogStats","l":"TransactionLogStats()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data","c":"TransactionMetadata","l":"TransactionMetadata()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data","c":"TransactionPendingAckInternalStats","l":"TransactionPendingAckInternalStats()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data","c":"TransactionPendingAckStats","l":"TransactionPendingAckStats()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdmin","l":"transactions()"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"triggerCompaction(String)","u":"triggerCompaction(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"triggerCompactionAsync(String)","u":"triggerCompactionAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Functions","l":"triggerFunction(String, String, String, String, String, String)","u":"triggerFunction(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Functions","l":"triggerFunctionAsync(String, String, String, String, String, String)","u":"triggerFunctionAsync(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"triggerOffload(String, MessageId)","u":"triggerOffload(java.lang.String,org.apache.pulsar.client.api.MessageId)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"triggerOffloadAsync(String, MessageId)","u":"triggerOffloadAsync(java.lang.String,org.apache.pulsar.client.api.MessageId)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"trimTopic(String)","u":"trimTopic(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"trimTopicAsync(String)","u":"trimTopicAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"truncate(String)","u":"truncate(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"truncateAsync(String)","u":"truncateAsync(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"TransactionMetadata","l":"txnId"},{"p":"org.apache.pulsar.common.policies.data","c":"SchemaCompatibilityStrategy","l":"UNDEFINED"},{"p":"org.apache.pulsar.common.policies.data","c":"ManagedLedgerInternalStats.LedgerInfo","l":"underReplicated"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"unload(String)","u":"unload(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"NonPersistentTopics","l":"unload(String)","u":"unload(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"unload(String)","u":"unload(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"unloadAsync(String)","u":"unloadAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"NonPersistentTopics","l":"unloadAsync(String)","u":"unloadAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"unloadAsync(String)","u":"unloadAsync(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"unloadNamespaceBundle(String, String)","u":"unloadNamespaceBundle(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"unloadNamespaceBundle(String, String, String)","u":"unloadNamespaceBundle(java.lang.String,java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"unloadNamespaceBundleAsync(String, String)","u":"unloadNamespaceBundleAsync(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"unloadNamespaceBundleAsync(String, String, String)","u":"unloadNamespaceBundleAsync(java.lang.String,java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"NamespaceIsolationData.Builder","l":"unloadScope(NamespaceIsolationPolicyUnloadScope)","u":"unloadScope(org.apache.pulsar.common.policies.data.NamespaceIsolationPolicyUnloadScope)"},{"p":"org.apache.pulsar.common.policies.data","c":"SegmentsStats","l":"unsealedAbortTxnIDSize"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"unsubscribeNamespace(String, String)","u":"unsubscribeNamespace(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"unsubscribeNamespaceAsync(String, String)","u":"unsubscribeNamespaceAsync(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"unsubscribeNamespaceBundle(String, String, String)","u":"unsubscribeNamespaceBundle(java.lang.String,java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"unsubscribeNamespaceBundleAsync(String, String, String)","u":"unsubscribeNamespaceBundleAsync(java.lang.String,java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"BookiesRackConfiguration","l":"updateBookie(String, String, BookieInfo)","u":"updateBookie(java.lang.String,java.lang.String,org.apache.pulsar.common.policies.data.BookieInfo)"},{"p":"org.apache.pulsar.client.admin","c":"Bookies","l":"updateBookieRackInfo(String, String, BookieInfo)","u":"updateBookieRackInfo(java.lang.String,java.lang.String,org.apache.pulsar.common.policies.data.BookieInfo)"},{"p":"org.apache.pulsar.client.admin","c":"Bookies","l":"updateBookieRackInfoAsync(String, String, BookieInfo)","u":"updateBookieRackInfoAsync(java.lang.String,java.lang.String,org.apache.pulsar.common.policies.data.BookieInfo)"},{"p":"org.apache.pulsar.client.admin","c":"Clusters","l":"updateCluster(String, ClusterData)","u":"updateCluster(java.lang.String,org.apache.pulsar.common.policies.data.ClusterData)"},{"p":"org.apache.pulsar.client.admin","c":"Clusters","l":"updateClusterAsync(String, ClusterData)","u":"updateClusterAsync(java.lang.String,org.apache.pulsar.common.policies.data.ClusterData)"},{"p":"org.apache.pulsar.client.admin","c":"Clusters","l":"updateClusterMigration(String, boolean, ClusterPolicies.ClusterUrl)","u":"updateClusterMigration(java.lang.String,boolean,org.apache.pulsar.common.policies.data.ClusterPolicies.ClusterUrl)"},{"p":"org.apache.pulsar.client.admin","c":"Clusters","l":"updateClusterMigrationAsync(String, boolean, ClusterPolicies.ClusterUrl)","u":"updateClusterMigrationAsync(java.lang.String,boolean,org.apache.pulsar.common.policies.data.ClusterPolicies.ClusterUrl)"},{"p":"org.apache.pulsar.client.admin","c":"Brokers","l":"updateDynamicConfiguration(String, String)","u":"updateDynamicConfiguration(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Brokers","l":"updateDynamicConfigurationAsync(String, String)","u":"updateDynamicConfigurationAsync(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Clusters","l":"updateFailureDomain(String, String, FailureDomain)","u":"updateFailureDomain(java.lang.String,java.lang.String,org.apache.pulsar.common.policies.data.FailureDomain)"},{"p":"org.apache.pulsar.client.admin","c":"Clusters","l":"updateFailureDomainAsync(String, String, FailureDomain)","u":"updateFailureDomainAsync(java.lang.String,java.lang.String,org.apache.pulsar.common.policies.data.FailureDomain)"},{"p":"org.apache.pulsar.client.admin","c":"Functions","l":"updateFunction(FunctionConfig, String)","u":"updateFunction(org.apache.pulsar.common.functions.FunctionConfig,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Functions","l":"updateFunction(FunctionConfig, String, UpdateOptions)","u":"updateFunction(org.apache.pulsar.common.functions.FunctionConfig,java.lang.String,org.apache.pulsar.common.functions.UpdateOptions)"},{"p":"org.apache.pulsar.client.admin","c":"Functions","l":"updateFunctionAsync(FunctionConfig, String)","u":"updateFunctionAsync(org.apache.pulsar.common.functions.FunctionConfig,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Functions","l":"updateFunctionAsync(FunctionConfig, String, UpdateOptions)","u":"updateFunctionAsync(org.apache.pulsar.common.functions.FunctionConfig,java.lang.String,org.apache.pulsar.common.functions.UpdateOptions)"},{"p":"org.apache.pulsar.client.admin","c":"Functions","l":"updateFunctionWithUrl(FunctionConfig, String)","u":"updateFunctionWithUrl(org.apache.pulsar.common.functions.FunctionConfig,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Functions","l":"updateFunctionWithUrl(FunctionConfig, String, UpdateOptions)","u":"updateFunctionWithUrl(org.apache.pulsar.common.functions.FunctionConfig,java.lang.String,org.apache.pulsar.common.functions.UpdateOptions)"},{"p":"org.apache.pulsar.client.admin","c":"Functions","l":"updateFunctionWithUrlAsync(FunctionConfig, String)","u":"updateFunctionWithUrlAsync(org.apache.pulsar.common.functions.FunctionConfig,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Functions","l":"updateFunctionWithUrlAsync(FunctionConfig, String, UpdateOptions)","u":"updateFunctionWithUrlAsync(org.apache.pulsar.common.functions.FunctionConfig,java.lang.String,org.apache.pulsar.common.functions.UpdateOptions)"},{"p":"org.apache.pulsar.client.admin","c":"Packages","l":"updateMetadata(String, PackageMetadata)","u":"updateMetadata(java.lang.String,org.apache.pulsar.packages.management.core.common.PackageMetadata)"},{"p":"org.apache.pulsar.client.admin","c":"Packages","l":"updateMetadataAsync(String, PackageMetadata)","u":"updateMetadataAsync(java.lang.String,org.apache.pulsar.packages.management.core.common.PackageMetadata)"},{"p":"org.apache.pulsar.client.admin","c":"Namespaces","l":"updateMigrationState(String, boolean)","u":"updateMigrationState(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Clusters","l":"updateNamespaceIsolationPolicy(String, String, NamespaceIsolationData)","u":"updateNamespaceIsolationPolicy(java.lang.String,java.lang.String,org.apache.pulsar.common.policies.data.NamespaceIsolationData)"},{"p":"org.apache.pulsar.client.admin","c":"Clusters","l":"updateNamespaceIsolationPolicyAsync(String, String, NamespaceIsolationData)","u":"updateNamespaceIsolationPolicyAsync(java.lang.String,java.lang.String,org.apache.pulsar.common.policies.data.NamespaceIsolationData)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"updatePartitionedTopic(String, int)","u":"updatePartitionedTopic(java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"updatePartitionedTopic(String, int, boolean)","u":"updatePartitionedTopic(java.lang.String,int,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"updatePartitionedTopic(String, int, boolean, boolean)","u":"updatePartitionedTopic(java.lang.String,int,boolean,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"updatePartitionedTopicAsync(String, int)","u":"updatePartitionedTopicAsync(java.lang.String,int)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"updatePartitionedTopicAsync(String, int, boolean)","u":"updatePartitionedTopicAsync(java.lang.String,int,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"updatePartitionedTopicAsync(String, int, boolean, boolean)","u":"updatePartitionedTopicAsync(java.lang.String,int,boolean,boolean)"},{"p":"org.apache.pulsar.client.admin","c":"Clusters","l":"updatePeerClusterNames(String, LinkedHashSet)","u":"updatePeerClusterNames(java.lang.String,java.util.LinkedHashSet)"},{"p":"org.apache.pulsar.client.admin","c":"Clusters","l":"updatePeerClusterNamesAsync(String, LinkedHashSet)","u":"updatePeerClusterNamesAsync(java.lang.String,java.util.LinkedHashSet)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"updateProperties(String, Map)","u":"updateProperties(java.lang.String,java.util.Map)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"updatePropertiesAsync(String, Map)","u":"updatePropertiesAsync(java.lang.String,java.util.Map)"},{"p":"org.apache.pulsar.client.admin","c":"Properties","l":"updateProperty(String, TenantInfo)","u":"updateProperty(java.lang.String,org.apache.pulsar.common.policies.data.TenantInfo)"},{"p":"org.apache.pulsar.client.admin","c":"ResourceGroups","l":"updateResourceGroup(String, ResourceGroup)","u":"updateResourceGroup(java.lang.String,org.apache.pulsar.common.policies.data.ResourceGroup)"},{"p":"org.apache.pulsar.client.admin","c":"ResourceGroups","l":"updateResourceGroupAsync(String, ResourceGroup)","u":"updateResourceGroupAsync(java.lang.String,org.apache.pulsar.common.policies.data.ResourceGroup)"},{"p":"org.apache.pulsar.client.admin","c":"Sinks","l":"updateSink(SinkConfig, String)","u":"updateSink(org.apache.pulsar.common.io.SinkConfig,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Sinks","l":"updateSink(SinkConfig, String, UpdateOptions)","u":"updateSink(org.apache.pulsar.common.io.SinkConfig,java.lang.String,org.apache.pulsar.common.functions.UpdateOptions)"},{"p":"org.apache.pulsar.client.admin","c":"Sinks","l":"updateSinkAsync(SinkConfig, String)","u":"updateSinkAsync(org.apache.pulsar.common.io.SinkConfig,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Sinks","l":"updateSinkAsync(SinkConfig, String, UpdateOptions)","u":"updateSinkAsync(org.apache.pulsar.common.io.SinkConfig,java.lang.String,org.apache.pulsar.common.functions.UpdateOptions)"},{"p":"org.apache.pulsar.client.admin","c":"Sinks","l":"updateSinkWithUrl(SinkConfig, String)","u":"updateSinkWithUrl(org.apache.pulsar.common.io.SinkConfig,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Sinks","l":"updateSinkWithUrl(SinkConfig, String, UpdateOptions)","u":"updateSinkWithUrl(org.apache.pulsar.common.io.SinkConfig,java.lang.String,org.apache.pulsar.common.functions.UpdateOptions)"},{"p":"org.apache.pulsar.client.admin","c":"Sinks","l":"updateSinkWithUrlAsync(SinkConfig, String)","u":"updateSinkWithUrlAsync(org.apache.pulsar.common.io.SinkConfig,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Sinks","l":"updateSinkWithUrlAsync(SinkConfig, String, UpdateOptions)","u":"updateSinkWithUrlAsync(org.apache.pulsar.common.io.SinkConfig,java.lang.String,org.apache.pulsar.common.functions.UpdateOptions)"},{"p":"org.apache.pulsar.client.admin","c":"Sources","l":"updateSource(SourceConfig, String)","u":"updateSource(org.apache.pulsar.common.io.SourceConfig,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Sources","l":"updateSource(SourceConfig, String, UpdateOptions)","u":"updateSource(org.apache.pulsar.common.io.SourceConfig,java.lang.String,org.apache.pulsar.common.functions.UpdateOptions)"},{"p":"org.apache.pulsar.client.admin","c":"Sources","l":"updateSourceAsync(SourceConfig, String)","u":"updateSourceAsync(org.apache.pulsar.common.io.SourceConfig,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Sources","l":"updateSourceAsync(SourceConfig, String, UpdateOptions)","u":"updateSourceAsync(org.apache.pulsar.common.io.SourceConfig,java.lang.String,org.apache.pulsar.common.functions.UpdateOptions)"},{"p":"org.apache.pulsar.client.admin","c":"Sources","l":"updateSourceWithUrl(SourceConfig, String)","u":"updateSourceWithUrl(org.apache.pulsar.common.io.SourceConfig,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Sources","l":"updateSourceWithUrl(SourceConfig, String, UpdateOptions)","u":"updateSourceWithUrl(org.apache.pulsar.common.io.SourceConfig,java.lang.String,org.apache.pulsar.common.functions.UpdateOptions)"},{"p":"org.apache.pulsar.client.admin","c":"Sources","l":"updateSourceWithUrlAsync(SourceConfig, String)","u":"updateSourceWithUrlAsync(org.apache.pulsar.common.io.SourceConfig,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Sources","l":"updateSourceWithUrlAsync(SourceConfig, String, UpdateOptions)","u":"updateSourceWithUrlAsync(org.apache.pulsar.common.io.SourceConfig,java.lang.String,org.apache.pulsar.common.functions.UpdateOptions)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"updateSubscriptionProperties(String, String, Map)","u":"updateSubscriptionProperties(java.lang.String,java.lang.String,java.util.Map)"},{"p":"org.apache.pulsar.client.admin","c":"Topics","l":"updateSubscriptionPropertiesAsync(String, String, Map)","u":"updateSubscriptionPropertiesAsync(java.lang.String,java.lang.String,java.util.Map)"},{"p":"org.apache.pulsar.client.admin","c":"Tenants","l":"updateTenant(String, TenantInfo)","u":"updateTenant(java.lang.String,org.apache.pulsar.common.policies.data.TenantInfo)"},{"p":"org.apache.pulsar.client.admin","c":"Tenants","l":"updateTenantAsync(String, TenantInfo)","u":"updateTenantAsync(java.lang.String,org.apache.pulsar.common.policies.data.TenantInfo)"},{"p":"org.apache.pulsar.client.admin","c":"Packages","l":"upload(PackageMetadata, String, String)","u":"upload(org.apache.pulsar.packages.management.core.common.PackageMetadata,java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Packages","l":"uploadAsync(PackageMetadata, String, String)","u":"uploadAsync(org.apache.pulsar.packages.management.core.common.PackageMetadata,java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Functions","l":"uploadFunction(String, String)","u":"uploadFunction(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Functions","l":"uploadFunctionAsync(String, String)","u":"uploadFunctionAsync(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.common.stats","c":"AllocatorStats.PoolChunkStats","l":"usage"},{"p":"org.apache.pulsar.policies.data.loadbalancer","c":"ResourceUsage","l":"usage"},{"p":"org.apache.pulsar.common.policies.impl","c":"MinAvailablePolicy","l":"usage_threshold"},{"p":"org.apache.pulsar.common.stats","c":"AllocatorStats","l":"usedDirectMemory"},{"p":"org.apache.pulsar.common.stats","c":"AllocatorStats","l":"usedHeapMemory"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdminBuilder","l":"useKeyStoreTls(boolean)"},{"p":"org.apache.pulsar.common.naming","c":"TopicVersion","l":"V1"},{"p":"org.apache.pulsar.common.naming","c":"TopicVersion","l":"V2"},{"p":"org.apache.pulsar.common.policies.data","c":"AutoFailoverPolicyData","l":"validate()"},{"p":"org.apache.pulsar.common.policies.data","c":"NamespaceIsolationData","l":"validate()"},{"p":"org.apache.pulsar.common.policies.data.impl","c":"AutoTopicCreationOverrideImpl","l":"validateOverride(AutoTopicCreationOverride)","u":"validateOverride(org.apache.pulsar.common.policies.data.AutoTopicCreationOverride)"},{"p":"org.apache.pulsar.client.admin","c":"Topics.QueryParam","l":"value"},{"p":"org.apache.pulsar.common.naming","c":"TopicDomain","l":"value()"},{"p":"org.apache.pulsar.packages.management.core.common","c":"PackageType","l":"value()"},{"p":"org.apache.pulsar.client.admin","c":"Mode","l":"valueOf(int)"},{"p":"org.apache.pulsar.client.admin","c":"LongRunningProcessStatus.Status","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Mode","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"Topics.QueryParam","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"org.apache.pulsar.common.functions","c":"FunctionConfig.ProcessingGuarantees","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"org.apache.pulsar.common.functions","c":"FunctionConfig.Runtime","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"org.apache.pulsar.common.functions","c":"WindowConfig.ProcessingGuarantees","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"org.apache.pulsar.common.naming","c":"TopicDomain","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"org.apache.pulsar.common.naming","c":"TopicVersion","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"AuthAction","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"AutoFailoverPolicyType","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"BacklogQuota.BacklogQuotaType","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"BacklogQuota.RetentionPolicy","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"BrokerAssignment","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"InactiveTopicDeleteMode","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"NamespaceIsolationPolicyUnloadScope","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"OffloadedReadPriority","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"Policies.BundleType","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"SchemaAutoUpdateCompatibilityStrategy","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"SchemaCompatibilityStrategy","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"SubscriptionAuthMode","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"org.apache.pulsar.common.policies.data","c":"TopicType","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"org.apache.pulsar.common.stats","c":"PositionInPendingAckStats.State","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"org.apache.pulsar.packages.management.core.common","c":"PackageType","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"org.apache.pulsar.client.admin","c":"LongRunningProcessStatus.Status","l":"values()"},{"p":"org.apache.pulsar.client.admin","c":"Mode","l":"values()"},{"p":"org.apache.pulsar.client.admin","c":"Topics.QueryParam","l":"values()"},{"p":"org.apache.pulsar.common.functions","c":"FunctionConfig.ProcessingGuarantees","l":"values()"},{"p":"org.apache.pulsar.common.functions","c":"FunctionConfig.Runtime","l":"values()"},{"p":"org.apache.pulsar.common.functions","c":"WindowConfig.ProcessingGuarantees","l":"values()"},{"p":"org.apache.pulsar.common.naming","c":"TopicDomain","l":"values()"},{"p":"org.apache.pulsar.common.naming","c":"TopicVersion","l":"values()"},{"p":"org.apache.pulsar.common.policies.data","c":"AuthAction","l":"values()"},{"p":"org.apache.pulsar.common.policies.data","c":"AutoFailoverPolicyType","l":"values()"},{"p":"org.apache.pulsar.common.policies.data","c":"BacklogQuota.BacklogQuotaType","l":"values()"},{"p":"org.apache.pulsar.common.policies.data","c":"BacklogQuota.RetentionPolicy","l":"values()"},{"p":"org.apache.pulsar.common.policies.data","c":"BrokerAssignment","l":"values()"},{"p":"org.apache.pulsar.common.policies.data","c":"InactiveTopicDeleteMode","l":"values()"},{"p":"org.apache.pulsar.common.policies.data","c":"NamespaceIsolationPolicyUnloadScope","l":"values()"},{"p":"org.apache.pulsar.common.policies.data","c":"OffloadedReadPriority","l":"values()"},{"p":"org.apache.pulsar.common.policies.data","c":"Policies.BundleType","l":"values()"},{"p":"org.apache.pulsar.common.policies.data","c":"SchemaAutoUpdateCompatibilityStrategy","l":"values()"},{"p":"org.apache.pulsar.common.policies.data","c":"SchemaCompatibilityStrategy","l":"values()"},{"p":"org.apache.pulsar.common.policies.data","c":"SubscriptionAuthMode","l":"values()"},{"p":"org.apache.pulsar.common.policies.data","c":"TopicType","l":"values()"},{"p":"org.apache.pulsar.common.stats","c":"PositionInPendingAckStats.State","l":"values()"},{"p":"org.apache.pulsar.packages.management.core.common","c":"PackageType","l":"values()"},{"p":"org.apache.pulsar.common.policies.data","c":"ManagedLedgerInternalStats","l":"waitingCursorsCount"},{"p":"org.apache.pulsar.common.policies.data","c":"ManagedLedgerInternalStats.CursorStats","l":"waitingReadOp"},{"p":"org.apache.pulsar.common.functions","c":"WindowConfig","l":"WINDOW_CONFIG_KEY"},{"p":"org.apache.pulsar.common.functions","c":"WindowConfig","l":"WindowConfig()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdmin","l":"worker()"},{"p":"org.apache.pulsar.common.policies.data","c":"WorkerFunctionInstanceStats","l":"WorkerFunctionInstanceStats()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.policies.data","c":"FunctionStatus.FunctionInstanceStatus.FunctionInstanceStatusData","l":"workerId"},{"p":"org.apache.pulsar.common.policies.data","c":"SinkStatus.SinkInstanceStatus.SinkInstanceStatusData","l":"workerId"},{"p":"org.apache.pulsar.common.policies.data","c":"SourceStatus.SourceInstanceStatus.SourceInstanceStatusData","l":"workerId"},{"p":"org.apache.pulsar.common.functions","c":"WorkerInfo","l":"WorkerInfo()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.client.admin","c":"PulsarAdminException","l":"wrap(PulsarAdminException)","u":"wrap(org.apache.pulsar.client.admin.PulsarAdminException)"}];updateSearchResults(); \ No newline at end of file diff --git a/static/api/admin/4.0.x/module-search-index.js b/static/api/admin/4.0.x/module-search-index.js new file mode 100644 index 000000000000..0d59754fc4ad --- /dev/null +++ b/static/api/admin/4.0.x/module-search-index.js @@ -0,0 +1 @@ +moduleSearchIndex = [];updateSearchResults(); \ No newline at end of file diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/Bookies.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/Bookies.html new file mode 100644 index 000000000000..453015df2dd3 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/Bookies.html @@ -0,0 +1,288 @@ + + + + +Bookies (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.client.admin
+

Interface Bookies

+
+
+
+
public interface Bookies
+
Admin interface for bookies rack placement management.
+
+
+ +
+
+ +
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/BrokerStats.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/BrokerStats.html new file mode 100644 index 000000000000..d3ddf78903d2 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/BrokerStats.html @@ -0,0 +1,349 @@ + + + + +BrokerStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.client.admin
+

Interface BrokerStats

+
+
+
+
public interface BrokerStats
+
Admin interface for brokers management.
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getMetrics

      +
      String getMetrics() + throws PulsarAdminException
      +
      Returns Monitoring metrics.
      +
      +
      Returns:
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getMetricsAsync

      +
      CompletableFuture<String> getMetricsAsync()
      +
      Returns Monitoring metrics asynchronously.
      +
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      getMBeans

      +
      String getMBeans() + throws PulsarAdminException
      +
      Requests JSON string server mbean dump. +

      + Notes: since we don't plan to introspect the response we avoid converting the response into POJO.

      +
      +
      Returns:
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getMBeansAsync

      +
      CompletableFuture<String> getMBeansAsync()
      +
      Requests JSON string server mbean dump asynchronously. +

      + Notes: since we don't plan to introspect the response we avoid converting the response into POJO.

      +
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      getTopics

      +
      String getTopics() + throws PulsarAdminException
      +
      Returns JSON string topics stats. +

      + Notes: since we don't plan to introspect the response we avoid converting the response into POJO.

      +
      +
      Returns:
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getTopicsAsync

      +
      CompletableFuture<String> getTopicsAsync()
      +
      Returns JSON string topics stats asynchronously. +

      + Notes: since we don't plan to introspect the response we avoid converting the response into POJO.

      +
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      getPendingBookieOpsStats

      +
      String getPendingBookieOpsStats() + throws PulsarAdminException
      +
      Get pending bookie client op stats by namespace. +

      + Notes: since we don't plan to introspect the response we avoid converting the response into POJO.

      +
      +
      Returns:
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getPendingBookieOpsStatsAsync

      +
      CompletableFuture<String> getPendingBookieOpsStatsAsync()
      +
      Get pending bookie client op stats by namespace asynchronously. +

      + Notes: since we don't plan to introspect the response we avoid converting the response into POJO.

      +
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      getAllocatorStats

      +
      AllocatorStats getAllocatorStats(String allocatorName) + throws PulsarAdminException
      +
      Get the stats for the Netty allocator.
      +
      +
      Parameters:
      +
      allocatorName -
      +
      Returns:
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getAllocatorStatsAsync

      +
      CompletableFuture<AllocatorStats> getAllocatorStatsAsync(String allocatorName)
      +
      Get the stats for the Netty allocator asynchronously.
      +
      +
      Parameters:
      +
      allocatorName -
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      getLoadReport

      +
      LoadManagerReport getLoadReport() + throws PulsarAdminException
      +
      Get load for this broker.
      +
      +
      Returns:
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getLoadReportAsync

      +
      CompletableFuture<LoadManagerReport> getLoadReportAsync()
      +
      Get load for this broker asynchronously.
      +
      +
      Returns:
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/Brokers.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/Brokers.html new file mode 100644 index 000000000000..a3c1346f5b00 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/Brokers.html @@ -0,0 +1,753 @@ + + + + +Brokers (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.client.admin
+

Interface Brokers

+
+
+
+
public interface Brokers
+
Admin interface for brokers management.
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getActiveBrokers

      +
      List<String> getActiveBrokers() + throws PulsarAdminException
      +
      Get the list of active brokers in the local cluster. +

      + Get the list of active brokers (broker ids) in the local cluster. +

      + Response Example: + + 

      + ["prod1-broker1.messaging.use.example.com:8080", "prod1-broker2.messaging.use.example.com:8080"
+ * * "prod1-broker3.messaging.use.example.com:8080"]
+
      +
      +
      Returns:
      +
      a list of broker ids
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - You don't have admin permission to get the list of active brokers in the cluster
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getActiveBrokersAsync

      +
      CompletableFuture<List<String>> getActiveBrokersAsync()
      +
      Get the list of active brokers in the local cluster asynchronously. +

      + Get the list of active brokers (broker ids) in the local cluster. +

      + Response Example: + + 

      + ["prod1-broker1.messaging.use.example.com:8080", "prod1-broker2.messaging.use.example.com:8080",
+ "prod1-broker3.messaging.use.example.com:8080"]
+
      +
      +
      Returns:
      +
      a list of broker ids
      +
      +
      +
      • +
    • +
      +

      getActiveBrokers

      +
      List<String> getActiveBrokers(String cluster) + throws PulsarAdminException
      +
      Get the list of active brokers in the cluster. +

      + Get the list of active brokers (broker ids) in the cluster. +

      + Response Example: + + 

      + ["prod1-broker1.messaging.use.example.com:8080", "prod1-broker2.messaging.use.example.com:8080"
+ * * "prod1-broker3.messaging.use.example.com:8080"]
+
      +
      +
      Parameters:
      +
      cluster - Cluster name
      +
      Returns:
      +
      a list of broker ids
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - You don't have admin permission to get the list of active brokers in the cluster
      +
      PulsarAdminException.NotFoundException - Cluster doesn't exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getActiveBrokersAsync

      +
      CompletableFuture<List<String>> getActiveBrokersAsync(String cluster)
      +
      Get the list of active brokers in the cluster asynchronously. +

      + Get the list of active brokers (broker ids) in the cluster. +

      + Response Example: + + 

      + ["prod1-broker1.messaging.use.example.com:8080", "prod1-broker2.messaging.use.example.com:8080",
+ "prod1-broker3.messaging.use.example.com:8080"]
+
      +
      +
      Parameters:
      +
      cluster - Cluster name
      +
      Returns:
      +
      a list of broker ids
      +
      +
      +
      • +
    • +
      +

      getLeaderBroker

      +
      BrokerInfo getLeaderBroker() + throws PulsarAdminException
      +
      Get the information of the leader broker. +

      + Get the information of the leader broker. +

      + Response Example: + + 

      + {serviceUrl:"prod1-broker1.messaging.use.example.com:8080"}
+
      +
      +
      Returns:
      +
      the information of the leader broker.
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getLeaderBrokerAsync

      +
      CompletableFuture<BrokerInfo> getLeaderBrokerAsync() + throws PulsarAdminException
      +
      Get the service url of the leader broker asynchronously. +

      + Get the service url of the leader broker. +

      + Response Example: + + 

      + {serviceUrl:"prod1-broker1.messaging.use.example.com:8080"}
+
      +
      +
      Returns:
      +
      the service url of the leader broker
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getOwnedNamespaces

      +
      Map<String,NamespaceOwnershipStatus> getOwnedNamespaces(String cluster, + String brokerId) + throws PulsarAdminException
      +
      Get the map of owned namespaces and their status from a single broker in the cluster. +

      + The map is returned in a JSON object format below +

      + Response Example: + + 

      + {"ns-1":{"broker_assignment":"shared","is_active":"true","is_controlled":"false"},
+ "ns-2":{"broker_assignment":"primary","is_active":"true","is_controlled":"true"}}
+
      +
      +
      Parameters:
      +
      cluster -
      +
      brokerId -
      +
      Returns:
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getOwnedNamespacesAsync

      +
      CompletableFuture<Map<String,NamespaceOwnershipStatus>> getOwnedNamespacesAsync(String cluster, + String brokerId)
      +
      Get the map of owned namespaces and their status from a single broker in the cluster asynchronously. +

      + The map is returned in a JSON object format below +

      + Response Example: + + 

      + {"ns-1":{"broker_assignment":"shared","is_active":"true","is_controlled":"false"},
+ "ns-2":{"broker_assignment":"primary","is_active":"true","is_controlled":"true"}}
+
      +
      +
      Parameters:
      +
      cluster -
      +
      brokerId -
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      updateDynamicConfiguration

      +
      void updateDynamicConfiguration(String configName, + String configValue) + throws PulsarAdminException
      +
      Update a dynamic configuration value into ZooKeeper. +

      + It updates dynamic configuration value in to Zk that triggers watch on + brokers and all brokers can update +

      +invalid reference +
      ServiceConfiguration
      +
      + value + locally
      +
      +
      Parameters:
      +
      configName -
      +
      configValue -
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      updateDynamicConfigurationAsync

      +
      CompletableFuture<Void> updateDynamicConfigurationAsync(String configName, + String configValue)
      +
      Update a dynamic configuration value into ZooKeeper asynchronously. +

      + It updates dynamic configuration value in to Zk that triggers watch on + brokers and all brokers can update +

      +invalid reference +
      ServiceConfiguration
      +
      + value + locally
      +
      +
      Parameters:
      +
      configName -
      +
      configValue -
      +
      +
      +
      • +
    • +
      +

      deleteDynamicConfiguration

      +
      void deleteDynamicConfiguration(String configName) + throws PulsarAdminException
      +
      It deletes dynamic configuration value into ZooKeeper. +

      + It will not impact current value in broker but next time when + broker restarts, it applies value from configuration file only.

      +
      +
      Parameters:
      +
      configName -
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      deleteDynamicConfigurationAsync

      +
      CompletableFuture<Void> deleteDynamicConfigurationAsync(String configName)
      +
      It deletes dynamic configuration value into ZooKeeper asynchronously. +

      + It will not impact current value in broker but next time when + broker restarts, it applies value from configuration file only.

      +
      +
      Parameters:
      +
      configName -
      +
      +
      +
      • +
    • +
      +

      getDynamicConfigurationNames

      +
      List<String> getDynamicConfigurationNames() + throws PulsarAdminException
      +
      Get list of updatable configuration name.
      +
      +
      Returns:
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getDynamicConfigurationNamesAsync

      +
      CompletableFuture<List<String>> getDynamicConfigurationNamesAsync()
      +
      Get list of updatable configuration name asynchronously.
      +
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      getRuntimeConfigurations

      +
      Map<String,String> getRuntimeConfigurations() + throws PulsarAdminException
      +
      Get values of runtime configuration.
      +
      +
      Returns:
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getRuntimeConfigurationsAsync

      +
      CompletableFuture<Map<String,String>> getRuntimeConfigurationsAsync()
      +
      Get values of runtime configuration asynchronously.
      +
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      getAllDynamicConfigurations

      +
      Map<String,String> getAllDynamicConfigurations() + throws PulsarAdminException
      +
      Get values of all overridden dynamic-configs.
      +
      +
      Returns:
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getAllDynamicConfigurationsAsync

      +
      CompletableFuture<Map<String,String>> getAllDynamicConfigurationsAsync()
      +
      Get values of all overridden dynamic-configs asynchronously.
      +
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      getInternalConfigurationData

      +
      InternalConfigurationData getInternalConfigurationData() + throws PulsarAdminException
      +
      Get the internal configuration data.
      +
      +
      Returns:
      +
      internal configuration data.
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getInternalConfigurationDataAsync

      +
      CompletableFuture<InternalConfigurationData> getInternalConfigurationDataAsync()
      +
      Get the internal configuration data asynchronously.
      +
      +
      Returns:
      +
      internal configuration data.
      +
      +
      +
      • +
    • +
      +

      backlogQuotaCheck

      +
      void backlogQuotaCheck() + throws PulsarAdminException
      +
      Manually trigger backlogQuotaCheck.
      +
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      backlogQuotaCheckAsync

      +
      CompletableFuture<Void> backlogQuotaCheckAsync()
      +
      Manually trigger backlogQuotaCheck asynchronously.
      +
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      healthcheck

      +
      @Deprecated +void healthcheck() + throws PulsarAdminException
      +
      Deprecated.
      +
      Run a healthcheck on the broker.
      +
      +
      Throws:
      +
      PulsarAdminException - if the healthcheck fails.
      +
      +
      +
      • +
    • +
      +

      healthcheckAsync

      +
      @Deprecated +CompletableFuture<Void> healthcheckAsync()
      +
      Deprecated.
      +
      Run a healthcheck on the broker asynchronously.
      +
      +
      • +
    • +
      +

      healthcheck

      +
      void healthcheck(TopicVersion topicVersion) + throws PulsarAdminException
      +
      Run a healthcheck on the broker.
      +
      +
      Throws:
      +
      PulsarAdminException - if the healthcheck fails.
      +
      +
      +
      • +
    • +
      +

      healthcheck

      +
      void healthcheck(TopicVersion topicVersion, + Optional<String> brokerId) + throws PulsarAdminException
      +
      Run a healthcheck on the target broker or on the broker.
      +
      +
      Parameters:
      +
      brokerId - target broker id to check the health. If empty, it checks the health on the connected broker.
      +
      Throws:
      +
      PulsarAdminException - if the healthcheck fails.
      +
      +
      +
      • +
    • +
      +

      healthcheckAsync

      +
      CompletableFuture<Void> healthcheckAsync(TopicVersion topicVersion, + Optional<String> brokerId)
      +
      Run a healthcheck on the broker asynchronously.
      +
      +
      • +
    • +
      +

      shutDownBrokerGracefully

      +
      CompletableFuture<Void> shutDownBrokerGracefully(int maxConcurrentUnloadPerSec, + boolean forcedTerminateTopic)
      +
      Trigger the current broker to graceful-shutdown asynchronously.
      +
      +
      Parameters:
      +
      maxConcurrentUnloadPerSec - the maximum number of topics to unload per second. + This helps control the speed of the unload operation during shutdown.
      +
      forcedTerminateTopic - if true, topics will be forcefully terminated during the shutdown process.
      +
      +
      +
      • +
    • +
      +

      getVersion

      +
      String getVersion() + throws PulsarAdminException
      +
      Get version of broker.
      +
      +
      Returns:
      +
      version of broker.
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/Clusters.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/Clusters.html new file mode 100644 index 000000000000..d89285cf5dd1 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/Clusters.html @@ -0,0 +1,1137 @@ + + + + +Clusters (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.client.admin
+

Interface Clusters

+
+
+
+
public interface Clusters
+
Admin interface for clusters management.
+
+
+ +
+
+ +
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/Functions.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/Functions.html new file mode 100644 index 000000000000..e7c4c6eb2c63 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/Functions.html @@ -0,0 +1,1620 @@ + + + + +Functions (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.client.admin
+

Interface Functions

+
+
+
+
public interface Functions
+
Admin interface for function management.
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getFunctions

      +
      List<String> getFunctions(String tenant, + String namespace) + throws PulsarAdminException
      +
      Get the list of functions. +

      + Get the list of all the Pulsar functions. +

      + Response Example: + + 

      + ["f1", "f2", "f3"]
+
      +
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getFunctionsAsync

      +
      CompletableFuture<List<String>> getFunctionsAsync(String tenant, + String namespace)
      +
      Get the list of functions asynchronously. +

      + Get the list of all the Pulsar functions. +

      + Response Example: + + 

      + ["f1", "f2", "f3"]
+
      +
      +
      • +
    • +
      +

      getFunction

      +
      FunctionConfig getFunction(String tenant, + String namespace, + String function) + throws PulsarAdminException
      +
      Get the configuration for the specified function. +

      + Response Example: + + 

      + { serviceUrl : "http://my-broker.example.com:8080/" }
+
      +
      +
      Parameters:
      +
      tenant - Tenant name
      +
      namespace - Namespace name
      +
      function - Function name
      +
      Returns:
      +
      the function configuration
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - You don't have admin permission to get the configuration of the cluster
      +
      PulsarAdminException.NotFoundException - Cluster doesn't exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getFunctionAsync

      +
      CompletableFuture<FunctionConfig> getFunctionAsync(String tenant, + String namespace, + String function)
      +
      Get the configuration for the specified function asynchronously. +

      + Response Example: + + 

      + { serviceUrl : "http://my-broker.example.com:8080/" }
+
      +
      +
      Parameters:
      +
      tenant - Tenant name
      +
      namespace - Namespace name
      +
      function - Function name
      +
      Returns:
      +
      the function configuration
      +
      +
      +
      • +
    • +
      +

      createFunction

      +
      void createFunction(FunctionConfig functionConfig, + String fileName) + throws PulsarAdminException
      +
      Create a new function.
      +
      +
      Parameters:
      +
      functionConfig - the function configuration object
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      createFunctionAsync

      +
      CompletableFuture<Void> createFunctionAsync(FunctionConfig functionConfig, + String fileName)
      +
      Create a new function asynchronously.
      +
      +
      Parameters:
      +
      functionConfig - the function configuration object
      +
      +
      +
      • +
    • +
      +

      createFunctionWithUrl

      +
      void createFunctionWithUrl(FunctionConfig functionConfig, + String pkgUrl) + throws PulsarAdminException
      +
      Create a new function with package url. +

      + Create a new function by providing url from which fun-pkg can be downloaded. supported url: http/file + eg: + File: file:/dir/fileName.jar + Http: http://www.repo.com/fileName.jar

      +
      +
      Parameters:
      +
      functionConfig - the function configuration object
      +
      pkgUrl - url from which pkg can be downloaded
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      createFunctionWithUrlAsync

      +
      CompletableFuture<Void> createFunctionWithUrlAsync(FunctionConfig functionConfig, + String pkgUrl)
      +
      Create a new function with package url asynchronously. +

      + Create a new function by providing url from which fun-pkg can be downloaded. supported url: http/file + eg: + File: file:/dir/fileName.jar + Http: http://www.repo.com/fileName.jar

      +
      +
      Parameters:
      +
      functionConfig - the function configuration object
      +
      pkgUrl - url from which pkg can be downloaded
      +
      +
      +
      • +
    • +
      +

      updateFunction

      +
      void updateFunction(FunctionConfig functionConfig, + String fileName) + throws PulsarAdminException
      +
      Update the configuration for a function. +

      +
      +
      Parameters:
      +
      functionConfig - the function configuration object
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - You don't have admin permission to create the cluster
      +
      PulsarAdminException.NotFoundException - Cluster doesn't exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      updateFunctionAsync

      +
      CompletableFuture<Void> updateFunctionAsync(FunctionConfig functionConfig, + String fileName)
      +
      Update the configuration for a function asynchronously. +

      +
      +
      Parameters:
      +
      functionConfig - the function configuration object
      +
      +
      +
      • +
    • +
      +

      updateFunction

      +
      void updateFunction(FunctionConfig functionConfig, + String fileName, + UpdateOptions updateOptions) + throws PulsarAdminException
      +
      Update the configuration for a function. +

      +
      +
      Parameters:
      +
      functionConfig - the function configuration object
      +
      updateOptions - options for the update operations
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - You don't have admin permission to create the cluster
      +
      PulsarAdminException.NotFoundException - Cluster doesn't exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      updateFunctionAsync

      +
      CompletableFuture<Void> updateFunctionAsync(FunctionConfig functionConfig, + String fileName, + UpdateOptions updateOptions)
      +
      Update the configuration for a function asynchronously. +

      +
      +
      Parameters:
      +
      functionConfig - the function configuration object
      +
      updateOptions - options for the update operations
      +
      +
      +
      • +
    • +
      +

      updateFunctionWithUrl

      +
      void updateFunctionWithUrl(FunctionConfig functionConfig, + String pkgUrl) + throws PulsarAdminException
      +
      Update the configuration for a function. +

      + Update a function by providing url from which fun-pkg can be downloaded. supported url: http/file + eg: + File: file:/dir/fileName.jar + Http: http://www.repo.com/fileName.jar

      +
      +
      Parameters:
      +
      functionConfig - the function configuration object
      +
      pkgUrl - url from which pkg can be downloaded
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - You don't have admin permission to create the cluster
      +
      PulsarAdminException.NotFoundException - Cluster doesn't exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      updateFunctionWithUrlAsync

      +
      CompletableFuture<Void> updateFunctionWithUrlAsync(FunctionConfig functionConfig, + String pkgUrl)
      +
      Update the configuration for a function asynchronously. +

      + Update a function by providing url from which fun-pkg can be downloaded. supported url: http/file + eg: + File: file:/dir/fileName.jar + Http: http://www.repo.com/fileName.jar

      +
      +
      Parameters:
      +
      functionConfig - the function configuration object
      +
      pkgUrl - url from which pkg can be downloaded
      +
      +
      +
      • +
    • +
      +

      updateFunctionWithUrl

      +
      void updateFunctionWithUrl(FunctionConfig functionConfig, + String pkgUrl, + UpdateOptions updateOptions) + throws PulsarAdminException
      +
      Update the configuration for a function. +

      + Update a function by providing url from which fun-pkg can be downloaded. supported url: http/file + eg: + File: file:/dir/fileName.jar + Http: http://www.repo.com/fileName.jar

      +
      +
      Parameters:
      +
      functionConfig - the function configuration object
      +
      pkgUrl - url from which pkg can be downloaded
      +
      updateOptions - options for the update operations
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - You don't have admin permission to create the cluster
      +
      PulsarAdminException.NotFoundException - Cluster doesn't exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      updateFunctionWithUrlAsync

      +
      CompletableFuture<Void> updateFunctionWithUrlAsync(FunctionConfig functionConfig, + String pkgUrl, + UpdateOptions updateOptions)
      +
      Update the configuration for a function asynchronously. +

      + Update a function by providing url from which fun-pkg can be downloaded. supported url: http/file + eg: + File: file:/dir/fileName.jar + Http: http://www.repo.com/fileName.jar

      +
      +
      Parameters:
      +
      functionConfig - the function configuration object
      +
      pkgUrl - url from which pkg can be downloaded
      +
      updateOptions - options for the update operations
      +
      +
      +
      • +
    • +
      +

      deleteFunction

      +
      void deleteFunction(String tenant, + String namespace, + String function) + throws PulsarAdminException
      +
      Delete an existing function. +

      + Delete a function

      +
      +
      Parameters:
      +
      tenant - Tenant name
      +
      namespace - Namespace name
      +
      function - Function name
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - You don't have admin permission
      +
      PulsarAdminException.NotFoundException - Cluster does not exist
      +
      PulsarAdminException.PreconditionFailedException - Cluster is not empty
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      deleteFunctionAsync

      +
      CompletableFuture<Void> deleteFunctionAsync(String tenant, + String namespace, + String function)
      +
      Delete an existing function asynchronously. +

      + Delete a function

      +
      +
      Parameters:
      +
      tenant - Tenant name
      +
      namespace - Namespace name
      +
      function - Function name
      +
      +
      +
      • +
    • +
      +

      getFunctionStatus

      +
      FunctionStatus getFunctionStatus(String tenant, + String namespace, + String function) + throws PulsarAdminException
      +
      Gets the current status of a function.
      +
      +
      Parameters:
      +
      tenant - Tenant name
      +
      namespace - Namespace name
      +
      function - Function name
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getFunctionStatusAsync

      +
      CompletableFuture<FunctionStatus> getFunctionStatusAsync(String tenant, + String namespace, + String function)
      +
      Gets the current status of a function asynchronously.
      +
      +
      Parameters:
      +
      tenant - Tenant name
      +
      namespace - Namespace name
      +
      function - Function name
      +
      +
      +
      • +
    • +
      +

      getFunctionStatus

      +
      FunctionStatus.FunctionInstanceStatus.FunctionInstanceStatusData getFunctionStatus(String tenant, + String namespace, + String function, + int id) + throws PulsarAdminException
      +
      Gets the current status of a function instance.
      +
      +
      Parameters:
      +
      tenant - Tenant name
      +
      namespace - Namespace name
      +
      function - Function name
      +
      id - Function instance-id
      +
      Returns:
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getFunctionStatusAsync

      +
      CompletableFuture<FunctionStatus.FunctionInstanceStatus.FunctionInstanceStatusData> getFunctionStatusAsync(String tenant, + String namespace, + String function, + int id)
      +
      Gets the current status of a function instance asynchronously.
      +
      +
      Parameters:
      +
      tenant - Tenant name
      +
      namespace - Namespace name
      +
      function - Function name
      +
      id - Function instance-id
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      getFunctionStats

      +
      FunctionInstanceStatsData getFunctionStats(String tenant, + String namespace, + String function, + int id) + throws PulsarAdminException
      +
      Gets the current stats of a function instance.
      +
      +
      Parameters:
      +
      tenant - Tenant name
      +
      namespace - Namespace name
      +
      function - Function name
      +
      id - Function instance-id
      +
      Returns:
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getFunctionStatsAsync

      +
      CompletableFuture<FunctionInstanceStatsData> getFunctionStatsAsync(String tenant, + String namespace, + String function, + int id)
      +
      Gets the current stats of a function instance asynchronously.
      +
      +
      Parameters:
      +
      tenant - Tenant name
      +
      namespace - Namespace name
      +
      function - Function name
      +
      id - Function instance-id
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      getFunctionStats

      +
      FunctionStats getFunctionStats(String tenant, + String namespace, + String function) + throws PulsarAdminException
      +
      Gets the current stats of a function.
      +
      +
      Parameters:
      +
      tenant - Tenant name
      +
      namespace - Namespace name
      +
      function - Function name
      +
      Returns:
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getFunctionStatsAsync

      +
      CompletableFuture<FunctionStats> getFunctionStatsAsync(String tenant, + String namespace, + String function)
      +
      Gets the current stats of a function asynchronously.
      +
      +
      Parameters:
      +
      tenant - Tenant name
      +
      namespace - Namespace name
      +
      function - Function name
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      restartFunction

      +
      void restartFunction(String tenant, + String namespace, + String function, + int instanceId) + throws PulsarAdminException
      +
      Restart function instance.
      +
      +
      Parameters:
      +
      tenant - Tenant name
      +
      namespace - Namespace name
      +
      function - Function name
      +
      instanceId - Function instanceId
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      restartFunctionAsync

      +
      CompletableFuture<Void> restartFunctionAsync(String tenant, + String namespace, + String function, + int instanceId)
      +
      Restart function instance asynchronously.
      +
      +
      Parameters:
      +
      tenant - Tenant name
      +
      namespace - Namespace name
      +
      function - Function name
      +
      instanceId - Function instanceId
      +
      +
      +
      • +
    • +
      +

      restartFunction

      +
      void restartFunction(String tenant, + String namespace, + String function) + throws PulsarAdminException
      +
      Restart all function instances.
      +
      +
      Parameters:
      +
      tenant - Tenant name
      +
      namespace - Namespace name
      +
      function - Function name
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      restartFunctionAsync

      +
      CompletableFuture<Void> restartFunctionAsync(String tenant, + String namespace, + String function)
      +
      Restart all function instances asynchronously.
      +
      +
      Parameters:
      +
      tenant - Tenant name
      +
      namespace - Namespace name
      +
      function - Function name
      +
      +
      +
      • +
    • +
      +

      stopFunction

      +
      void stopFunction(String tenant, + String namespace, + String function, + int instanceId) + throws PulsarAdminException
      +
      Stop function instance.
      +
      +
      Parameters:
      +
      tenant - Tenant name
      +
      namespace - Namespace name
      +
      function - Function name
      +
      instanceId - Function instanceId
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      stopFunctionAsync

      +
      CompletableFuture<Void> stopFunctionAsync(String tenant, + String namespace, + String function, + int instanceId)
      +
      Stop function instance asynchronously.
      +
      +
      Parameters:
      +
      tenant - Tenant name
      +
      namespace - Namespace name
      +
      function - Function name
      +
      instanceId - Function instanceId
      +
      +
      +
      • +
    • +
      +

      startFunction

      +
      void startFunction(String tenant, + String namespace, + String function) + throws PulsarAdminException
      +
      Start all function instances.
      +
      +
      Parameters:
      +
      tenant - Tenant name
      +
      namespace - Namespace name
      +
      function - Function name
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      startFunctionAsync

      +
      CompletableFuture<Void> startFunctionAsync(String tenant, + String namespace, + String function)
      +
      Start all function instances asynchronously.
      +
      +
      Parameters:
      +
      tenant - Tenant name
      +
      namespace - Namespace name
      +
      function - Function name
      +
      +
      +
      • +
    • +
      +

      startFunction

      +
      void startFunction(String tenant, + String namespace, + String function, + int instanceId) + throws PulsarAdminException
      +
      Start function instance.
      +
      +
      Parameters:
      +
      tenant - Tenant name
      +
      namespace - Namespace name
      +
      function - Function name
      +
      instanceId - Function instanceId
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      startFunctionAsync

      +
      CompletableFuture<Void> startFunctionAsync(String tenant, + String namespace, + String function, + int instanceId)
      +
      Start function instance asynchronously.
      +
      +
      Parameters:
      +
      tenant - Tenant name
      +
      namespace - Namespace name
      +
      function - Function name
      +
      instanceId - Function instanceId
      +
      +
      +
      • +
    • +
      +

      stopFunction

      +
      void stopFunction(String tenant, + String namespace, + String function) + throws PulsarAdminException
      +
      Stop all function instances.
      +
      +
      Parameters:
      +
      tenant - Tenant name
      +
      namespace - Namespace name
      +
      function - Function name
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      stopFunctionAsync

      +
      CompletableFuture<Void> stopFunctionAsync(String tenant, + String namespace, + String function)
      +
      Stop all function instances asynchronously.
      +
      +
      Parameters:
      +
      tenant - Tenant name
      +
      namespace - Namespace name
      +
      function - Function name
      +
      +
      +
      • +
    • +
      +

      triggerFunction

      +
      String triggerFunction(String tenant, + String namespace, + String function, + String topic, + String triggerValue, + String triggerFile) + throws PulsarAdminException
      +
      Triggers the function by writing to the input topic.
      +
      +
      Parameters:
      +
      tenant - Tenant name
      +
      namespace - Namespace name
      +
      function - Function name
      +
      triggerValue - The input that will be written to input topic
      +
      triggerFile - The file which contains the input that will be written to input topic
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      triggerFunctionAsync

      +
      CompletableFuture<String> triggerFunctionAsync(String tenant, + String namespace, + String function, + String topic, + String triggerValue, + String triggerFile)
      +
      Triggers the function by writing to the input topic asynchronously.
      +
      +
      Parameters:
      +
      tenant - Tenant name
      +
      namespace - Namespace name
      +
      function - Function name
      +
      triggerValue - The input that will be written to input topic
      +
      triggerFile - The file which contains the input that will be written to input topic
      +
      +
      +
      • +
    • +
      +

      uploadFunction

      +
      void uploadFunction(String sourceFile, + String path) + throws PulsarAdminException
      +
      Upload Data.
      +
      +
      Parameters:
      +
      sourceFile - dataFile that needs to be uploaded
      +
      path - Path where data should be stored
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      uploadFunctionAsync

      +
      CompletableFuture<Void> uploadFunctionAsync(String sourceFile, + String path)
      +
      Upload Data asynchronously.
      +
      +
      Parameters:
      +
      sourceFile - dataFile that needs to be uploaded
      +
      path - Path where data should be stored
      +
      +
      +
      • +
    • +
      +

      downloadFunction

      +
      void downloadFunction(String destinationFile, + String path) + throws PulsarAdminException
      +
      Download Function Code.
      +
      +
      Parameters:
      +
      destinationFile - file where data should be downloaded to
      +
      path - Path where data is located
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      downloadFunctionAsync

      +
      CompletableFuture<Void> downloadFunctionAsync(String destinationFile, + String path)
      +
      Download Function Code.
      +
      +
      Parameters:
      +
      destinationFile - file where data should be downloaded to
      +
      path - Path where data is located
      +
      +
      +
      • +
    • +
      +

      downloadFunction

      +
      void downloadFunction(String destinationFile, + String tenant, + String namespace, + String function) + throws PulsarAdminException
      +
      Download Function Code.
      +
      +
      Parameters:
      +
      destinationFile - file where data should be downloaded to
      +
      tenant - Tenant name
      +
      namespace - Namespace name
      +
      function - Function name
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      downloadFunctionAsync

      +
      CompletableFuture<Void> downloadFunctionAsync(String destinationFile, + String tenant, + String namespace, + String function)
      +
      Download Function Code asynchronously.
      +
      +
      Parameters:
      +
      destinationFile - file where data should be downloaded to
      +
      tenant - Tenant name
      +
      namespace - Namespace name
      +
      function - Function name
      +
      +
      +
      • +
    • +
      +

      downloadFunction

      +
      void downloadFunction(String destinationFile, + String tenant, + String namespace, + String function, + boolean transformFunction) + throws PulsarAdminException
      +
      Download Function Code.
      +
      +
      Parameters:
      +
      destinationFile - file where data should be downloaded to
      +
      tenant - Tenant name
      +
      namespace - Namespace name
      +
      function - Function name
      +
      transformFunction - Whether to download the transform function (for sources and sinks)
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      downloadFunctionAsync

      +
      CompletableFuture<Void> downloadFunctionAsync(String destinationFile, + String tenant, + String namespace, + String function, + boolean transformFunction)
      +
      Download Function Code asynchronously.
      +
      +
      Parameters:
      +
      destinationFile - file where data should be downloaded to
      +
      tenant - Tenant name
      +
      namespace - Namespace name
      +
      function - Function name
      +
      transformFunction - Whether to download the transform function (for sources and sinks)
      +
      +
      +
      • +
    • +
      +

      getConnectorsList

      +
      @Deprecated +List<ConnectorDefinition> getConnectorsList() + throws PulsarAdminException
      +
      Deprecated.
      +
      Deprecated in favor of getting sources and sinks for their own APIs. +

      + Fetches a list of supported Pulsar IO connectors currently running in cluster mode

      +
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getSources

      +
      @Deprecated +Set<String> getSources() + throws PulsarAdminException
      +
      Deprecated.
      +
      Deprecated in favor of getting sources and sinks for their own APIs. +

      + Fetches a list of supported Pulsar IO sources currently running in cluster mode

      +
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getSinks

      +
      @Deprecated +Set<String> getSinks() + throws PulsarAdminException
      +
      Deprecated.
      +
      Deprecated in favor of getting sources and sinks for their own APIs. +

      + Fetches a list of supported Pulsar IO sinks currently running in cluster mode

      +
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getBuiltInFunctions

      +
      List<FunctionDefinition> getBuiltInFunctions() + throws PulsarAdminException
      +
      Fetches a list of supported Pulsar Functions currently running in cluster mode.
      +
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getBuiltInFunctionsAsync

      +
      CompletableFuture<List<FunctionDefinition>> getBuiltInFunctionsAsync()
      +
      Fetches a list of supported Pulsar Functions currently running in cluster mode asynchronously.
      +
      +
      • +
    • +
      +

      getFunctionState

      +
      FunctionState getFunctionState(String tenant, + String namespace, + String function, + String key) + throws PulsarAdminException
      +
      Fetch the current state associated with a Pulsar Function. +

      + Response Example: + + 

      + { "value : 12, version : 2"}
+
      +
      +
      Parameters:
      +
      tenant - Tenant name
      +
      namespace - Namespace name
      +
      function - Function name
      +
      key - Key name of State
      +
      Returns:
      +
      the function configuration
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - You don't have admin permission to get the configuration of the cluster
      +
      PulsarAdminException.NotFoundException - Cluster doesn't exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getFunctionStateAsync

      +
      CompletableFuture<FunctionState> getFunctionStateAsync(String tenant, + String namespace, + String function, + String key)
      +
      Fetch the current state associated with a Pulsar Function asynchronously. +

      + Response Example: + + 

      + { "value : 12, version : 2"}
+
      +
      +
      Parameters:
      +
      tenant - Tenant name
      +
      namespace - Namespace name
      +
      function - Function name
      +
      key - Key name of State
      +
      Returns:
      +
      the function configuration
      +
      +
      +
      • +
    • +
      +

      putFunctionState

      +
      void putFunctionState(String tenant, + String namespace, + String function, + FunctionState state) + throws PulsarAdminException
      +
      Puts the given state associated with a Pulsar Function. +

      + Response Example: + + 

      + { "value : 12, version : 2"}
+
      +
      +
      Parameters:
      +
      tenant - Tenant name
      +
      namespace - Namespace name
      +
      function - Function name
      +
      state - FunctionState
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - You don't have admin permission to get the configuration of the cluster
      +
      PulsarAdminException.NotFoundException - Cluster doesn't exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      putFunctionStateAsync

      +
      CompletableFuture<Void> putFunctionStateAsync(String tenant, + String namespace, + String function, + FunctionState state)
      +
      Puts the given state associated with a Pulsar Function asynchronously. +

      + Response Example: + + 

      + { "value : 12, version : 2"}
+
      +
      +
      Parameters:
      +
      tenant - Tenant name
      +
      namespace - Namespace name
      +
      function - Function name
      +
      state - FunctionState
      +
      +
      +
      • +
    • +
      +

      reloadBuiltInFunctions

      +
      void reloadBuiltInFunctions() + throws PulsarAdminException
      +
      Reload the available built-in functions.
      +
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      reloadBuiltInFunctionsAsync

      +
      CompletableFuture<Void> reloadBuiltInFunctionsAsync()
      +
      Reload the available built-in functions.
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/GetStatsOptions.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/GetStatsOptions.html new file mode 100644 index 000000000000..6421a1a1302e --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/GetStatsOptions.html @@ -0,0 +1,150 @@ + + + + +GetStatsOptions (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.client.admin
+

Class GetStatsOptions

+
+
java.lang.Object +
org.apache.pulsar.client.admin.GetStatsOptions
+
+
+
+
public class GetStatsOptions +extends Object
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      GetStatsOptions

      +
      public GetStatsOptions()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/GrantTopicPermissionOptions.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/GrantTopicPermissionOptions.html new file mode 100644 index 000000000000..5a084968d3c3 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/GrantTopicPermissionOptions.html @@ -0,0 +1,150 @@ + + + + +GrantTopicPermissionOptions (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.client.admin
+

Class GrantTopicPermissionOptions

+
+
java.lang.Object +
org.apache.pulsar.client.admin.GrantTopicPermissionOptions
+
+
+
+
public class GrantTopicPermissionOptions +extends Object
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      GrantTopicPermissionOptions

      +
      public GrantTopicPermissionOptions()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/ListNamespaceTopicsOptions.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/ListNamespaceTopicsOptions.html new file mode 100644 index 000000000000..d6ec49f03241 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/ListNamespaceTopicsOptions.html @@ -0,0 +1,179 @@ + + + + +ListNamespaceTopicsOptions (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.client.admin
+

Class ListNamespaceTopicsOptions

+
+
java.lang.Object +
org.apache.pulsar.client.admin.ListNamespaceTopicsOptions
+
+
+
+
public class ListNamespaceTopicsOptions +extends Object
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    + +
    +
    • + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      ListNamespaceTopicsOptions

      +
      public ListNamespaceTopicsOptions()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/ListTopicsOptions.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/ListTopicsOptions.html new file mode 100644 index 000000000000..81a3d2327090 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/ListTopicsOptions.html @@ -0,0 +1,179 @@ + + + + +ListTopicsOptions (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.client.admin
+

Class ListTopicsOptions

+
+
java.lang.Object +
org.apache.pulsar.client.admin.ListTopicsOptions
+
+
+
+
public class ListTopicsOptions +extends Object
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    + +
    +
    • + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      ListTopicsOptions

      +
      public ListTopicsOptions()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/LongRunningProcessStatus.Status.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/LongRunningProcessStatus.Status.html new file mode 100644 index 000000000000..4a452aa3c29e --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/LongRunningProcessStatus.Status.html @@ -0,0 +1,257 @@ + + + + +LongRunningProcessStatus.Status (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.client.admin
+

Enum Class LongRunningProcessStatus.Status

+
+
java.lang.Object +
java.lang.Enum<LongRunningProcessStatus.Status> +
org.apache.pulsar.client.admin.LongRunningProcessStatus.Status
+
+
+
+
+
All Implemented Interfaces:
+
Serializable, Comparable<LongRunningProcessStatus.Status>, Constable
+
+
+
Enclosing class:
+
LongRunningProcessStatus
+
+
+
public static enum LongRunningProcessStatus.Status +extends Enum<LongRunningProcessStatus.Status>
+
Status code.
+
+
+ +
+
+
    + +
  • +
    +

    Enum Constant Details

    + +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      values

      +
      public static LongRunningProcessStatus.Status[] values()
      +
      Returns an array containing the constants of this enum class, in +the order they are declared.
      +
      +
      Returns:
      +
      an array containing the constants of this enum class, in the order they are declared
      +
      +
      +
      • +
    • +
      +

      valueOf

      +
      public static LongRunningProcessStatus.Status valueOf(String name)
      +
      Returns the enum constant of this class with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this class. (Extraneous whitespace characters are +not permitted.)
      +
      +
      Parameters:
      +
      name - the name of the enum constant to be returned.
      +
      Returns:
      +
      the enum constant with the specified name
      +
      Throws:
      +
      IllegalArgumentException - if this enum class has no constant with the specified name
      +
      NullPointerException - if the argument is null
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/LongRunningProcessStatus.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/LongRunningProcessStatus.html new file mode 100644 index 000000000000..35cab1309fa6 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/LongRunningProcessStatus.html @@ -0,0 +1,242 @@ + + + + +LongRunningProcessStatus (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.client.admin
+

Class LongRunningProcessStatus

+
+
java.lang.Object +
org.apache.pulsar.client.admin.LongRunningProcessStatus
+
+
+
+
public class LongRunningProcessStatus +extends Object
+
Status of long running process.
+
+
+ +
+
+ +
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/Lookup.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/Lookup.html new file mode 100644 index 000000000000..f076de38da2c --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/Lookup.html @@ -0,0 +1,250 @@ + + + + +Lookup (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.client.admin
+

Interface Lookup

+
+
+
+
public interface Lookup
+
This is an interface class to allow using command line tool to quickly lookup the broker serving the topic.
+
+
+ +
+
+ +
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/Mode.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/Mode.html new file mode 100644 index 000000000000..4f0219936784 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/Mode.html @@ -0,0 +1,277 @@ + + + + +Mode (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.client.admin
+

Enum Class Mode

+
+
java.lang.Object +
java.lang.Enum<Mode> +
org.apache.pulsar.client.admin.Mode
+
+
+
+
+
All Implemented Interfaces:
+
Serializable, Comparable<Mode>, Constable
+
+
+
public enum Mode +extends Enum<Mode>
+
+
+ +
+
+
    + +
  • +
    +

    Enum Constant Details

    +
      +
    • +
      +

      PERSISTENT

      +
      public static final Mode PERSISTENT
      +
      +
      • +
    • +
      +

      NON_PERSISTENT

      +
      public static final Mode NON_PERSISTENT
      +
      +
      • +
    • +
      +

      ALL

      +
      public static final Mode ALL
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      values

      +
      public static Mode[] values()
      +
      Returns an array containing the constants of this enum class, in +the order they are declared.
      +
      +
      Returns:
      +
      an array containing the constants of this enum class, in the order they are declared
      +
      +
      +
      • +
    • +
      +

      valueOf

      +
      public static Mode valueOf(String name)
      +
      Returns the enum constant of this class with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this class. (Extraneous whitespace characters are +not permitted.)
      +
      +
      Parameters:
      +
      name - the name of the enum constant to be returned.
      +
      Returns:
      +
      the enum constant with the specified name
      +
      Throws:
      +
      IllegalArgumentException - if this enum class has no constant with the specified name
      +
      NullPointerException - if the argument is null
      +
      +
      +
      • +
    • +
      +

      getValue

      +
      public int getValue()
      +
      +
      • +
    • +
      +

      valueOf

      +
      public static Mode valueOf(int n)
      +
      Returns the enum constant of this class with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this class. (Extraneous whitespace characters are +not permitted.)
      +
      +
      Parameters:
      +
      n - the name of the enum constant to be returned.
      +
      Returns:
      +
      the enum constant with the specified name
      +
      Throws:
      +
      IllegalArgumentException - if this enum class has no constant with the specified name
      +
      NullPointerException - if the argument is null
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/Namespaces.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/Namespaces.html new file mode 100644 index 000000000000..27e95e65ba17 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/Namespaces.html @@ -0,0 +1,7829 @@ + + + + +Namespaces (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.client.admin
+

Interface Namespaces

+
+
+
+
public interface Namespaces
+
Admin interface for namespaces management.
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getNamespaces

      +
      List<String> getNamespaces(String tenant) + throws PulsarAdminException
      +
      Get the list of namespaces. +

      + Get the list of all the namespaces for a certain tenant. +

      + Response Example: + + 

      + ["my-tenant/c1/namespace1",
+  "my-tenant/global/namespace2",
+  "my-tenant/c2/namespace3"]
+
      +
      +
      Parameters:
      +
      tenant - Tenant name
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Tenant does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getNamespacesAsync

      +
      CompletableFuture<List<String>> getNamespacesAsync(String tenant)
      +
      Get the list of namespaces asynchronously. +

      + Get the list of all the namespaces for a certain tenant. +

      + Response Example: + + 

      + ["my-tenant/c1/namespace1",
+  "my-tenant/global/namespace2",
+  "my-tenant/c2/namespace3"]
+
      +
      +
      Parameters:
      +
      tenant - Tenant name
      +
      +
      +
      • +
    • +
      +

      getNamespaces

      +
      @Deprecated +List<String> getNamespaces(String tenant, + String cluster) + throws PulsarAdminException
      +
      Deprecated.
      +
      Get the list of namespaces. +

      + Get the list of all the namespaces for a certain tenant on single cluster. +

      + Response Example: + + 

      + ["my-tenant/use/namespace1", "my-tenant/use/namespace2"]
+
      +
      +
      Parameters:
      +
      tenant - Tenant name
      +
      cluster - Cluster name
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Tenant or cluster does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getTopics

      +
      List<String> getTopics(String namespace) + throws PulsarAdminException
      +
      Get the list of topics. +

      + Get the list of all the topics under a certain namespace. +

      + Response Example: + + 

      + ["persistent://my-tenant/use/namespace1/my-topic-1",
+  "persistent://my-tenant/use/namespace1/my-topic-2"]
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - You don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getTopicsAsync

      +
      CompletableFuture<List<String>> getTopicsAsync(String namespace)
      +
      Get the list of topics asynchronously. +

      + Get the list of all the topics under a certain namespace. +

      + Response Example: + + 

      + ["persistent://my-tenant/use/namespace1/my-topic-1",
+  "persistent://my-tenant/use/namespace1/my-topic-2"]
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      +
      +
      • +
    • +
      +

      getTopics

      +
      List<String> getTopics(String namespace, + ListNamespaceTopicsOptions options) + throws PulsarAdminException
      +
      Get the list of topics. +

      + Get the list of all the topics under a certain namespace. +

      + Response Example: + + 

      + ["persistent://my-tenant/use/namespace1/my-topic-1",
+  "persistent://my-tenant/use/namespace1/my-topic-2"]
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      options - List namespace topics options
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - You don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getTopicsAsync

      +
      CompletableFuture<List<String>> getTopicsAsync(String namespace, + ListNamespaceTopicsOptions options)
      +
      Get the list of topics asynchronously. +

      + Get the list of all the topics under a certain namespace. +

      + Response Example: + + 

      + ["persistent://my-tenant/use/namespace1/my-topic-1",
+  "persistent://my-tenant/use/namespace1/my-topic-2"]
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      options - List namespace topics options
      +
      +
      +
      • +
    • +
      +

      getBundles

      +
      BundlesData getBundles(String namespace) + throws PulsarAdminException
      +
      Get the list of bundles. +

      + Get the list of all the bundles under a certain namespace. +

      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - You don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getBundlesAsync

      +
      CompletableFuture<BundlesData> getBundlesAsync(String namespace)
      +
      Get the list of bundles asynchronously. +

      + Get the list of all the bundles under a certain namespace. +

      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      +
      +
      • +
    • +
      +

      getPolicies

      +
      Policies getPolicies(String namespace) + throws PulsarAdminException
      +
      Get policies for a namespace. +

      + Get the dump all the policies specified for a namespace. +

      + Response example: + + 

      + {
+   "auth_policies" : {
+     "namespace_auth" : {
+       "my-role" : [ "produce" ]
+     },
+     "destination_auth" : {
+       "persistent://prop/local/ns1/my-topic" : {
+         "role-1" : [ "produce" ],
+         "role-2" : [ "consume" ]
+       }
+     }
+   },
+   "replication_clusters" : ["use", "usw"],
+   "message_ttl_in_seconds" : 300
+ }
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - You don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException - Unexpected error
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      getPoliciesAsync

      +
      CompletableFuture<Policies> getPoliciesAsync(String namespace)
      +
      Get policies for a namespace asynchronously. +

      + Get the dump all the policies specified for a namespace. +

      + Response example: + + 

      + {
+   "auth_policies" : {
+     "namespace_auth" : {
+       "my-role" : [ "produce" ]
+     },
+     "destination_auth" : {
+       "persistent://prop/local/ns1/my-topic" : {
+         "role-1" : [ "produce" ],
+         "role-2" : [ "consume" ]
+       }
+     }
+   },
+   "replication_clusters" : ["use", "usw"],
+   "message_ttl_in_seconds" : 300
+ }
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      createNamespace

      +
      void createNamespace(String namespace, + int numBundles) + throws PulsarAdminException
      +
      Create a new namespace. +

      + Creates a new empty namespace with no policies attached.

      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      numBundles - Number of bundles
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - You don't have admin permission
      +
      PulsarAdminException.NotFoundException - Tenant or cluster does not exist
      +
      PulsarAdminException.ConflictException - Namespace already exists
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      createNamespaceAsync

      +
      CompletableFuture<Void> createNamespaceAsync(String namespace, + int numBundles)
      +
      Create a new namespace. +

      + Creates a new empty namespace with no policies attached.

      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      numBundles - Number of bundles
      +
      +
      +
      • +
    • +
      +

      createNamespace

      +
      void createNamespace(String namespace, + BundlesData bundlesData) + throws PulsarAdminException
      +
      Create a new namespace. +

      + Creates a new empty namespace with no policies attached.

      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      bundlesData - Bundles Data
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - You don't have admin permission
      +
      PulsarAdminException.NotFoundException - Tenant or cluster does not exist
      +
      PulsarAdminException.ConflictException - Namespace already exists
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      createNamespaceAsync

      +
      CompletableFuture<Void> createNamespaceAsync(String namespace, + BundlesData bundlesData)
      +
      Create a new namespace asynchronously. +

      + Creates a new empty namespace with no policies attached.

      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      bundlesData - Bundles Data
      +
      +
      +
      • +
    • +
      +

      createNamespace

      +
      void createNamespace(String namespace) + throws PulsarAdminException
      +
      Create a new namespace. +

      + Creates a new empty namespace with no policies attached.

      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - You don't have admin permission
      +
      PulsarAdminException.NotFoundException - Tenant or cluster does not exist
      +
      PulsarAdminException.ConflictException - Namespace already exists
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      createNamespaceAsync

      +
      CompletableFuture<Void> createNamespaceAsync(String namespace)
      +
      Create a new namespace asynchronously. +

      + Creates a new empty namespace with no policies attached.

      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      +
      +
      • +
    • +
      +

      createNamespace

      +
      void createNamespace(String namespace, + Set<String> clusters) + throws PulsarAdminException
      +
      Create a new namespace. +

      + Creates a new empty namespace with no policies attached.

      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      clusters - Clusters in which the namespace will be present. If more than one cluster is present, replication + across clusters will be enabled.
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - You don't have admin permission
      +
      PulsarAdminException.NotFoundException - Tenant or cluster does not exist
      +
      PulsarAdminException.ConflictException - Namespace already exists
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      createNamespaceAsync

      +
      CompletableFuture<Void> createNamespaceAsync(String namespace, + Set<String> clusters)
      +
      Create a new namespace asynchronously. +

      + Creates a new empty namespace with no policies attached.

      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      clusters - Clusters in which the namespace will be present. If more than one cluster is present, replication + across clusters will be enabled.
      +
      +
      +
      • +
    • +
      +

      createNamespace

      +
      void createNamespace(String namespace, + Policies policies) + throws PulsarAdminException
      +
      Create a new namespace. +

      + Creates a new namespace with the specified policies.

      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      policies - Policies for the namespace
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - You don't have admin permission
      +
      PulsarAdminException.NotFoundException - Tenant or cluster does not exist
      +
      PulsarAdminException.ConflictException - Namespace already exists
      +
      PulsarAdminException - Unexpected error
      +
      Since:
      +
      2.0
      +
      +
      +
      • +
    • +
      +

      createNamespaceAsync

      +
      CompletableFuture<Void> createNamespaceAsync(String namespace, + Policies policies)
      +
      Create a new namespace asynchronously. +

      + Creates a new namespace with the specified policies.

      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      policies - Policies for the namespace
      +
      +
      +
      • +
    • +
      +

      deleteNamespace

      +
      void deleteNamespace(String namespace) + throws PulsarAdminException
      +
      Delete an existing namespace. +

      + The namespace needs to be empty.

      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - You don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException.ConflictException - Namespace is not empty
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      deleteNamespace

      +
      void deleteNamespace(String namespace, + boolean force) + throws PulsarAdminException
      +
      Delete an existing namespace. +

      + Force flag deletes namespace forcefully by force deleting all topics under it.

      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      force - Delete namespace forcefully
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - You don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException.ConflictException - Namespace is not empty
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      deleteNamespaceAsync

      +
      CompletableFuture<Void> deleteNamespaceAsync(String namespace)
      +
      Delete an existing namespace asynchronously. +

      + The namespace needs to be empty.

      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      +
      +
      • +
    • +
      +

      deleteNamespaceAsync

      +
      CompletableFuture<Void> deleteNamespaceAsync(String namespace, + boolean force)
      +
      Delete an existing namespace asynchronously. +

      + Force flag deletes namespace forcefully by force deleting all topics under it.

      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      force - Delete namespace forcefully
      +
      +
      +
      • +
    • +
      +

      deleteNamespaceBundle

      +
      void deleteNamespaceBundle(String namespace, + String bundleRange) + throws PulsarAdminException
      +
      Delete an existing bundle in a namespace. +

      + The bundle needs to be empty.

      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      bundleRange - range of the bundle
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - You don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace/bundle does not exist
      +
      PulsarAdminException.ConflictException - Bundle is not empty
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      deleteNamespaceBundle

      +
      void deleteNamespaceBundle(String namespace, + String bundleRange, + boolean force) + throws PulsarAdminException
      +
      Delete an existing bundle in a namespace. +

      + Force flag deletes bundle forcefully.

      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      bundleRange - range of the bundle
      +
      force - Delete bundle forcefully
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - You don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace/bundle does not exist
      +
      PulsarAdminException.ConflictException - Bundle is not empty
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      deleteNamespaceBundleAsync

      +
      CompletableFuture<Void> deleteNamespaceBundleAsync(String namespace, + String bundleRange)
      +
      Delete an existing bundle in a namespace asynchronously. +

      + The bundle needs to be empty.

      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      bundleRange - range of the bundle
      +
      Returns:
      +
      a future that can be used to track when the bundle is deleted
      +
      +
      +
      • +
    • +
      +

      deleteNamespaceBundleAsync

      +
      CompletableFuture<Void> deleteNamespaceBundleAsync(String namespace, + String bundleRange, + boolean force)
      +
      Delete an existing bundle in a namespace asynchronously. +

      + Force flag deletes bundle forcefully.

      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      bundleRange - range of the bundle
      +
      force - Delete bundle forcefully
      +
      Returns:
      +
      a future that can be used to track when the bundle is deleted
      +
      +
      +
      • +
    • +
      +

      getPermissions

      +
      Map<String,Set<AuthAction>> getPermissions(String namespace) + throws PulsarAdminException
      +
      Get permissions on a namespace. +

      + Retrieve the permissions for a namespace. +

      + Response example: + + 

      + {
+   "my-role" : [ "produce" ]
+   "other-role" : [ "consume" ]
+ }
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - You don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getPermissionsAsync

      +
      CompletableFuture<Map<String,Set<AuthAction>>> getPermissionsAsync(String namespace)
      +
      Get permissions on a namespace asynchronously. +

      + Retrieve the permissions for a namespace. +

      + Response example: + + 

      + {
+   "my-role" : [ "produce" ]
+   "other-role" : [ "consume" ]
+ }
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      +
      +
      • +
    • +
      +

      grantPermissionOnNamespace

      +
      void grantPermissionOnNamespace(String namespace, + String role, + Set<AuthAction> actions) + throws PulsarAdminException
      +
      Grant permission on a namespace. +

      + Grant a new permission to a client role on a namespace. +

      + Request parameter example: + + 

      + ["produce", "consume"]
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      role - Client role to which grant permission
      +
      actions - Auth actions (produce and consume)
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException.ConflictException - Concurrent modification
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      grantPermissionOnNamespaceAsync

      +
      CompletableFuture<Void> grantPermissionOnNamespaceAsync(String namespace, + String role, + Set<AuthAction> actions)
      +
      Grant permission on a namespace asynchronously. +

      + Grant a new permission to a client role on a namespace. +

      + Request parameter example: + + 

      + ["produce", "consume"]
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      role - Client role to which grant permission
      +
      actions - Auth actions (produce and consume)
      +
      +
      +
      • +
    • +
      +

      grantPermissionOnTopicsAsync

      +
      CompletableFuture<Void> grantPermissionOnTopicsAsync(List<GrantTopicPermissionOptions> options)
      +
      Grant permissions on topics asynchronously.
      +
      +
      Parameters:
      +
      options -
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      grantPermissionOnTopics

      +
      void grantPermissionOnTopics(List<GrantTopicPermissionOptions> options) + throws PulsarAdminException
      +
      Grant permissions on topics.
      +
      +
      Parameters:
      +
      options -
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      revokePermissionOnTopicsAsync

      +
      CompletableFuture<Void> revokePermissionOnTopicsAsync(List<RevokeTopicPermissionOptions> options)
      +
      Revoke permissions on topics asynchronously.
      +
      +
      Parameters:
      +
      options -
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      revokePermissionOnTopics

      +
      void revokePermissionOnTopics(List<RevokeTopicPermissionOptions> options) + throws PulsarAdminException
      +
      Revoke permissions on topics.
      +
      +
      Parameters:
      +
      options -
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      revokePermissionsOnNamespace

      +
      void revokePermissionsOnNamespace(String namespace, + String role) + throws PulsarAdminException
      +
      Revoke permissions on a namespace. +

      + Revoke all permissions to a client role on a namespace.

      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      role - Client role to which remove permissions
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      revokePermissionsOnNamespaceAsync

      +
      CompletableFuture<Void> revokePermissionsOnNamespaceAsync(String namespace, + String role)
      +
      Revoke permissions on a namespace asynchronously. +

      + Revoke all permissions to a client role on a namespace.

      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      role - Client role to which remove permissions
      +
      +
      +
      • +
    • +
      +

      getPermissionOnSubscription

      +
      Map<String,Set<String>> getPermissionOnSubscription(String namespace) + throws PulsarAdminException
      +
      Get permission to role to access subscription's admin-api.
      +
      +
      Parameters:
      +
      namespace -
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getPermissionOnSubscriptionAsync

      +
      CompletableFuture<Map<String,Set<String>>> getPermissionOnSubscriptionAsync(String namespace)
      +
      Get permission to role to access subscription's admin-api asynchronously.
      +
      +
      Parameters:
      +
      namespace -
      +
      +
      +
      • +
    • +
      +

      grantPermissionOnSubscription

      +
      void grantPermissionOnSubscription(String namespace, + String subscription, + Set<String> roles) + throws PulsarAdminException
      +
      Grant permission to role to access subscription's admin-api.
      +
      +
      Parameters:
      +
      namespace -
      +
      subscription -
      +
      roles -
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      grantPermissionOnSubscriptionAsync

      +
      CompletableFuture<Void> grantPermissionOnSubscriptionAsync(String namespace, + String subscription, + Set<String> roles)
      +
      Grant permission to role to access subscription's admin-api asynchronously.
      +
      +
      Parameters:
      +
      namespace -
      +
      subscription -
      +
      roles -
      +
      +
      +
      • +
    • +
      +

      revokePermissionOnSubscription

      +
      void revokePermissionOnSubscription(String namespace, + String subscription, + String role) + throws PulsarAdminException
      +
      Revoke permissions on a subscription's admin-api access.
      +
      +
      Parameters:
      +
      namespace -
      +
      subscription -
      +
      role -
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      revokePermissionOnSubscriptionAsync

      +
      CompletableFuture<Void> revokePermissionOnSubscriptionAsync(String namespace, + String subscription, + String role)
      +
      Revoke permissions on a subscription's admin-api access asynchronously.
      +
      +
      Parameters:
      +
      namespace -
      +
      subscription -
      +
      role -
      +
      +
      +
      • +
    • +
      +

      getNamespaceReplicationClusters

      +
      List<String> getNamespaceReplicationClusters(String namespace) + throws PulsarAdminException
      +
      Get the replication clusters for a namespace. +

      + Response example: + + 

      + ["use", "usw", "usc"]
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException.PreconditionFailedException - Namespace is not global
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getNamespaceReplicationClustersAsync

      +
      CompletableFuture<List<String>> getNamespaceReplicationClustersAsync(String namespace)
      +
      Get the replication clusters for a namespace asynchronously. +

      + Response example: + + 

      + ["use", "usw", "usc"]
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      +
      +
      • +
    • +
      +

      setNamespaceReplicationClusters

      +
      void setNamespaceReplicationClusters(String namespace, + Set<String> clusterIds) + throws PulsarAdminException
      +
      Set the replication clusters for a namespace. +

      + Request example: + + 

      + ["us-west", "us-east", "us-cent"]
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      clusterIds - Pulsar Cluster Ids
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException.PreconditionFailedException - Namespace is not global
      +
      PulsarAdminException.PreconditionFailedException - Invalid cluster ids
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      setNamespaceReplicationClustersAsync

      +
      CompletableFuture<Void> setNamespaceReplicationClustersAsync(String namespace, + Set<String> clusterIds)
      +
      Set the replication clusters for a namespace asynchronously. +

      + Request example: + + 

      + ["us-west", "us-east", "us-cent"]
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      clusterIds - Pulsar Cluster Ids
      +
      +
      +
      • +
    • +
      +

      getNamespaceMessageTTL

      +
      Integer getNamespaceMessageTTL(String namespace) + throws PulsarAdminException
      +
      Get the message TTL for a namespace. +

      + Response example: + + 

      + 60
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getNamespaceMessageTTLAsync

      +
      CompletableFuture<Integer> getNamespaceMessageTTLAsync(String namespace)
      +
      Get the message TTL for a namespace asynchronously. +

      + Response example: + + 

      + 60
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      +
      +
      • +
    • +
      +

      setNamespaceMessageTTL

      +
      void setNamespaceMessageTTL(String namespace, + int ttlInSeconds) + throws PulsarAdminException
      +
      Set the messages Time to Live for all the topics within a namespace. +

      + Request example: + + 

      + 60
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      ttlInSeconds - TTL values for all messages for all topics in this namespace
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      setNamespaceMessageTTLAsync

      +
      CompletableFuture<Void> setNamespaceMessageTTLAsync(String namespace, + int ttlInSeconds)
      +
      Set the messages Time to Live for all the topics within a namespace asynchronously. +

      + Request example: + + 

      + 60
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      ttlInSeconds - TTL values for all messages for all topics in this namespace
      +
      +
      +
      • +
    • +
      +

      removeNamespaceMessageTTL

      +
      void removeNamespaceMessageTTL(String namespace) + throws PulsarAdminException
      +
      Remove the messages Time to Live for all the topics within a namespace.
      +
      +
      Parameters:
      +
      namespace -
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      removeNamespaceMessageTTLAsync

      +
      CompletableFuture<Void> removeNamespaceMessageTTLAsync(String namespace)
      +
      Remove the messages Time to Live for all the topics within a namespace asynchronously.
      +
      +
      Parameters:
      +
      namespace -
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      getSubscriptionExpirationTime

      +
      Integer getSubscriptionExpirationTime(String namespace) + throws PulsarAdminException
      +
      Get the subscription expiration time for a namespace. +

      + Response example: + + 

      + 1440
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getSubscriptionExpirationTimeAsync

      +
      CompletableFuture<Integer> getSubscriptionExpirationTimeAsync(String namespace)
      +
      Get the subscription expiration time for a namespace asynchronously. +

      + Response example: + + 

      + 1440
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      +
      +
      • +
    • +
      +

      setSubscriptionExpirationTime

      +
      void setSubscriptionExpirationTime(String namespace, + int expirationTime) + throws PulsarAdminException
      +
      Set the subscription expiration time in minutes for all the topics within a namespace. +

      + Request example: + + 

      + 1440
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      expirationTime - Expiration time values for all subscriptions for all topics in this namespace
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      setSubscriptionExpirationTimeAsync

      +
      CompletableFuture<Void> setSubscriptionExpirationTimeAsync(String namespace, + int expirationTime)
      +
      Set the subscription expiration time in minutes for all the topics within a namespace asynchronously. +

      + Request example: + + 

      + 1440
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      expirationTime - Expiration time values for all subscriptions for all topics in this namespace
      +
      +
      +
      • +
    • +
      +

      removeSubscriptionExpirationTime

      +
      void removeSubscriptionExpirationTime(String namespace) + throws PulsarAdminException
      +
      Remove the subscription expiration time for a namespace.
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      removeSubscriptionExpirationTimeAsync

      +
      CompletableFuture<Void> removeSubscriptionExpirationTimeAsync(String namespace)
      +
      Remove the subscription expiration time for a namespace asynchronously.
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      +
      +
      • +
    • +
      +

      setNamespaceAntiAffinityGroup

      +
      void setNamespaceAntiAffinityGroup(String namespace, + String namespaceAntiAffinityGroup) + throws PulsarAdminException
      +
      Set anti-affinity group name for a namespace. +

      + Request example:

      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      namespaceAntiAffinityGroup - anti-affinity group name for a namespace
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      setNamespaceAntiAffinityGroupAsync

      +
      CompletableFuture<Void> setNamespaceAntiAffinityGroupAsync(String namespace, + String namespaceAntiAffinityGroup)
      +
      Set anti-affinity group name for a namespace asynchronously. +

      + Request example:

      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      namespaceAntiAffinityGroup - anti-affinity group name for a namespace
      +
      +
      +
      • +
    • +
      +

      getAntiAffinityNamespaces

      +
      List<String> getAntiAffinityNamespaces(String tenant, + String cluster, + String namespaceAntiAffinityGroup) + throws PulsarAdminException
      +
      Get all namespaces that grouped with given anti-affinity group.
      +
      +
      Parameters:
      +
      tenant - tenant is only used for authorization. Client has to be admin of any of the tenant to access this + api api.
      +
      cluster - cluster name
      +
      namespaceAntiAffinityGroup - Anti-affinity group name
      +
      Returns:
      +
      list of namespace grouped under a given anti-affinity group
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getAntiAffinityNamespacesAsync

      +
      CompletableFuture<List<String>> getAntiAffinityNamespacesAsync(String tenant, + String cluster, + String namespaceAntiAffinityGroup)
      +
      Get all namespaces that grouped with given anti-affinity group asynchronously.
      +
      +
      Parameters:
      +
      tenant - tenant is only used for authorization. Client has to be admin of any of the tenant to access this + api api.
      +
      cluster - cluster name
      +
      namespaceAntiAffinityGroup - Anti-affinity group name
      +
      Returns:
      +
      list of namespace grouped under a given anti-affinity group
      +
      +
      +
      • +
    • +
      +

      getNamespaceAntiAffinityGroup

      +
      String getNamespaceAntiAffinityGroup(String namespace) + throws PulsarAdminException
      +
      Get anti-affinity group name for a namespace. +

      + Response example: + + 

      + 60
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getNamespaceAntiAffinityGroupAsync

      +
      CompletableFuture<String> getNamespaceAntiAffinityGroupAsync(String namespace)
      +
      Get anti-affinity group name for a namespace asynchronously. +

      + Response example: + + 

      + 60
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      +
      +
      • +
    • +
      +

      deleteNamespaceAntiAffinityGroup

      +
      void deleteNamespaceAntiAffinityGroup(String namespace) + throws PulsarAdminException
      +
      Delete anti-affinity group name for a namespace.
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - You don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      deleteNamespaceAntiAffinityGroupAsync

      +
      CompletableFuture<Void> deleteNamespaceAntiAffinityGroupAsync(String namespace)
      +
      Delete anti-affinity group name for a namespace.
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      +
      +
      • +
    • +
      +

      removeDeduplicationStatus

      +
      void removeDeduplicationStatus(String namespace) + throws PulsarAdminException
      +
      Remove the deduplication status for all topics within a namespace.
      +
      +
      Parameters:
      +
      namespace -
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      removeDeduplicationStatusAsync

      +
      CompletableFuture<Void> removeDeduplicationStatusAsync(String namespace)
      +
      Get the deduplication status for all topics within a namespace asynchronously.
      +
      +
      Parameters:
      +
      namespace -
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      getDeduplicationStatus

      +
      Boolean getDeduplicationStatus(String namespace) + throws PulsarAdminException
      +
      Get the deduplication status for all topics within a namespace .
      +
      +
      Parameters:
      +
      namespace -
      +
      Returns:
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getDeduplicationStatusAsync

      +
      CompletableFuture<Boolean> getDeduplicationStatusAsync(String namespace)
      +
      Get the deduplication status for all topics within a namespace asynchronously.
      +
      +
      Parameters:
      +
      namespace -
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      setDeduplicationStatus

      +
      void setDeduplicationStatus(String namespace, + boolean enableDeduplication) + throws PulsarAdminException
      +
      Set the deduplication status for all topics within a namespace. +

      + When deduplication is enabled, the broker will prevent to store the same message multiple times. +

      + Request example: + + 

      + true
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      enableDeduplication - wether to enable or disable deduplication feature
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      setDeduplicationStatusAsync

      +
      CompletableFuture<Void> setDeduplicationStatusAsync(String namespace, + boolean enableDeduplication)
      +
      Set the deduplication status for all topics within a namespace asynchronously. +

      + When deduplication is enabled, the broker will prevent to store the same message multiple times. +

      + Request example: + + 

      + true
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      enableDeduplication - whether to enable or disable deduplication feature
      +
      +
      +
      • +
    • +
      +

      setAutoTopicCreation

      +
      void setAutoTopicCreation(String namespace, + AutoTopicCreationOverride autoTopicCreationOverride) + throws PulsarAdminException
      +
      Sets the autoTopicCreation policy for a given namespace, overriding broker settings. +

      + When autoTopicCreationOverride is enabled, new topics will be created upon connection, + regardless of the broker level configuration. +

      + Request example: + + 

      + 
+  {
+      "allowAutoTopicCreation" : true,
+      "topicType" : "partitioned",
+      "defaultNumPartitions": 2
+  }
+ 
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      autoTopicCreationOverride - Override policies for auto topic creation
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      setAutoTopicCreationAsync

      +
      CompletableFuture<Void> setAutoTopicCreationAsync(String namespace, + AutoTopicCreationOverride autoTopicCreationOverride)
      +
      Sets the autoTopicCreation policy for a given namespace, overriding broker settings asynchronously. +

      + When autoTopicCreationOverride is enabled, new topics will be created upon connection, + regardless of the broker level configuration. +

      + Request example: + + 

      + 
+  {
+      "allowAutoTopicCreation" : true,
+      "topicType" : "partitioned",
+      "defaultNumPartitions": 2
+  }
+ 
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      autoTopicCreationOverride - Override policies for auto topic creation
      +
      +
      +
      • +
    • +
      +

      getAutoTopicCreation

      +
      AutoTopicCreationOverride getAutoTopicCreation(String namespace) + throws PulsarAdminException
      +
      Get the autoTopicCreation info within a namespace.
      +
      +
      Parameters:
      +
      namespace -
      +
      Returns:
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getAutoTopicCreationAsync

      +
      CompletableFuture<AutoTopicCreationOverride> getAutoTopicCreationAsync(String namespace)
      +
      Get the autoTopicCreation info within a namespace asynchronously.
      +
      +
      Parameters:
      +
      namespace -
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      removeAutoTopicCreation

      +
      void removeAutoTopicCreation(String namespace) + throws PulsarAdminException
      +
      Removes the autoTopicCreation policy for a given namespace. +

      + Allowing the broker to dictate the auto-creation policy. +

      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      removeAutoTopicCreationAsync

      +
      CompletableFuture<Void> removeAutoTopicCreationAsync(String namespace)
      +
      Removes the autoTopicCreation policy for a given namespace asynchronously. +

      + Allowing the broker to dictate the auto-creation policy. +

      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      +
      +
      • +
    • +
      +

      setAutoSubscriptionCreation

      +
      void setAutoSubscriptionCreation(String namespace, + AutoSubscriptionCreationOverride autoSubscriptionCreationOverride) + throws PulsarAdminException
      +
      Sets the autoSubscriptionCreation policy for a given namespace, overriding broker settings. +

      + When autoSubscriptionCreationOverride is enabled, new subscriptions will be created upon connection, + regardless of the broker level configuration. +

      + Request example: + + 

      + 
+  {
+      "allowAutoSubscriptionCreation" : true
+  }
+ 
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      autoSubscriptionCreationOverride - Override policies for auto subscription creation
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      setAutoSubscriptionCreationAsync

      +
      CompletableFuture<Void> setAutoSubscriptionCreationAsync(String namespace, + AutoSubscriptionCreationOverride autoSubscriptionCreationOverride)
      +
      Sets the autoSubscriptionCreation policy for a given namespace, overriding broker settings asynchronously. +

      + When autoSubscriptionCreationOverride is enabled, new subscriptions will be created upon connection, + regardless of the broker level configuration. +

      + Request example: + + 

      + 
+  {
+      "allowAutoSubscriptionCreation" : true
+  }
+ 
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      autoSubscriptionCreationOverride - Override policies for auto subscription creation
      +
      +
      +
      • +
    • +
      +

      getAutoSubscriptionCreation

      +
      AutoSubscriptionCreationOverride getAutoSubscriptionCreation(String namespace) + throws PulsarAdminException
      +
      Get the autoSubscriptionCreation info within a namespace.
      +
      +
      Parameters:
      +
      namespace -
      +
      Returns:
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getAutoSubscriptionCreationAsync

      +
      CompletableFuture<AutoSubscriptionCreationOverride> getAutoSubscriptionCreationAsync(String namespace)
      +
      Get the autoSubscriptionCreation info within a namespace asynchronously.
      +
      +
      Parameters:
      +
      namespace -
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      setSubscriptionTypesEnabled

      +
      void setSubscriptionTypesEnabled(String namespace, + Set<org.apache.pulsar.client.api.SubscriptionType> subscriptionTypesEnabled) + throws PulsarAdminException
      +
      Sets the subscriptionTypesEnabled policy for a given namespace, overriding broker settings. + + Request example: + + 
      + 
+  {
+      "subscriptionTypesEnabled" : {"Shared", "Failover"}
+  }
+ 
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      subscriptionTypesEnabled - is enable subscription types
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      setSubscriptionTypesEnabledAsync

      +
      CompletableFuture<Void> setSubscriptionTypesEnabledAsync(String namespace, + Set<org.apache.pulsar.client.api.SubscriptionType> subscriptionTypesEnabled)
      +
      Sets the subscriptionTypesEnabled policy for a given namespace, overriding broker settings. + + Request example: + + 
      + 
+  {
+      "subscriptionTypesEnabled" : {"Shared", "Failover"}
+  }
+ 
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      subscriptionTypesEnabled - is enable subscription types
      +
      +
      +
      • +
    • +
      +

      getSubscriptionTypesEnabled

      +
      Set<org.apache.pulsar.client.api.SubscriptionType> getSubscriptionTypesEnabled(String namespace) + throws PulsarAdminException
      +
      Get the subscriptionTypesEnabled policy for a given namespace, overriding broker settings.
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      Returns:
      +
      subscription types Set<org.apache.pulsar.client.api.SubscriptionType> the subscription types
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getSubscriptionTypesEnabledAsync

      +
      CompletableFuture<Set<org.apache.pulsar.client.api.SubscriptionType>> getSubscriptionTypesEnabledAsync(String namespace)
      +
      Get the subscriptionTypesEnabled policy for a given namespace, overriding broker settings.
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      Returns:
      +
      the future of subscription types Set<org.apache.pulsar.client.api.SubscriptionType> the subscription types
      +
      +
      +
      • +
    • +
      +

      removeSubscriptionTypesEnabled

      +
      void removeSubscriptionTypesEnabled(String namespace) + throws PulsarAdminException
      +
      Removes the subscriptionTypesEnabled policy for a given namespace.
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      removeSubscriptionTypesEnabledAsync

      +
      CompletableFuture<Void> removeSubscriptionTypesEnabledAsync(String namespace)
      +
      Removes the subscriptionTypesEnabled policy for a given namespace.
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      removeAutoSubscriptionCreation

      +
      void removeAutoSubscriptionCreation(String namespace) + throws PulsarAdminException
      +
      Removes the autoSubscriptionCreation policy for a given namespace. +

      + Allowing the broker to dictate the subscription auto-creation policy. +

      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      removeAutoSubscriptionCreationAsync

      +
      CompletableFuture<Void> removeAutoSubscriptionCreationAsync(String namespace)
      +
      Removes the autoSubscriptionCreation policy for a given namespace asynchronously. +

      + Allowing the broker to dictate the subscription auto-creation policy. +

      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      +
      +
      • +
    • +
      +

      getBacklogQuotaMap

      +
      Map<BacklogQuota.BacklogQuotaType,BacklogQuota> getBacklogQuotaMap(String namespace) + throws PulsarAdminException
      +
      Get backlog quota map on a namespace. +

      + Get backlog quota map on a namespace. +

      + Response example: + + 

      + 
+  {
+      "namespace_memory" : {
+          "limit" : "134217728",
+          "policy" : "consumer_backlog_eviction"
+      },
+      "destination_storage" : {
+          "limit" : "-1",
+          "policy" : "producer_exception"
+      }
+  }
+ 
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Permission denied
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getBacklogQuotaMapAsync

      +
      CompletableFuture<Map<BacklogQuota.BacklogQuotaType,BacklogQuota>> getBacklogQuotaMapAsync(String namespace)
      +
      Get backlog quota map on a namespace asynchronously. +

      + Get backlog quota map on a namespace. +

      + Response example: + + 

      + 
+  {
+      "namespace_memory" : {
+          "limit" : "134217728",
+          "policy" : "consumer_backlog_eviction"
+      },
+      "destination_storage" : {
+          "limit" : "-1",
+          "policy" : "producer_exception"
+      }
+  }
+ 
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      +
      +
      • +
    • +
      +

      setBacklogQuota

      +
      void setBacklogQuota(String namespace, + BacklogQuota backlogQuota, + BacklogQuota.BacklogQuotaType backlogQuotaType) + throws PulsarAdminException
      +
      Set a backlog quota for all the topics on a namespace. +

      + Set a backlog quota on a namespace. +

      + The backlog quota can be set on this resource: +

      + Request parameter example: + + 

      + 
+ {
+     "limit" : "134217728",
+     "policy" : "consumer_backlog_eviction"
+ }
+ 
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      backlogQuota - the new BacklogQuota
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      setBacklogQuota

      +
      default void setBacklogQuota(String namespace, + BacklogQuota backlogQuota) + throws PulsarAdminException
      +
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      setBacklogQuotaAsync

      +
      CompletableFuture<Void> setBacklogQuotaAsync(String namespace, + BacklogQuota backlogQuota, + BacklogQuota.BacklogQuotaType backlogQuotaType)
      +
      Set a backlog quota for all the topics on a namespace asynchronously. +

      + Set a backlog quota on a namespace. +

      + The backlog quota can be set on this resource: +

      + Request parameter example: + + 

      + 
+ {
+     "limit" : "134217728",
+     "policy" : "consumer_backlog_eviction"
+ }
+ 
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      backlogQuota - the new BacklogQuota
      +
      +
      +
      • +
    • +
      +

      setBacklogQuotaAsync

      +
      default CompletableFuture<Void> setBacklogQuotaAsync(String namespace, + BacklogQuota backlogQuota)
      +
      +
      • +
    • +
      +

      removeBacklogQuota

      +
      void removeBacklogQuota(String namespace, + BacklogQuota.BacklogQuotaType backlogQuotaType) + throws PulsarAdminException
      +
      Remove a backlog quota policy from a namespace. +

      + Remove a backlog quota policy from a namespace. +

      + The backlog retention policy will fall back to the default.

      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      removeBacklogQuota

      +
      default void removeBacklogQuota(String namespace) + throws PulsarAdminException
      +
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      removeBacklogQuotaAsync

      +
      CompletableFuture<Void> removeBacklogQuotaAsync(String namespace, + BacklogQuota.BacklogQuotaType backlogQuotaType)
      +
      Remove a backlog quota policy from a namespace asynchronously. +

      + Remove a backlog quota policy from a namespace. +

      + The backlog retention policy will fall back to the default.

      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      +
      +
      • +
    • +
      +

      removeBacklogQuotaAsync

      +
      default CompletableFuture<Void> removeBacklogQuotaAsync(String namespace)
      +
      +
      • +
    • +
      +

      removePersistence

      +
      void removePersistence(String namespace) + throws PulsarAdminException
      +
      Remove the persistence configuration on a namespace.
      +
      +
      Parameters:
      +
      namespace -
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      removePersistenceAsync

      +
      CompletableFuture<Void> removePersistenceAsync(String namespace)
      +
      Remove the persistence configuration on a namespace asynchronously.
      +
      +
      Parameters:
      +
      namespace -
      +
      +
      +
      • +
    • +
      +

      setPersistence

      +
      void setPersistence(String namespace, + PersistencePolicies persistence) + throws PulsarAdminException
      +
      Set the persistence configuration for all the topics on a namespace. +

      + Set the persistence configuration on a namespace. +

      + Request parameter example: + + 

      + 
+ {
+     "bookkeeperEnsemble" : 3,                 // Number of bookies to use for a topic
+     "bookkeeperWriteQuorum" : 2,              // How many writes to make of each entry
+     "bookkeeperAckQuorum" : 2,                // Number of acks (guaranteed copies) to wait for each entry
+     "managedLedgerMaxMarkDeleteRate" : 10.0,  // Throttling rate of mark-delete operation
+                                               // to avoid high number of updates for each
+                                               // consumer
+ }
+ 
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      persistence - Persistence policies object
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException.ConflictException - Concurrent modification
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      setPersistenceAsync

      +
      CompletableFuture<Void> setPersistenceAsync(String namespace, + PersistencePolicies persistence)
      +
      Set the persistence configuration for all the topics on a namespace asynchronously. +

      + Set the persistence configuration on a namespace. +

      + Request parameter example: + + 

      + 
+ {
+     "bookkeeperEnsemble" : 3,                 // Number of bookies to use for a topic
+     "bookkeeperWriteQuorum" : 2,              // How many writes to make of each entry
+     "bookkeeperAckQuorum" : 2,                // Number of acks (guaranteed copies) to wait for each entry
+     "managedLedgerMaxMarkDeleteRate" : 10.0,  // Throttling rate of mark-delete operation
+                                               // to avoid high number of updates for each
+                                               // consumer
+ }
+ 
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      persistence - Persistence policies object
      +
      +
      +
      • +
    • +
      +

      getPersistence

      +
      PersistencePolicies getPersistence(String namespace) + throws PulsarAdminException
      +
      Get the persistence configuration for a namespace. +

      + Get the persistence configuration for a namespace. +

      + Response example: + + 

      + 
+ {
+     "bookkeeperEnsemble" : 3,                 // Number of bookies to use for a topic
+     "bookkeeperWriteQuorum" : 2,              // How many writes to make of each entry
+     "bookkeeperAckQuorum" : 2,                // Number of acks (guaranteed copies) to wait for each entry
+     "managedLedgerMaxMarkDeleteRate" : 10.0,  // Throttling rate of mark-delete operation
+                                               // to avoid high number of updates for each
+                                               // consumer
+ }
+ 
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException.ConflictException - Concurrent modification
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getPersistenceAsync

      +
      CompletableFuture<PersistencePolicies> getPersistenceAsync(String namespace)
      +
      Get the persistence configuration for a namespace asynchronously. +

      + Get the persistence configuration for a namespace. +

      + Response example: + + 

      + 
+ {
+     "bookkeeperEnsemble" : 3,                 // Number of bookies to use for a topic
+     "bookkeeperWriteQuorum" : 2,              // How many writes to make of each entry
+     "bookkeeperAckQuorum" : 2,                // Number of acks (guaranteed copies) to wait for each entry
+     "managedLedgerMaxMarkDeleteRate" : 10.0,  // Throttling rate of mark-delete operation
+                                               // to avoid high number of updates for each
+                                               // consumer
+ }
+ 
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      +
      +
      • +
    • +
      +

      setBookieAffinityGroup

      +
      void setBookieAffinityGroup(String namespace, + BookieAffinityGroupData bookieAffinityGroup) + throws PulsarAdminException
      +
      Set bookie affinity group for a namespace to isolate namespace write to bookies that are part of given affinity + group.
      +
      +
      Parameters:
      +
      namespace - namespace name
      +
      bookieAffinityGroup - bookie affinity group
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      setBookieAffinityGroupAsync

      +
      CompletableFuture<Void> setBookieAffinityGroupAsync(String namespace, + BookieAffinityGroupData bookieAffinityGroup)
      +
      Set bookie affinity group for a namespace to isolate namespace write to bookies that are part of given affinity + group asynchronously.
      +
      +
      Parameters:
      +
      namespace - namespace name
      +
      bookieAffinityGroup - bookie affinity group
      +
      +
      +
      • +
    • +
      +

      deleteBookieAffinityGroup

      +
      void deleteBookieAffinityGroup(String namespace) + throws PulsarAdminException
      +
      Delete bookie affinity group configured for a namespace.
      +
      +
      Parameters:
      +
      namespace -
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      deleteBookieAffinityGroupAsync

      +
      CompletableFuture<Void> deleteBookieAffinityGroupAsync(String namespace)
      +
      Delete bookie affinity group configured for a namespace asynchronously.
      +
      +
      Parameters:
      +
      namespace -
      +
      +
      +
      • +
    • +
      +

      getBookieAffinityGroup

      +
      BookieAffinityGroupData getBookieAffinityGroup(String namespace) + throws PulsarAdminException
      +
      Get bookie affinity group configured for a namespace.
      +
      +
      Parameters:
      +
      namespace -
      +
      Returns:
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getBookieAffinityGroupAsync

      +
      CompletableFuture<BookieAffinityGroupData> getBookieAffinityGroupAsync(String namespace)
      +
      Get bookie affinity group configured for a namespace asynchronously.
      +
      +
      Parameters:
      +
      namespace -
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      setRetention

      +
      void setRetention(String namespace, + RetentionPolicies retention) + throws PulsarAdminException
      +
      Set the retention configuration for all the topics on a namespace. +

      + Set the retention configuration on a namespace. This operation requires Pulsar super-user access. +

      + Request parameter example: +

      + + 

      + 
+ {
+     "retentionTimeInMinutes" : 60,            // how long to retain messages
+     "retentionSizeInMB" : 1024,              // retention backlog limit
+ }
+ 
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException.ConflictException - Concurrent modification
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      setRetentionAsync

      +
      CompletableFuture<Void> setRetentionAsync(String namespace, + RetentionPolicies retention)
      +
      Set the retention configuration for all the topics on a namespace asynchronously. +

      + Set the retention configuration on a namespace. This operation requires Pulsar super-user access. +

      + Request parameter example: +

      + + 

      + 
+ {
+     "retentionTimeInMinutes" : 60,            // how long to retain messages
+     "retentionSizeInMB" : 1024,              // retention backlog limit
+ }
+ 
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      +
      +
      • +
    • +
      +

      removeRetention

      +
      void removeRetention(String namespace) + throws PulsarAdminException
      +
      Remove the retention configuration for all the topics on a namespace.
      +
      +
      Parameters:
      +
      namespace -
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      removeRetentionAsync

      +
      CompletableFuture<Void> removeRetentionAsync(String namespace)
      +
      Remove the retention configuration for all the topics on a namespace asynchronously.
      +
      +
      Parameters:
      +
      namespace -
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      getRetention

      +
      RetentionPolicies getRetention(String namespace) + throws PulsarAdminException
      +
      Get the retention configuration for a namespace. +

      + Get the retention configuration for a namespace. +

      + Response example: +

      + + 

      + 
+ {
+     "retentionTimeInMinutes" : 60,            // how long to retain messages
+     "retentionSizeInMB" : 1024,              // retention backlog limit
+ }
+ 
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException.ConflictException - Concurrent modification
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getRetentionAsync

      +
      CompletableFuture<RetentionPolicies> getRetentionAsync(String namespace)
      +
      Get the retention configuration for a namespace asynchronously. +

      + Get the retention configuration for a namespace. +

      + Response example: +

      + + 

      + 
+ {
+     "retentionTimeInMinutes" : 60,            // how long to retain messages
+     "retentionSizeInMB" : 1024,              // retention backlog limit
+ }
+ 
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      +
      +
      • +
    • +
      +

      unload

      +
      void unload(String namespace) + throws PulsarAdminException
      +
      Unload a namespace from the current serving broker.
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException.PreconditionFailedException - Namespace is already unloaded
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      unloadAsync

      +
      CompletableFuture<Void> unloadAsync(String namespace)
      +
      Unload a namespace from the current serving broker asynchronously.
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      +
      +
      • +
    • +
      +

      getReplicationConfigVersion

      +
      String getReplicationConfigVersion(String namespace) + throws PulsarAdminException
      +
      Get the replication configuration version for a given namespace.
      +
      +
      Parameters:
      +
      namespace -
      +
      Returns:
      +
      Replication configuration version
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getReplicationConfigVersionAsync

      +
      CompletableFuture<String> getReplicationConfigVersionAsync(String namespace)
      +
      Get the replication configuration version for a given namespace asynchronously.
      +
      +
      Parameters:
      +
      namespace -
      +
      Returns:
      +
      Replication configuration version
      +
      +
      +
      • +
    • +
      +

      unloadNamespaceBundle

      +
      void unloadNamespaceBundle(String namespace, + String bundle) + throws PulsarAdminException
      +
      Unload namespace bundle.
      +
      +
      Parameters:
      +
      namespace -
      +
      bundle - range of bundle to unload
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      unloadNamespaceBundle

      +
      void unloadNamespaceBundle(String namespace, + String bundle, + String destinationBroker) + throws PulsarAdminException
      +
      Unload namespace bundle and assign the bundle to specified broker.
      +
      +
      Parameters:
      +
      namespace -
      +
      bundle - range of bundle to unload
      +
      destinationBroker - Target broker url to which the bundle should be assigned to
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      unloadNamespaceBundleAsync

      +
      CompletableFuture<Void> unloadNamespaceBundleAsync(String namespace, + String bundle)
      +
      Unload namespace bundle asynchronously.
      +
      +
      Parameters:
      +
      namespace -
      +
      bundle - range of bundle to unload
      +
      Returns:
      +
      a future that can be used to track when the bundle is unloaded
      +
      +
      +
      • +
    • +
      +

      unloadNamespaceBundleAsync

      +
      CompletableFuture<Void> unloadNamespaceBundleAsync(String namespace, + String bundle, + String destinationBroker)
      +
      Unload namespace bundle asynchronously.
      +
      +
      Parameters:
      +
      namespace -
      +
      bundle - range of bundle to unload
      +
      destinationBroker - Target broker url to which the bundle should be assigned to
      +
      Returns:
      +
      a future that can be used to track when the bundle is unloaded
      +
      +
      +
      • +
    • +
      +

      splitNamespaceBundle

      +
      void splitNamespaceBundle(String namespace, + String bundle, + boolean unloadSplitBundles, + String splitAlgorithmName) + throws PulsarAdminException
      +
      Split namespace bundle.
      +
      +
      Parameters:
      +
      namespace -
      +
      bundle - range of bundle to split
      +
      unloadSplitBundles -
      +
      splitAlgorithmName -
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      splitNamespaceBundleAsync

      +
      CompletableFuture<Void> splitNamespaceBundleAsync(String namespace, + String bundle, + boolean unloadSplitBundles, + String splitAlgorithmName)
      +
      Split namespace bundle asynchronously.
      +
      +
      Parameters:
      +
      namespace -
      +
      bundle - range of bundle to split
      +
      unloadSplitBundles -
      +
      splitAlgorithmName -
      +
      +
      +
      • +
    • +
      +

      splitNamespaceBundle

      +
      void splitNamespaceBundle(String namespace, + String bundle, + boolean unloadSplitBundles, + String splitAlgorithmName, + List<Long> splitBoundaries) + throws PulsarAdminException
      +
      Split namespace bundle.
      +
      +
      Parameters:
      +
      namespace -
      +
      bundle - range of bundle to split
      +
      unloadSplitBundles -
      +
      splitAlgorithmName -
      +
      splitBoundaries -
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      splitNamespaceBundleAsync

      +
      CompletableFuture<Void> splitNamespaceBundleAsync(String namespace, + String bundle, + boolean unloadSplitBundles, + String splitAlgorithmName, + List<Long> splitBoundaries)
      +
      Split namespace bundle asynchronously.
      +
      +
      Parameters:
      +
      namespace -
      +
      bundle - range of bundle to split
      +
      unloadSplitBundles -
      +
      splitAlgorithmName -
      +
      splitBoundaries -
      +
      +
      +
      • +
    • +
      +

      getTopicHashPositions

      +
      TopicHashPositions getTopicHashPositions(String namespace, + String bundle, + List<String> topics) + throws PulsarAdminException
      +
      Get positions for topic list in a bundle.
      +
      +
      Parameters:
      +
      namespace -
      +
      bundle - range of bundle
      +
      topics -
      +
      Returns:
      +
      hash positions for all topics in topicList
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getTopicHashPositionsAsync

      +
      CompletableFuture<TopicHashPositions> getTopicHashPositionsAsync(String namespace, + String bundle, + List<String> topics)
      +
      Get positions for topic list in a bundle.
      +
      +
      Parameters:
      +
      namespace -
      +
      bundle - range of bundle
      +
      topics -
      +
      Returns:
      +
      hash positions for all topics in topicList
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      setPublishRate

      +
      void setPublishRate(String namespace, + PublishRate publishMsgRate) + throws PulsarAdminException
      +
      Set message-publish-rate (topics under this namespace can publish this many messages per second).
      +
      +
      Parameters:
      +
      namespace -
      +
      publishMsgRate - number of messages per second
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      removePublishRate

      +
      void removePublishRate(String namespace) + throws PulsarAdminException
      +
      Remove message-publish-rate (topics under this namespace can publish this many messages per second).
      +
      +
      Parameters:
      +
      namespace -
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      setPublishRateAsync

      +
      CompletableFuture<Void> setPublishRateAsync(String namespace, + PublishRate publishMsgRate)
      +
      Set message-publish-rate (topics under this namespace can publish this many messages per second) asynchronously.
      +
      +
      Parameters:
      +
      namespace -
      +
      publishMsgRate - number of messages per second
      +
      +
      +
      • +
    • +
      +

      removePublishRateAsync

      +
      CompletableFuture<Void> removePublishRateAsync(String namespace)
      +
      Remove message-publish-rate asynchronously. +

      + topics under this namespace can publish this many messages per second

      +
      +
      Parameters:
      +
      namespace -
      +
      +
      +
      • +
    • +
      +

      getPublishRate

      +
      PublishRate getPublishRate(String namespace) + throws PulsarAdminException
      +
      Get message-publish-rate (topics under this namespace can publish this many messages per second).
      +
      +
      Parameters:
      +
      namespace -
      +
      Returns:
      +
      number of messages per second
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getPublishRateAsync

      +
      CompletableFuture<PublishRate> getPublishRateAsync(String namespace)
      +
      Get message-publish-rate (topics under this namespace can publish this many messages per second) asynchronously.
      +
      +
      Parameters:
      +
      namespace -
      +
      Returns:
      +
      number of messages per second
      +
      +
      +
      • +
    • +
      +

      removeDispatchRate

      +
      void removeDispatchRate(String namespace) + throws PulsarAdminException
      +
      Remove message-dispatch-rate.
      +
      +
      Parameters:
      +
      namespace -
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      removeDispatchRateAsync

      +
      CompletableFuture<Void> removeDispatchRateAsync(String namespace)
      +
      Remove message-dispatch-rate asynchronously.
      +
      +
      Parameters:
      +
      namespace -
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      setDispatchRate

      +
      void setDispatchRate(String namespace, + DispatchRate dispatchRate) + throws PulsarAdminException
      +
      Set message-dispatch-rate (topics under this namespace can dispatch this many messages per second).
      +
      +
      Parameters:
      +
      namespace -
      +
      dispatchRate - number of messages per second
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      setDispatchRateAsync

      +
      CompletableFuture<Void> setDispatchRateAsync(String namespace, + DispatchRate dispatchRate)
      +
      Set message-dispatch-rate asynchronously. +

      + topics under this namespace can dispatch this many messages per second

      +
      +
      Parameters:
      +
      namespace -
      +
      dispatchRate - number of messages per second
      +
      +
      +
      • +
    • +
      +

      getDispatchRate

      +
      DispatchRate getDispatchRate(String namespace) + throws PulsarAdminException
      +
      Get message-dispatch-rate (topics under this namespace can dispatch this many messages per second).
      +
      +
      Parameters:
      +
      namespace -
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getDispatchRateAsync

      +
      CompletableFuture<DispatchRate> getDispatchRateAsync(String namespace)
      +
      Get message-dispatch-rate asynchronously. +

      + Topics under this namespace can dispatch this many messages per second.

      +
      +
      Parameters:
      +
      namespace -
      +
      +
      +
      • +
    • +
      +

      setSubscribeRate

      +
      void setSubscribeRate(String namespace, + SubscribeRate subscribeRate) + throws PulsarAdminException
      +
      Set namespace-subscribe-rate (topics under this namespace will limit by subscribeRate).
      +
      +
      Parameters:
      +
      namespace -
      +
      subscribeRate - consumer subscribe limit by this subscribeRate
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      setSubscribeRateAsync

      +
      CompletableFuture<Void> setSubscribeRateAsync(String namespace, + SubscribeRate subscribeRate)
      +
      Set namespace-subscribe-rate (topics under this namespace will limit by subscribeRate) asynchronously.
      +
      +
      Parameters:
      +
      namespace -
      +
      subscribeRate - consumer subscribe limit by this subscribeRate
      +
      +
      +
      • +
    • +
      +

      removeSubscribeRate

      +
      void removeSubscribeRate(String namespace) + throws PulsarAdminException
      +
      Remove namespace-subscribe-rate (topics under this namespace will limit by subscribeRate).
      +
      +
      Parameters:
      +
      namespace -
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      removeSubscribeRateAsync

      +
      CompletableFuture<Void> removeSubscribeRateAsync(String namespace)
      +
      Remove namespace-subscribe-rate (topics under this namespace will limit by subscribeRate) asynchronously.
      +
      +
      Parameters:
      +
      namespace -
      +
      +
      +
      • +
    • +
      +

      getSubscribeRate

      +
      SubscribeRate getSubscribeRate(String namespace) + throws PulsarAdminException
      +
      Get namespace-subscribe-rate (topics under this namespace allow subscribe times per consumer in a period).
      +
      +
      Parameters:
      +
      namespace -
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getSubscribeRateAsync

      +
      CompletableFuture<SubscribeRate> getSubscribeRateAsync(String namespace)
      +
      Get namespace-subscribe-rate asynchronously. +

      + Topics under this namespace allow subscribe times per consumer in a period.

      +
      +
      Parameters:
      +
      namespace -
      +
      +
      +
      • +
    • +
      +

      removeSubscriptionDispatchRate

      +
      void removeSubscriptionDispatchRate(String namespace) + throws PulsarAdminException
      +
      Remove subscription-message-dispatch-rate.
      +
      +
      Parameters:
      +
      namespace -
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      removeSubscriptionDispatchRateAsync

      +
      CompletableFuture<Void> removeSubscriptionDispatchRateAsync(String namespace)
      +
      Remove subscription-message-dispatch-rate asynchronously.
      +
      +
      Parameters:
      +
      namespace -
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      setSubscriptionDispatchRate

      +
      void setSubscriptionDispatchRate(String namespace, + DispatchRate dispatchRate) + throws PulsarAdminException
      +
      Set subscription-message-dispatch-rate. +

      + Subscriptions under this namespace can dispatch this many messages per second

      +
      +
      Parameters:
      +
      namespace -
      +
      dispatchRate - number of messages per second
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      setSubscriptionDispatchRateAsync

      +
      CompletableFuture<Void> setSubscriptionDispatchRateAsync(String namespace, + DispatchRate dispatchRate)
      +
      Set subscription-message-dispatch-rate asynchronously. +

      + Subscriptions under this namespace can dispatch this many messages per second.

      +
      +
      Parameters:
      +
      namespace -
      +
      dispatchRate - number of messages per second
      +
      +
      +
      • +
    • +
      +

      getSubscriptionDispatchRate

      +
      DispatchRate getSubscriptionDispatchRate(String namespace) + throws PulsarAdminException
      +
      Get subscription-message-dispatch-rate. +

      + Subscriptions under this namespace can dispatch this many messages per second.

      +
      +
      Parameters:
      +
      namespace -
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getSubscriptionDispatchRateAsync

      +
      CompletableFuture<DispatchRate> getSubscriptionDispatchRateAsync(String namespace)
      +
      Get subscription-message-dispatch-rate asynchronously. +

      + Subscriptions under this namespace can dispatch this many messages per second.

      +
      +
      Parameters:
      +
      namespace -
      +
      +
      +
      • +
    • +
      +

      setReplicatorDispatchRate

      +
      void setReplicatorDispatchRate(String namespace, + DispatchRate dispatchRate) + throws PulsarAdminException
      +
      Set replicator-message-dispatch-rate. +

      + Replicators under this namespace can dispatch this many messages per second.

      +
      +
      Parameters:
      +
      namespace -
      +
      dispatchRate - number of messages per second
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      setReplicatorDispatchRateAsync

      +
      CompletableFuture<Void> setReplicatorDispatchRateAsync(String namespace, + DispatchRate dispatchRate)
      +
      Set replicator-message-dispatch-rate asynchronously. +

      + Replicators under this namespace can dispatch this many messages per second.

      +
      +
      Parameters:
      +
      namespace -
      +
      dispatchRate - number of messages per second
      +
      +
      +
      • +
    • +
      +

      removeReplicatorDispatchRate

      +
      void removeReplicatorDispatchRate(String namespace) + throws PulsarAdminException
      +
      Remove replicator-message-dispatch-rate.
      +
      +
      Parameters:
      +
      namespace -
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      removeReplicatorDispatchRateAsync

      +
      CompletableFuture<Void> removeReplicatorDispatchRateAsync(String namespace)
      +
      Set replicator-message-dispatch-rate asynchronously.
      +
      +
      Parameters:
      +
      namespace -
      +
      +
      +
      • +
    • +
      +

      getReplicatorDispatchRate

      +
      DispatchRate getReplicatorDispatchRate(String namespace) + throws PulsarAdminException
      +
      Get replicator-message-dispatch-rate. +

      + Replicators under this namespace can dispatch this many messages per second.

      +
      +
      Parameters:
      +
      namespace -
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getReplicatorDispatchRateAsync

      +
      CompletableFuture<DispatchRate> getReplicatorDispatchRateAsync(String namespace)
      +
      Get replicator-message-dispatch-rate asynchronously. +

      + Replicators under this namespace can dispatch this many messages per second.

      +
      +
      Parameters:
      +
      namespace -
      +
      +
      +
      • +
    • +
      +

      clearNamespaceBacklog

      +
      void clearNamespaceBacklog(String namespace) + throws PulsarAdminException
      +
      Clear backlog for all topics on a namespace.
      +
      +
      Parameters:
      +
      namespace -
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      clearNamespaceBacklogAsync

      +
      CompletableFuture<Void> clearNamespaceBacklogAsync(String namespace)
      +
      Clear backlog for all topics on a namespace asynchronously.
      +
      +
      Parameters:
      +
      namespace -
      +
      +
      +
      • +
    • +
      +

      clearNamespaceBacklogForSubscription

      +
      void clearNamespaceBacklogForSubscription(String namespace, + String subscription) + throws PulsarAdminException
      +
      Clear backlog for a given subscription on all topics on a namespace.
      +
      +
      Parameters:
      +
      namespace -
      +
      subscription -
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      clearNamespaceBacklogForSubscriptionAsync

      +
      CompletableFuture<Void> clearNamespaceBacklogForSubscriptionAsync(String namespace, + String subscription)
      +
      Clear backlog for a given subscription on all topics on a namespace asynchronously.
      +
      +
      Parameters:
      +
      namespace -
      +
      subscription -
      +
      +
      +
      • +
    • +
      +

      clearNamespaceBundleBacklog

      +
      void clearNamespaceBundleBacklog(String namespace, + String bundle) + throws PulsarAdminException
      +
      Clear backlog for all topics on a namespace bundle.
      +
      +
      Parameters:
      +
      namespace -
      +
      bundle -
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      clearNamespaceBundleBacklogAsync

      +
      CompletableFuture<Void> clearNamespaceBundleBacklogAsync(String namespace, + String bundle)
      +
      Clear backlog for all topics on a namespace bundle asynchronously.
      +
      +
      Parameters:
      +
      namespace -
      +
      bundle -
      +
      Returns:
      +
      a future that can be used to track when the bundle is cleared
      +
      +
      +
      • +
    • +
      +

      clearNamespaceBundleBacklogForSubscription

      +
      void clearNamespaceBundleBacklogForSubscription(String namespace, + String bundle, + String subscription) + throws PulsarAdminException
      +
      Clear backlog for a given subscription on all topics on a namespace bundle.
      +
      +
      Parameters:
      +
      namespace -
      +
      bundle -
      +
      subscription -
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      clearNamespaceBundleBacklogForSubscriptionAsync

      +
      CompletableFuture<Void> clearNamespaceBundleBacklogForSubscriptionAsync(String namespace, + String bundle, + String subscription)
      +
      Clear backlog for a given subscription on all topics on a namespace bundle asynchronously.
      +
      +
      Parameters:
      +
      namespace -
      +
      bundle -
      +
      subscription -
      +
      Returns:
      +
      a future that can be used to track when the bundle is cleared
      +
      +
      +
      • +
    • +
      +

      unsubscribeNamespace

      +
      void unsubscribeNamespace(String namespace, + String subscription) + throws PulsarAdminException
      +
      Unsubscribe the given subscription on all topics on a namespace.
      +
      +
      Parameters:
      +
      namespace -
      +
      subscription -
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      unsubscribeNamespaceAsync

      +
      CompletableFuture<Void> unsubscribeNamespaceAsync(String namespace, + String subscription)
      +
      Unsubscribe the given subscription on all topics on a namespace asynchronously.
      +
      +
      Parameters:
      +
      namespace -
      +
      subscription -
      +
      +
      +
      • +
    • +
      +

      unsubscribeNamespaceBundle

      +
      void unsubscribeNamespaceBundle(String namespace, + String bundle, + String subscription) + throws PulsarAdminException
      +
      Unsubscribe the given subscription on all topics on a namespace bundle.
      +
      +
      Parameters:
      +
      namespace -
      +
      bundle -
      +
      subscription -
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      unsubscribeNamespaceBundleAsync

      +
      CompletableFuture<Void> unsubscribeNamespaceBundleAsync(String namespace, + String bundle, + String subscription)
      +
      Unsubscribe the given subscription on all topics on a namespace bundle asynchronously.
      +
      +
      Parameters:
      +
      namespace -
      +
      bundle -
      +
      subscription -
      +
      Returns:
      +
      a future that can be used to track when the subscription is unsubscribed
      +
      +
      +
      • +
    • +
      +

      setEncryptionRequiredStatus

      +
      void setEncryptionRequiredStatus(String namespace, + boolean encryptionRequired) + throws PulsarAdminException
      +
      Set the encryption required status for all topics within a namespace. +

      + When encryption required is true, the broker will prevent to store unencrypted messages. +

      + Request example: + + 

      + true
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      encryptionRequired - whether message encryption is required or not
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getEncryptionRequiredStatus

      +
      Boolean getEncryptionRequiredStatus(String namespace) + throws PulsarAdminException
      +
      Get the encryption required status within a namespace.
      +
      +
      Parameters:
      +
      namespace -
      +
      Returns:
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getEncryptionRequiredStatusAsync

      +
      CompletableFuture<Boolean> getEncryptionRequiredStatusAsync(String namespace)
      +
      Get the encryption required status within a namespace asynchronously.
      +
      +
      Parameters:
      +
      namespace -
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      setEncryptionRequiredStatusAsync

      +
      CompletableFuture<Void> setEncryptionRequiredStatusAsync(String namespace, + boolean encryptionRequired)
      +
      Set the encryption required status for all topics within a namespace asynchronously. +

      + When encryption required is true, the broker will prevent to store unencrypted messages. +

      + Request example: + + 

      + true
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      encryptionRequired - whether message encryption is required or not
      +
      +
      +
      • +
    • +
      +

      getDelayedDelivery

      +
      DelayedDeliveryPolicies getDelayedDelivery(String namespace) + throws PulsarAdminException
      +
      Get the delayed delivery messages for all topics within a namespace. +

      + If disabled, messages will be immediately delivered and there will + be no tracking overhead. +

      + Request example: + + 

      + 
+ {
+     "active" : true,   // Enable or disable delayed delivery for messages on a namespace
+     "tickTime" : 1000, // The tick time for when retrying on delayed delivery messages
+ }
+ 
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      Returns:
      +
      delayedDeliveryPolicies + Whether to enable the delayed delivery for messages.
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getDelayedDeliveryAsync

      +
      CompletableFuture<DelayedDeliveryPolicies> getDelayedDeliveryAsync(String namespace)
      +
      Get the delayed delivery messages for all topics within a namespace asynchronously. +

      + If disabled, messages will be immediately delivered and there will + be no tracking overhead. +

      + Request example: + + 

      + 
+ {
+     "active" : true,   // Enable or disable delayed delivery for messages on a namespace
+     "tickTime" : 1000, // The tick time for when retrying on delayed delivery messages
+ }
+ 
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      Returns:
      +
      delayedDeliveryPolicies + Whether to enable the delayed delivery for messages.
      +
      +
      +
      • +
    • +
      +

      setDelayedDeliveryMessages

      +
      void setDelayedDeliveryMessages(String namespace, + DelayedDeliveryPolicies delayedDeliveryPolicies) + throws PulsarAdminException
      +
      Set the delayed delivery messages for all topics within a namespace. +

      + If disabled, messages will be immediately delivered and there will + be no tracking overhead. +

      + Request example: + + 

      + 
+ {
+     "tickTime" : 1000, // Enable or disable delayed delivery for messages on a namespace
+     "active" : true,   // The tick time for when retrying on delayed delivery messages
+ }
+ 
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      delayedDeliveryPolicies - Whether to enable the delayed delivery for messages.
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      setDelayedDeliveryMessagesAsync

      +
      CompletableFuture<Void> setDelayedDeliveryMessagesAsync(String namespace, + DelayedDeliveryPolicies delayedDeliveryPolicies)
      +
      Set the delayed delivery messages for all topics within a namespace asynchronously. +

      + If disabled, messages will be immediately delivered and there will + be no tracking overhead. +

      + Request example: + + 

      + 
+ {
+     "tickTime" : 1000, // Enable or disable delayed delivery for messages on a namespace
+     "active" : true,   // The tick time for when retrying on delayed delivery messages
+ }
+ 
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      delayedDeliveryPolicies - Whether to enable the delayed delivery for messages.
      +
      +
      +
      • +
    • +
      +

      removeDelayedDeliveryMessages

      +
      void removeDelayedDeliveryMessages(String namespace) + throws PulsarAdminException
      +
      Remove the delayed delivery messages for all topics within a namespace.
      +
      +
      Parameters:
      +
      namespace -
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      removeDelayedDeliveryMessagesAsync

      +
      CompletableFuture<Void> removeDelayedDeliveryMessagesAsync(String namespace)
      +
      Remove the delayed delivery messages for all topics within a namespace asynchronously.
      +
      +
      Parameters:
      +
      namespace -
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      getInactiveTopicPolicies

      +
      InactiveTopicPolicies getInactiveTopicPolicies(String namespace) + throws PulsarAdminException
      +
      Get the inactive deletion strategy for all topics within a namespace synchronously.
      +
      +
      Parameters:
      +
      namespace -
      +
      Returns:
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      removeInactiveTopicPoliciesAsync

      +
      CompletableFuture<Void> removeInactiveTopicPoliciesAsync(String namespace)
      +
      remove InactiveTopicPolicies from a namespace asynchronously.
      +
      +
      Parameters:
      +
      namespace -
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      removeInactiveTopicPolicies

      +
      void removeInactiveTopicPolicies(String namespace) + throws PulsarAdminException
      +
      Remove inactive topic policies from a namespace.
      +
      +
      Parameters:
      +
      namespace -
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getInactiveTopicPoliciesAsync

      +
      CompletableFuture<InactiveTopicPolicies> getInactiveTopicPoliciesAsync(String namespace)
      +
      Get the inactive deletion strategy for all topics within a namespace asynchronously.
      +
      +
      Parameters:
      +
      namespace -
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      setInactiveTopicPolicies

      +
      void setInactiveTopicPolicies(String namespace, + InactiveTopicPolicies inactiveTopicPolicies) + throws PulsarAdminException
      +
      As same as setInactiveTopicPoliciesAsync, but it is synchronous.
      +
      +
      Parameters:
      +
      namespace -
      +
      inactiveTopicPolicies -
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      setInactiveTopicPoliciesAsync

      +
      CompletableFuture<Void> setInactiveTopicPoliciesAsync(String namespace, + InactiveTopicPolicies inactiveTopicPolicies)
      +
      You can set the inactive deletion strategy at the namespace level. + Its priority is higher than the inactive deletion strategy at the broker level. + All topics under this namespace will follow this strategy.
      +
      +
      Parameters:
      +
      namespace -
      +
      inactiveTopicPolicies -
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      setSubscriptionAuthMode

      +
      void setSubscriptionAuthMode(String namespace, + SubscriptionAuthMode subscriptionAuthMode) + throws PulsarAdminException
      +
      Set the given subscription auth mode on all topics on a namespace.
      +
      +
      Parameters:
      +
      namespace -
      +
      subscriptionAuthMode -
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      setSubscriptionAuthModeAsync

      +
      CompletableFuture<Void> setSubscriptionAuthModeAsync(String namespace, + SubscriptionAuthMode subscriptionAuthMode)
      +
      Set the given subscription auth mode on all topics on a namespace asynchronously.
      +
      +
      Parameters:
      +
      namespace -
      +
      subscriptionAuthMode -
      +
      +
      +
      • +
    • +
      +

      getSubscriptionAuthMode

      +
      SubscriptionAuthMode getSubscriptionAuthMode(String namespace) + throws PulsarAdminException
      +
      Get the subscriptionAuthMode within a namespace.
      +
      +
      Parameters:
      +
      namespace -
      +
      Returns:
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getSubscriptionAuthModeAsync

      +
      CompletableFuture<SubscriptionAuthMode> getSubscriptionAuthModeAsync(String namespace)
      +
      Get the subscriptionAuthMode within a namespace asynchronously.
      +
      +
      Parameters:
      +
      namespace -
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      getDeduplicationSnapshotInterval

      +
      Integer getDeduplicationSnapshotInterval(String namespace) + throws PulsarAdminException
      +
      Get the deduplicationSnapshotInterval for a namespace.
      +
      +
      Parameters:
      +
      namespace -
      +
      Returns:
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getDeduplicationSnapshotIntervalAsync

      +
      CompletableFuture<Integer> getDeduplicationSnapshotIntervalAsync(String namespace)
      +
      Get the deduplicationSnapshotInterval for a namespace asynchronously.
      +
      +
      Parameters:
      +
      namespace -
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      setDeduplicationSnapshotInterval

      +
      void setDeduplicationSnapshotInterval(String namespace, + Integer interval) + throws PulsarAdminException
      +
      Set the deduplicationSnapshotInterval for a namespace.
      +
      +
      Parameters:
      +
      namespace -
      +
      interval -
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      setDeduplicationSnapshotIntervalAsync

      +
      CompletableFuture<Void> setDeduplicationSnapshotIntervalAsync(String namespace, + Integer interval)
      +
      Set the deduplicationSnapshotInterval for a namespace asynchronously.
      +
      +
      Parameters:
      +
      namespace -
      +
      interval -
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      removeDeduplicationSnapshotInterval

      +
      void removeDeduplicationSnapshotInterval(String namespace) + throws PulsarAdminException
      +
      Remove the deduplicationSnapshotInterval for a namespace.
      +
      +
      Parameters:
      +
      namespace -
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      removeDeduplicationSnapshotIntervalAsync

      +
      CompletableFuture<Void> removeDeduplicationSnapshotIntervalAsync(String namespace)
      +
      Remove the deduplicationSnapshotInterval for a namespace asynchronously.
      +
      +
      Parameters:
      +
      namespace -
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      getMaxSubscriptionsPerTopic

      +
      Integer getMaxSubscriptionsPerTopic(String namespace) + throws PulsarAdminException
      +
      Get the maxSubscriptionsPerTopic for a namespace.
      +
      +
      Parameters:
      +
      namespace -
      +
      Returns:
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getMaxSubscriptionsPerTopicAsync

      +
      CompletableFuture<Integer> getMaxSubscriptionsPerTopicAsync(String namespace)
      +
      Get the maxSubscriptionsPerTopic for a namespace asynchronously.
      +
      +
      Parameters:
      +
      namespace -
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      setMaxSubscriptionsPerTopic

      +
      void setMaxSubscriptionsPerTopic(String namespace, + int maxSubscriptionsPerTopic) + throws PulsarAdminException
      +
      Set the maxSubscriptionsPerTopic for a namespace.
      +
      +
      Parameters:
      +
      namespace -
      +
      maxSubscriptionsPerTopic -
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      setMaxSubscriptionsPerTopicAsync

      +
      CompletableFuture<Void> setMaxSubscriptionsPerTopicAsync(String namespace, + int maxSubscriptionsPerTopic)
      +
      Set the maxSubscriptionsPerTopic for a namespace asynchronously.
      +
      +
      Parameters:
      +
      namespace -
      +
      maxSubscriptionsPerTopic -
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      removeMaxSubscriptionsPerTopic

      +
      void removeMaxSubscriptionsPerTopic(String namespace) + throws PulsarAdminException
      +
      Remove the maxSubscriptionsPerTopic for a namespace.
      +
      +
      Parameters:
      +
      namespace -
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      removeMaxSubscriptionsPerTopicAsync

      +
      CompletableFuture<Void> removeMaxSubscriptionsPerTopicAsync(String namespace)
      +
      Remove the maxSubscriptionsPerTopic for a namespace asynchronously.
      +
      +
      Parameters:
      +
      namespace -
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      getMaxProducersPerTopic

      +
      Integer getMaxProducersPerTopic(String namespace) + throws PulsarAdminException
      +
      Get the maxProducersPerTopic for a namespace. +

      + Response example: + + 

      + 0
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getMaxProducersPerTopicAsync

      +
      CompletableFuture<Integer> getMaxProducersPerTopicAsync(String namespace)
      +
      Get the maxProducersPerTopic for a namespace asynchronously. +

      + Response example: + + 

      + 0
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      +
      +
      • +
    • +
      +

      setMaxProducersPerTopic

      +
      void setMaxProducersPerTopic(String namespace, + int maxProducersPerTopic) + throws PulsarAdminException
      +
      Set maxProducersPerTopic for a namespace. +

      + Request example: + + 

      + 10
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      maxProducersPerTopic - maxProducersPerTopic value for a namespace
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      setMaxProducersPerTopicAsync

      +
      CompletableFuture<Void> setMaxProducersPerTopicAsync(String namespace, + int maxProducersPerTopic)
      +
      Set maxProducersPerTopic for a namespace asynchronously. +

      + Request example: + + 

      + 10
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      maxProducersPerTopic - maxProducersPerTopic value for a namespace
      +
      +
      +
      • +
    • +
      +

      removeMaxProducersPerTopic

      +
      void removeMaxProducersPerTopic(String namespace) + throws PulsarAdminException
      +
      Remove maxProducersPerTopic for a namespace.
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      removeMaxProducersPerTopicAsync

      +
      CompletableFuture<Void> removeMaxProducersPerTopicAsync(String namespace)
      +
      Set maxProducersPerTopic for a namespace asynchronously.
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      +
      +
      • +
    • +
      +

      getMaxConsumersPerTopic

      +
      Integer getMaxConsumersPerTopic(String namespace) + throws PulsarAdminException
      +
      Get the maxProducersPerTopic for a namespace. +

      + Response example: + + 

      + 0
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getMaxConsumersPerTopicAsync

      +
      CompletableFuture<Integer> getMaxConsumersPerTopicAsync(String namespace)
      +
      Get the maxProducersPerTopic for a namespace asynchronously. +

      + Response example: + + 

      + 0
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      +
      +
      • +
    • +
      +

      setMaxConsumersPerTopic

      +
      void setMaxConsumersPerTopic(String namespace, + int maxConsumersPerTopic) + throws PulsarAdminException
      +
      Set maxConsumersPerTopic for a namespace. +

      + Request example: + + 

      + 10
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      maxConsumersPerTopic - maxConsumersPerTopic value for a namespace
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      setMaxConsumersPerTopicAsync

      +
      CompletableFuture<Void> setMaxConsumersPerTopicAsync(String namespace, + int maxConsumersPerTopic)
      +
      Set maxConsumersPerTopic for a namespace asynchronously. +

      + Request example: + + 

      + 10
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      maxConsumersPerTopic - maxConsumersPerTopic value for a namespace
      +
      +
      +
      • +
    • +
      +

      removeMaxConsumersPerTopic

      +
      void removeMaxConsumersPerTopic(String namespace) + throws PulsarAdminException
      +
      Remove maxConsumersPerTopic for a namespace.
      +
      +
      Parameters:
      +
      namespace -
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      removeMaxConsumersPerTopicAsync

      +
      CompletableFuture<Void> removeMaxConsumersPerTopicAsync(String namespace)
      +
      Remove maxConsumersPerTopic for a namespace asynchronously.
      +
      +
      Parameters:
      +
      namespace -
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      getMaxConsumersPerSubscription

      +
      Integer getMaxConsumersPerSubscription(String namespace) + throws PulsarAdminException
      +
      Get the maxConsumersPerSubscription for a namespace. +

      + Response example: + + 

      + 0
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getMaxConsumersPerSubscriptionAsync

      +
      CompletableFuture<Integer> getMaxConsumersPerSubscriptionAsync(String namespace)
      +
      Get the maxConsumersPerSubscription for a namespace asynchronously. +

      + Response example: + + 

      + 0
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      +
      +
      • +
    • +
      +

      setMaxConsumersPerSubscription

      +
      void setMaxConsumersPerSubscription(String namespace, + int maxConsumersPerSubscription) + throws PulsarAdminException
      +
      Set maxConsumersPerSubscription for a namespace. +

      + Request example: + + 

      + 10
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      maxConsumersPerSubscription - maxConsumersPerSubscription value for a namespace
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      setMaxConsumersPerSubscriptionAsync

      +
      CompletableFuture<Void> setMaxConsumersPerSubscriptionAsync(String namespace, + int maxConsumersPerSubscription)
      +
      Set maxConsumersPerSubscription for a namespace asynchronously. +

      + Request example: + + 

      + 10
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      maxConsumersPerSubscription - maxConsumersPerSubscription value for a namespace
      +
      +
      +
      • +
    • +
      +

      removeMaxConsumersPerSubscription

      +
      void removeMaxConsumersPerSubscription(String namespace) + throws PulsarAdminException
      +
      Remove maxConsumersPerSubscription for a namespace.
      +
      +
      Parameters:
      +
      namespace -
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      removeMaxConsumersPerSubscriptionAsync

      +
      CompletableFuture<Void> removeMaxConsumersPerSubscriptionAsync(String namespace)
      +
      Remove maxConsumersPerSubscription for a namespace asynchronously.
      +
      +
      Parameters:
      +
      namespace -
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      getMaxUnackedMessagesPerConsumer

      +
      Integer getMaxUnackedMessagesPerConsumer(String namespace) + throws PulsarAdminException
      +
      Get the maxUnackedMessagesPerConsumer for a namespace. +

      + Response example: + + 

      + 0
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getMaxUnackedMessagesPerConsumerAsync

      +
      CompletableFuture<Integer> getMaxUnackedMessagesPerConsumerAsync(String namespace)
      +
      Get the maxUnackedMessagesPerConsumer for a namespace asynchronously. +

      + Response example: + + 

      + 0
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      +
      +
      • +
    • +
      +

      setMaxUnackedMessagesPerConsumer

      +
      void setMaxUnackedMessagesPerConsumer(String namespace, + int maxUnackedMessagesPerConsumer) + throws PulsarAdminException
      +
      Set maxUnackedMessagesPerConsumer for a namespace. +

      + Request example: + + 

      + 10
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      maxUnackedMessagesPerConsumer - maxUnackedMessagesPerConsumer value for a namespace
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      setMaxUnackedMessagesPerConsumerAsync

      +
      CompletableFuture<Void> setMaxUnackedMessagesPerConsumerAsync(String namespace, + int maxUnackedMessagesPerConsumer)
      +
      Set maxUnackedMessagesPerConsumer for a namespace asynchronously. +

      + Request example: + + 

      + 10
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      maxUnackedMessagesPerConsumer - maxUnackedMessagesPerConsumer value for a namespace
      +
      +
      +
      • +
    • +
      +

      removeMaxUnackedMessagesPerConsumer

      +
      void removeMaxUnackedMessagesPerConsumer(String namespace) + throws PulsarAdminException
      +
      Remove maxUnackedMessagesPerConsumer for a namespace.
      +
      +
      Parameters:
      +
      namespace -
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      removeMaxUnackedMessagesPerConsumerAsync

      +
      CompletableFuture<Void> removeMaxUnackedMessagesPerConsumerAsync(String namespace)
      +
      Remove maxUnackedMessagesPerConsumer for a namespace asynchronously.
      +
      +
      Parameters:
      +
      namespace -
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      getMaxUnackedMessagesPerSubscription

      +
      Integer getMaxUnackedMessagesPerSubscription(String namespace) + throws PulsarAdminException
      +
      Get the maxUnackedMessagesPerSubscription for a namespace. +

      + Response example: + + 

      + 0
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getMaxUnackedMessagesPerSubscriptionAsync

      +
      CompletableFuture<Integer> getMaxUnackedMessagesPerSubscriptionAsync(String namespace)
      +
      Get the maxUnackedMessagesPerSubscription for a namespace asynchronously. +

      + Response example: + + 

      + 0
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      +
      +
      • +
    • +
      +

      setMaxUnackedMessagesPerSubscription

      +
      void setMaxUnackedMessagesPerSubscription(String namespace, + int maxUnackedMessagesPerSubscription) + throws PulsarAdminException
      +
      Set maxUnackedMessagesPerSubscription for a namespace. +

      + Request example: + + 

      + 10
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      maxUnackedMessagesPerSubscription - Max number of unacknowledged messages allowed per shared subscription.
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      setMaxUnackedMessagesPerSubscriptionAsync

      +
      CompletableFuture<Void> setMaxUnackedMessagesPerSubscriptionAsync(String namespace, + int maxUnackedMessagesPerSubscription)
      +
      Set maxUnackedMessagesPerSubscription for a namespace asynchronously. +

      + Request example: + + 

      + 10
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      maxUnackedMessagesPerSubscription - Max number of unacknowledged messages allowed per shared subscription.
      +
      +
      +
      • +
    • +
      +

      removeMaxUnackedMessagesPerSubscription

      +
      void removeMaxUnackedMessagesPerSubscription(String namespace) + throws PulsarAdminException
      +
      Remove maxUnackedMessagesPerSubscription for a namespace.
      +
      +
      Parameters:
      +
      namespace -
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      removeMaxUnackedMessagesPerSubscriptionAsync

      +
      CompletableFuture<Void> removeMaxUnackedMessagesPerSubscriptionAsync(String namespace)
      +
      Remove maxUnackedMessagesPerSubscription for a namespace asynchronously.
      +
      +
      Parameters:
      +
      namespace -
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      getCompactionThreshold

      +
      Long getCompactionThreshold(String namespace) + throws PulsarAdminException
      +
      Get the compactionThreshold for a namespace. The maximum number of bytes topics in the namespace + can have before compaction is triggered. 0 disables. +

      + Response example: + + 

      + 10000000
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getCompactionThresholdAsync

      +
      CompletableFuture<Long> getCompactionThresholdAsync(String namespace)
      +
      Get the compactionThreshold for a namespace asynchronously. The maximum number of bytes topics in the namespace + can have before compaction is triggered. 0 disables. +

      + Response example: + + 

      + 10000000
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      +
      +
      • +
    • +
      +

      setCompactionThreshold

      +
      void setCompactionThreshold(String namespace, + long compactionThreshold) + throws PulsarAdminException
      +
      Set the compactionThreshold for a namespace. The maximum number of bytes topics in the namespace + can have before compaction is triggered. 0 disables. +

      + Request example: + + 

      + 10000000
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      compactionThreshold - maximum number of backlog bytes before compaction is triggered
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      setCompactionThresholdAsync

      +
      CompletableFuture<Void> setCompactionThresholdAsync(String namespace, + long compactionThreshold)
      +
      Set the compactionThreshold for a namespace asynchronously. The maximum number of bytes topics in the namespace + can have before compaction is triggered. 0 disables. +

      + Request example: + + 

      + 10000000
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      compactionThreshold - maximum number of backlog bytes before compaction is triggered
      +
      +
      +
      • +
    • +
      +

      removeCompactionThreshold

      +
      void removeCompactionThreshold(String namespace) + throws PulsarAdminException
      +
      Delete the compactionThreshold for a namespace.
      +
      +
      Parameters:
      +
      namespace -
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      removeCompactionThresholdAsync

      +
      CompletableFuture<Void> removeCompactionThresholdAsync(String namespace)
      +
      Delete the compactionThreshold for a namespace asynchronously.
      +
      +
      Parameters:
      +
      namespace -
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      getOffloadThreshold

      +
      long getOffloadThreshold(String namespace) + throws PulsarAdminException
      +
      Get the offloadThreshold for a namespace. The maximum number of bytes stored on the pulsar cluster for topics + in the namespace before data starts being offloaded to longterm storage. + +

      + Response example: + + 

      + 10000000
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getOffloadThresholdAsync

      +
      CompletableFuture<Long> getOffloadThresholdAsync(String namespace)
      +
      Get the offloadThreshold for a namespace asynchronously. +

      + The maximum number of bytes stored on the pulsar cluster for topics + in the namespace before data starts being offloaded to longterm storage. + +

      + Response example: + + 

      + 10000000
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      +
      +
      • +
    • +
      +

      getOffloadThresholdInSeconds

      +
      long getOffloadThresholdInSeconds(String namespace) + throws PulsarAdminException
      +
      Get the offloadThresholdInSeconds for a namespace. + +

      + Response example: + + 

      + 10000000
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getOffloadThresholdInSecondsAsync

      +
      CompletableFuture<Long> getOffloadThresholdInSecondsAsync(String namespace)
      +
      Get the offloadThresholdInSeconds for a namespace. + +

      + Response example: + + 

      + 10000000
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      +
      +
      • +
    • +
      +

      setOffloadThreshold

      +
      void setOffloadThreshold(String namespace, + long offloadThreshold) + throws PulsarAdminException
      +
      Set the offloadThreshold for a namespace. +

      + The maximum number of bytes stored on the pulsar cluster for topics + in the namespace before data starts being offloaded to longterm storage. +

      + Negative values disabled automatic offloading. Setting a threshold of 0 will offload data as soon as possible. +

      + Request example: + + 

      + 10000000
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      offloadThreshold - maximum number of bytes stored before offloading is triggered
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      setOffloadThresholdAsync

      +
      CompletableFuture<Void> setOffloadThresholdAsync(String namespace, + long offloadThreshold)
      +
      Set the offloadThreshold for a namespace asynchronously. +

      + The maximum number of bytes stored on the pulsar cluster for topics + in the namespace before data starts being offloaded to longterm storage. +

      + Negative values disabled automatic offloading. Setting a threshold of 0 will offload data as soon as possible. +

      + Request example: + + 

      + 10000000
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      offloadThreshold - maximum number of bytes stored before offloading is triggered
      +
      +
      +
      • +
    • +
      +

      setOffloadThresholdInSeconds

      +
      void setOffloadThresholdInSeconds(String namespace, + long offloadThresholdInSeconds) + throws PulsarAdminException
      +
      Set the offloadThresholdInSeconds for a namespace. +

      + Negative values disabled automatic offloading. Setting a threshold of 0 will offload data as soon as possible. +

      + Request example: + + 

      + 10000000
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      offloadThresholdInSeconds - maximum number of bytes stored before offloading is triggered
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      setOffloadThresholdInSecondsAsync

      +
      CompletableFuture<Void> setOffloadThresholdInSecondsAsync(String namespace, + long offloadThresholdInSeconds)
      +
      Set the offloadThresholdInSeconds for a namespace. +

      + Negative values disabled automatic offloading. Setting a threshold of 0 will offload data as soon as possible. +

      + Request example: + + 

      + 10000000
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      offloadThresholdInSeconds - maximum number of seconds stored before offloading is triggered
      +
      +
      +
      • +
    • +
      +

      getOffloadDeleteLagMs

      +
      Long getOffloadDeleteLagMs(String namespace) + throws PulsarAdminException
      +
      Get the offload deletion lag for a namespace, in milliseconds. + The number of milliseconds to wait before deleting a ledger segment which has been offloaded from + the Pulsar cluster's local storage (i.e. BookKeeper). +

      + If the offload deletion lag has not been set for the namespace, the method returns 'null' + and the namespace will use the configured default of the pulsar broker. +

      + A negative value disables deletion of the local ledger completely, though it will still be deleted + if it exceeds the topics retention policy, along with the offloaded copy. + +

      + Response example: + + 

      + 3600000
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      Returns:
      +
      the offload deletion lag for the namespace in milliseconds, or null if not set
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getOffloadDeleteLagMsAsync

      +
      CompletableFuture<Long> getOffloadDeleteLagMsAsync(String namespace)
      +
      Get the offload deletion lag asynchronously for a namespace, in milliseconds. +

      + The number of milliseconds to wait before deleting a ledger segment which has been offloaded from + the Pulsar cluster's local storage (i.e. BookKeeper). +

      + If the offload deletion lag has not been set for the namespace, the method returns 'null' + and the namespace will use the configured default of the pulsar broker. +

      + A negative value disables deletion of the local ledger completely, though it will still be deleted + if it exceeds the topics retention policy, along with the offloaded copy. + +

      + Response example: + + 

      + 3600000
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      Returns:
      +
      the offload deletion lag for the namespace in milliseconds, or null if not set
      +
      +
      +
      • +
    • +
      +

      setOffloadDeleteLag

      +
      void setOffloadDeleteLag(String namespace, + long lag, + TimeUnit unit) + throws PulsarAdminException
      +
      Set the offload deletion lag for a namespace. +

      + The offload deletion lag is the amount of time to wait after offloading a ledger segment to long term storage, + before deleting its copy stored on the Pulsar cluster's local storage (i.e. BookKeeper). +

      + A negative value disables deletion of the local ledger completely, though it will still be deleted + if it exceeds the topics retention policy, along with the offloaded copy.

      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      lag - the duration to wait before deleting the local copy
      +
      unit - the timeunit of the duration
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      setOffloadDeleteLagAsync

      +
      CompletableFuture<Void> setOffloadDeleteLagAsync(String namespace, + long lag, + TimeUnit unit)
      +
      Set the offload deletion lag for a namespace asynchronously. +

      + The offload deletion lag is the amount of time to wait after offloading a ledger segment to long term storage, + before deleting its copy stored on the Pulsar cluster's local storage (i.e. BookKeeper). +

      + A negative value disables deletion of the local ledger completely, though it will still be deleted + if it exceeds the topics retention policy, along with the offloaded copy.

      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      lag - the duration to wait before deleting the local copy
      +
      unit - the timeunit of the duration
      +
      +
      +
      • +
    • +
      +

      clearOffloadDeleteLag

      +
      void clearOffloadDeleteLag(String namespace) + throws PulsarAdminException
      +
      Clear the offload deletion lag for a namespace. +

      + The namespace will fall back to using the configured default of the pulsar broker.

      +
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      clearOffloadDeleteLagAsync

      +
      CompletableFuture<Void> clearOffloadDeleteLagAsync(String namespace)
      +
      Clear the offload deletion lag for a namespace asynchronously. +

      + The namespace will fall back to using the configured default of the pulsar broker.

      +
      +
      • +
    • +
      +

      getSchemaAutoUpdateCompatibilityStrategy

      +
      @Deprecated +SchemaAutoUpdateCompatibilityStrategy getSchemaAutoUpdateCompatibilityStrategy(String namespace) + throws PulsarAdminException
      +
      Deprecated.
      +
      Get the strategy used to check the a new schema provided by a producer is compatible with the current schema + before it is installed. +

      + If this is + SchemaAutoUpdateCompatibilityStrategy.AutoUpdateDisabled, + then all new schemas provided via the producer are rejected, and schemas must be updated through the REST api.

      +
      +
      Parameters:
      +
      namespace - The namespace in whose policy we are interested
      +
      Returns:
      +
      the strategy used to check compatibility
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      setSchemaAutoUpdateCompatibilityStrategy

      +
      @Deprecated +void setSchemaAutoUpdateCompatibilityStrategy(String namespace, + SchemaAutoUpdateCompatibilityStrategy strategy) + throws PulsarAdminException
      +
      Deprecated.
      +
      Set the strategy used to check the a new schema provided by a producer is compatible with the current schema + before it is installed. +

      + To disable all new schema updates through the producer, set this to + SchemaAutoUpdateCompatibilityStrategy.AutoUpdateDisabled.

      +
      +
      Parameters:
      +
      namespace - The namespace in whose policy should be set
      +
      strategy -
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getSchemaValidationEnforced

      +
      boolean getSchemaValidationEnforced(String namespace) + throws PulsarAdminException
      +
      Get schema validation enforced for namespace.
      +
      +
      Parameters:
      +
      namespace - namespace for this command.
      +
      Returns:
      +
      the schema validation enforced flag
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Tenant or Namespace does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getSchemaValidationEnforcedAsync

      +
      CompletableFuture<Boolean> getSchemaValidationEnforcedAsync(String namespace)
      +
      Get schema validation enforced for namespace asynchronously.
      +
      +
      Parameters:
      +
      namespace - namespace for this command.
      +
      Returns:
      +
      the schema validation enforced flag
      +
      +
      +
      • +
    • +
      +

      getSchemaValidationEnforced

      +
      boolean getSchemaValidationEnforced(String namespace, + boolean applied) + throws PulsarAdminException
      +
      Get schema validation enforced for namespace.
      +
      +
      Parameters:
      +
      namespace - namespace for this command.
      +
      applied - applied for this command.
      +
      Returns:
      +
      the schema validation enforced flag
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Tenant or Namespace does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getSchemaValidationEnforcedAsync

      +
      CompletableFuture<Boolean> getSchemaValidationEnforcedAsync(String namespace, + boolean applied)
      +
      Get schema validation enforced for namespace asynchronously.
      +
      +
      Parameters:
      +
      namespace - namespace for this command.
      +
      applied - applied for this command.
      +
      Returns:
      +
      the schema validation enforced flag
      +
      +
      +
      • +
    • +
      +

      setSchemaValidationEnforced

      +
      void setSchemaValidationEnforced(String namespace, + boolean schemaValidationEnforced) + throws PulsarAdminException
      +
      Set schema validation enforced for namespace. + if a producer without a schema attempts to produce to a topic with schema in this the namespace, the + producer will be failed to connect. PLEASE be carefully on using this, since non-java clients don't + support schema. if you enable this setting, it will cause non-java clients failed to produce.
      +
      +
      Parameters:
      +
      namespace - pulsar namespace name
      +
      schemaValidationEnforced - flag to enable or disable schema validation for the given namespace
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Tenant or Namespace does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      setSchemaValidationEnforcedAsync

      +
      CompletableFuture<Void> setSchemaValidationEnforcedAsync(String namespace, + boolean schemaValidationEnforced)
      +
      Set schema validation enforced for namespace asynchronously. + if a producer without a schema attempts to produce to a topic with schema in this the namespace, the + producer will be failed to connect. PLEASE be carefully on using this, since non-java clients don't + support schema. if you enable this setting, it will cause non-java clients failed to produce.
      +
      +
      Parameters:
      +
      namespace - pulsar namespace name
      +
      schemaValidationEnforced - flag to enable or disable schema validation for the given namespace
      +
      +
      +
      • +
    • +
      +

      getSchemaCompatibilityStrategy

      +
      SchemaCompatibilityStrategy getSchemaCompatibilityStrategy(String namespace) + throws PulsarAdminException
      +
      Get the strategy used to check the a new schema provided by a producer is compatible with the current schema + before it is installed.
      +
      +
      Parameters:
      +
      namespace - The namespace in whose policy we are interested
      +
      Returns:
      +
      the strategy used to check compatibility
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getSchemaCompatibilityStrategyAsync

      +
      CompletableFuture<SchemaCompatibilityStrategy> getSchemaCompatibilityStrategyAsync(String namespace)
      +
      Get the strategy used to check the a new schema provided by a producer is compatible with the current schema + before it is installed asynchronously.
      +
      +
      Parameters:
      +
      namespace - The namespace in whose policy we are interested
      +
      Returns:
      +
      the strategy used to check compatibility
      +
      +
      +
      • +
    • +
      +

      setSchemaCompatibilityStrategy

      +
      void setSchemaCompatibilityStrategy(String namespace, + SchemaCompatibilityStrategy strategy) + throws PulsarAdminException
      +
      Set the strategy used to check the a new schema provided by a producer is compatible with the current schema + before it is installed.
      +
      +
      Parameters:
      +
      namespace - The namespace in whose policy should be set
      +
      strategy - The schema compatibility strategy
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      setSchemaCompatibilityStrategyAsync

      +
      CompletableFuture<Void> setSchemaCompatibilityStrategyAsync(String namespace, + SchemaCompatibilityStrategy strategy)
      +
      Set the strategy used to check the a new schema provided by a producer is compatible with the current schema + before it is installed asynchronously.
      +
      +
      Parameters:
      +
      namespace - The namespace in whose policy should be set
      +
      strategy - The schema compatibility strategy
      +
      +
      +
      • +
    • +
      +

      getIsAllowAutoUpdateSchema

      +
      boolean getIsAllowAutoUpdateSchema(String namespace) + throws PulsarAdminException
      +
      Get whether allow auto update schema.
      +
      +
      Parameters:
      +
      namespace - pulsar namespace name
      +
      Returns:
      +
      the schema validation enforced flag
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Tenant or Namespace does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getIsAllowAutoUpdateSchemaAsync

      +
      CompletableFuture<Boolean> getIsAllowAutoUpdateSchemaAsync(String namespace)
      +
      Get whether allow auto update schema asynchronously.
      +
      +
      Parameters:
      +
      namespace - pulsar namespace name
      +
      Returns:
      +
      the schema validation enforced flag
      +
      +
      +
      • +
    • +
      +

      setIsAllowAutoUpdateSchema

      +
      void setIsAllowAutoUpdateSchema(String namespace, + boolean isAllowAutoUpdateSchema) + throws PulsarAdminException
      +
      Set whether to allow automatic schema updates. +

      + The flag is when producer bring a new schema and the schema pass compatibility check + whether allow schema auto registered

      +
      +
      Parameters:
      +
      namespace - pulsar namespace name
      +
      isAllowAutoUpdateSchema - flag to enable or disable auto update schema
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Tenant or Namespace does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      setIsAllowAutoUpdateSchemaAsync

      +
      CompletableFuture<Void> setIsAllowAutoUpdateSchemaAsync(String namespace, + boolean isAllowAutoUpdateSchema)
      +
      Set whether to allow automatic schema updates asynchronously. +

      + The flag is when producer bring a new schema and the schema pass compatibility check + whether allow schema auto registered

      +
      +
      Parameters:
      +
      namespace - pulsar namespace name
      +
      isAllowAutoUpdateSchema - flag to enable or disable auto update schema
      +
      +
      +
      • +
    • +
      +

      setOffloadPolicies

      +
      void setOffloadPolicies(String namespace, + OffloadPolicies offloadPolicies) + throws PulsarAdminException
      +
      Set the offload configuration for all the topics in a namespace. +

      + Set the offload configuration in a namespace. This operation requires pulsar tenant access. +

      + Request parameter example: +

      + + 

      + 
+ {
+     "region" : "us-east-2",                   // The long term storage region
+     "bucket" : "bucket",                      // Bucket to place offloaded ledger into
+     "endpoint" : "endpoint",                  // Alternative endpoint to connect to
+     "maxBlockSize" : 1024,                    // Max Block Size, default 64MB
+     "readBufferSize" : 1024,                  // Read Buffer Size, default 1MB
+ }
+ 
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      offloadPolicies - Offload configuration
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException.ConflictException - Concurrent modification
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      removeOffloadPolicies

      +
      void removeOffloadPolicies(String namespace) + throws PulsarAdminException
      +
      Remove the offload configuration for a namespace. +

      + Remove the offload configuration in a namespace. This operation requires pulsar tenant access. +

      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException.ConflictException - Concurrent modification
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      setOffloadPoliciesAsync

      +
      CompletableFuture<Void> setOffloadPoliciesAsync(String namespace, + OffloadPolicies offloadPolicies)
      +
      Set the offload configuration for all the topics in a namespace asynchronously. +

      + Set the offload configuration in a namespace. This operation requires pulsar tenant access. +

      + Request parameter example: +

      + + 

      + 
+ {
+     "region" : "us-east-2",                   // The long term storage region
+     "bucket" : "bucket",                      // Bucket to place offloaded ledger into
+     "endpoint" : "endpoint",                  // Alternative endpoint to connect to
+     "maxBlockSize" : 1024,                    // Max Block Size, default 64MB
+     "readBufferSize" : 1024,                  // Read Buffer Size, default 1MB
+ }
+ 
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      offloadPolicies - Offload configuration
      +
      +
      +
      • +
    • +
      +

      removeOffloadPoliciesAsync

      +
      CompletableFuture<Void> removeOffloadPoliciesAsync(String namespace)
      +
      Remove the offload configuration for a namespace asynchronously. +

      + Remove the offload configuration in a namespace. This operation requires pulsar tenant access. +

      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException.ConflictException - Concurrent modification
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getOffloadPolicies

      +
      OffloadPolicies getOffloadPolicies(String namespace) + throws PulsarAdminException
      +
      Get the offload configuration for a namespace. +

      + Get the offload configuration for a namespace. +

      + Response example: +

      + + 

      + 
+ {
+     "region" : "us-east-2",                   // The long term storage region
+     "bucket" : "bucket",                      // Bucket to place offloaded ledger into
+     "endpoint" : "endpoint",                  // Alternative endpoint to connect to
+     "maxBlockSize" : 1024,                    // Max Block Size, default 64MB
+     "readBufferSize" : 1024,                  // Read Buffer Size, default 1MB
+ }
+ 
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException.ConflictException - Concurrent modification
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getOffloadPoliciesAsync

      +
      CompletableFuture<OffloadPolicies> getOffloadPoliciesAsync(String namespace)
      +
      Get the offload configuration for a namespace asynchronously. +

      + Get the offload configuration for a namespace. +

      + Response example: +

      + + 

      + 
+ {
+     "region" : "us-east-2",                   // The long term storage region
+     "bucket" : "bucket",                      // Bucket to place offloaded ledger into
+     "endpoint" : "endpoint",                  // Alternative endpoint to connect to
+     "maxBlockSize" : 1024,                    // Max Block Size, default 64MB
+     "readBufferSize" : 1024,                  // Read Buffer Size, default 1MB
+ }
+ 
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      +
      +
      • +
    • +
      +

      getMaxTopicsPerNamespace

      +
      int getMaxTopicsPerNamespace(String namespace) + throws PulsarAdminException
      +
      Get maxTopicsPerNamespace for a namespace. +

      + Response example: + + 

      +     0
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      Returns:
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace dost not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getMaxTopicsPerNamespaceAsync

      +
      CompletableFuture<Integer> getMaxTopicsPerNamespaceAsync(String namespace)
      +
      Get maxTopicsPerNamespace for a namespace asynchronously. +

      + Response example: + + 

      +     0
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      setMaxTopicsPerNamespace

      +
      void setMaxTopicsPerNamespace(String namespace, + int maxTopicsPerNamespace) + throws PulsarAdminException
      +
      Set maxTopicsPerNamespace for a namespace. +

      + Request example: + + 

      +     100
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      maxTopicsPerNamespace - maxTopicsPerNamespace value for a namespace
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      setMaxTopicsPerNamespaceAsync

      +
      CompletableFuture<Void> setMaxTopicsPerNamespaceAsync(String namespace, + int maxTopicsPerNamespace)
      +
      Set maxTopicsPerNamespace for a namespace asynchronously. +

      + Request example: + + 

      +     100
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      maxTopicsPerNamespace - maxTopicsPerNamespace value for a namespace
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      removeMaxTopicsPerNamespace

      +
      void removeMaxTopicsPerNamespace(String namespace) + throws PulsarAdminException
      +
      remove maxTopicsPerNamespace for a namespace.
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      removeMaxTopicsPerNamespaceAsync

      +
      CompletableFuture<Void> removeMaxTopicsPerNamespaceAsync(String namespace)
      +
      remove maxTopicsPerNamespace for a namespace asynchronously.
      +
      +
      Parameters:
      +
      namespace - Namespace name + @throws NotAuthorizedException + Don't have admin permission
      +
      Throws:
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      setPropertyAsync

      +
      CompletableFuture<Void> setPropertyAsync(String namespace, + String key, + String value)
      +
      Set key value pair property for a namespace. + If the property absents, a new property will added. Otherwise, the new value will overwrite. + +

      + Example: + + 

      +     admin.namespaces().setProperty("a", "a");
+     admin.namespaces().setProperty("b", "b");
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      key - key of the property
      +
      value - value of the property
      +
      +
      +
      • +
    • +
      +

      setProperty

      +
      void setProperty(String namespace, + String key, + String value) + throws PulsarAdminException
      +
      Set key value pair property for a namespace. + If the property absents, a new property will added. Otherwise, the new value will overwrite. + +

      + Example: + + 

      +     admin.namespaces().setProperty("a", "a");
+     admin.namespaces().setProperty("b", "b");
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      key - key of the property
      +
      value - value of the property
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      setPropertiesAsync

      +
      CompletableFuture<Void> setPropertiesAsync(String namespace, + Map<String,String> properties)
      +
      Set key value pair properties for a namespace asynchronously. + If the property absents, a new property will added. Otherwise, the new value will overwrite.
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      properties - key value pair properties
      +
      +
      +
      • +
    • +
      +

      setProperties

      +
      void setProperties(String namespace, + Map<String,String> properties) + throws PulsarAdminException
      +
      Set key value pair properties for a namespace. + If the property absents, a new property will added. Otherwise, the new value will overwrite.
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      properties - key value pair properties
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getPropertyAsync

      +
      CompletableFuture<String> getPropertyAsync(String namespace, + String key)
      +
      Get property value for a given key. + If the property absents, will return null. + +

      + Example: + + 

      +     admin.namespaces().getProperty("a");
+     admin.namespaces().getProperty("b");
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      key - key of the property
      +
      Returns:
      +
      value of the property.
      +
      +
      +
      • +
    • +
      +

      getProperty

      +
      String getProperty(String namespace, + String key) + throws PulsarAdminException
      +
      Get property value for a given key. + If the property absents, will return null. + +

      + Example: + + 

      +     admin.namespaces().getProperty("a");
+     admin.namespaces().getProperty("b");
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      key - key of the property
      +
      Returns:
      +
      value of the property.
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getPropertiesAsync

      +
      CompletableFuture<Map<String,String>> getPropertiesAsync(String namespace)
      +
      Get all properties of a namespace asynchronously. + +

      + Example: + + 

      +     admin.namespaces().getPropertiesAsync();
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      Returns:
      +
      key value pair properties.
      +
      +
      +
      • +
    • +
      +

      getProperties

      +
      Map<String,String> getProperties(String namespace) + throws PulsarAdminException
      +
      Get all properties of a namespace. + +

      + Example: + + 

      +     admin.namespaces().getProperties();
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      Returns:
      +
      key value pair properties.
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      removePropertyAsync

      +
      CompletableFuture<String> removePropertyAsync(String namespace, + String key)
      +
      Remove a property for a given key. + Return value of the property if the property exists, otherwise return null. + +

      + Example: + + 

      +     admin.namespaces().removeProperty("a");
+     admin.namespaces().removeProperty("b");
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      key - key of the property
      +
      Returns:
      +
      value of the property.
      +
      +
      +
      • +
    • +
      +

      removeProperty

      +
      String removeProperty(String namespace, + String key) + throws PulsarAdminException
      +
      Remove a property for a given key. + Return value of the property if the property exists, otherwise return null. + +

      + Example: + + 

      +     admin.namespaces().removeProperty("a");
+     admin.namespaces().removeProperty("b");
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      key - key of the property
      +
      Returns:
      +
      value of the property.
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      clearPropertiesAsync

      +
      CompletableFuture<Void> clearPropertiesAsync(String namespace)
      +
      Clear all properties of a namespace asynchronously. + +

      + Example: + + 

      +     admin.namespaces().clearPropertiesAsync();
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      +
      +
      • +
    • +
      +

      clearProperties

      +
      void clearProperties(String namespace) + throws PulsarAdminException
      +
      Clear all properties of a namespace. + +

      + Example: + + 

      +     admin.namespaces().clearProperties();
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getNamespaceResourceGroup

      +
      String getNamespaceResourceGroup(String namespace) + throws PulsarAdminException
      +
      Get the ResourceGroup for a namespace. +

      + Response example: + + 

      + 60
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      Returns:
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getNamespaceResourceGroupAsync

      +
      CompletableFuture<String> getNamespaceResourceGroupAsync(String namespace)
      +
      Get the ResourceGroup for a namespace asynchronously. +

      + Response example: + + 

      + 60
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      +
      +
      • +
    • +
      +

      setNamespaceResourceGroup

      +
      void setNamespaceResourceGroup(String namespace, + String resourcegroupname) + throws PulsarAdminException
      +
      Set the ResourceGroup for a namespace. +

      + Request example: + + 

      + 60
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      resourcegroupname - ResourceGroup name
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      setNamespaceResourceGroupAsync

      +
      CompletableFuture<Void> setNamespaceResourceGroupAsync(String namespace, + String resourcegroupname)
      +
      Set the ResourceGroup for a namespace asynchronously. +

      + Request example: + + 

      + 60
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      resourcegroupname - TTL values for all messages for all topics in this namespace
      +
      +
      +
      • +
    • +
      +

      removeNamespaceResourceGroup

      +
      void removeNamespaceResourceGroup(String namespace) + throws PulsarAdminException
      +
      Remove the ResourceGroup on a namespace.
      +
      +
      Parameters:
      +
      namespace -
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      removeNamespaceResourceGroupAsync

      +
      CompletableFuture<Void> removeNamespaceResourceGroupAsync(String namespace)
      +
      Remove the ResourceGroup on a namespace asynchronously.
      +
      +
      Parameters:
      +
      namespace -
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      getNamespaceEntryFilters

      +
      EntryFilters getNamespaceEntryFilters(String namespace) + throws PulsarAdminException
      +
      Get entry filters for a namespace.
      +
      +
      Parameters:
      +
      namespace -
      +
      Returns:
      +
      entry filters classes info.
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getNamespaceEntryFiltersAsync

      +
      CompletableFuture<EntryFilters> getNamespaceEntryFiltersAsync(String namespace)
      +
      Get entry filters for a namespace asynchronously.
      +
      +
      Parameters:
      +
      namespace -
      +
      Returns:
      +
      entry filters classes info.
      +
      +
      +
      • +
    • +
      +

      setNamespaceEntryFilters

      +
      void setNamespaceEntryFilters(String namespace, + EntryFilters entryFilters) + throws PulsarAdminException
      +
      Set entry filters on a namespace.
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      entryFilters - The entry filters
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      setNamespaceEntryFiltersAsync

      +
      CompletableFuture<Void> setNamespaceEntryFiltersAsync(String namespace, + EntryFilters entryFilters)
      +
      Set entry filters on a namespace asynchronously.
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      entryFilters - The entry filters
      +
      +
      +
      • +
    • +
      +

      removeNamespaceEntryFilters

      +
      void removeNamespaceEntryFilters(String namespace) + throws PulsarAdminException
      +
      remove entry filters of a namespace.
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      removeNamespaceEntryFiltersAsync

      +
      CompletableFuture<Void> removeNamespaceEntryFiltersAsync(String namespace)
      +
      remove entry filters of a namespace asynchronously.
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      updateMigrationState

      +
      void updateMigrationState(String namespace, + boolean migrated) + throws PulsarAdminException
      +
      Enable migration for all topics within a namespace. +

      + Migrate all topics of a namespace to new broker. +

      + Request example: + + 

      + true
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      migrated - Flag to determine namespace is migrated or not
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      setDispatcherPauseOnAckStatePersistentAsync

      +
      CompletableFuture<Void> setDispatcherPauseOnAckStatePersistentAsync(String namespace)
      +
      Set DispatcherPauseOnAckStatePersistent for a namespace asynchronously.
      +
      +
      • +
    • +
      +

      setDispatcherPauseOnAckStatePersistent

      +
      void setDispatcherPauseOnAckStatePersistent(String namespace) + throws PulsarAdminException
      +
      Remove entry filters of a namespace.
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      removeDispatcherPauseOnAckStatePersistentAsync

      +
      CompletableFuture<Void> removeDispatcherPauseOnAckStatePersistentAsync(String namespace)
      +
      Removes the dispatcherPauseOnAckStatePersistentEnabled policy for a given namespace asynchronously.
      +
      +
      • +
    • +
      +

      removeDispatcherPauseOnAckStatePersistent

      +
      void removeDispatcherPauseOnAckStatePersistent(String namespace) + throws PulsarAdminException
      +
      Removes the dispatcherPauseOnAckStatePersistentEnabled policy for a given namespace.
      +
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getDispatcherPauseOnAckStatePersistentAsync

      +
      CompletableFuture<Boolean> getDispatcherPauseOnAckStatePersistentAsync(String namespace)
      +
      Get the dispatcherPauseOnAckStatePersistentEnabled policy for a given namespace asynchronously.
      +
      +
      • +
    • +
      +

      getDispatcherPauseOnAckStatePersistent

      +
      boolean getDispatcherPauseOnAckStatePersistent(String namespace) + throws PulsarAdminException
      +
      Get the dispatcherPauseOnAckStatePersistentEnabled policy for a given namespace.
      +
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getNamespaceAllowedClusters

      +
      List<String> getNamespaceAllowedClusters(String namespace) + throws PulsarAdminException
      +
      Get the allowed clusters for a namespace. +

      + Response example: + + 

      + ["use", "usw", "usc"]
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException.PreconditionFailedException - Namespace is not global
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getNamespaceAllowedClustersAsync

      +
      CompletableFuture<List<String>> getNamespaceAllowedClustersAsync(String namespace)
      +
      Get the allowed clusters for a namespace asynchronously. +

      + Response example: + + 

      + ["use", "usw", "usc"]
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      +
      +
      • +
    • +
      +

      setNamespaceAllowedClusters

      +
      void setNamespaceAllowedClusters(String namespace, + Set<String> clusterIds) + throws PulsarAdminException
      +
      Set the allowed clusters for a namespace. +

      + Request example: + + 

      + ["us-west", "us-east", "us-cent"]
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      clusterIds - Pulsar Cluster Ids
      +
      Throws:
      +
      PulsarAdminException.ConflictException - Peer-cluster cannot be part of an allowed-cluster
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException.PreconditionFailedException - Namespace is not global
      +
      PulsarAdminException.PreconditionFailedException - Invalid cluster ids
      +
      PulsarAdminException - The list of allowed clusters should include all replication clusters.
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      setNamespaceAllowedClustersAsync

      +
      CompletableFuture<Void> setNamespaceAllowedClustersAsync(String namespace, + Set<String> clusterIds)
      +
      Set the allowed clusters for a namespace asynchronously. +

      + Request example: + + 

      + ["us-west", "us-east", "us-cent"]
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      clusterIds - Pulsar Cluster Ids
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/NonPersistentTopics.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/NonPersistentTopics.html new file mode 100644 index 000000000000..74d707ee5577 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/NonPersistentTopics.html @@ -0,0 +1,525 @@ + + + + +NonPersistentTopics (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.client.admin
+

Interface NonPersistentTopics

+
+
+
+
@Deprecated +public interface NonPersistentTopics
+
Deprecated. +
since 2.0. See Topics
+
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getPartitionedTopicMetadata

      +
      PartitionedTopicMetadata getPartitionedTopicMetadata(String topic) + throws PulsarAdminException
      +
      Deprecated.
      +
      Get metadata of a partitioned topic. +

      + Get metadata of a partitioned topic. +

      +
      +
      Parameters:
      +
      topic - Topic name
      +
      Returns:
      +
      Partitioned topic metadata
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getPartitionedTopicMetadataAsync

      +
      CompletableFuture<PartitionedTopicMetadata> getPartitionedTopicMetadataAsync(String topic)
      +
      Deprecated.
      +
      Get metadata of a partitioned topic asynchronously. +

      + Get metadata of a partitioned topic asynchronously. +

      +
      +
      Parameters:
      +
      topic - Topic name
      +
      Returns:
      +
      a future that can be used to track when the partitioned topic metadata is returned
      +
      +
      +
      • +
    • +
      +

      getStats

      +
      NonPersistentTopicStats getStats(String topic) + throws PulsarAdminException
      +
      Deprecated.
      +
      Get the stats for the topic. +

      + Response Example: + + 

      + 
+ {
+   "msgRateIn" : 100.0,                    // Total rate of messages published on the topic. msg/s
+   "msgThroughputIn" : 10240.0,            // Total throughput of messages published on the topic. byte/s
+   "msgRateOut" : 100.0,                   // Total rate of messages delivered on the topic. msg/s
+   "msgThroughputOut" : 10240.0,           // Total throughput of messages delivered on the topic. byte/s
+   "averageMsgSize" : 1024.0,              // Average size of published messages. bytes
+   "publishers" : [                        // List of publishes on this topic with their stats
+      {
+          "producerId" : 10                // producer id
+          "address"   : 10.4.1.23:3425     // IP and port for this producer
+          "connectedSince" : 2014-11-21 23:54:46 // Timestamp of this published connection
+          "msgRateIn" : 100.0,             // Total rate of messages published by this producer. msg/s
+          "msgThroughputIn" : 10240.0,     // Total throughput of messages published by this producer. byte/s
+          "averageMsgSize" : 1024.0,       // Average size of published messages by this producer. bytes
+      },
+   ],
+   "subscriptions" : {                     // Map of subscriptions on this topic
+     "sub1" : {
+       "msgRateOut" : 100.0,               // Total rate of messages delivered on this subscription. msg/s
+       "msgThroughputOut" : 10240.0,       // Total throughput delivered on this subscription. bytes/s
+       "msgBacklog" : 0,                   // Number of messages in the subscriotion backlog
+       "type" : Exclusive                  // Whether the subscription is exclusive or shared
+       "consumers" [                       // List of consumers on this subscription
+          {
+              "id" : 5                            // Consumer id
+              "address" : 10.4.1.23:3425          // IP and port for this consumer
+              "connectedSince" : 2014-11-21 23:54:46 // Timestamp of this consumer connection
+              "msgRateOut" : 100.0,               // Total rate of messages delivered to this consumer. msg/s
+              "msgThroughputOut" : 10240.0,       // Total throughput delivered to this consumer. bytes/s
+          }
+       ],
+   },
+   "replication" : {                    // Replication statistics
+     "cluster_1" : {                    // Cluster name in the context of from-cluster or to-cluster
+       "msgRateIn" : 100.0,             // Total rate of messages received from this remote cluster. msg/s
+       "msgThroughputIn" : 10240.0,     // Total throughput received from this remote cluster. bytes/s
+       "msgRateOut" : 100.0,            // Total rate of messages delivered to the replication-subscriber. msg/s
+       "msgThroughputOut" : 10240.0,    // Total throughput delivered to the replication-subscriber. bytes/s
+       "connected" : true,              // Whether the replication-subscriber is currently connected locally
+     },
+     "cluster_2" : {
+       "msgRateIn" : 100.0,
+       "msgThroughputIn" : 10240.0,
+       "msgRateOut" : 100.0,
+       "msghroughputOut" : 10240.0,
+       "connected" : true,
+     }
+   },
+ }
+ 
+
      +

      + All the rates are computed over a 1 minute window and are relative the last completed 1 minute period.

      +
      +
      Parameters:
      +
      topic - Topic name
      +
      Returns:
      +
      the topic statistics
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Topic does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getStatsAsync

      +
      CompletableFuture<NonPersistentTopicStats> getStatsAsync(String topic)
      +
      Deprecated.
      +
      Get the stats for the topic asynchronously. All the rates are computed over a 1 minute window and are relative + the last completed 1 minute period.
      +
      +
      Parameters:
      +
      topic - Topic name
      +
      Returns:
      +
      a future that can be used to track when the topic statistics are returned
      +
      +
      +
      • +
    • +
      +

      getInternalStats

      +
      PersistentTopicInternalStats getInternalStats(String topic) + throws PulsarAdminException
      +
      Deprecated.
      +
      Get the internal stats for the topic. +

      + Access the internal state of the topic

      +
      +
      Parameters:
      +
      topic - Topic name
      +
      Returns:
      +
      the topic statistics
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Topic does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getInternalStatsAsync

      +
      CompletableFuture<PersistentTopicInternalStats> getInternalStatsAsync(String topic)
      +
      Deprecated.
      +
      Get the internal stats for the topic asynchronously.
      +
      +
      Parameters:
      +
      topic - Topic Name
      +
      Returns:
      +
      a future that can be used to track when the internal topic statistics are returned
      +
      +
      +
      • +
    • +
      +

      createPartitionedTopic

      +
      void createPartitionedTopic(String topic, + int numPartitions) + throws PulsarAdminException
      +
      Deprecated.
      +
      Create a partitioned topic. +

      + Create a partitioned topic. It needs to be called before creating a producer for a partitioned topic. +

      +
      +
      Parameters:
      +
      topic - Topic name
      +
      numPartitions - Number of partitions to create of the topic
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      createPartitionedTopicAsync

      +
      CompletableFuture<Void> createPartitionedTopicAsync(String topic, + int numPartitions)
      +
      Deprecated.
      +
      Create a partitioned topic asynchronously. +

      + Create a partitioned topic asynchronously. It needs to be called before creating a producer for a partitioned + topic. +

      +
      +
      Parameters:
      +
      topic - Topic name
      +
      numPartitions - Number of partitions to create of the topic
      +
      Returns:
      +
      a future that can be used to track when the partitioned topic is created
      +
      +
      +
      • +
    • +
      +

      unload

      +
      void unload(String topic) + throws PulsarAdminException
      +
      Deprecated.
      +
      Unload a topic. +

      +
      +
      Parameters:
      +
      topic - Topic name
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Topic does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      unloadAsync

      +
      CompletableFuture<Void> unloadAsync(String topic)
      +
      Deprecated.
      +
      Unload a topic asynchronously. +

      +
      +
      Parameters:
      +
      topic - Topic name
      +
      Returns:
      +
      a future that can be used to track when the topic is unloaded
      +
      +
      +
      • +
    • +
      +

      getListInBundle

      +
      List<String> getListInBundle(String namespace, + String bundleRange) + throws PulsarAdminException
      +
      Deprecated.
      +
      Get list of topics exist into given bundle.
      +
      +
      Parameters:
      +
      namespace -
      +
      bundleRange -
      +
      Returns:
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getListInBundleAsync

      +
      CompletableFuture<List<String>> getListInBundleAsync(String namespace, + String bundleRange)
      +
      Deprecated.
      +
      Get list of topics exist into given bundle asynchronously.
      +
      +
      Parameters:
      +
      namespace -
      +
      bundleRange -
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      getList

      +
      List<String> getList(String namespace) + throws PulsarAdminException
      +
      Deprecated.
      +
      Get list of topics exist into given namespace.
      +
      +
      Parameters:
      +
      namespace -
      +
      Returns:
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getListAsync

      +
      CompletableFuture<List<String>> getListAsync(String namespace)
      +
      Deprecated.
      +
      Get list of topics exist into given namespace asynchronously.
      +
      +
      Parameters:
      +
      namespace -
      +
      Returns:
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/OffloadProcessStatus.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/OffloadProcessStatus.html new file mode 100644 index 000000000000..f9fad34b8680 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/OffloadProcessStatus.html @@ -0,0 +1,189 @@ + + + + +OffloadProcessStatus (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.client.admin
+

Interface OffloadProcessStatus

+
+
+
+
public interface OffloadProcessStatus
+
interface class of Status of offload process.
+
+
+ +
+
+ +
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/Packages.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/Packages.html new file mode 100644 index 000000000000..4937c53b3237 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/Packages.html @@ -0,0 +1,428 @@ + + + + +Packages (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.client.admin
+

Interface Packages

+
+
+
+
public interface Packages
+
Administration operations of the packages management service.
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getMetadata

      +
      PackageMetadata getMetadata(String packageName) + throws PulsarAdminException
      +
      Get a package metadata information.
      +
      +
      Parameters:
      +
      packageName - the package name of the package metadata you want to find
      +
      Returns:
      +
      the package metadata information
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getMetadataAsync

      +
      CompletableFuture<PackageMetadata> getMetadataAsync(String packageName)
      +
      Get a package metadata information asynchronously.
      +
      +
      Parameters:
      +
      packageName - the package name of the package metadata you want to find
      +
      Returns:
      +
      the package metadata information
      +
      +
      +
      • +
    • +
      +

      updateMetadata

      +
      void updateMetadata(String packageName, + PackageMetadata metadata) + throws PulsarAdminException
      +
      Update a package metadata information.
      +
      +
      Parameters:
      +
      packageName - the package name of the package metadata you want to update
      +
      metadata - the updated metadata information
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      updateMetadataAsync

      +
      CompletableFuture<Void> updateMetadataAsync(String packageName, + PackageMetadata metadata)
      +
      Update a package metadata information asynchronously.
      +
      +
      Parameters:
      +
      packageName - the package name of the package metadata you want to update
      +
      metadata - the updated metadata information
      +
      Returns:
      +
      nothing
      +
      +
      +
      • +
    • +
      +

      upload

      +
      void upload(PackageMetadata metadata, + String packageName, + String path) + throws PulsarAdminException
      +
      Upload a package to the package management service.
      +
      +
      Parameters:
      +
      packageName - the package name of the upload file
      +
      path - the upload file path
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      uploadAsync

      +
      CompletableFuture<Void> uploadAsync(PackageMetadata metadata, + String packageName, + String path)
      +
      Upload a package to the package management service asynchronously.
      +
      +
      Parameters:
      +
      packageName - the package name you want to upload
      +
      path - the path you want to upload from
      +
      Returns:
      +
      nothing
      +
      +
      +
      • +
    • +
      +

      download

      +
      void download(String packageName, + String path) + throws PulsarAdminException
      +
      Download a package from the package management service.
      +
      +
      Parameters:
      +
      packageName - the package name you want to download
      +
      path - the path you want to download to
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      downloadAsync

      +
      CompletableFuture<Void> downloadAsync(String packageName, + String path)
      +
      Download a package from the package management service asynchronously.
      +
      +
      Parameters:
      +
      packageName - the package name you want to download
      +
      path - the path you want to download to
      +
      Returns:
      +
      nothing
      +
      +
      +
      • +
    • +
      +

      delete

      +
      void delete(String packageName) + throws PulsarAdminException
      +
      Delete the specified package.
      +
      +
      Parameters:
      +
      packageName - the package name which you want to delete
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      deleteAsync

      +
      CompletableFuture<Void> deleteAsync(String packageName)
      +
      Delete the specified package asynchronously.
      +
      +
      Parameters:
      +
      packageName - the package name which you want to delete
      +
      Returns:
      +
      nothing
      +
      +
      +
      • +
    • +
      +

      listPackageVersions

      +
      List<String> listPackageVersions(String packageName) + throws PulsarAdminException
      +
      List all the versions of a package.
      +
      +
      Parameters:
      +
      packageName - the package name which you want to get all the versions
      +
      Returns:
      +
      all the versions of the package
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      listPackageVersionsAsync

      +
      CompletableFuture<List<String>> listPackageVersionsAsync(String packageName)
      +
      List all the versions of a package asynchronously.
      +
      +
      Parameters:
      +
      packageName - the package name which you want to get all the versions
      +
      Returns:
      +
      all the versions of the package
      +
      +
      +
      • +
    • +
      +

      listPackages

      +
      List<String> listPackages(String type, + String namespace) + throws PulsarAdminException
      +
      List all the packages with the given type in a namespace.
      +
      +
      Parameters:
      +
      type - the type you want to get the packages
      +
      namespace - the namespace you want to get the packages
      +
      Returns:
      +
      all the packages of the given type which in the given namespace
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      listPackagesAsync

      +
      CompletableFuture<List<String>> listPackagesAsync(String type, + String namespace)
      +
      List all the packages with the given type in a namespace asynchronously.
      +
      +
      Parameters:
      +
      type - the type you want to get the packages
      +
      namespace - the namespace you want to get the packages
      +
      Returns:
      +
      all the packages of the given type which in the given namespace
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/Properties.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/Properties.html new file mode 100644 index 000000000000..89b9cb26004c --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/Properties.html @@ -0,0 +1,279 @@ + + + + +Properties (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.client.admin
+

Interface Properties

+
+
+
+
@Deprecated +public interface Properties
+
Deprecated. +
see Tenants from PulsarAdmin.tenants()
+
+
Admin interface for properties management.
+
+
+ +
+
+ +
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/ProxyStats.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/ProxyStats.html new file mode 100644 index 000000000000..5113ebe0f306 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/ProxyStats.html @@ -0,0 +1,171 @@ + + + + +ProxyStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.client.admin
+

Interface ProxyStats

+
+
+
+
public interface ProxyStats
+
Admin interface for proxy stats management.
+
+
+
    + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    String
    +
    getConnections()
    +
    +
    Returns Connections metrics.
    +
    +
    String
    +
    getTopics()
    +
    +
    Returns Topics metrics.
    +
    +
    +
    +
    +
    +
    • +
+
+
+ +
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/PulsarAdmin.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/PulsarAdmin.html new file mode 100644 index 000000000000..715486d015bc --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/PulsarAdmin.html @@ -0,0 +1,534 @@ + + + + +PulsarAdmin (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.client.admin
+

Interface PulsarAdmin

+
+
+
+
All Superinterfaces:
+
AutoCloseable, Closeable
+
+
+
@Public +@Stable +public interface PulsarAdmin +extends Closeable
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      builder

      +
      static PulsarAdminBuilder builder()
      +
      Get a new builder instance that can used to configure and build a PulsarAdmin instance.
      +
      +
      Returns:
      +
      the PulsarAdminBuilder
      +
      +
      +
      • +
    • +
      +

      clusters

      +
      Clusters clusters()
      +
      +
      Returns:
      +
      the clusters management object
      +
      +
      +
      • +
    • +
      +

      brokers

      +
      Brokers brokers()
      +
      +
      Returns:
      +
      the brokers management object
      +
      +
      +
      • +
    • +
      +

      tenants

      +
      Tenants tenants()
      +
      +
      Returns:
      +
      the tenants management object
      +
      +
      +
      • +
    • +
      +

      resourcegroups

      +
      ResourceGroups resourcegroups()
      +
      +
      Returns:
      +
      the resourcegroups managements object
      +
      +
      +
      • +
    • +
      +

      properties

      +
      @Deprecated +Properties properties()
      +
      Deprecated. +
      since 2.0. See tenants()
      +
      +
      +
      • +
    • +
      +

      namespaces

      +
      Namespaces namespaces()
      +
      +
      Returns:
      +
      the namespaces management object
      +
      +
      +
      • +
    • +
      +

      topics

      +
      Topics topics()
      +
      +
      Returns:
      +
      the topics management object
      +
      +
      +
      • +
    • +
      +

      topicPolicies

      +
      TopicPolicies topicPolicies()
      +
      Get the topic policies management object.
      +
      +
      Returns:
      +
      the topic policies management object
      +
      +
      +
      • +
    • +
      +

      topicPolicies

      +
      TopicPolicies topicPolicies(boolean isGlobal)
      +
      Get the local/global topic policies management object.
      +
      +
      Returns:
      +
      the topic policies management object
      +
      +
      +
      • +
    • +
      +

      bookies

      +
      Bookies bookies()
      +
      +
      Returns:
      +
      the bookies management object
      +
      +
      +
      • +
    • +
      +

      nonPersistentTopics

      +
      @Deprecated +NonPersistentTopics nonPersistentTopics()
      +
      Deprecated. +
      Since 2.0. See topics()
      +
      +
      +
      Returns:
      +
      the persistentTopics management object
      +
      +
      +
      • +
    • +
      +

      resourceQuotas

      +
      ResourceQuotas resourceQuotas()
      +
      +
      Returns:
      +
      the resource quota management object
      +
      +
      +
      • +
    • +
      +

      lookups

      +
      Lookup lookups()
      +
      +
      Returns:
      +
      does a looks up for the broker serving the topic
      +
      +
      +
      • +
    • +
      +

      functions

      +
      Functions functions()
      +
      +
      Returns:
      +
      the functions management object
      +
      +
      +
      • +
    • +
      +

      source

      +
      @Deprecated +Source source()
      +
      Deprecated. +
      in favor of sources()
      +
      +
      +
      Returns:
      +
      the sources management object
      +
      +
      +
      • +
    • +
      +

      sources

      +
      Sources sources()
      +
      +
      Returns:
      +
      the sources management object
      +
      +
      +
      • +
    • +
      +

      sink

      +
      @Deprecated +Sink sink()
      +
      Deprecated. +
      in favor of sinks()
      +
      +
      +
      Returns:
      +
      the sinks management object
      +
      +
      +
      • +
    • +
      +

      sinks

      +
      Sinks sinks()
      +
      +
      Returns:
      +
      the sinks management object
      +
      +
      +
      • +
    • +
      +

      worker

      +
      Worker worker()
      +
      +
      Returns:
      +
      the Worker stats
      +
      +
      +
      • +
    • +
      +

      brokerStats

      +
      BrokerStats brokerStats()
      +
      +
      Returns:
      +
      the broker statics
      +
      +
      +
      • +
    • +
      +

      proxyStats

      +
      ProxyStats proxyStats()
      +
      +
      Returns:
      +
      the proxy statics
      +
      +
      +
      • +
    • +
      +

      getServiceUrl

      +
      String getServiceUrl()
      +
      +
      Returns:
      +
      the service HTTP URL that is being used
      +
      +
      +
      • +
    • +
      +

      schemas

      +
      Schemas schemas()
      +
      +
      Returns:
      +
      the schemas
      +
      +
      +
      • +
    • +
      +

      packages

      +
      Packages packages()
      +
      +
      Returns:
      +
      the packages management object
      +
      +
      +
      • +
    • +
      +

      transactions

      +
      Transactions transactions()
      +
      +
      Returns:
      +
      the transactions management object
      +
      +
      +
      • +
    • +
      +

      close

      +
      void close()
      +
      Close the PulsarAdminClient and release all the resources.
      +
      +
      Specified by:
      +
      close in interface AutoCloseable
      +
      Specified by:
      +
      close in interface Closeable
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/PulsarAdminBuilder.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/PulsarAdminBuilder.html new file mode 100644 index 000000000000..5ff190b55f23 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/PulsarAdminBuilder.html @@ -0,0 +1,787 @@ + + + + +PulsarAdminBuilder (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.client.admin
+

Interface PulsarAdminBuilder

+
+
+
+
public interface PulsarAdminBuilder
+
Builder class for a PulsarAdmin instance.
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      build

      +
      PulsarAdmin build() + throws org.apache.pulsar.client.api.PulsarClientException
      +
      +
      Returns:
      +
      the new PulsarAdmin instance
      +
      Throws:
      +
      org.apache.pulsar.client.api.PulsarClientException
      +
      +
      +
      • +
    • +
      +

      loadConf

      +
      PulsarAdminBuilder loadConf(Map<String,Object> config)
      +
      Load the configuration from provided config map. + +

      Example: + + 

      + 
+ Map<String, Object> config = new HashMap<>();
+ config.put("serviceHttpUrl", "http://localhost:6650");
+
+ PulsarAdminBuilder builder = ...;
+ builder = builder.loadConf(config);
+
+ PulsarAdmin client = builder.build();
+ 
+
      +
      +
      Parameters:
      +
      config - configuration to load
      +
      Returns:
      +
      the client builder instance
      +
      +
      +
      • +
    • +
      +

      clone

      +
      PulsarAdminBuilder clone()
      +
      Create a copy of the current client builder. +

      + Cloning the builder can be used to share an incomplete configuration and specialize it multiple times. For + example: + + 

      + PulsarAdminBuilder builder = PulsarAdmin.builder().allowTlsInsecureConnection(false);
+
+ PulsarAdmin client1 = builder.clone().serviceHttpUrl(URL_1).build();
+ PulsarAdmin client2 = builder.clone().serviceHttpUrl(URL_2).build();
+
      +
      +
      • +
    • +
      +

      serviceHttpUrl

      +
      PulsarAdminBuilder serviceHttpUrl(String serviceHttpUrl)
      +
      Set the Pulsar service HTTP URL for the admin endpoint (eg. "http://my-broker.example.com:8080", or + "https://my-broker.example.com:8443" for TLS)
      +
      +
      • +
    • +
      +

      authentication

      +
      PulsarAdminBuilder authentication(String authPluginClassName, + String authParamsString) + throws org.apache.pulsar.client.api.PulsarClientException.UnsupportedAuthenticationException
      +
      Set the authentication provider to use in the Pulsar client instance. +

      + Example: +

      + + 

      + 
+ String AUTH_CLASS = "org.apache.pulsar.client.impl.auth.AuthenticationTls";
+ String AUTH_PARAMS = "tlsCertFile:/my/cert/file,tlsKeyFile:/my/key/file";
+
+ PulsarAdmin client = PulsarAdmin.builder()
+          .serviceHttpUrl(SERVICE_HTTP_URL)
+          .authentication(AUTH_CLASS, AUTH_PARAMS)
+          .build();
+ ....
+ 
+
      +
      +
      Parameters:
      +
      authPluginClassName - name of the Authentication-Plugin you want to use
      +
      authParamsString - string which represents parameters for the Authentication-Plugin, e.g., "key1:val1,key2:val2"
      +
      Throws:
      +
      org.apache.pulsar.client.api.PulsarClientException.UnsupportedAuthenticationException - failed to instantiate specified Authentication-Plugin
      +
      +
      +
      • +
    • +
      +

      authentication

      +
      PulsarAdminBuilder authentication(String authPluginClassName, + Map<String,String> authParams) + throws org.apache.pulsar.client.api.PulsarClientException.UnsupportedAuthenticationException
      +
      Set the authentication provider to use in the Pulsar client instance. +

      + Example: +

      + + 

      
+ String AUTH_CLASS = "org.apache.pulsar.client.impl.auth.AuthenticationTls";
+
+ Map<String, String> conf = new TreeMap<>();
+ conf.put("tlsCertFile", "/my/cert/file");
+ conf.put("tlsKeyFile", "/my/key/file");
+
+ PulsarAdmin client = PulsarAdmin.builder()
+          .serviceHttpUrl(SERVICE_HTTP_URL)
+          .authentication(AUTH_CLASS, conf)
+          .build();
+ ....
+ 
+
      +
      +
      Parameters:
      +
      authPluginClassName - name of the Authentication-Plugin you want to use
      +
      authParams - map which represents parameters for the Authentication-Plugin
      +
      Throws:
      +
      org.apache.pulsar.client.api.PulsarClientException.UnsupportedAuthenticationException - failed to instantiate specified Authentication-Plugin
      +
      +
      +
      • +
    • +
      +

      authentication

      +
      PulsarAdminBuilder authentication(org.apache.pulsar.client.api.Authentication authentication)
      +
      Set the authentication provider to use in the Pulsar admin instance. +

      + Example: +

      + + 

      
+ String AUTH_CLASS = "org.apache.pulsar.client.impl.auth.AuthenticationTls";
+
+ Map<String, String> conf = new TreeMap<>();
+ conf.put("tlsCertFile", "/my/cert/file");
+ conf.put("tlsKeyFile", "/my/key/file");
+
+ Authentication auth = AuthenticationFactor.create(AUTH_CLASS, conf);
+
+ PulsarAdmin admin = PulsarAdmin.builder()
+          .serviceHttpUrl(SERVICE_URL)
+          .authentication(auth)
+          .build();
+ ....
+ 
+
      +
      +
      Parameters:
      +
      authentication - an instance of the Authentication provider already constructed
      +
      +
      +
      • +
    • +
      +

      tlsKeyFilePath

      +
      PulsarAdminBuilder tlsKeyFilePath(String tlsKeyFilePath)
      +
      Set the path to the TLS key file.
      +
      +
      Parameters:
      +
      tlsKeyFilePath -
      +
      Returns:
      +
      the admin builder instance
      +
      +
      +
      • +
    • +
      +

      tlsCertificateFilePath

      +
      PulsarAdminBuilder tlsCertificateFilePath(String tlsCertificateFilePath)
      +
      Set the path to the TLS certificate file.
      +
      +
      Parameters:
      +
      tlsCertificateFilePath -
      +
      Returns:
      +
      the admin builder instance
      +
      +
      +
      • +
    • +
      +

      tlsTrustCertsFilePath

      +
      PulsarAdminBuilder tlsTrustCertsFilePath(String tlsTrustCertsFilePath)
      +
      Set the path to the trusted TLS certificate file.
      +
      +
      Parameters:
      +
      tlsTrustCertsFilePath -
      +
      +
      +
      • +
    • +
      +

      allowTlsInsecureConnection

      +
      PulsarAdminBuilder allowTlsInsecureConnection(boolean allowTlsInsecureConnection)
      +
      Configure whether the Pulsar admin client accept untrusted TLS certificate from broker (default: false).
      +
      +
      Parameters:
      +
      allowTlsInsecureConnection -
      +
      +
      +
      • +
    • +
      +

      enableTlsHostnameVerification

      +
      PulsarAdminBuilder enableTlsHostnameVerification(boolean enableTlsHostnameVerification)
      +
      It allows to validate hostname verification when client connects to broker over TLS. It validates incoming x509 + certificate and matches provided hostname(CN/SAN) with expected broker's host name. It follows RFC 2818, 3.1. + Server Identity hostname verification.
      +
      +
      Parameters:
      +
      enableTlsHostnameVerification -
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      useKeyStoreTls

      +
      PulsarAdminBuilder useKeyStoreTls(boolean useKeyStoreTls)
      +
      If Tls is enabled, whether use KeyStore type as tls configuration parameter. + False means use default pem type configuration.
      +
      +
      Parameters:
      +
      useKeyStoreTls -
      +
      +
      +
      • +
    • +
      +

      sslProvider

      +
      PulsarAdminBuilder sslProvider(String sslProvider)
      +
      The name of the security provider used for SSL connections. + Default value is the default security provider of the JVM.
      +
      +
      Parameters:
      +
      sslProvider -
      +
      +
      +
      • +
    • +
      +

      tlsKeyStoreType

      +
      PulsarAdminBuilder tlsKeyStoreType(String tlsKeyStoreType)
      +
      The file format of the key store file.
      +
      +
      Parameters:
      +
      tlsKeyStoreType -
      +
      Returns:
      +
      the admin builder instance
      +
      +
      +
      • +
    • +
      +

      tlsKeyStorePath

      +
      PulsarAdminBuilder tlsKeyStorePath(String tlsTrustStorePath)
      +
      The location of the key store file.
      +
      +
      Parameters:
      +
      tlsTrustStorePath -
      +
      Returns:
      +
      the admin builder instance
      +
      +
      +
      • +
    • +
      +

      tlsKeyStorePassword

      +
      PulsarAdminBuilder tlsKeyStorePassword(String tlsKeyStorePassword)
      +
      The store password for the key store file.
      +
      +
      Parameters:
      +
      tlsKeyStorePassword -
      +
      Returns:
      +
      the admin builder instance
      +
      +
      +
      • +
    • +
      +

      tlsTrustStoreType

      +
      PulsarAdminBuilder tlsTrustStoreType(String tlsTrustStoreType)
      +
      The file format of the trust store file.
      +
      +
      Parameters:
      +
      tlsTrustStoreType -
      +
      +
      +
      • +
    • +
      +

      tlsTrustStorePath

      +
      PulsarAdminBuilder tlsTrustStorePath(String tlsTrustStorePath)
      +
      The location of the trust store file.
      +
      +
      Parameters:
      +
      tlsTrustStorePath -
      +
      +
      +
      • +
    • +
      +

      tlsTrustStorePassword

      +
      PulsarAdminBuilder tlsTrustStorePassword(String tlsTrustStorePassword)
      +
      The store password for the key store file.
      +
      +
      Parameters:
      +
      tlsTrustStorePassword -
      +
      Returns:
      +
      the client builder instance
      +
      +
      +
      • +
    • +
      +

      tlsCiphers

      +
      PulsarAdminBuilder tlsCiphers(Set<String> tlsCiphers)
      +
      A list of cipher suites. + This is a named combination of authentication, encryption, MAC and key exchange algorithm + used to negotiate the security settings for a network connection using TLS or SSL network protocol. + By default all the available cipher suites are supported.
      +
      +
      Parameters:
      +
      tlsCiphers -
      +
      +
      +
      • +
    • +
      +

      tlsProtocols

      +
      PulsarAdminBuilder tlsProtocols(Set<String> tlsProtocols)
      +
      The SSL protocol used to generate the SSLContext. + Default setting is TLS, which is fine for most cases. + Allowed values in recent JVMs are TLS, TLSv1.3, TLSv1.2 and TLSv1.1.
      +
      +
      Parameters:
      +
      tlsProtocols -
      +
      +
      +
      • +
    • +
      +

      sslFactoryPlugin

      +
      PulsarAdminBuilder sslFactoryPlugin(String sslFactoryPlugin)
      +
      SSL Factory Plugin used to generate the SSL Context and SSLEngine.
      +
      +
      Parameters:
      +
      sslFactoryPlugin - Name of the SSL Factory Class to be used.
      +
      Returns:
      +
      PulsarAdminBuilder
      +
      +
      +
      • +
    • +
      +

      sslFactoryPluginParams

      +
      PulsarAdminBuilder sslFactoryPluginParams(String sslFactoryPluginParams)
      +
      Parameters used by the SSL Factory Plugin class.
      +
      +
      Parameters:
      +
      sslFactoryPluginParams - String parameters to be used by the SSL Factory Class.
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      connectionTimeout

      +
      PulsarAdminBuilder connectionTimeout(int connectionTimeout, + TimeUnit connectionTimeoutUnit)
      +
      This sets the connection time out for the pulsar admin client.
      +
      +
      Parameters:
      +
      connectionTimeout -
      +
      connectionTimeoutUnit -
      +
      +
      +
      • +
    • +
      +

      readTimeout

      +
      PulsarAdminBuilder readTimeout(int readTimeout, + TimeUnit readTimeoutUnit)
      +
      This sets the server response read time out for the pulsar admin client for any request.
      +
      +
      Parameters:
      +
      readTimeout -
      +
      readTimeoutUnit -
      +
      +
      +
      • +
    • +
      +

      requestTimeout

      +
      PulsarAdminBuilder requestTimeout(int requestTimeout, + TimeUnit requestTimeoutUnit)
      +
      This sets the server request time out for the pulsar admin client for any request.
      +
      +
      Parameters:
      +
      requestTimeout -
      +
      requestTimeoutUnit -
      +
      +
      +
      • +
    • +
      +

      autoCertRefreshTime

      +
      PulsarAdminBuilder autoCertRefreshTime(int autoCertRefreshTime, + TimeUnit autoCertRefreshTimeUnit)
      +
      This sets auto cert refresh time if Pulsar admin uses tls authentication.
      +
      +
      Parameters:
      +
      autoCertRefreshTime -
      +
      autoCertRefreshTimeUnit -
      +
      +
      +
      • +
    • +
      +

      setContextClassLoader

      +
      PulsarAdminBuilder setContextClassLoader(ClassLoader clientBuilderClassLoader)
      +
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      acceptGzipCompression

      +
      PulsarAdminBuilder acceptGzipCompression(boolean acceptGzipCompression)
      +
      Determines whether to include the "Accept-Encoding: gzip" header in HTTP requests. + By default, the "Accept-Encoding: gzip" header is included in HTTP requests. + If this is set to false, the "Accept-Encoding: gzip" header will not be included in the requests.
      +
      +
      Parameters:
      +
      acceptGzipCompression - A flag that indicates whether to include the "Accept-Encoding: gzip" header in HTTP + requests
      +
      +
      +
      • +
    • +
      +

      maxConnectionsPerHost

      +
      PulsarAdminBuilder maxConnectionsPerHost(int maxConnectionsPerHost)
      +
      Configures the maximum number of connections that the client library will establish with a single host. +

      + By default, the connection pool maintains up to 16 connections to a single host. This method allows you to + modify this default behavior and limit the number of connections. +

      + This setting can be useful in scenarios where you want to limit the resources used by the client library, + or control the level of parallelism for operations so that a single client does not overwhelm + the Pulsar cluster with too many concurrent connections.

      +
      +
      Parameters:
      +
      maxConnectionsPerHost - the maximum number of connections to establish per host. Set to invalid input: '<'= 0 to disable + the limit.
      +
      Returns:
      +
      the PulsarAdminBuilder instance, allowing for method chaining
      +
      +
      +
      • +
    • +
      +

      connectionMaxIdleSeconds

      +
      PulsarAdminBuilder connectionMaxIdleSeconds(int connectionMaxIdleSeconds)
      +
      Sets the maximum idle time for a pooled connection. If a connection is idle for more than the specified + amount of seconds, it will be released back to the connection pool. + Defaults to 25 seconds.
      +
      +
      Parameters:
      +
      connectionMaxIdleSeconds - the maximum idle time, in seconds, for a pooled connection
      +
      Returns:
      +
      the PulsarAdminBuilder instance
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/PulsarAdminException.ConflictException.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/PulsarAdminException.ConflictException.html new file mode 100644 index 000000000000..46771fcb72ec --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/PulsarAdminException.ConflictException.html @@ -0,0 +1,230 @@ + + + + +PulsarAdminException.ConflictException (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.client.admin
+

Class PulsarAdminException.ConflictException

+
+
java.lang.Object +
java.lang.Throwable +
java.lang.Exception +
org.apache.pulsar.client.admin.PulsarAdminException +
org.apache.pulsar.client.admin.PulsarAdminException.ConflictException
+
+
+
+
+
+
+
All Implemented Interfaces:
+
Serializable
+
+
+
Enclosing class:
+
PulsarAdminException
+
+
+
public static class PulsarAdminException.ConflictException +extends PulsarAdminException
+
Conflict Exception.
+
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      ConflictException

      +
      public ConflictException(Throwable t, + String httpError, + int statusCode)
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      clone

      +
      protected PulsarAdminException clone()
      +
      Description copied from class: PulsarAdminException
      +
      This method is meant to be overriden by all subclasses. + We cannot make it 'abstract' because it would be a breaking change in the public API.
      +
      +
      Overrides:
      +
      clone in class PulsarAdminException
      +
      Returns:
      +
      a new PulsarAdminException
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/PulsarAdminException.ConnectException.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/PulsarAdminException.ConnectException.html new file mode 100644 index 000000000000..47d5b1e1843c --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/PulsarAdminException.ConnectException.html @@ -0,0 +1,236 @@ + + + + +PulsarAdminException.ConnectException (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.client.admin
+

Class PulsarAdminException.ConnectException

+
+
java.lang.Object +
java.lang.Throwable +
java.lang.Exception +
org.apache.pulsar.client.admin.PulsarAdminException +
org.apache.pulsar.client.admin.PulsarAdminException.ConnectException
+
+
+
+
+
+
+
All Implemented Interfaces:
+
Serializable
+
+
+
Enclosing class:
+
PulsarAdminException
+
+
+
public static class PulsarAdminException.ConnectException +extends PulsarAdminException
+
Connect Exception.
+
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      ConnectException

      +
      public ConnectException(Throwable t)
      +
      +
      • +
    • +
      +

      ConnectException

      +
      public ConnectException(String message, + Throwable t)
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      clone

      +
      protected PulsarAdminException clone()
      +
      Description copied from class: PulsarAdminException
      +
      This method is meant to be overriden by all subclasses. + We cannot make it 'abstract' because it would be a breaking change in the public API.
      +
      +
      Overrides:
      +
      clone in class PulsarAdminException
      +
      Returns:
      +
      a new PulsarAdminException
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/PulsarAdminException.GettingAuthenticationDataException.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/PulsarAdminException.GettingAuthenticationDataException.html new file mode 100644 index 000000000000..0bc6695ec191 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/PulsarAdminException.GettingAuthenticationDataException.html @@ -0,0 +1,238 @@ + + + + +PulsarAdminException.GettingAuthenticationDataException (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.client.admin
+

Class PulsarAdminException.GettingAuthenticationDataException

+
+
java.lang.Object +
java.lang.Throwable +
java.lang.Exception +
org.apache.pulsar.client.admin.PulsarAdminException +
org.apache.pulsar.client.admin.PulsarAdminException.GettingAuthenticationDataException
+
+
+
+
+
+
+
All Implemented Interfaces:
+
Serializable
+
+
+
Enclosing class:
+
PulsarAdminException
+
+
+
public static class PulsarAdminException.GettingAuthenticationDataException +extends PulsarAdminException
+
Getting Authentication Data Exception.
+
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      GettingAuthenticationDataException

      +
      public GettingAuthenticationDataException(Throwable t)
      +
      +
      • +
    • +
      +

      GettingAuthenticationDataException

      +
      @Deprecated +public GettingAuthenticationDataException(String msg)
      +
      Deprecated.
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      clone

      +
      protected PulsarAdminException clone()
      +
      Description copied from class: PulsarAdminException
      +
      This method is meant to be overriden by all subclasses. + We cannot make it 'abstract' because it would be a breaking change in the public API.
      +
      +
      Overrides:
      +
      clone in class PulsarAdminException
      +
      Returns:
      +
      a new PulsarAdminException
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/PulsarAdminException.HttpErrorException.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/PulsarAdminException.HttpErrorException.html new file mode 100644 index 000000000000..8d7df69afd18 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/PulsarAdminException.HttpErrorException.html @@ -0,0 +1,234 @@ + + + + +PulsarAdminException.HttpErrorException (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.client.admin
+

Class PulsarAdminException.HttpErrorException

+
+
java.lang.Object +
java.lang.Throwable +
java.lang.Exception +
org.apache.pulsar.client.admin.PulsarAdminException +
org.apache.pulsar.client.admin.PulsarAdminException.HttpErrorException
+
+
+
+
+
+
+
All Implemented Interfaces:
+
Serializable
+
+
+
Enclosing class:
+
PulsarAdminException
+
+
+
public static class PulsarAdminException.HttpErrorException +extends PulsarAdminException
+
Http Error Exception.
+
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      HttpErrorException

      +
      public HttpErrorException(Exception e)
      +
      +
      • +
    • +
      +

      HttpErrorException

      +
      public HttpErrorException(Throwable t)
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      clone

      +
      protected PulsarAdminException clone()
      +
      Description copied from class: PulsarAdminException
      +
      This method is meant to be overriden by all subclasses. + We cannot make it 'abstract' because it would be a breaking change in the public API.
      +
      +
      Overrides:
      +
      clone in class PulsarAdminException
      +
      Returns:
      +
      a new PulsarAdminException
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/PulsarAdminException.NotAllowedException.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/PulsarAdminException.NotAllowedException.html new file mode 100644 index 000000000000..24c520b98933 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/PulsarAdminException.NotAllowedException.html @@ -0,0 +1,230 @@ + + + + +PulsarAdminException.NotAllowedException (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.client.admin
+

Class PulsarAdminException.NotAllowedException

+
+
java.lang.Object +
java.lang.Throwable +
java.lang.Exception +
org.apache.pulsar.client.admin.PulsarAdminException +
org.apache.pulsar.client.admin.PulsarAdminException.NotAllowedException
+
+
+
+
+
+
+
All Implemented Interfaces:
+
Serializable
+
+
+
Enclosing class:
+
PulsarAdminException
+
+
+
public static class PulsarAdminException.NotAllowedException +extends PulsarAdminException
+
Not Allowed Exception.
+
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      NotAllowedException

      +
      public NotAllowedException(Throwable t, + String httpError, + int statusCode)
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      clone

      +
      protected PulsarAdminException clone()
      +
      Description copied from class: PulsarAdminException
      +
      This method is meant to be overriden by all subclasses. + We cannot make it 'abstract' because it would be a breaking change in the public API.
      +
      +
      Overrides:
      +
      clone in class PulsarAdminException
      +
      Returns:
      +
      a new PulsarAdminException
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/PulsarAdminException.NotAuthorizedException.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/PulsarAdminException.NotAuthorizedException.html new file mode 100644 index 000000000000..e020e3bc198f --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/PulsarAdminException.NotAuthorizedException.html @@ -0,0 +1,230 @@ + + + + +PulsarAdminException.NotAuthorizedException (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.client.admin
+

Class PulsarAdminException.NotAuthorizedException

+
+
java.lang.Object +
java.lang.Throwable +
java.lang.Exception +
org.apache.pulsar.client.admin.PulsarAdminException +
org.apache.pulsar.client.admin.PulsarAdminException.NotAuthorizedException
+
+
+
+
+
+
+
All Implemented Interfaces:
+
Serializable
+
+
+
Enclosing class:
+
PulsarAdminException
+
+
+
public static class PulsarAdminException.NotAuthorizedException +extends PulsarAdminException
+
Not Authorized Exception.
+
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      NotAuthorizedException

      +
      public NotAuthorizedException(Throwable t, + String httpError, + int statusCode)
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      clone

      +
      protected PulsarAdminException clone()
      +
      Description copied from class: PulsarAdminException
      +
      This method is meant to be overriden by all subclasses. + We cannot make it 'abstract' because it would be a breaking change in the public API.
      +
      +
      Overrides:
      +
      clone in class PulsarAdminException
      +
      Returns:
      +
      a new PulsarAdminException
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/PulsarAdminException.NotFoundException.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/PulsarAdminException.NotFoundException.html new file mode 100644 index 000000000000..8bc876e3595a --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/PulsarAdminException.NotFoundException.html @@ -0,0 +1,230 @@ + + + + +PulsarAdminException.NotFoundException (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.client.admin
+

Class PulsarAdminException.NotFoundException

+
+
java.lang.Object +
java.lang.Throwable +
java.lang.Exception +
org.apache.pulsar.client.admin.PulsarAdminException +
org.apache.pulsar.client.admin.PulsarAdminException.NotFoundException
+
+
+
+
+
+
+
All Implemented Interfaces:
+
Serializable
+
+
+
Enclosing class:
+
PulsarAdminException
+
+
+
public static class PulsarAdminException.NotFoundException +extends PulsarAdminException
+
Not Found Exception.
+
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      NotFoundException

      +
      public NotFoundException(Throwable t, + String httpError, + int statusCode)
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      clone

      +
      protected PulsarAdminException clone()
      +
      Description copied from class: PulsarAdminException
      +
      This method is meant to be overriden by all subclasses. + We cannot make it 'abstract' because it would be a breaking change in the public API.
      +
      +
      Overrides:
      +
      clone in class PulsarAdminException
      +
      Returns:
      +
      a new PulsarAdminException
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/PulsarAdminException.PreconditionFailedException.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/PulsarAdminException.PreconditionFailedException.html new file mode 100644 index 000000000000..4450bfae8729 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/PulsarAdminException.PreconditionFailedException.html @@ -0,0 +1,230 @@ + + + + +PulsarAdminException.PreconditionFailedException (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.client.admin
+

Class PulsarAdminException.PreconditionFailedException

+
+
java.lang.Object +
java.lang.Throwable +
java.lang.Exception +
org.apache.pulsar.client.admin.PulsarAdminException +
org.apache.pulsar.client.admin.PulsarAdminException.PreconditionFailedException
+
+
+
+
+
+
+
All Implemented Interfaces:
+
Serializable
+
+
+
Enclosing class:
+
PulsarAdminException
+
+
+
public static class PulsarAdminException.PreconditionFailedException +extends PulsarAdminException
+
Precondition Failed Exception.
+
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      PreconditionFailedException

      +
      public PreconditionFailedException(Throwable t, + String httpError, + int statusCode)
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      clone

      +
      protected PulsarAdminException clone()
      +
      Description copied from class: PulsarAdminException
      +
      This method is meant to be overriden by all subclasses. + We cannot make it 'abstract' because it would be a breaking change in the public API.
      +
      +
      Overrides:
      +
      clone in class PulsarAdminException
      +
      Returns:
      +
      a new PulsarAdminException
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/PulsarAdminException.ServerSideErrorException.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/PulsarAdminException.ServerSideErrorException.html new file mode 100644 index 000000000000..8ef5518afde6 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/PulsarAdminException.ServerSideErrorException.html @@ -0,0 +1,244 @@ + + + + +PulsarAdminException.ServerSideErrorException (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.client.admin
+

Class PulsarAdminException.ServerSideErrorException

+
+
java.lang.Object +
java.lang.Throwable +
java.lang.Exception +
org.apache.pulsar.client.admin.PulsarAdminException +
org.apache.pulsar.client.admin.PulsarAdminException.ServerSideErrorException
+
+
+
+
+
+
+
All Implemented Interfaces:
+
Serializable
+
+
+
Enclosing class:
+
PulsarAdminException
+
+
+
public static class PulsarAdminException.ServerSideErrorException +extends PulsarAdminException
+
Server Side Error Exception.
+
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      ServerSideErrorException

      +
      public ServerSideErrorException(Throwable t, + String message, + String httpError, + int statusCode)
      +
      +
      • +
    • +
      +

      ServerSideErrorException

      +
      @Deprecated +public ServerSideErrorException(Throwable t)
      +
      Deprecated.
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      clone

      +
      protected PulsarAdminException clone()
      +
      Description copied from class: PulsarAdminException
      +
      This method is meant to be overriden by all subclasses. + We cannot make it 'abstract' because it would be a breaking change in the public API.
      +
      +
      Overrides:
      +
      clone in class PulsarAdminException
      +
      Returns:
      +
      a new PulsarAdminException
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/PulsarAdminException.TimeoutException.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/PulsarAdminException.TimeoutException.html new file mode 100644 index 000000000000..445b0f009326 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/PulsarAdminException.TimeoutException.html @@ -0,0 +1,226 @@ + + + + +PulsarAdminException.TimeoutException (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.client.admin
+

Class PulsarAdminException.TimeoutException

+
+
java.lang.Object +
java.lang.Throwable +
java.lang.Exception +
org.apache.pulsar.client.admin.PulsarAdminException +
org.apache.pulsar.client.admin.PulsarAdminException.TimeoutException
+
+
+
+
+
+
+
All Implemented Interfaces:
+
Serializable
+
+
+
Enclosing class:
+
PulsarAdminException
+
+
+
public static class PulsarAdminException.TimeoutException +extends PulsarAdminException
+
Timeout Exception.
+
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      TimeoutException

      +
      public TimeoutException(Throwable t)
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      clone

      +
      protected PulsarAdminException clone()
      +
      Description copied from class: PulsarAdminException
      +
      This method is meant to be overriden by all subclasses. + We cannot make it 'abstract' because it would be a breaking change in the public API.
      +
      +
      Overrides:
      +
      clone in class PulsarAdminException
      +
      Returns:
      +
      a new PulsarAdminException
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/PulsarAdminException.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/PulsarAdminException.html new file mode 100644 index 000000000000..36e76563d751 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/PulsarAdminException.html @@ -0,0 +1,353 @@ + + + + +PulsarAdminException (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.client.admin
+

Class PulsarAdminException

+
+
java.lang.Object +
java.lang.Throwable +
java.lang.Exception +
org.apache.pulsar.client.admin.PulsarAdminException
+
+
+
+
+
+
All Implemented Interfaces:
+
Serializable
+
+
+
Direct Known Subclasses:
+
PulsarAdminException.ConflictException, PulsarAdminException.ConnectException, PulsarAdminException.GettingAuthenticationDataException, PulsarAdminException.HttpErrorException, PulsarAdminException.NotAllowedException, PulsarAdminException.NotAuthorizedException, PulsarAdminException.NotFoundException, PulsarAdminException.PreconditionFailedException, PulsarAdminException.ServerSideErrorException, PulsarAdminException.TimeoutException
+
+
+
public class PulsarAdminException +extends Exception
+
Pulsar admin exceptions.
+
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      PulsarAdminException

      +
      public PulsarAdminException(Throwable t, + String httpError, + int statusCode)
      +
      +
      • +
    • +
      +

      PulsarAdminException

      +
      public PulsarAdminException(String message, + Throwable t, + String httpError, + int statusCode)
      +
      +
      • +
    • +
      +

      PulsarAdminException

      +
      public PulsarAdminException(Throwable t)
      +
      +
      • +
    • +
      +

      PulsarAdminException

      +
      public PulsarAdminException(String message, + Throwable t)
      +
      +
      • +
    • +
      +

      PulsarAdminException

      +
      public PulsarAdminException(String message)
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getHttpError

      +
      public String getHttpError()
      +
      +
      • +
    • +
      +

      getStatusCode

      +
      public int getStatusCode()
      +
      +
      • +
    • +
      +

      clone

      +
      protected PulsarAdminException clone()
      +
      This method is meant to be overriden by all subclasses. + We cannot make it 'abstract' because it would be a breaking change in the public API.
      +
      +
      Overrides:
      +
      clone in class Object
      +
      Returns:
      +
      a new PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      wrap

      +
      public static PulsarAdminException wrap(PulsarAdminException e)
      +
      Clone the exception and grab the current stacktrace.
      +
      +
      Parameters:
      +
      e - a PulsarAdminException
      +
      Returns:
      +
      a new PulsarAdminException, of the same class.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/ResourceGroups.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/ResourceGroups.html new file mode 100644 index 000000000000..3a0ebcc4520b --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/ResourceGroups.html @@ -0,0 +1,397 @@ + + + + +ResourceGroups (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.client.admin
+

Interface ResourceGroups

+
+
+
+
public interface ResourceGroups
+
Admin interface for ResourceGroups management.
+
+
+ +
+
+ +
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/ResourceQuotas.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/ResourceQuotas.html new file mode 100644 index 000000000000..6d16ffd86563 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/ResourceQuotas.html @@ -0,0 +1,528 @@ + + + + +ResourceQuotas (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.client.admin
+

Interface ResourceQuotas

+
+
+
+
public interface ResourceQuotas
+
Admin interface on interacting with resource quotas.
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getDefaultResourceQuota

      +
      ResourceQuota getDefaultResourceQuota() + throws PulsarAdminException
      +
      Get default resource quota for new resource bundles. +

      + Get default resource quota for new resource bundles. +

      + Response example: + + 

      + 
+  {
+      "msgRateIn" : 10,
+      "msgRateOut" : 30,
+      "bandwidthIn" : 10000,
+      "bandwidthOut" : 30000,
+      "memory" : 100,
+      "dynamic" : true
+  }
+ 
+
      +
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Permission denied
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getDefaultResourceQuotaAsync

      +
      CompletableFuture<ResourceQuota> getDefaultResourceQuotaAsync()
      +
      Get default resource quota for new resource bundles asynchronously. +

      + Get default resource quota for new resource bundles. +

      + Response example: + + 

      + 
+  {
+      "msgRateIn" : 10,
+      "msgRateOut" : 30,
+      "bandwidthIn" : 10000,
+      "bandwidthOut" : 30000,
+      "memory" : 100,
+      "dynamic" : true
+  }
+ 
+
      +
      +
      • +
    • +
      +

      setDefaultResourceQuota

      +
      void setDefaultResourceQuota(ResourceQuota quota) + throws PulsarAdminException
      +
      Set default resource quota for new namespace bundles. +

      + Set default resource quota for new namespace bundles. +

      + The resource quota can be set with these properties: +

        +
      • msgRateIn : The maximum incoming messages per second. +
      • msgRateOut : The maximum outgoing messages per second. +
      • bandwidthIn : The maximum inbound bandwidth used. +
      • bandwidthOut : The maximum outbound bandwidth used. +
      • memory : The maximum memory used. +
      • dynamic : allow the quota to be dynamically re-calculated. +
        • +
      + +

      + Request parameter example: + + 

      + 
+  {
+      "msgRateIn" : 10,
+      "msgRateOut" : 30,
+      "bandwidthIn" : 10000,
+      "bandwidthOut" : 30000,
+      "memory" : 100,
+      "dynamic" : false
+  }
+ 
+
      +
      +
      Parameters:
      +
      quota - The new ResourceQuota
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      setDefaultResourceQuotaAsync

      +
      CompletableFuture<Void> setDefaultResourceQuotaAsync(ResourceQuota quota)
      +
      Set default resource quota for new namespace bundles asynchronously. +

      + Set default resource quota for new namespace bundles. +

      + The resource quota can be set with these properties: +

        +
      • msgRateIn : The maximum incoming messages per second. +
      • msgRateOut : The maximum outgoing messages per second. +
      • bandwidthIn : The maximum inbound bandwidth used. +
      • bandwidthOut : The maximum outbound bandwidth used. +
      • memory : The maximum memory used. +
      • dynamic : allow the quota to be dynamically re-calculated. +
        • +
      + +

      + Request parameter example: + + 

      + 
+  {
+      "msgRateIn" : 10,
+      "msgRateOut" : 30,
+      "bandwidthIn" : 10000,
+      "bandwidthOut" : 30000,
+      "memory" : 100,
+      "dynamic" : false
+  }
+ 
+
      +
      +
      Parameters:
      +
      quota - The new ResourceQuota
      +
      +
      +
      • +
    • +
      +

      getNamespaceBundleResourceQuota

      +
      ResourceQuota getNamespaceBundleResourceQuota(String namespace, + String bundle) + throws PulsarAdminException
      +
      Get resource quota of a namespace bundle. +

      + Get resource quota of a namespace bundle. +

      + Response example: + + 

      + 
+  {
+      "msgRateIn" : 10,
+      "msgRateOut" : 30,
+      "bandwidthIn" : 10000,
+      "bandwidthOut" : 30000,
+      "memory" : 100,
+      "dynamic" : true
+  }
+ 
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      bundle - Range of bundle {start}_{end}
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Permission denied
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getNamespaceBundleResourceQuotaAsync

      +
      CompletableFuture<ResourceQuota> getNamespaceBundleResourceQuotaAsync(String namespace, + String bundle)
      +
      Get resource quota of a namespace bundle asynchronously. +

      + Get resource quota of a namespace bundle. +

      + Response example: + + 

      + 
+  {
+      "msgRateIn" : 10,
+      "msgRateOut" : 30,
+      "bandwidthIn" : 10000,
+      "bandwidthOut" : 30000,
+      "memory" : 100,
+      "dynamic" : true
+  }
+ 
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      bundle - Range of bundle {start}_{end}
      +
      +
      +
      • +
    • +
      +

      setNamespaceBundleResourceQuota

      +
      void setNamespaceBundleResourceQuota(String namespace, + String bundle, + ResourceQuota quota) + throws PulsarAdminException
      +
      Set resource quota for a namespace bundle. +

      + Set resource quota for a namespace bundle. +

      + The resource quota can be set with these properties: +

        +
      • msgRateIn : The maximum incoming messages per second. +
      • msgRateOut : The maximum outgoing messages per second. +
      • bandwidthIn : The maximum inbound bandwidth used. +
      • bandwidthOut : The maximum outbound bandwidth used. +
      • memory : The maximum memory used. +
      • dynamic : allow the quota to be dynamically re-calculated. +
        • +
      + +

      + Request parameter example: + + 

      + 
+  {
+      "msgRateIn" : 10,
+      "msgRateOut" : 30,
+      "bandwidthIn" : 10000,
+      "bandwidthOut" : 30000,
+      "memory" : 100,
+      "dynamic" : false
+  }
+ 
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      bundle - Bundle range {start}_{end}
      +
      quota - The new ResourceQuota
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      setNamespaceBundleResourceQuotaAsync

      +
      CompletableFuture<Void> setNamespaceBundleResourceQuotaAsync(String namespace, + String bundle, + ResourceQuota quota)
      +
      Set resource quota for a namespace bundle asynchronously. +

      + Set resource quota for a namespace bundle. +

      + The resource quota can be set with these properties: +

        +
      • msgRateIn : The maximum incoming messages per second. +
      • msgRateOut : The maximum outgoing messages per second. +
      • bandwidthIn : The maximum inbound bandwidth used. +
      • bandwidthOut : The maximum outbound bandwidth used. +
      • memory : The maximum memory used. +
      • dynamic : allow the quota to be dynamically re-calculated. +
        • +
      + +

      + Request parameter example: + + 

      + 
+  {
+      "msgRateIn" : 10,
+      "msgRateOut" : 30,
+      "bandwidthIn" : 10000,
+      "bandwidthOut" : 30000,
+      "memory" : 100,
+      "dynamic" : false
+  }
+ 
+
      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      bundle - Bundle range {start}_{end}
      +
      quota - The new ResourceQuota
      +
      +
      +
      • +
    • +
      +

      resetNamespaceBundleResourceQuota

      +
      void resetNamespaceBundleResourceQuota(String namespace, + String bundle) + throws PulsarAdminException
      +
      Reset resource quota for a namespace bundle to default value. +

      + Reset resource quota for a namespace bundle to default value. +

      + The resource quota policy will fall back to the default.

      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      bundle - Bundle range {start}_{end}
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      resetNamespaceBundleResourceQuotaAsync

      +
      CompletableFuture<Void> resetNamespaceBundleResourceQuotaAsync(String namespace, + String bundle)
      +
      Reset resource quota for a namespace bundle to default value asynchronously. +

      + Reset resource quota for a namespace bundle to default value. +

      + The resource quota policy will fall back to the default.

      +
      +
      Parameters:
      +
      namespace - Namespace name
      +
      bundle - Bundle range {start}_{end}
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/RevokeTopicPermissionOptions.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/RevokeTopicPermissionOptions.html new file mode 100644 index 000000000000..0294da67321c --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/RevokeTopicPermissionOptions.html @@ -0,0 +1,150 @@ + + + + +RevokeTopicPermissionOptions (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.client.admin
+

Class RevokeTopicPermissionOptions

+
+
java.lang.Object +
org.apache.pulsar.client.admin.RevokeTopicPermissionOptions
+
+
+
+
public class RevokeTopicPermissionOptions +extends Object
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      RevokeTopicPermissionOptions

      +
      public RevokeTopicPermissionOptions()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/Schemas.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/Schemas.html new file mode 100644 index 000000000000..da905fdd7ad9 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/Schemas.html @@ -0,0 +1,651 @@ + + + + +Schemas (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.client.admin
+

Interface Schemas

+
+
+
+
public interface Schemas
+
Admin interface on interacting with schemas.
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getSchemaInfo

      +
      org.apache.pulsar.common.schema.SchemaInfo getSchemaInfo(String topic) + throws PulsarAdminException
      +
      Retrieve the latest schema of a topic.
      +
      +
      Parameters:
      +
      topic - topic name, in fully qualified format
      +
      Returns:
      +
      latest schema
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getSchemaInfoAsync

      +
      CompletableFuture<org.apache.pulsar.common.schema.SchemaInfo> getSchemaInfoAsync(String topic)
      +
      Retrieve the latest schema of a topic asynchronously.
      +
      +
      Parameters:
      +
      topic - topic name, in fully qualified format
      +
      Returns:
      +
      latest schema
      +
      +
      +
      • +
    • +
      +

      getSchemaInfoWithVersion

      +
      org.apache.pulsar.common.schema.SchemaInfoWithVersion getSchemaInfoWithVersion(String topic) + throws PulsarAdminException
      +
      Retrieve the latest schema with verison of a topic.
      +
      +
      Parameters:
      +
      topic - topic name, in fully qualified format
      +
      Returns:
      +
      latest schema with version
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getSchemaInfoWithVersionAsync

      +
      CompletableFuture<org.apache.pulsar.common.schema.SchemaInfoWithVersion> getSchemaInfoWithVersionAsync(String topic)
      +
      Retrieve the latest schema with verison of a topic asynchronously.
      +
      +
      Parameters:
      +
      topic - topic name, in fully qualified format
      +
      Returns:
      +
      latest schema with version
      +
      +
      +
      • +
    • +
      +

      getSchemaInfo

      +
      org.apache.pulsar.common.schema.SchemaInfo getSchemaInfo(String topic, + long version) + throws PulsarAdminException
      +
      Retrieve the schema of a topic at a given version.
      +
      +
      Parameters:
      +
      topic - topic name, in fully qualified format
      +
      version - schema version
      +
      Returns:
      +
      the schema info at a given version
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getSchemaInfoAsync

      +
      CompletableFuture<org.apache.pulsar.common.schema.SchemaInfo> getSchemaInfoAsync(String topic, + long version)
      +
      Retrieve the schema of a topic at a given version asynchronously.
      +
      +
      Parameters:
      +
      topic - topic name, in fully qualified format
      +
      version - schema version
      +
      Returns:
      +
      the schema info at a given version
      +
      +
      +
      • +
    • +
      +

      deleteSchema

      +
      void deleteSchema(String topic) + throws PulsarAdminException
      +
      Delete the schema associated with a given topic.
      +
      +
      Parameters:
      +
      topic - topic name, in fully qualified format
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      deleteSchemaAsync

      +
      CompletableFuture<Void> deleteSchemaAsync(String topic)
      +
      Delete the schema associated with a given topic asynchronously.
      +
      +
      Parameters:
      +
      topic - topic name, in fully qualified format
      +
      +
      +
      • +
    • +
      +

      deleteSchema

      +
      void deleteSchema(String topic, + boolean force) + throws PulsarAdminException
      +
      Delete the schema associated with a given topic.
      +
      +
      Parameters:
      +
      topic - topic name, in fully qualified format
      +
      force - whether to delete schema completely. + If true, delete all resources (including metastore and ledger), + otherwise only do a mark deletion and not remove any resources indeed
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      deleteSchemaAsync

      +
      CompletableFuture<Void> deleteSchemaAsync(String topic, + boolean force)
      +
      Delete the schema associated with a given topic asynchronously.
      +
      +
      Parameters:
      +
      topic - topic name, in fully qualified format
      +
      +
      +
      • +
    • +
      +

      createSchema

      +
      void createSchema(String topic, + org.apache.pulsar.common.schema.SchemaInfo schemaInfo) + throws PulsarAdminException
      +
      Create a schema for a given topic with the provided schema info.
      +
      +
      Parameters:
      +
      topic - topic name, in fully qualified fomrat
      +
      schemaInfo - schema info
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      createSchemaAsync

      +
      CompletableFuture<Void> createSchemaAsync(String topic, + org.apache.pulsar.common.schema.SchemaInfo schemaInfo)
      +
      Create a schema for a given topic with the provided schema info asynchronously.
      +
      +
      Parameters:
      +
      topic - topic name, in fully qualified fomrat
      +
      schemaInfo - schema info
      +
      +
      +
      • +
    • +
      +

      createSchema

      +
      void createSchema(String topic, + PostSchemaPayload schemaPayload) + throws PulsarAdminException
      +
      Create a schema for a given topic.
      +
      +
      Parameters:
      +
      topic - topic name, in fully qualified format
      +
      schemaPayload - schema payload
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      createSchemaAsync

      +
      CompletableFuture<Void> createSchemaAsync(String topic, + PostSchemaPayload schemaPayload)
      +
      Create a schema for a given topic asynchronously.
      +
      +
      Parameters:
      +
      topic - topic name, in fully qualified format
      +
      schemaPayload - schema payload
      +
      +
      +
      • +
    • +
      +

      testCompatibility

      +
      IsCompatibilityResponse testCompatibility(String topic, + PostSchemaPayload schemaPayload) + throws PulsarAdminException
      +
      Judge schema compatibility topic.
      +
      +
      Parameters:
      +
      topic - topic name, in fully qualified format
      +
      schemaPayload - schema payload
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      testCompatibilityAsync

      +
      CompletableFuture<IsCompatibilityResponse> testCompatibilityAsync(String topic, + PostSchemaPayload schemaPayload)
      +
      Judge schema compatibility topic asynchronously.
      +
      +
      Parameters:
      +
      topic - topic name, in fully qualified format
      +
      schemaPayload - schema payload
      +
      +
      +
      • +
    • +
      +

      getVersionBySchema

      +
      Long getVersionBySchema(String topic, + PostSchemaPayload schemaPayload) + throws PulsarAdminException
      +
      Find schema version topic.
      +
      +
      Parameters:
      +
      topic - topic name, in fully qualified format
      +
      schemaPayload - schema payload
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getVersionBySchemaAsync

      +
      CompletableFuture<Long> getVersionBySchemaAsync(String topic, + PostSchemaPayload schemaPayload)
      +
      Find schema version topic asynchronously.
      +
      +
      Parameters:
      +
      topic - topic name, in fully qualified format
      +
      schemaPayload - schema payload
      +
      +
      +
      • +
    • +
      +

      testCompatibility

      +
      IsCompatibilityResponse testCompatibility(String topic, + org.apache.pulsar.common.schema.SchemaInfo schemaInfo) + throws PulsarAdminException
      +
      Judge schema compatibility topic.
      +
      +
      Parameters:
      +
      topic - topic name, in fully qualified format
      +
      schemaInfo - schema info
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      testCompatibilityAsync

      +
      CompletableFuture<IsCompatibilityResponse> testCompatibilityAsync(String topic, + org.apache.pulsar.common.schema.SchemaInfo schemaInfo)
      +
      Judge schema compatibility topic asynchronously.
      +
      +
      Parameters:
      +
      topic - topic name, in fully qualified format
      +
      schemaInfo - schema info
      +
      +
      +
      • +
    • +
      +

      getVersionBySchema

      +
      Long getVersionBySchema(String topic, + org.apache.pulsar.common.schema.SchemaInfo schemaInfo) + throws PulsarAdminException
      +
      Find schema version topic.
      +
      +
      Parameters:
      +
      topic - topic name, in fully qualified format
      +
      schemaInfo - schema info
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getVersionBySchemaAsync

      +
      CompletableFuture<Long> getVersionBySchemaAsync(String topic, + org.apache.pulsar.common.schema.SchemaInfo schemaInfo)
      +
      Find schema version topic asynchronously.
      +
      +
      Parameters:
      +
      topic - topic name, in fully qualified format
      +
      schemaInfo - schema info
      +
      +
      +
      • +
    • +
      +

      getAllSchemas

      +
      List<org.apache.pulsar.common.schema.SchemaInfo> getAllSchemas(String topic) + throws PulsarAdminException
      +
      Get all version schemas topic.
      +
      +
      Parameters:
      +
      topic - topic name, in fully qualified format
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getAllSchemasAsync

      +
      CompletableFuture<List<org.apache.pulsar.common.schema.SchemaInfo>> getAllSchemasAsync(String topic)
      +
      Get all version schemas topic asynchronously.
      +
      +
      Parameters:
      +
      topic - topic name, in fully qualified format
      +
      +
      +
      • +
    • +
      +

      getSchemaMetadata

      +
      SchemaMetadata getSchemaMetadata(String topic) + throws PulsarAdminException
      +
      Get schema metadata of the topic.
      +
      +
      Parameters:
      +
      topic - topic name, in fully qualified format
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getSchemaMetadataAsync

      +
      CompletableFuture<SchemaMetadata> getSchemaMetadataAsync(String topic)
      +
      Get schema metadata of the topic asynchronously.
      +
      +
      Parameters:
      +
      topic - topic name, in fully qualified format
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/Sink.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/Sink.html new file mode 100644 index 000000000000..689e7e85db15 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/Sink.html @@ -0,0 +1,124 @@ + + + + +Sink (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.client.admin
+

Interface Sink

+
+
+
+
All Superinterfaces:
+
Sinks
+
+
+
@Deprecated +public interface Sink +extends Sinks
+
Deprecated. +
in favor of Sinks
+
+
+
+ +
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/Sinks.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/Sinks.html new file mode 100644 index 000000000000..ed577ed04b28 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/Sinks.html @@ -0,0 +1,1062 @@ + + + + +Sinks (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.client.admin
+

Interface Sinks

+
+
+
+
All Known Subinterfaces:
+
Sink
+
+
+
public interface Sinks
+
Admin interface for Sink management.
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      listSinks

      +
      List<String> listSinks(String tenant, + String namespace) + throws PulsarAdminException
      +
      Get the list of sinks. +

      + Get the list of all the Pulsar Sinks. +

      + Response Example: + + 

      + ["f1", "f2", "f3"]
+
      +
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      listSinksAsync

      +
      CompletableFuture<List<String>> listSinksAsync(String tenant, + String namespace)
      +
      Get the list of sinks asynchronously. +

      + Get the list of all the Pulsar Sinks. +

      + Response Example: + + 

      + ["f1", "f2", "f3"]
+
      +
      +
      • +
    • +
      +

      getSink

      +
      SinkConfig getSink(String tenant, + String namespace, + String sink) + throws PulsarAdminException
      +
      Get the configuration for the specified sink. +

      + Response Example: + + 

      + { serviceUrl : "http://my-broker.example.com:8080/" }
+
      +
      +
      Parameters:
      +
      tenant - Tenant name
      +
      namespace - Namespace name
      +
      sink - Sink name
      +
      Returns:
      +
      the sink configuration
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - You don't have admin permission to get the configuration of the cluster
      +
      PulsarAdminException.NotFoundException - Cluster doesn't exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getSinkAsync

      +
      CompletableFuture<SinkConfig> getSinkAsync(String tenant, + String namespace, + String sink)
      +
      Get the configuration for the specified sink asynchronously. +

      + Response Example: + + 

      + { serviceUrl : "http://my-broker.example.com:8080/" }
+
      +
      +
      Parameters:
      +
      tenant - Tenant name
      +
      namespace - Namespace name
      +
      sink - Sink name
      +
      Returns:
      +
      the sink configuration
      +
      +
      +
      • +
    • +
      +

      createSink

      +
      void createSink(SinkConfig sinkConfig, + String fileName) + throws PulsarAdminException
      +
      Create a new sink.
      +
      +
      Parameters:
      +
      sinkConfig - the sink configuration object
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      createSinkAsync

      +
      CompletableFuture<Void> createSinkAsync(SinkConfig sinkConfig, + String fileName)
      +
      Create a new sink asynchronously.
      +
      +
      Parameters:
      +
      sinkConfig - the sink configuration object
      +
      +
      +
      • +
    • +
      +

      createSinkWithUrl

      +
      void createSinkWithUrl(SinkConfig sinkConfig, + String pkgUrl) + throws PulsarAdminException
      +
      Create a new sink with package url. +

      + Create a new sink by providing url from which fun-pkg can be downloaded. supported url: http/file + eg: + File: file:/dir/fileName.jar + Http: http://www.repo.com/fileName.jar

      +
      +
      Parameters:
      +
      sinkConfig - the sink configuration object
      +
      pkgUrl - url from which pkg can be downloaded
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      createSinkWithUrlAsync

      +
      CompletableFuture<Void> createSinkWithUrlAsync(SinkConfig sinkConfig, + String pkgUrl)
      +
      Create a new sink with package url asynchronously. +

      + Create a new sink by providing url from which fun-pkg can be downloaded. supported url: http/file + eg: + File: file:/dir/fileName.jar + Http: http://www.repo.com/fileName.jar

      +
      +
      Parameters:
      +
      sinkConfig - the sink configuration object
      +
      pkgUrl - url from which pkg can be downloaded
      +
      +
      +
      • +
    • +
      +

      updateSink

      +
      void updateSink(SinkConfig sinkConfig, + String fileName) + throws PulsarAdminException
      +
      Update the configuration for a sink. +

      +
      +
      Parameters:
      +
      sinkConfig - the sink configuration object
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - You don't have admin permission to create the cluster
      +
      PulsarAdminException.NotFoundException - Cluster doesn't exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      updateSinkAsync

      +
      CompletableFuture<Void> updateSinkAsync(SinkConfig sinkConfig, + String fileName)
      +
      Update the configuration for a sink asynchronously. +

      +
      +
      Parameters:
      +
      sinkConfig - the sink configuration object
      +
      +
      +
      • +
    • +
      +

      updateSink

      +
      void updateSink(SinkConfig sinkConfig, + String fileName, + UpdateOptions updateOptions) + throws PulsarAdminException
      +
      Update the configuration for a sink. +

      +
      +
      Parameters:
      +
      sinkConfig - the sink configuration object
      +
      updateOptions - options for the update operations
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - You don't have admin permission to create the cluster
      +
      PulsarAdminException.NotFoundException - Cluster doesn't exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      updateSinkAsync

      +
      CompletableFuture<Void> updateSinkAsync(SinkConfig sinkConfig, + String fileName, + UpdateOptions updateOptions)
      +
      Update the configuration for a sink asynchronously. +

      +
      +
      Parameters:
      +
      sinkConfig - the sink configuration object
      +
      updateOptions - options for the update operations
      +
      +
      +
      • +
    • +
      +

      updateSinkWithUrl

      +
      void updateSinkWithUrl(SinkConfig sinkConfig, + String pkgUrl) + throws PulsarAdminException
      +
      Update the configuration for a sink. +

      + Update a sink by providing url from which fun-pkg can be downloaded. supported url: http/file + eg: + File: file:/dir/fileName.jar + Http: http://www.repo.com/fileName.jar

      +
      +
      Parameters:
      +
      sinkConfig - the sink configuration object
      +
      pkgUrl - url from which pkg can be downloaded
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - You don't have admin permission to create the cluster
      +
      PulsarAdminException.NotFoundException - Cluster doesn't exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      updateSinkWithUrlAsync

      +
      CompletableFuture<Void> updateSinkWithUrlAsync(SinkConfig sinkConfig, + String pkgUrl)
      +
      Update the configuration for a sink asynchronously. +

      + Update a sink by providing url from which fun-pkg can be downloaded. supported url: http/file + eg: + File: file:/dir/fileName.jar + Http: http://www.repo.com/fileName.jar

      +
      +
      Parameters:
      +
      sinkConfig - the sink configuration object
      +
      pkgUrl - url from which pkg can be downloaded
      +
      +
      +
      • +
    • +
      +

      updateSinkWithUrl

      +
      void updateSinkWithUrl(SinkConfig sinkConfig, + String pkgUrl, + UpdateOptions updateOptions) + throws PulsarAdminException
      +
      Update the configuration for a sink. +

      + Update a sink by providing url from which fun-pkg can be downloaded. supported url: http/file + eg: + File: file:/dir/fileName.jar + Http: http://www.repo.com/fileName.jar

      +
      +
      Parameters:
      +
      sinkConfig - the sink configuration object
      +
      pkgUrl - url from which pkg can be downloaded
      +
      updateOptions - options for the update operations
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - You don't have admin permission to create the cluster
      +
      PulsarAdminException.NotFoundException - Cluster doesn't exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      updateSinkWithUrlAsync

      +
      CompletableFuture<Void> updateSinkWithUrlAsync(SinkConfig sinkConfig, + String pkgUrl, + UpdateOptions updateOptions)
      +
      Update the configuration for a sink asynchronously. +

      + Update a sink by providing url from which fun-pkg can be downloaded. supported url: http/file + eg: + File: file:/dir/fileName.jar + Http: http://www.repo.com/fileName.jar

      +
      +
      Parameters:
      +
      sinkConfig - the sink configuration object
      +
      pkgUrl - url from which pkg can be downloaded
      +
      updateOptions - options for the update operations
      +
      +
      +
      • +
    • +
      +

      deleteSink

      +
      void deleteSink(String tenant, + String namespace, + String sink) + throws PulsarAdminException
      +
      Delete an existing sink. +

      + Delete a sink

      +
      +
      Parameters:
      +
      tenant - Tenant name
      +
      namespace - Namespace name
      +
      sink - Sink name
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - You don't have admin permission
      +
      PulsarAdminException.NotFoundException - Cluster does not exist
      +
      PulsarAdminException.PreconditionFailedException - Cluster is not empty
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      deleteSinkAsync

      +
      CompletableFuture<Void> deleteSinkAsync(String tenant, + String namespace, + String sink)
      +
      Delete an existing sink asynchronously. +

      + Delete a sink

      +
      +
      Parameters:
      +
      tenant - Tenant name
      +
      namespace - Namespace name
      +
      sink - Sink name
      +
      +
      +
      • +
    • +
      +

      getSinkStatus

      +
      SinkStatus getSinkStatus(String tenant, + String namespace, + String sink) + throws PulsarAdminException
      +
      Gets the current status of a sink.
      +
      +
      Parameters:
      +
      tenant - Tenant name
      +
      namespace - Namespace name
      +
      sink - Sink name
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getSinkStatusAsync

      +
      CompletableFuture<SinkStatus> getSinkStatusAsync(String tenant, + String namespace, + String sink)
      +
      Gets the current status of a sink asynchronously.
      +
      +
      Parameters:
      +
      tenant - Tenant name
      +
      namespace - Namespace name
      +
      sink - Sink name
      +
      +
      +
      • +
    • +
      +

      getSinkStatus

      +
      SinkStatus.SinkInstanceStatus.SinkInstanceStatusData getSinkStatus(String tenant, + String namespace, + String sink, + int id) + throws PulsarAdminException
      +
      Gets the current status of a sink instance.
      +
      +
      Parameters:
      +
      tenant - Tenant name
      +
      namespace - Namespace name
      +
      sink - Sink name
      +
      id - Sink instance-id
      +
      Returns:
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getSinkStatusAsync

      +
      CompletableFuture<SinkStatus.SinkInstanceStatus.SinkInstanceStatusData> getSinkStatusAsync(String tenant, + String namespace, + String sink, + int id)
      +
      Gets the current status of a sink instance asynchronously.
      +
      +
      Parameters:
      +
      tenant - Tenant name
      +
      namespace - Namespace name
      +
      sink - Sink name
      +
      id - Sink instance-id
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      restartSink

      +
      void restartSink(String tenant, + String namespace, + String sink, + int instanceId) + throws PulsarAdminException
      +
      Restart sink instance.
      +
      +
      Parameters:
      +
      tenant - Tenant name
      +
      namespace - Namespace name
      +
      sink - Sink name
      +
      instanceId - Sink instanceId
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      restartSinkAsync

      +
      CompletableFuture<Void> restartSinkAsync(String tenant, + String namespace, + String sink, + int instanceId)
      +
      Restart sink instance asynchronously.
      +
      +
      Parameters:
      +
      tenant - Tenant name
      +
      namespace - Namespace name
      +
      sink - Sink name
      +
      instanceId - Sink instanceId
      +
      +
      +
      • +
    • +
      +

      restartSink

      +
      void restartSink(String tenant, + String namespace, + String sink) + throws PulsarAdminException
      +
      Restart all sink instances.
      +
      +
      Parameters:
      +
      tenant - Tenant name
      +
      namespace - Namespace name
      +
      sink - Sink name
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      restartSinkAsync

      +
      CompletableFuture<Void> restartSinkAsync(String tenant, + String namespace, + String sink)
      +
      Restart all sink instances asynchronously.
      +
      +
      Parameters:
      +
      tenant - Tenant name
      +
      namespace - Namespace name
      +
      sink - Sink name
      +
      +
      +
      • +
    • +
      +

      stopSink

      +
      void stopSink(String tenant, + String namespace, + String sink, + int instanceId) + throws PulsarAdminException
      +
      Stop sink instance.
      +
      +
      Parameters:
      +
      tenant - Tenant name
      +
      namespace - Namespace name
      +
      sink - Sink name
      +
      instanceId - Sink instanceId
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      stopSinkAsync

      +
      CompletableFuture<Void> stopSinkAsync(String tenant, + String namespace, + String sink, + int instanceId)
      +
      Stop sink instance asynchronously.
      +
      +
      Parameters:
      +
      tenant - Tenant name
      +
      namespace - Namespace name
      +
      sink - Sink name
      +
      instanceId - Sink instanceId
      +
      +
      +
      • +
    • +
      +

      stopSink

      +
      void stopSink(String tenant, + String namespace, + String sink) + throws PulsarAdminException
      +
      Stop all sink instances.
      +
      +
      Parameters:
      +
      tenant - Tenant name
      +
      namespace - Namespace name
      +
      sink - Sink name
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      stopSinkAsync

      +
      CompletableFuture<Void> stopSinkAsync(String tenant, + String namespace, + String sink)
      +
      Stop all sink instances asynchronously.
      +
      +
      Parameters:
      +
      tenant - Tenant name
      +
      namespace - Namespace name
      +
      sink - Sink name
      +
      +
      +
      • +
    • +
      +

      startSink

      +
      void startSink(String tenant, + String namespace, + String sink, + int instanceId) + throws PulsarAdminException
      +
      Start sink instance.
      +
      +
      Parameters:
      +
      tenant - Tenant name
      +
      namespace - Namespace name
      +
      sink - Sink name
      +
      instanceId - Sink instanceId
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      startSinkAsync

      +
      CompletableFuture<Void> startSinkAsync(String tenant, + String namespace, + String sink, + int instanceId)
      +
      Start sink instance asynchronously.
      +
      +
      Parameters:
      +
      tenant - Tenant name
      +
      namespace - Namespace name
      +
      sink - Sink name
      +
      instanceId - Sink instanceId
      +
      +
      +
      • +
    • +
      +

      startSink

      +
      void startSink(String tenant, + String namespace, + String sink) + throws PulsarAdminException
      +
      Start all sink instances.
      +
      +
      Parameters:
      +
      tenant - Tenant name
      +
      namespace - Namespace name
      +
      sink - Sink name
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      startSinkAsync

      +
      CompletableFuture<Void> startSinkAsync(String tenant, + String namespace, + String sink)
      +
      Start all sink instances asynchronously.
      +
      +
      Parameters:
      +
      tenant - Tenant name
      +
      namespace - Namespace name
      +
      sink - Sink name
      +
      +
      +
      • +
    • +
      +

      getBuiltInSinks

      +
      List<ConnectorDefinition> getBuiltInSinks() + throws PulsarAdminException
      +
      Fetches a list of supported Pulsar IO sinks currently running in cluster mode.
      +
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getBuiltInSinksAsync

      +
      CompletableFuture<List<ConnectorDefinition>> getBuiltInSinksAsync()
      +
      Fetches a list of supported Pulsar IO sinks currently running in cluster mode asynchronously.
      +
      +
      • +
    • +
      +

      reloadBuiltInSinks

      +
      void reloadBuiltInSinks() + throws PulsarAdminException
      +
      Reload the available built-in connectors, include Source and Sink.
      +
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      reloadBuiltInSinksAsync

      +
      CompletableFuture<Void> reloadBuiltInSinksAsync()
      +
      Reload the available built-in connectors, include Source and Sink asynchronously.
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/Source.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/Source.html new file mode 100644 index 000000000000..2a7df7ae35c9 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/Source.html @@ -0,0 +1,124 @@ + + + + +Source (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.client.admin
+

Interface Source

+
+
+
+
All Superinterfaces:
+
Sources
+
+
+
@Deprecated +public interface Source +extends Sources
+
Deprecated. +
in favor of Sources
+
+
+
+ +
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/Sources.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/Sources.html new file mode 100644 index 000000000000..f358d038a325 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/Sources.html @@ -0,0 +1,1062 @@ + + + + +Sources (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.client.admin
+

Interface Sources

+
+
+
+
All Known Subinterfaces:
+
Source
+
+
+
public interface Sources
+
Admin interface for Source management.
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      listSources

      +
      List<String> listSources(String tenant, + String namespace) + throws PulsarAdminException
      +
      Get the list of sources. +

      + Get the list of all the Pulsar Sources. +

      + Response Example: + + 

      + ["f1", "f2", "f3"]
+
      +
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      listSourcesAsync

      +
      CompletableFuture<List<String>> listSourcesAsync(String tenant, + String namespace)
      +
      Get the list of sources asynchronously. +

      + Get the list of all the Pulsar Sources. +

      + Response Example: + + 

      + ["f1", "f2", "f3"]
+
      +
      +
      • +
    • +
      +

      getSource

      +
      SourceConfig getSource(String tenant, + String namespace, + String source) + throws PulsarAdminException
      +
      Get the configuration for the specified source. +

      + Response Example: + + 

      + { serviceUrl : "http://my-broker.example.com:8080/" }
+
      +
      +
      Parameters:
      +
      tenant - Tenant name
      +
      namespace - Namespace name
      +
      source - Source name
      +
      Returns:
      +
      the source configuration
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - You don't have admin permission to get the configuration of the cluster
      +
      PulsarAdminException.NotFoundException - Cluster doesn't exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getSourceAsync

      +
      CompletableFuture<SourceConfig> getSourceAsync(String tenant, + String namespace, + String source)
      +
      Get the configuration for the specified source asynchronously. +

      + Response Example: + + 

      + { serviceUrl : "http://my-broker.example.com:8080/" }
+
      +
      +
      Parameters:
      +
      tenant - Tenant name
      +
      namespace - Namespace name
      +
      source - Source name
      +
      Returns:
      +
      the source configuration
      +
      +
      +
      • +
    • +
      +

      createSource

      +
      void createSource(SourceConfig sourceConfig, + String fileName) + throws PulsarAdminException
      +
      Create a new source.
      +
      +
      Parameters:
      +
      sourceConfig - the source configuration object
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      createSourceAsync

      +
      CompletableFuture<Void> createSourceAsync(SourceConfig sourceConfig, + String fileName)
      +
      Create a new source asynchronously.
      +
      +
      Parameters:
      +
      sourceConfig - the source configuration object
      +
      +
      +
      • +
    • +
      +

      createSourceWithUrl

      +
      void createSourceWithUrl(SourceConfig sourceConfig, + String pkgUrl) + throws PulsarAdminException
      +
      Create a new source with package url. +

      + Create a new source by providing url from which fun-pkg can be downloaded. supported url: http/file + eg: + File: file:/dir/fileName.jar + Http: http://www.repo.com/fileName.jar

      +
      +
      Parameters:
      +
      sourceConfig - the source configuration object
      +
      pkgUrl - url from which pkg can be downloaded
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      createSourceWithUrlAsync

      +
      CompletableFuture<Void> createSourceWithUrlAsync(SourceConfig sourceConfig, + String pkgUrl)
      +
      Create a new source with package url asynchronously. +

      + Create a new source by providing url from which fun-pkg can be downloaded. supported url: http/file + eg: + File: file:/dir/fileName.jar + Http: http://www.repo.com/fileName.jar

      +
      +
      Parameters:
      +
      sourceConfig - the source configuration object
      +
      pkgUrl - url from which pkg can be downloaded
      +
      +
      +
      • +
    • +
      +

      updateSource

      +
      void updateSource(SourceConfig sourceConfig, + String fileName) + throws PulsarAdminException
      +
      Update the configuration for a source. +

      +
      +
      Parameters:
      +
      sourceConfig - the source configuration object
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - You don't have admin permission to create the cluster
      +
      PulsarAdminException.NotFoundException - Cluster doesn't exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      updateSourceAsync

      +
      CompletableFuture<Void> updateSourceAsync(SourceConfig sourceConfig, + String fileName)
      +
      Update the configuration for a source asynchronously. +

      +
      +
      Parameters:
      +
      sourceConfig - the source configuration object
      +
      +
      +
      • +
    • +
      +

      updateSource

      +
      void updateSource(SourceConfig sourceConfig, + String fileName, + UpdateOptions updateOptions) + throws PulsarAdminException
      +
      Update the configuration for a source. +

      +
      +
      Parameters:
      +
      sourceConfig - the source configuration object
      +
      updateOptions - options for the update operations
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - You don't have admin permission to create the cluster
      +
      PulsarAdminException.NotFoundException - Cluster doesn't exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      updateSourceAsync

      +
      CompletableFuture<Void> updateSourceAsync(SourceConfig sourceConfig, + String fileName, + UpdateOptions updateOptions)
      +
      Update the configuration for a source asynchronously. +

      +
      +
      Parameters:
      +
      sourceConfig - the source configuration object
      +
      updateOptions - options for the update operations
      +
      +
      +
      • +
    • +
      +

      updateSourceWithUrl

      +
      void updateSourceWithUrl(SourceConfig sourceConfig, + String pkgUrl) + throws PulsarAdminException
      +
      Update the configuration for a source. +

      + Update a source by providing url from which fun-pkg can be downloaded. supported url: http/file + eg: + File: file:/dir/fileName.jar + Http: http://www.repo.com/fileName.jar

      +
      +
      Parameters:
      +
      sourceConfig - the source configuration object
      +
      pkgUrl - url from which pkg can be downloaded
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - You don't have admin permission to create the cluster
      +
      PulsarAdminException.NotFoundException - Cluster doesn't exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      updateSourceWithUrlAsync

      +
      CompletableFuture<Void> updateSourceWithUrlAsync(SourceConfig sourceConfig, + String pkgUrl)
      +
      Update the configuration for a source asynchronously. +

      + Update a source by providing url from which fun-pkg can be downloaded. supported url: http/file + eg: + File: file:/dir/fileName.jar + Http: http://www.repo.com/fileName.jar

      +
      +
      Parameters:
      +
      sourceConfig - the source configuration object
      +
      pkgUrl - url from which pkg can be downloaded
      +
      +
      +
      • +
    • +
      +

      updateSourceWithUrl

      +
      void updateSourceWithUrl(SourceConfig sourceConfig, + String pkgUrl, + UpdateOptions updateOptions) + throws PulsarAdminException
      +
      Update the configuration for a source. +

      + Update a source by providing url from which fun-pkg can be downloaded. supported url: http/file + eg: + File: file:/dir/fileName.jar + Http: http://www.repo.com/fileName.jar

      +
      +
      Parameters:
      +
      sourceConfig - the source configuration object
      +
      pkgUrl - url from which pkg can be downloaded
      +
      updateOptions - options for the update operations
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - You don't have admin permission to create the cluster
      +
      PulsarAdminException.NotFoundException - Cluster doesn't exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      updateSourceWithUrlAsync

      +
      CompletableFuture<Void> updateSourceWithUrlAsync(SourceConfig sourceConfig, + String pkgUrl, + UpdateOptions updateOptions)
      +
      Update the configuration for a source asynchronously. +

      + Update a source by providing url from which fun-pkg can be downloaded. supported url: http/file + eg: + File: file:/dir/fileName.jar + Http: http://www.repo.com/fileName.jar

      +
      +
      Parameters:
      +
      sourceConfig - the source configuration object
      +
      pkgUrl - url from which pkg can be downloaded
      +
      updateOptions - options for the update operations
      +
      +
      +
      • +
    • +
      +

      deleteSource

      +
      void deleteSource(String tenant, + String namespace, + String source) + throws PulsarAdminException
      +
      Delete an existing source. +

      + Delete a source

      +
      +
      Parameters:
      +
      tenant - Tenant name
      +
      namespace - Namespace name
      +
      source - Source name
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - You don't have admin permission
      +
      PulsarAdminException.NotFoundException - Cluster does not exist
      +
      PulsarAdminException.PreconditionFailedException - Cluster is not empty
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      deleteSourceAsync

      +
      CompletableFuture<Void> deleteSourceAsync(String tenant, + String namespace, + String source)
      +
      Delete an existing source asynchronously. +

      + Delete a source

      +
      +
      Parameters:
      +
      tenant - Tenant name
      +
      namespace - Namespace name
      +
      source - Source name
      +
      +
      +
      • +
    • +
      +

      getSourceStatus

      +
      SourceStatus getSourceStatus(String tenant, + String namespace, + String source) + throws PulsarAdminException
      +
      Gets the current status of a source.
      +
      +
      Parameters:
      +
      tenant - Tenant name
      +
      namespace - Namespace name
      +
      source - Source name
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getSourceStatusAsync

      +
      CompletableFuture<SourceStatus> getSourceStatusAsync(String tenant, + String namespace, + String source)
      +
      Gets the current status of a source asynchronously.
      +
      +
      Parameters:
      +
      tenant - Tenant name
      +
      namespace - Namespace name
      +
      source - Source name
      +
      +
      +
      • +
    • +
      +

      getSourceStatus

      +
      SourceStatus.SourceInstanceStatus.SourceInstanceStatusData getSourceStatus(String tenant, + String namespace, + String source, + int id) + throws PulsarAdminException
      +
      Gets the current status of a source instance.
      +
      +
      Parameters:
      +
      tenant - Tenant name
      +
      namespace - Namespace name
      +
      source - Source name
      +
      id - Source instance-id
      +
      Returns:
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getSourceStatusAsync

      +
      CompletableFuture<SourceStatus.SourceInstanceStatus.SourceInstanceStatusData> getSourceStatusAsync(String tenant, + String namespace, + String source, + int id)
      +
      Gets the current status of a source instance asynchronously.
      +
      +
      Parameters:
      +
      tenant - Tenant name
      +
      namespace - Namespace name
      +
      source - Source name
      +
      id - Source instance-id
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      restartSource

      +
      void restartSource(String tenant, + String namespace, + String source, + int instanceId) + throws PulsarAdminException
      +
      Restart source instance.
      +
      +
      Parameters:
      +
      tenant - Tenant name
      +
      namespace - Namespace name
      +
      source - Source name
      +
      instanceId - Source instanceId
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      restartSourceAsync

      +
      CompletableFuture<Void> restartSourceAsync(String tenant, + String namespace, + String source, + int instanceId)
      +
      Restart source instance asynchronously.
      +
      +
      Parameters:
      +
      tenant - Tenant name
      +
      namespace - Namespace name
      +
      source - Source name
      +
      instanceId - Source instanceId
      +
      +
      +
      • +
    • +
      +

      restartSource

      +
      void restartSource(String tenant, + String namespace, + String source) + throws PulsarAdminException
      +
      Restart all source instances.
      +
      +
      Parameters:
      +
      tenant - Tenant name
      +
      namespace - Namespace name
      +
      source - Source name
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      restartSourceAsync

      +
      CompletableFuture<Void> restartSourceAsync(String tenant, + String namespace, + String source)
      +
      Restart all source instances asynchronously.
      +
      +
      Parameters:
      +
      tenant - Tenant name
      +
      namespace - Namespace name
      +
      source - Source name
      +
      +
      +
      • +
    • +
      +

      stopSource

      +
      void stopSource(String tenant, + String namespace, + String source, + int instanceId) + throws PulsarAdminException
      +
      Stop source instance.
      +
      +
      Parameters:
      +
      tenant - Tenant name
      +
      namespace - Namespace name
      +
      source - Source name
      +
      instanceId - Source instanceId
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      stopSourceAsync

      +
      CompletableFuture<Void> stopSourceAsync(String tenant, + String namespace, + String source, + int instanceId)
      +
      Stop source instance asynchronously.
      +
      +
      Parameters:
      +
      tenant - Tenant name
      +
      namespace - Namespace name
      +
      source - Source name
      +
      instanceId - Source instanceId
      +
      +
      +
      • +
    • +
      +

      stopSource

      +
      void stopSource(String tenant, + String namespace, + String source) + throws PulsarAdminException
      +
      Stop all source instances.
      +
      +
      Parameters:
      +
      tenant - Tenant name
      +
      namespace - Namespace name
      +
      source - Source name
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      stopSourceAsync

      +
      CompletableFuture<Void> stopSourceAsync(String tenant, + String namespace, + String source)
      +
      Stop all source instances asynchronously.
      +
      +
      Parameters:
      +
      tenant - Tenant name
      +
      namespace - Namespace name
      +
      source - Source name
      +
      +
      +
      • +
    • +
      +

      startSource

      +
      void startSource(String tenant, + String namespace, + String source, + int instanceId) + throws PulsarAdminException
      +
      Start source instance.
      +
      +
      Parameters:
      +
      tenant - Tenant name
      +
      namespace - Namespace name
      +
      source - Source name
      +
      instanceId - Source instanceId
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      startSourceAsync

      +
      CompletableFuture<Void> startSourceAsync(String tenant, + String namespace, + String source, + int instanceId)
      +
      Start source instance asynchronously.
      +
      +
      Parameters:
      +
      tenant - Tenant name
      +
      namespace - Namespace name
      +
      source - Source name
      +
      instanceId - Source instanceId
      +
      +
      +
      • +
    • +
      +

      startSource

      +
      void startSource(String tenant, + String namespace, + String source) + throws PulsarAdminException
      +
      Start all source instances.
      +
      +
      Parameters:
      +
      tenant - Tenant name
      +
      namespace - Namespace name
      +
      source - Source name
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      startSourceAsync

      +
      CompletableFuture<Void> startSourceAsync(String tenant, + String namespace, + String source)
      +
      Start all source instances asynchronously.
      +
      +
      Parameters:
      +
      tenant - Tenant name
      +
      namespace - Namespace name
      +
      source - Source name
      +
      +
      +
      • +
    • +
      +

      getBuiltInSources

      +
      List<ConnectorDefinition> getBuiltInSources() + throws PulsarAdminException
      +
      Fetches a list of supported Pulsar IO sources currently running in cluster mode.
      +
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getBuiltInSourcesAsync

      +
      CompletableFuture<List<ConnectorDefinition>> getBuiltInSourcesAsync()
      +
      Fetches a list of supported Pulsar IO sources currently running in cluster mode asynchronously.
      +
      +
      • +
    • +
      +

      reloadBuiltInSources

      +
      void reloadBuiltInSources() + throws PulsarAdminException
      +
      Reload the available built-in connectors, include Source and Source.
      +
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      reloadBuiltInSourcesAsync

      +
      CompletableFuture<Void> reloadBuiltInSourcesAsync()
      +
      Reload the available built-in connectors, include Source and Source asynchronously.
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/Tenants.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/Tenants.html new file mode 100644 index 000000000000..29449702ca46 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/Tenants.html @@ -0,0 +1,413 @@ + + + + +Tenants (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.client.admin
+

Interface Tenants

+
+
+
+
public interface Tenants
+
Admin interface for tenants management.
+
+
+ +
+
+ +
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/TopicPolicies.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/TopicPolicies.html new file mode 100644 index 000000000000..00d18183bd8d --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/TopicPolicies.html @@ -0,0 +1,4073 @@ + + + + +TopicPolicies (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.client.admin
+

Interface TopicPolicies

+
+
+
+
public interface TopicPolicies
+
Admin interface for topic policies management.
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getBacklogQuotaMap

      +
      Map<BacklogQuota.BacklogQuotaType,BacklogQuota> getBacklogQuotaMap(String topic) + throws PulsarAdminException
      +
      Get backlog quota map for a topic.
      +
      +
      Parameters:
      +
      topic - Topic name
      +
      Throws:
      +
      PulsarAdminException.NotFoundException - Topic does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getBacklogQuotaMap

      +
      Map<BacklogQuota.BacklogQuotaType,BacklogQuota> getBacklogQuotaMap(String topic, + boolean applied) + throws PulsarAdminException
      +
      Get applied backlog quota map for a topic.
      +
      +
      Parameters:
      +
      topic -
      +
      applied -
      +
      Returns:
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      setBacklogQuota

      +
      void setBacklogQuota(String topic, + BacklogQuota backlogQuota, + BacklogQuota.BacklogQuotaType backlogQuotaType) + throws PulsarAdminException
      +
      Set a backlog quota for a topic.
      +
      +
      Parameters:
      +
      topic - Topic name
      +
      backlogQuota - the new BacklogQuota
      +
      backlogQuotaType -
      +
      Throws:
      +
      PulsarAdminException.NotFoundException - Topic does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      setBacklogQuota

      +
      default void setBacklogQuota(String topic, + BacklogQuota backlogQuota) + throws PulsarAdminException
      +
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      removeBacklogQuota

      +
      void removeBacklogQuota(String topic, + BacklogQuota.BacklogQuotaType backlogQuotaType) + throws PulsarAdminException
      +
      Remove a backlog quota policy from a topic. + The namespace backlog policy falls back to the default.
      +
      +
      Parameters:
      +
      topic - Topic name
      +
      backlogQuotaType -
      +
      Throws:
      +
      PulsarAdminException.NotFoundException - Topic does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      removeBacklogQuota

      +
      default void removeBacklogQuota(String topic) + throws PulsarAdminException
      +
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getDelayedDeliveryPolicy

      +
      DelayedDeliveryPolicies getDelayedDeliveryPolicy(String topic, + boolean applied) + throws PulsarAdminException
      +
      Get the delayed delivery policy applied for a specified topic.
      +
      +
      Parameters:
      +
      topic -
      +
      applied -
      +
      Returns:
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getDelayedDeliveryPolicyAsync

      +
      CompletableFuture<DelayedDeliveryPolicies> getDelayedDeliveryPolicyAsync(String topic, + boolean applied)
      +
      Get the delayed delivery policy applied for a specified topic asynchronously.
      +
      +
      Parameters:
      +
      topic -
      +
      applied -
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      getDelayedDeliveryPolicy

      +
      DelayedDeliveryPolicies getDelayedDeliveryPolicy(String topic) + throws PulsarAdminException
      +
      Get the delayed delivery policy for a specified topic.
      +
      +
      Parameters:
      +
      topic -
      +
      Returns:
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getDelayedDeliveryPolicyAsync

      +
      CompletableFuture<DelayedDeliveryPolicies> getDelayedDeliveryPolicyAsync(String topic)
      +
      Get the delayed delivery policy for a specified topic asynchronously.
      +
      +
      Parameters:
      +
      topic -
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      setDelayedDeliveryPolicy

      +
      void setDelayedDeliveryPolicy(String topic, + DelayedDeliveryPolicies delayedDeliveryPolicies) + throws PulsarAdminException
      +
      Set the delayed delivery policy for a specified topic.
      +
      +
      Parameters:
      +
      topic -
      +
      delayedDeliveryPolicies -
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      setDelayedDeliveryPolicyAsync

      +
      CompletableFuture<Void> setDelayedDeliveryPolicyAsync(String topic, + DelayedDeliveryPolicies delayedDeliveryPolicies)
      +
      Set the delayed delivery policy for a specified topic asynchronously.
      +
      +
      Parameters:
      +
      topic -
      +
      delayedDeliveryPolicies -
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      removeDelayedDeliveryPolicyAsync

      +
      CompletableFuture<Void> removeDelayedDeliveryPolicyAsync(String topic)
      +
      Remove the delayed delivery policy for a specified topic asynchronously.
      +
      +
      Parameters:
      +
      topic -
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      removeDelayedDeliveryPolicy

      +
      void removeDelayedDeliveryPolicy(String topic) + throws PulsarAdminException
      +
      Remove the delayed delivery policy for a specified topic.
      +
      +
      Parameters:
      +
      topic -
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      setMessageTTL

      +
      void setMessageTTL(String topic, + int messageTTLInSecond) + throws PulsarAdminException
      +
      Set message TTL for a topic.
      +
      +
      Parameters:
      +
      topic - Topic name
      +
      messageTTLInSecond - Message TTL in second.
      +
      +
      +
      • +
    • +
      +

      getMessageTTL

      +
      Integer getMessageTTL(String topic) + throws PulsarAdminException
      +
      Get message TTL for a topic.
      +
      +
      Parameters:
      +
      topic -
      +
      Returns:
      +
      Message TTL in second.
      +
      +
      +
      • +
    • +
      +

      getMessageTTL

      +
      Integer getMessageTTL(String topic, + boolean applied) + throws PulsarAdminException
      +
      Get message TTL applied for a topic.
      +
      +
      Parameters:
      +
      topic -
      +
      Returns:
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      removeMessageTTL

      +
      void removeMessageTTL(String topic) + throws PulsarAdminException
      +
      Remove message TTL for a topic.
      +
      +
      Parameters:
      +
      topic -
      +
      +
      +
      • +
    • +
      +

      setRetention

      +
      void setRetention(String topic, + RetentionPolicies retention) + throws PulsarAdminException
      +
      Set the retention configuration on a topic. +

      + Set the retention configuration on a topic. This operation requires Pulsar super-user access. +

      + Request parameter example: +

      + + 

      + 
+ {
+     "retentionTimeInMinutes" : 60,            // how long to retain messages
+     "retentionSizeInMB" : 1024,              // retention backlog limit
+ }
+ 
+
      +
      +
      Parameters:
      +
      topic - Topic name
      +
      +
      +
      • +
    • +
      +

      setRetentionAsync

      +
      CompletableFuture<Void> setRetentionAsync(String topic, + RetentionPolicies retention)
      +
      Set the retention configuration for all the topics on a topic asynchronously. +

      + Set the retention configuration on a topic. This operation requires Pulsar super-user access. +

      + Request parameter example: +

      + + 

      + 
+ {
+     "retentionTimeInMinutes" : 60,            // how long to retain messages
+     "retentionSizeInMB" : 1024,              // retention backlog limit
+ }
+ 
+
      +
      +
      Parameters:
      +
      topic - Topic name
      +
      +
      +
      • +
    • +
      +

      getRetention

      +
      RetentionPolicies getRetention(String topic) + throws PulsarAdminException
      +
      Get the retention configuration for a topic. +

      + Get the retention configuration for a topic. +

      + Response example: +

      + + 

      + 
+ {
+     "retentionTimeInMinutes" : 60,            // how long to retain messages
+     "retentionSizeInMB" : 1024,              // retention backlog limit
+ }
+ 
+
      +
      +
      Parameters:
      +
      topic - Topic name
      +
      +
      +
      • +
    • +
      +

      getRetentionAsync

      +
      CompletableFuture<RetentionPolicies> getRetentionAsync(String topic)
      +
      Get the retention configuration for a topic asynchronously. +

      + Get the retention configuration for a topic. +

      +
      +
      Parameters:
      +
      topic - Topic name
      +
      +
      +
      • +
    • +
      +

      getRetention

      +
      RetentionPolicies getRetention(String topic, + boolean applied) + throws PulsarAdminException
      +
      Get the applied retention configuration for a topic.
      +
      +
      Parameters:
      +
      topic -
      +
      applied -
      +
      Returns:
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getRetentionAsync

      +
      CompletableFuture<RetentionPolicies> getRetentionAsync(String topic, + boolean applied)
      +
      Get the applied retention configuration for a topic asynchronously.
      +
      +
      Parameters:
      +
      topic -
      +
      applied -
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      removeRetention

      +
      void removeRetention(String topic) + throws PulsarAdminException
      +
      Remove the retention configuration for all the topics on a topic. +

      + Remove the retention configuration on a topic. This operation requires Pulsar super-user access. +

      + Request parameter example: +

      +
      +
      Parameters:
      +
      topic - Topic name
      +
      +
      +
      • +
    • +
      +

      removeRetentionAsync

      +
      CompletableFuture<Void> removeRetentionAsync(String topic)
      +
      Remove the retention configuration for all the topics on a topic asynchronously. +

      + Remove the retention configuration on a topic. This operation requires Pulsar super-user access. +

      + Request parameter example: +

      + + 

      + 
+ {
+     "retentionTimeInMinutes" : 60,            // how long to retain messages
+     "retentionSizeInMB" : 1024,              // retention backlog limit
+ }
+ 
+
      +
      +
      Parameters:
      +
      topic - Topic name
      +
      +
      +
      • +
    • +
      +

      getMaxUnackedMessagesOnConsumer

      +
      Integer getMaxUnackedMessagesOnConsumer(String topic) + throws PulsarAdminException
      +
      Get max unacked messages on a consumer of a topic.
      +
      +
      Parameters:
      +
      topic -
      +
      Returns:
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getMaxUnackedMessagesOnConsumerAsync

      +
      CompletableFuture<Integer> getMaxUnackedMessagesOnConsumerAsync(String topic)
      +
      get max unacked messages on consumer of a topic asynchronously.
      +
      +
      Parameters:
      +
      topic -
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      getMaxUnackedMessagesOnConsumer

      +
      Integer getMaxUnackedMessagesOnConsumer(String topic, + boolean applied) + throws PulsarAdminException
      +
      get applied max unacked messages on consumer of a topic.
      +
      +
      Parameters:
      +
      topic -
      +
      applied -
      +
      Returns:
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getMaxUnackedMessagesOnConsumerAsync

      +
      CompletableFuture<Integer> getMaxUnackedMessagesOnConsumerAsync(String topic, + boolean applied)
      +
      get applied max unacked messages on consumer of a topic asynchronously.
      +
      +
      Parameters:
      +
      topic -
      +
      applied -
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      setMaxUnackedMessagesOnConsumer

      +
      void setMaxUnackedMessagesOnConsumer(String topic, + int maxNum) + throws PulsarAdminException
      +
      set max unacked messages on consumer of a topic.
      +
      +
      Parameters:
      +
      topic -
      +
      maxNum -
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      setMaxUnackedMessagesOnConsumerAsync

      +
      CompletableFuture<Void> setMaxUnackedMessagesOnConsumerAsync(String topic, + int maxNum)
      +
      set max unacked messages on consumer of a topic asynchronously.
      +
      +
      Parameters:
      +
      topic -
      +
      maxNum -
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      removeMaxUnackedMessagesOnConsumer

      +
      void removeMaxUnackedMessagesOnConsumer(String topic) + throws PulsarAdminException
      +
      remove max unacked messages on consumer of a topic.
      +
      +
      Parameters:
      +
      topic -
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      removeMaxUnackedMessagesOnConsumerAsync

      +
      CompletableFuture<Void> removeMaxUnackedMessagesOnConsumerAsync(String topic)
      +
      remove max unacked messages on consumer of a topic asynchronously.
      +
      +
      Parameters:
      +
      topic -
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      getInactiveTopicPolicies

      +
      InactiveTopicPolicies getInactiveTopicPolicies(String topic, + boolean applied) + throws PulsarAdminException
      +
      Get inactive topic policies applied for a topic.
      +
      +
      Parameters:
      +
      topic -
      +
      Returns:
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getInactiveTopicPoliciesAsync

      +
      CompletableFuture<InactiveTopicPolicies> getInactiveTopicPoliciesAsync(String topic, + boolean applied)
      +
      Get inactive topic policies applied for a topic asynchronously.
      +
      +
      Parameters:
      +
      topic -
      +
      applied -
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      getInactiveTopicPolicies

      +
      InactiveTopicPolicies getInactiveTopicPolicies(String topic) + throws PulsarAdminException
      +
      get inactive topic policies of a topic.
      +
      +
      Parameters:
      +
      topic -
      +
      Returns:
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getInactiveTopicPoliciesAsync

      +
      CompletableFuture<InactiveTopicPolicies> getInactiveTopicPoliciesAsync(String topic)
      +
      get inactive topic policies of a topic asynchronously.
      +
      +
      Parameters:
      +
      topic -
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      setInactiveTopicPolicies

      +
      void setInactiveTopicPolicies(String topic, + InactiveTopicPolicies inactiveTopicPolicies) + throws PulsarAdminException
      +
      set inactive topic policies of a topic.
      +
      +
      Parameters:
      +
      topic -
      +
      inactiveTopicPolicies -
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      setInactiveTopicPoliciesAsync

      +
      CompletableFuture<Void> setInactiveTopicPoliciesAsync(String topic, + InactiveTopicPolicies inactiveTopicPolicies)
      +
      set inactive topic policies of a topic asynchronously.
      +
      +
      Parameters:
      +
      topic -
      +
      inactiveTopicPolicies -
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      removeInactiveTopicPolicies

      +
      void removeInactiveTopicPolicies(String topic) + throws PulsarAdminException
      +
      remove inactive topic policies of a topic.
      +
      +
      Parameters:
      +
      topic -
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      removeInactiveTopicPoliciesAsync

      +
      CompletableFuture<Void> removeInactiveTopicPoliciesAsync(String topic)
      +
      remove inactive topic policies of a topic asynchronously.
      +
      +
      Parameters:
      +
      topic -
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      getOffloadPolicies

      +
      OffloadPolicies getOffloadPolicies(String topic) + throws PulsarAdminException
      +
      get offload policies of a topic.
      +
      +
      Parameters:
      +
      topic -
      +
      Returns:
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getOffloadPoliciesAsync

      +
      CompletableFuture<OffloadPolicies> getOffloadPoliciesAsync(String topic)
      +
      get offload policies of a topic asynchronously.
      +
      +
      Parameters:
      +
      topic -
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      getOffloadPolicies

      +
      OffloadPolicies getOffloadPolicies(String topic, + boolean applied) + throws PulsarAdminException
      +
      get applied offload policies of a topic.
      +
      +
      Parameters:
      +
      topic -
      +
      Returns:
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getOffloadPoliciesAsync

      +
      CompletableFuture<OffloadPolicies> getOffloadPoliciesAsync(String topic, + boolean applied)
      +
      get applied offload policies of a topic asynchronously.
      +
      +
      Parameters:
      +
      topic -
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      setOffloadPolicies

      +
      void setOffloadPolicies(String topic, + OffloadPolicies offloadPolicies) + throws PulsarAdminException
      +
      set offload policies of a topic.
      +
      +
      Parameters:
      +
      topic -
      +
      offloadPolicies -
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      setOffloadPoliciesAsync

      +
      CompletableFuture<Void> setOffloadPoliciesAsync(String topic, + OffloadPolicies offloadPolicies)
      +
      set offload policies of a topic asynchronously.
      +
      +
      Parameters:
      +
      topic -
      +
      offloadPolicies -
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      removeOffloadPolicies

      +
      void removeOffloadPolicies(String topic) + throws PulsarAdminException
      +
      remove offload policies of a topic.
      +
      +
      Parameters:
      +
      topic -
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      removeOffloadPoliciesAsync

      +
      CompletableFuture<Void> removeOffloadPoliciesAsync(String topic)
      +
      remove offload policies of a topic asynchronously.
      +
      +
      Parameters:
      +
      topic -
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      getMaxUnackedMessagesOnSubscription

      +
      Integer getMaxUnackedMessagesOnSubscription(String topic) + throws PulsarAdminException
      +
      get max unacked messages on subscription of a topic.
      +
      +
      Parameters:
      +
      topic -
      +
      Returns:
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getMaxUnackedMessagesOnSubscriptionAsync

      +
      CompletableFuture<Integer> getMaxUnackedMessagesOnSubscriptionAsync(String topic)
      +
      get max unacked messages on subscription of a topic asynchronously.
      +
      +
      Parameters:
      +
      topic -
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      getMaxUnackedMessagesOnSubscription

      +
      Integer getMaxUnackedMessagesOnSubscription(String topic, + boolean applied) + throws PulsarAdminException
      +
      get max unacked messages on subscription of a topic.
      +
      +
      Parameters:
      +
      topic -
      +
      Returns:
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getMaxUnackedMessagesOnSubscriptionAsync

      +
      CompletableFuture<Integer> getMaxUnackedMessagesOnSubscriptionAsync(String topic, + boolean applied)
      +
      get max unacked messages on subscription of a topic asynchronously.
      +
      +
      Parameters:
      +
      topic -
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      setMaxUnackedMessagesOnSubscription

      +
      void setMaxUnackedMessagesOnSubscription(String topic, + int maxNum) + throws PulsarAdminException
      +
      set max unacked messages on subscription of a topic.
      +
      +
      Parameters:
      +
      topic -
      +
      maxNum -
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      setMaxUnackedMessagesOnSubscriptionAsync

      +
      CompletableFuture<Void> setMaxUnackedMessagesOnSubscriptionAsync(String topic, + int maxNum)
      +
      set max unacked messages on subscription of a topic asynchronously.
      +
      +
      Parameters:
      +
      topic -
      +
      maxNum -
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      removeMaxUnackedMessagesOnSubscription

      +
      void removeMaxUnackedMessagesOnSubscription(String topic) + throws PulsarAdminException
      +
      remove max unacked messages on subscription of a topic.
      +
      +
      Parameters:
      +
      topic -
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      removeMaxUnackedMessagesOnSubscriptionAsync

      +
      CompletableFuture<Void> removeMaxUnackedMessagesOnSubscriptionAsync(String topic)
      +
      remove max unacked messages on subscription of a topic asynchronously.
      +
      +
      Parameters:
      +
      topic -
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      setPersistence

      +
      void setPersistence(String topic, + PersistencePolicies persistencePolicies) + throws PulsarAdminException
      +
      Set the configuration of persistence policies for specified topic.
      +
      +
      Parameters:
      +
      topic - Topic name
      +
      persistencePolicies - Configuration of bookkeeper persistence policies
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      setPersistenceAsync

      +
      CompletableFuture<Void> setPersistenceAsync(String topic, + PersistencePolicies persistencePolicies)
      +
      Set the configuration of persistence policies for specified topic asynchronously.
      +
      +
      Parameters:
      +
      topic - Topic name
      +
      persistencePolicies - Configuration of bookkeeper persistence policies
      +
      +
      +
      • +
    • +
      +

      getPersistence

      +
      PersistencePolicies getPersistence(String topic) + throws PulsarAdminException
      +
      Get the configuration of persistence policies for specified topic.
      +
      +
      Parameters:
      +
      topic - Topic name
      +
      Returns:
      +
      Configuration of bookkeeper persistence policies
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getPersistenceAsync

      +
      CompletableFuture<PersistencePolicies> getPersistenceAsync(String topic)
      +
      Get the configuration of persistence policies for specified topic asynchronously.
      +
      +
      Parameters:
      +
      topic - Topic name
      +
      +
      +
      • +
    • +
      +

      getPersistence

      +
      PersistencePolicies getPersistence(String topic, + boolean applied) + throws PulsarAdminException
      +
      Get the applied configuration of persistence policies for specified topic.
      +
      +
      Parameters:
      +
      topic - Topic name
      +
      Returns:
      +
      Configuration of bookkeeper persistence policies
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getPersistenceAsync

      +
      CompletableFuture<PersistencePolicies> getPersistenceAsync(String topic, + boolean applied)
      +
      Get the applied configuration of persistence policies for specified topic asynchronously.
      +
      +
      Parameters:
      +
      topic - Topic name
      +
      +
      +
      • +
    • +
      +

      removePersistence

      +
      void removePersistence(String topic) + throws PulsarAdminException
      +
      Remove the configuration of persistence policies for specified topic.
      +
      +
      Parameters:
      +
      topic - Topic name
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      removePersistenceAsync

      +
      CompletableFuture<Void> removePersistenceAsync(String topic)
      +
      Remove the configuration of persistence policies for specified topic asynchronously.
      +
      +
      Parameters:
      +
      topic - Topic name
      +
      +
      +
      • +
    • +
      +

      getDeduplicationStatus

      +
      Boolean getDeduplicationStatus(String topic) + throws PulsarAdminException
      +
      get deduplication enabled of a topic.
      +
      +
      Parameters:
      +
      topic -
      +
      Returns:
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getDeduplicationStatusAsync

      +
      CompletableFuture<Boolean> getDeduplicationStatusAsync(String topic)
      +
      get deduplication enabled of a topic asynchronously.
      +
      +
      Parameters:
      +
      topic -
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      getDeduplicationStatus

      +
      Boolean getDeduplicationStatus(String topic, + boolean applied) + throws PulsarAdminException
      +
      get applied deduplication enabled of a topic.
      +
      +
      Parameters:
      +
      topic -
      +
      Returns:
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getDeduplicationStatusAsync

      +
      CompletableFuture<Boolean> getDeduplicationStatusAsync(String topic, + boolean applied)
      +
      get applied deduplication enabled of a topic asynchronously.
      +
      +
      Parameters:
      +
      topic -
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      setDeduplicationStatus

      +
      void setDeduplicationStatus(String topic, + boolean enabled) + throws PulsarAdminException
      +
      set deduplication enabled of a topic.
      +
      +
      Parameters:
      +
      topic -
      +
      enabled -
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      setDeduplicationStatusAsync

      +
      CompletableFuture<Void> setDeduplicationStatusAsync(String topic, + boolean enabled)
      +
      set deduplication enabled of a topic asynchronously.
      +
      +
      Parameters:
      +
      topic -
      +
      enabled -
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      removeDeduplicationStatus

      +
      void removeDeduplicationStatus(String topic) + throws PulsarAdminException
      +
      remove deduplication enabled of a topic.
      +
      +
      Parameters:
      +
      topic -
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      removeDeduplicationStatusAsync

      +
      CompletableFuture<Void> removeDeduplicationStatusAsync(String topic)
      +
      remove deduplication enabled of a topic asynchronously.
      +
      +
      Parameters:
      +
      topic -
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      setDispatchRate

      +
      void setDispatchRate(String topic, + DispatchRate dispatchRate) + throws PulsarAdminException
      +
      Set message-dispatch-rate (topic can dispatch this many messages per second).
      +
      +
      Parameters:
      +
      topic -
      +
      dispatchRate - number of messages per second
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      setDispatchRateAsync

      +
      CompletableFuture<Void> setDispatchRateAsync(String topic, + DispatchRate dispatchRate)
      +
      Set message-dispatch-rate asynchronously. +

      + topic can dispatch this many messages per second

      +
      +
      Parameters:
      +
      topic -
      +
      dispatchRate - number of messages per second
      +
      +
      +
      • +
    • +
      +

      getDispatchRate

      +
      DispatchRate getDispatchRate(String topic) + throws PulsarAdminException
      +
      Get message-dispatch-rate (topic can dispatch this many messages per second).
      +
      +
      Parameters:
      +
      topic -
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getDispatchRateAsync

      +
      CompletableFuture<DispatchRate> getDispatchRateAsync(String topic)
      +
      Get message-dispatch-rate asynchronously. +

      + Topic can dispatch this many messages per second.

      +
      +
      Parameters:
      +
      topic -
      +
      +
      +
      • +
    • +
      +

      getDispatchRate

      +
      DispatchRate getDispatchRate(String topic, + boolean applied) + throws PulsarAdminException
      +
      Get applied message-dispatch-rate (topic can dispatch this many messages per second).
      +
      +
      Parameters:
      +
      topic -
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getDispatchRateAsync

      +
      CompletableFuture<DispatchRate> getDispatchRateAsync(String topic, + boolean applied)
      +
      Get applied message-dispatch-rate asynchronously. +

      + Topic can dispatch this many messages per second.

      +
      +
      Parameters:
      +
      topic -
      +
      +
      +
      • +
    • +
      +

      removeDispatchRate

      +
      void removeDispatchRate(String topic) + throws PulsarAdminException
      +
      Remove message-dispatch-rate. +

      + Remove topic message dispatch rate

      +
      +
      Parameters:
      +
      topic -
      +
      Throws:
      +
      PulsarAdminException - unexpected error
      +
      +
      +
      • +
    • +
      +

      removeDispatchRateAsync

      +
      CompletableFuture<Void> removeDispatchRateAsync(String topic) + throws PulsarAdminException
      +
      Remove message-dispatch-rate asynchronously. +

      + Remove topic message dispatch rate

      +
      +
      Parameters:
      +
      topic -
      +
      Throws:
      +
      PulsarAdminException - unexpected error
      +
      +
      +
      • +
    • +
      +

      setSubscriptionDispatchRate

      +
      void setSubscriptionDispatchRate(String topic, + DispatchRate dispatchRate) + throws PulsarAdminException
      +
      Set subscription-message-dispatch-rate for the topic. +

      + Subscriptions of this topic can dispatch this many messages per second

      +
      +
      Parameters:
      +
      topic -
      +
      dispatchRate - number of messages per second
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      setSubscriptionDispatchRateAsync

      +
      CompletableFuture<Void> setSubscriptionDispatchRateAsync(String topic, + DispatchRate dispatchRate)
      +
      Set subscription-message-dispatch-rate for the topic asynchronously. +

      + Subscriptions of this topic can dispatch this many messages per second.

      +
      +
      Parameters:
      +
      topic -
      +
      dispatchRate - number of messages per second
      +
      +
      +
      • +
    • +
      +

      getSubscriptionDispatchRate

      +
      DispatchRate getSubscriptionDispatchRate(String topic, + boolean applied) + throws PulsarAdminException
      +
      Get applied subscription-message-dispatch-rate. +

      + Subscriptions of this topic can dispatch this many messages per second.

      +
      +
      Parameters:
      +
      topic -
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getSubscriptionDispatchRateAsync

      +
      CompletableFuture<DispatchRate> getSubscriptionDispatchRateAsync(String topic, + boolean applied)
      +
      Get applied subscription-message-dispatch-rate asynchronously. +

      + Subscriptions in this topic can dispatch this many messages per second.

      +
      +
      Parameters:
      +
      topic -
      +
      +
      +
      • +
    • +
      +

      getSubscriptionDispatchRate

      +
      DispatchRate getSubscriptionDispatchRate(String topic) + throws PulsarAdminException
      +
      Get subscription-message-dispatch-rate for the topic. +

      + Subscriptions of this topic can dispatch this many messages per second.

      +
      +
      Parameters:
      +
      topic -
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getSubscriptionDispatchRateAsync

      +
      CompletableFuture<DispatchRate> getSubscriptionDispatchRateAsync(String topic)
      +
      Get subscription-message-dispatch-rate asynchronously. +

      + Subscriptions of this topic can dispatch this many messages per second.

      +
      +
      Parameters:
      +
      topic -
      +
      +
      +
      • +
    • +
      +

      removeSubscriptionDispatchRate

      +
      void removeSubscriptionDispatchRate(String topic) + throws PulsarAdminException
      +
      Remove subscription-message-dispatch-rate for a topic.
      +
      +
      Parameters:
      +
      topic - Topic name
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      removeSubscriptionDispatchRateAsync

      +
      CompletableFuture<Void> removeSubscriptionDispatchRateAsync(String topic)
      +
      Remove subscription-message-dispatch-rate for a topic asynchronously.
      +
      +
      Parameters:
      +
      topic - Topic name
      +
      +
      +
      • +
    • +
      +

      setSubscriptionDispatchRate

      +
      void setSubscriptionDispatchRate(String topic, + String subscriptionName, + DispatchRate dispatchRate) + throws PulsarAdminException
      +
      Set dispatch rate limiter for a specific subscription.
      +
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      setSubscriptionDispatchRateAsync

      +
      CompletableFuture<Void> setSubscriptionDispatchRateAsync(String topic, + String subscriptionName, + DispatchRate dispatchRate)
      +
      Async version of setSubscriptionDispatchRate(String, String, DispatchRate).
      +
      +
      • +
    • +
      +

      getSubscriptionDispatchRate

      +
      DispatchRate getSubscriptionDispatchRate(String topic, + String subscriptionName, + boolean applied) + throws PulsarAdminException
      +
      If applied is true, get dispatch rate limiter for a specific subscription. + Or else, return subscription level setting.
      +
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getSubscriptionDispatchRateAsync

      +
      CompletableFuture<DispatchRate> getSubscriptionDispatchRateAsync(String topic, + String subscriptionName, + boolean applied)
      +
      Async version of getSubscriptionDispatchRate(String, String, boolean).
      +
      +
      • +
    • +
      +

      getSubscriptionDispatchRate

      +
      DispatchRate getSubscriptionDispatchRate(String topic, + String subscriptionName) + throws PulsarAdminException
      +
      Get subscription level dispatch rate limiter setting for a specific subscription.
      +
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getSubscriptionDispatchRateAsync

      +
      CompletableFuture<DispatchRate> getSubscriptionDispatchRateAsync(String topic, + String subscriptionName)
      +
      Async version of getSubscriptionDispatchRate(String, String).
      +
      +
      • +
    • +
      +

      removeSubscriptionDispatchRate

      +
      void removeSubscriptionDispatchRate(String topic, + String subscriptionName) + throws PulsarAdminException
      +
      Remove subscription level dispatch rate limiter setting for a specific subscription.
      +
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      removeSubscriptionDispatchRateAsync

      +
      CompletableFuture<Void> removeSubscriptionDispatchRateAsync(String topic, + String subscriptionName)
      +
      Async version of removeSubscriptionDispatchRate(String, String).
      +
      +
      • +
    • +
      +

      setReplicatorDispatchRate

      +
      void setReplicatorDispatchRate(String topic, + DispatchRate dispatchRate) + throws PulsarAdminException
      +
      Set replicatorDispatchRate for the topic. +

      + Replicator dispatch rate under this topic can dispatch this many messages per second

      +
      +
      Parameters:
      +
      topic -
      +
      dispatchRate - number of messages per second
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      setReplicatorDispatchRateAsync

      +
      CompletableFuture<Void> setReplicatorDispatchRateAsync(String topic, + DispatchRate dispatchRate)
      +
      Set replicatorDispatchRate for the topic asynchronously. +

      + Replicator dispatch rate under this topic can dispatch this many messages per second.

      +
      +
      Parameters:
      +
      topic -
      +
      dispatchRate - number of messages per second
      +
      +
      +
      • +
    • +
      +

      getReplicatorDispatchRate

      +
      DispatchRate getReplicatorDispatchRate(String topic) + throws PulsarAdminException
      +
      Get replicatorDispatchRate for the topic. +

      + Replicator dispatch rate under this topic can dispatch this many messages per second.

      +
      +
      Parameters:
      +
      topic -
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getReplicatorDispatchRateAsync

      +
      CompletableFuture<DispatchRate> getReplicatorDispatchRateAsync(String topic)
      +
      Get replicatorDispatchRate asynchronously. +

      + Replicator dispatch rate under this topic can dispatch this many messages per second.

      +
      +
      Parameters:
      +
      topic -
      +
      +
      +
      • +
    • +
      +

      getReplicatorDispatchRate

      +
      DispatchRate getReplicatorDispatchRate(String topic, + boolean applied) + throws PulsarAdminException
      +
      Get applied replicatorDispatchRate for the topic.
      +
      +
      Parameters:
      +
      topic -
      +
      applied -
      +
      Returns:
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getReplicatorDispatchRateAsync

      +
      CompletableFuture<DispatchRate> getReplicatorDispatchRateAsync(String topic, + boolean applied)
      +
      Get applied replicatorDispatchRate asynchronously.
      +
      +
      Parameters:
      +
      topic -
      +
      applied -
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      removeReplicatorDispatchRate

      +
      void removeReplicatorDispatchRate(String topic) + throws PulsarAdminException
      +
      Remove replicatorDispatchRate for a topic.
      +
      +
      Parameters:
      +
      topic - Topic name
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      removeReplicatorDispatchRateAsync

      +
      CompletableFuture<Void> removeReplicatorDispatchRateAsync(String topic)
      +
      Remove replicatorDispatchRate for a topic asynchronously.
      +
      +
      Parameters:
      +
      topic - Topic name
      +
      +
      +
      • +
    • +
      +

      getCompactionThreshold

      +
      Long getCompactionThreshold(String topic) + throws PulsarAdminException
      +
      Get the compactionThreshold for a topic. The maximum number of bytes + can have before compaction is triggered. 0 disables. +

      + Response example: + + 

      + 10000000
+
      +
      +
      Parameters:
      +
      topic - Topic name
      +
      +
      +
      • +
    • +
      +

      getCompactionThresholdAsync

      +
      CompletableFuture<Long> getCompactionThresholdAsync(String topic)
      +
      Get the compactionThreshold for a topic asynchronously. The maximum number of bytes + can have before compaction is triggered. 0 disables. +

      + Response example: + + 

      + 10000000
+
      +
      +
      Parameters:
      +
      topic - Topic name
      +
      +
      +
      • +
    • +
      +

      getCompactionThreshold

      +
      Long getCompactionThreshold(String topic, + boolean applied) + throws PulsarAdminException
      +
      Get the compactionThreshold for a topic. The maximum number of bytes + can have before compaction is triggered. 0 disables.
      +
      +
      Parameters:
      +
      topic - Topic name
      +
      +
      +
      • +
    • +
      +

      getCompactionThresholdAsync

      +
      CompletableFuture<Long> getCompactionThresholdAsync(String topic, + boolean applied)
      +
      Get the compactionThreshold for a topic asynchronously. The maximum number of bytes + can have before compaction is triggered. 0 disables.
      +
      +
      Parameters:
      +
      topic - Topic name
      +
      +
      +
      • +
    • +
      +

      setCompactionThreshold

      +
      void setCompactionThreshold(String topic, + long compactionThreshold) + throws PulsarAdminException
      +
      Set the compactionThreshold for a topic. The maximum number of bytes + can have before compaction is triggered. 0 disables. +

      + Request example: + + 

      + 10000000
+
      +
      +
      Parameters:
      +
      topic - Topic name
      +
      compactionThreshold - maximum number of backlog bytes before compaction is triggered
      +
      +
      +
      • +
    • +
      +

      setCompactionThresholdAsync

      +
      CompletableFuture<Void> setCompactionThresholdAsync(String topic, + long compactionThreshold)
      +
      Set the compactionThreshold for a topic asynchronously. The maximum number of bytes + can have before compaction is triggered. 0 disables. +

      + Request example: + + 

      + 10000000
+
      +
      +
      Parameters:
      +
      topic - Topic name
      +
      compactionThreshold - maximum number of backlog bytes before compaction is triggered
      +
      +
      +
      • +
    • +
      +

      removeCompactionThreshold

      +
      void removeCompactionThreshold(String topic) + throws PulsarAdminException
      +
      Remove the compactionThreshold for a topic.
      +
      +
      Parameters:
      +
      topic - Topic name
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      removeCompactionThresholdAsync

      +
      CompletableFuture<Void> removeCompactionThresholdAsync(String topic)
      +
      Remove the compactionThreshold for a topic asynchronously.
      +
      +
      Parameters:
      +
      topic - Topic name
      +
      +
      +
      • +
    • +
      +

      setPublishRate

      +
      void setPublishRate(String topic, + PublishRate publishMsgRate) + throws PulsarAdminException
      +
      Set message-publish-rate (topics can publish this many messages per second).
      +
      +
      Parameters:
      +
      topic -
      +
      publishMsgRate - number of messages per second
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      setPublishRateAsync

      +
      CompletableFuture<Void> setPublishRateAsync(String topic, + PublishRate publishMsgRate)
      +
      Set message-publish-rate (topics can publish this many messages per second) asynchronously.
      +
      +
      Parameters:
      +
      topic -
      +
      publishMsgRate - number of messages per second
      +
      +
      +
      • +
    • +
      +

      getPublishRate

      +
      PublishRate getPublishRate(String topic) + throws PulsarAdminException
      +
      Get message-publish-rate (topics can publish this many messages per second).
      +
      +
      Parameters:
      +
      topic -
      +
      Returns:
      +
      number of messages per second
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getPublishRateAsync

      +
      CompletableFuture<PublishRate> getPublishRateAsync(String topic)
      +
      Get message-publish-rate (topics can publish this many messages per second) asynchronously.
      +
      +
      Parameters:
      +
      topic -
      +
      Returns:
      +
      number of messages per second
      +
      +
      +
      • +
    • +
      +

      removePublishRate

      +
      void removePublishRate(String topic) + throws PulsarAdminException
      +
      Remove message-publish-rate. +

      + Remove topic message publish rate

      +
      +
      Parameters:
      +
      topic -
      +
      Throws:
      +
      PulsarAdminException - unexpected error
      +
      +
      +
      • +
    • +
      +

      removePublishRateAsync

      +
      CompletableFuture<Void> removePublishRateAsync(String topic) + throws PulsarAdminException
      +
      Remove message-publish-rate asynchronously. +

      + Remove topic message publish rate

      +
      +
      Parameters:
      +
      topic -
      +
      Throws:
      +
      PulsarAdminException - unexpected error
      +
      +
      +
      • +
    • +
      +

      getMaxConsumersPerSubscription

      +
      Integer getMaxConsumersPerSubscription(String topic) + throws PulsarAdminException
      +
      Get the maxConsumersPerSubscription for a topic. +

      + Response example: + + 

      + 0
+
      +
      +
      Parameters:
      +
      topic - Topic name
      +
      +
      +
      • +
    • +
      +

      getMaxConsumersPerSubscriptionAsync

      +
      CompletableFuture<Integer> getMaxConsumersPerSubscriptionAsync(String topic)
      +
      Get the maxConsumersPerSubscription for a topic asynchronously. +

      + Response example: + + 

      + 0
+
      +
      +
      Parameters:
      +
      topic - Topic name
      +
      +
      +
      • +
    • +
      +

      setMaxConsumersPerSubscription

      +
      void setMaxConsumersPerSubscription(String topic, + int maxConsumersPerSubscription) + throws PulsarAdminException
      +
      Set maxConsumersPerSubscription for a topic. +

      + Request example: + + 

      + 10
+
      +
      +
      Parameters:
      +
      topic - Topic name
      +
      maxConsumersPerSubscription - maxConsumersPerSubscription value for a namespace
      +
      +
      +
      • +
    • +
      +

      setMaxConsumersPerSubscriptionAsync

      +
      CompletableFuture<Void> setMaxConsumersPerSubscriptionAsync(String topic, + int maxConsumersPerSubscription)
      +
      Set maxConsumersPerSubscription for a topic asynchronously. +

      + Request example: + + 

      + 10
+
      +
      +
      Parameters:
      +
      topic - Topic name
      +
      maxConsumersPerSubscription - maxConsumersPerSubscription value for a namespace
      +
      +
      +
      • +
    • +
      +

      removeMaxConsumersPerSubscription

      +
      void removeMaxConsumersPerSubscription(String topic) + throws PulsarAdminException
      +
      Remove the maxConsumersPerSubscription for a topic.
      +
      +
      Parameters:
      +
      topic - Topic name
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      removeMaxConsumersPerSubscriptionAsync

      +
      CompletableFuture<Void> removeMaxConsumersPerSubscriptionAsync(String topic)
      +
      Remove the maxConsumersPerSubscription for a topic asynchronously.
      +
      +
      Parameters:
      +
      topic - Topic name
      +
      +
      +
      • +
    • +
      +

      getMaxProducers

      +
      Integer getMaxProducers(String topic) + throws PulsarAdminException
      +
      Get the max number of producer for specified topic.
      +
      +
      Parameters:
      +
      topic - Topic name
      +
      Returns:
      +
      Configuration of bookkeeper persistence policies
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getMaxProducersAsync

      +
      CompletableFuture<Integer> getMaxProducersAsync(String topic)
      +
      Get the max number of producer for specified topic asynchronously.
      +
      +
      Parameters:
      +
      topic - Topic name
      +
      Returns:
      +
      Configuration of bookkeeper persistence policies
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getMaxProducers

      +
      Integer getMaxProducers(String topic, + boolean applied) + throws PulsarAdminException
      +
      Get the max number of producer applied for specified topic.
      +
      +
      Parameters:
      +
      topic -
      +
      applied -
      +
      Returns:
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getMaxProducersAsync

      +
      CompletableFuture<Integer> getMaxProducersAsync(String topic, + boolean applied)
      +
      Get the max number of producer applied for specified topic asynchronously.
      +
      +
      Parameters:
      +
      topic -
      +
      applied -
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      setMaxProducers

      +
      void setMaxProducers(String topic, + int maxProducers) + throws PulsarAdminException
      +
      Set the max number of producer for specified topic.
      +
      +
      Parameters:
      +
      topic - Topic name
      +
      maxProducers - Max number of producer
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      setMaxProducersAsync

      +
      CompletableFuture<Void> setMaxProducersAsync(String topic, + int maxProducers)
      +
      Set the max number of producer for specified topic asynchronously.
      +
      +
      Parameters:
      +
      topic - Topic name
      +
      maxProducers - Max number of producer
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      removeMaxProducers

      +
      void removeMaxProducers(String topic) + throws PulsarAdminException
      +
      Remove the max number of producer for specified topic.
      +
      +
      Parameters:
      +
      topic - Topic name
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      removeMaxProducersAsync

      +
      CompletableFuture<Void> removeMaxProducersAsync(String topic)
      +
      Remove the max number of producer for specified topic asynchronously.
      +
      +
      Parameters:
      +
      topic - Topic name
      +
      +
      +
      • +
    • +
      +

      getMaxSubscriptionsPerTopic

      +
      Integer getMaxSubscriptionsPerTopic(String topic) + throws PulsarAdminException
      +
      Get the max number of subscriptions for specified topic.
      +
      +
      Parameters:
      +
      topic - Topic name
      +
      Returns:
      +
      Configuration of bookkeeper persistence policies
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getMaxSubscriptionsPerTopicAsync

      +
      CompletableFuture<Integer> getMaxSubscriptionsPerTopicAsync(String topic)
      +
      Get the max number of subscriptions for specified topic asynchronously.
      +
      +
      Parameters:
      +
      topic - Topic name
      +
      Returns:
      +
      Configuration of bookkeeper persistence policies
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      setMaxSubscriptionsPerTopic

      +
      void setMaxSubscriptionsPerTopic(String topic, + int maxSubscriptionsPerTopic) + throws PulsarAdminException
      +
      Set the max number of subscriptions for specified topic.
      +
      +
      Parameters:
      +
      topic - Topic name
      +
      maxSubscriptionsPerTopic - Max number of subscriptions
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      setMaxSubscriptionsPerTopicAsync

      +
      CompletableFuture<Void> setMaxSubscriptionsPerTopicAsync(String topic, + int maxSubscriptionsPerTopic)
      +
      Set the max number of subscriptions for specified topic asynchronously.
      +
      +
      Parameters:
      +
      topic - Topic name
      +
      maxSubscriptionsPerTopic - Max number of subscriptions
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      removeMaxSubscriptionsPerTopic

      +
      void removeMaxSubscriptionsPerTopic(String topic) + throws PulsarAdminException
      +
      Remove the max number of subscriptions for specified topic.
      +
      +
      Parameters:
      +
      topic - Topic name
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      removeMaxSubscriptionsPerTopicAsync

      +
      CompletableFuture<Void> removeMaxSubscriptionsPerTopicAsync(String topic)
      +
      Remove the max number of subscriptions for specified topic asynchronously.
      +
      +
      Parameters:
      +
      topic - Topic name
      +
      +
      +
      • +
    • +
      +

      getMaxMessageSize

      +
      Integer getMaxMessageSize(String topic) + throws PulsarAdminException
      +
      Get the max message size for specified topic.
      +
      +
      Parameters:
      +
      topic - Topic name
      +
      Returns:
      +
      Configuration of bookkeeper persistence policies
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getMaxMessageSizeAsync

      +
      CompletableFuture<Integer> getMaxMessageSizeAsync(String topic)
      +
      Get the max message size for specified topic asynchronously.
      +
      +
      Parameters:
      +
      topic - Topic name
      +
      Returns:
      +
      Configuration of bookkeeper persistence policies
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      setMaxMessageSize

      +
      void setMaxMessageSize(String topic, + int maxMessageSize) + throws PulsarAdminException
      +
      Set the max message size for specified topic.
      +
      +
      Parameters:
      +
      topic - Topic name
      +
      maxMessageSize - Max message size of producer
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      setMaxMessageSizeAsync

      +
      CompletableFuture<Void> setMaxMessageSizeAsync(String topic, + int maxMessageSize)
      +
      Set the max message size for specified topic asynchronously.0 disables.
      +
      +
      Parameters:
      +
      topic - Topic name
      +
      maxMessageSize - Max message size of topic
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      removeMaxMessageSize

      +
      void removeMaxMessageSize(String topic) + throws PulsarAdminException
      +
      Remove the max message size for specified topic.
      +
      +
      Parameters:
      +
      topic - Topic name
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      removeMaxMessageSizeAsync

      +
      CompletableFuture<Void> removeMaxMessageSizeAsync(String topic)
      +
      Remove the max message size for specified topic asynchronously.
      +
      +
      Parameters:
      +
      topic - Topic name
      +
      +
      +
      • +
    • +
      +

      getMaxConsumers

      +
      Integer getMaxConsumers(String topic) + throws PulsarAdminException
      +
      Get the max number of consumer for specified topic.
      +
      +
      Parameters:
      +
      topic - Topic name
      +
      Returns:
      +
      Configuration of bookkeeper persistence policies
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getMaxConsumersAsync

      +
      CompletableFuture<Integer> getMaxConsumersAsync(String topic)
      +
      Get the max number of consumer for specified topic asynchronously.
      +
      +
      Parameters:
      +
      topic - Topic name
      +
      Returns:
      +
      Configuration of bookkeeper persistence policies
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getMaxConsumers

      +
      Integer getMaxConsumers(String topic, + boolean applied) + throws PulsarAdminException
      +
      Get the max number of consumer applied for specified topic.
      +
      +
      Parameters:
      +
      topic -
      +
      applied -
      +
      Returns:
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getMaxConsumersAsync

      +
      CompletableFuture<Integer> getMaxConsumersAsync(String topic, + boolean applied)
      +
      Get the max number of consumer applied for specified topic asynchronously.
      +
      +
      Parameters:
      +
      topic -
      +
      applied -
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      setMaxConsumers

      +
      void setMaxConsumers(String topic, + int maxConsumers) + throws PulsarAdminException
      +
      Set the max number of consumer for specified topic.
      +
      +
      Parameters:
      +
      topic - Topic name
      +
      maxConsumers - Max number of consumer
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      setMaxConsumersAsync

      +
      CompletableFuture<Void> setMaxConsumersAsync(String topic, + int maxConsumers)
      +
      Set the max number of consumer for specified topic asynchronously.
      +
      +
      Parameters:
      +
      topic - Topic name
      +
      maxConsumers - Max number of consumer
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      removeMaxConsumers

      +
      void removeMaxConsumers(String topic) + throws PulsarAdminException
      +
      Remove the max number of consumer for specified topic.
      +
      +
      Parameters:
      +
      topic - Topic name
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      removeMaxConsumersAsync

      +
      CompletableFuture<Void> removeMaxConsumersAsync(String topic)
      +
      Remove the max number of consumer for specified topic asynchronously.
      +
      +
      Parameters:
      +
      topic - Topic name
      +
      +
      +
      • +
    • +
      +

      getDeduplicationSnapshotInterval

      +
      Integer getDeduplicationSnapshotInterval(String topic) + throws PulsarAdminException
      +
      Get the deduplication snapshot interval for specified topic.
      +
      +
      Parameters:
      +
      topic -
      +
      Returns:
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getDeduplicationSnapshotIntervalAsync

      +
      CompletableFuture<Integer> getDeduplicationSnapshotIntervalAsync(String topic)
      +
      Get the deduplication snapshot interval for specified topic asynchronously.
      +
      +
      Parameters:
      +
      topic -
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      setDeduplicationSnapshotInterval

      +
      void setDeduplicationSnapshotInterval(String topic, + int interval) + throws PulsarAdminException
      +
      Set the deduplication snapshot interval for specified topic.
      +
      +
      Parameters:
      +
      topic -
      +
      interval -
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      setDeduplicationSnapshotIntervalAsync

      +
      CompletableFuture<Void> setDeduplicationSnapshotIntervalAsync(String topic, + int interval)
      +
      Set the deduplication snapshot interval for specified topic asynchronously.
      +
      +
      Parameters:
      +
      topic -
      +
      interval -
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      removeDeduplicationSnapshotInterval

      +
      void removeDeduplicationSnapshotInterval(String topic) + throws PulsarAdminException
      +
      Remove the deduplication snapshot interval for specified topic.
      +
      +
      Parameters:
      +
      topic -
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      removeDeduplicationSnapshotIntervalAsync

      +
      CompletableFuture<Void> removeDeduplicationSnapshotIntervalAsync(String topic)
      +
      Remove the deduplication snapshot interval for specified topic asynchronously.
      +
      +
      Parameters:
      +
      topic -
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      setSubscriptionTypesEnabled

      +
      void setSubscriptionTypesEnabled(String topic, + Set<org.apache.pulsar.client.api.SubscriptionType> subscriptionTypesEnabled) + throws PulsarAdminException
      +
      Set is enable sub types.
      +
      +
      Parameters:
      +
      topic -
      +
      subscriptionTypesEnabled - is enable subTypes
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      setSubscriptionTypesEnabledAsync

      +
      CompletableFuture<Void> setSubscriptionTypesEnabledAsync(String topic, + Set<org.apache.pulsar.client.api.SubscriptionType> subscriptionTypesEnabled)
      +
      Set is enable sub types asynchronously.
      +
      +
      Parameters:
      +
      topic -
      +
      subscriptionTypesEnabled - is enable subTypes
      +
      +
      +
      • +
    • +
      +

      getSubscriptionTypesEnabled

      +
      Set<org.apache.pulsar.client.api.SubscriptionType> getSubscriptionTypesEnabled(String topic) + throws PulsarAdminException
      +
      Get is enable sub types.
      +
      +
      Parameters:
      +
      topic - is topic for get is enable sub types
      +
      Returns:
      +
      set of enable sub types
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getSubscriptionTypesEnabledAsync

      +
      CompletableFuture<Set<org.apache.pulsar.client.api.SubscriptionType>> getSubscriptionTypesEnabledAsync(String topic)
      +
      Get is enable sub types asynchronously.
      +
      +
      Parameters:
      +
      topic - is topic for get is enable sub types
      +
      +
      +
      • +
    • +
      +

      removeSubscriptionTypesEnabled

      +
      void removeSubscriptionTypesEnabled(String topic) + throws PulsarAdminException
      +
      Remove subscription types enabled for a topic.
      +
      +
      Parameters:
      +
      topic -
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      removeSubscriptionTypesEnabledAsync

      +
      CompletableFuture<Void> removeSubscriptionTypesEnabledAsync(String topic)
      +
      Remove subscription types enabled for a topic asynchronously.
      +
      +
      Parameters:
      +
      topic -
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      setSubscribeRate

      +
      void setSubscribeRate(String topic, + SubscribeRate subscribeRate) + throws PulsarAdminException
      +
      Set topic-subscribe-rate (topic will limit by subscribeRate).
      +
      +
      Parameters:
      +
      topic -
      +
      subscribeRate - consumer subscribe limit by this subscribeRate
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      setSubscribeRateAsync

      +
      CompletableFuture<Void> setSubscribeRateAsync(String topic, + SubscribeRate subscribeRate)
      +
      Set topic-subscribe-rate (topics will limit by subscribeRate) asynchronously.
      +
      +
      Parameters:
      +
      topic -
      +
      subscribeRate - consumer subscribe limit by this subscribeRate
      +
      +
      +
      • +
    • +
      +

      getSubscribeRate

      +
      SubscribeRate getSubscribeRate(String topic) + throws PulsarAdminException
      +
      Get topic-subscribe-rate (topics allow subscribe times per consumer in a period).
      +
      +
      Parameters:
      +
      topic -
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getSubscribeRateAsync

      +
      CompletableFuture<SubscribeRate> getSubscribeRateAsync(String topic)
      +
      Get topic-subscribe-rate asynchronously. +

      + Topic allow subscribe times per consumer in a period.

      +
      +
      Parameters:
      +
      topic -
      +
      +
      +
      • +
    • +
      +

      getSubscribeRate

      +
      SubscribeRate getSubscribeRate(String topic, + boolean applied) + throws PulsarAdminException
      +
      Get applied topic-subscribe-rate (topics allow subscribe times per consumer in a period).
      +
      +
      Parameters:
      +
      topic -
      +
      Throws:
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      getSubscribeRateAsync

      +
      CompletableFuture<SubscribeRate> getSubscribeRateAsync(String topic, + boolean applied)
      +
      Get applied topic-subscribe-rate asynchronously.
      +
      +
      Parameters:
      +
      topic -
      +
      +
      +
      • +
    • +
      +

      removeSubscribeRate

      +
      void removeSubscribeRate(String topic) + throws PulsarAdminException
      +
      Remove topic-subscribe-rate. +

      + Remove topic subscribe rate

      +
      +
      Parameters:
      +
      topic -
      +
      Throws:
      +
      PulsarAdminException - unexpected error
      +
      +
      +
      • +
    • +
      +

      removeSubscribeRateAsync

      +
      CompletableFuture<Void> removeSubscribeRateAsync(String topic) + throws PulsarAdminException
      +
      Remove topic-subscribe-rate asynchronously. +

      + Remove topic subscribe rate

      +
      +
      Parameters:
      +
      topic -
      +
      Throws:
      +
      PulsarAdminException - unexpected error
      +
      +
      +
      • +
    • +
      +

      getSchemaCompatibilityStrategy

      +
      SchemaCompatibilityStrategy getSchemaCompatibilityStrategy(String topic, + boolean applied) + throws PulsarAdminException
      +
      Get schema compatibility strategy on a topic.
      +
      +
      Parameters:
      +
      topic - The topic in whose policy we are interested
      +
      applied - Get the current applied schema compatibility strategy
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getSchemaCompatibilityStrategyAsync

      +
      CompletableFuture<SchemaCompatibilityStrategy> getSchemaCompatibilityStrategyAsync(String topic, + boolean applied)
      +
      Get schema compatibility strategy on a topic asynchronously.
      +
      +
      Parameters:
      +
      topic - The topic in whose policy we are interested
      +
      applied - Get the current applied schema compatibility strategy
      +
      +
      +
      • +
    • +
      +

      setSchemaCompatibilityStrategy

      +
      void setSchemaCompatibilityStrategy(String topic, + SchemaCompatibilityStrategy strategy) + throws PulsarAdminException
      +
      Set schema compatibility strategy on a topic.
      +
      +
      Parameters:
      +
      topic - The topic in whose policy should be set
      +
      strategy - The schema compatibility strategy
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      setSchemaCompatibilityStrategyAsync

      +
      CompletableFuture<Void> setSchemaCompatibilityStrategyAsync(String topic, + SchemaCompatibilityStrategy strategy)
      +
      Set schema compatibility strategy on a topic asynchronously.
      +
      +
      Parameters:
      +
      topic - The topic in whose policy should be set
      +
      strategy - The schema compatibility strategy
      +
      +
      +
      • +
    • +
      +

      removeSchemaCompatibilityStrategy

      +
      void removeSchemaCompatibilityStrategy(String topic) + throws PulsarAdminException
      +
      Remove schema compatibility strategy on a topic.
      +
      +
      Parameters:
      +
      topic - The topic in whose policy should be removed
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      removeSchemaCompatibilityStrategyAsync

      +
      CompletableFuture<Void> removeSchemaCompatibilityStrategyAsync(String topic)
      +
      Remove schema compatibility strategy on a topic asynchronously.
      +
      +
      Parameters:
      +
      topic - The topic in whose policy should be removed
      +
      +
      +
      • +
    • +
      +

      getEntryFiltersPerTopic

      +
      EntryFilters getEntryFiltersPerTopic(String topic, + boolean applied) + throws PulsarAdminException
      +
      Get applied entry filters for a topic.
      +
      +
      Parameters:
      +
      topic -
      +
      applied -
      +
      Returns:
      +
      entry filters classes info.
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getEntryFiltersPerTopicAsync

      +
      CompletableFuture<EntryFilters> getEntryFiltersPerTopicAsync(String topic, + boolean applied)
      +
      Get applied entry filters for a topic asynchronously.
      +
      +
      Parameters:
      +
      topic -
      +
      applied -
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      setEntryFiltersPerTopic

      +
      void setEntryFiltersPerTopic(String topic, + EntryFilters entryFilters) + throws PulsarAdminException
      +
      Set entry filters on a topic.
      +
      +
      Parameters:
      +
      topic - The topic in whose policy should be set
      +
      entryFilters - The entry filters
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      setEntryFiltersPerTopicAsync

      +
      CompletableFuture<Void> setEntryFiltersPerTopicAsync(String topic, + EntryFilters entryFilters)
      +
      Set entry filters on a topic asynchronously.
      +
      +
      Parameters:
      +
      topic - The topic in whose policy should be set
      +
      entryFilters - The entry filters
      +
      +
      +
      • +
    • +
      +

      removeEntryFiltersPerTopic

      +
      void removeEntryFiltersPerTopic(String topic) + throws PulsarAdminException
      +
      remove entry filters of a topic.
      +
      +
      Parameters:
      +
      topic -
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      removeEntryFiltersPerTopicAsync

      +
      CompletableFuture<Void> removeEntryFiltersPerTopicAsync(String topic)
      +
      remove entry filters of a topic asynchronously.
      +
      +
      Parameters:
      +
      topic -
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      setAutoSubscriptionCreation

      +
      void setAutoSubscriptionCreation(String topic, + AutoSubscriptionCreationOverride autoSubscriptionCreationOverride) + throws PulsarAdminException
      +
      Sets the autoSubscriptionCreation policy for a given topic, overriding namespace settings. +

      + When autoSubscriptionCreationOverride is enabled, new subscriptions will be created upon connection, + regardless of the namespace level configuration. +

      + Request example: + + 

      + 
+  {
+      "allowAutoSubscriptionCreation" : true
+  }
+ 
+
      +
      +
      Parameters:
      +
      topic - Topic name
      +
      autoSubscriptionCreationOverride - Override policies for auto subscription creation
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Topic does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      setAutoSubscriptionCreationAsync

      +
      CompletableFuture<Void> setAutoSubscriptionCreationAsync(String topic, + AutoSubscriptionCreationOverride autoSubscriptionCreationOverride)
      +
      Sets the autoSubscriptionCreation policy for a given topic, overriding namespace settings asynchronously. +

      + When autoSubscriptionCreationOverride is enabled, new subscriptions will be created upon connection, + regardless of the namespace level configuration. +

      + Request example: + + 

      + 
+  {
+      "allowAutoSubscriptionCreation" : true
+  }
+ 
+
      +
      +
      Parameters:
      +
      topic - Topic name
      +
      autoSubscriptionCreationOverride - Override policies for auto subscription creation
      +
      +
      +
      • +
    • +
      +

      getAutoSubscriptionCreation

      +
      AutoSubscriptionCreationOverride getAutoSubscriptionCreation(String topic, + boolean applied) + throws PulsarAdminException
      +
      Get the autoSubscriptionCreation info within a topic.
      +
      +
      Parameters:
      +
      topic -
      +
      applied -
      +
      Returns:
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getAutoSubscriptionCreationAsync

      +
      CompletableFuture<AutoSubscriptionCreationOverride> getAutoSubscriptionCreationAsync(String topic, + boolean applied)
      +
      Get the autoSubscriptionCreation info within a topic asynchronously.
      +
      +
      Parameters:
      +
      topic -
      +
      applied -
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      removeAutoSubscriptionCreation

      +
      void removeAutoSubscriptionCreation(String topic) + throws PulsarAdminException
      +
      Removes the autoSubscriptionCreation policy for a given topic.
      +
      +
      Parameters:
      +
      topic - Topic name
      +
      Throws:
      +
      PulsarAdminException.NotAuthorizedException - Don't have admin permission
      +
      PulsarAdminException.NotFoundException - Namespace does not exist
      +
      PulsarAdminException - Unexpected error
      +
      +
      +
      • +
    • +
      +

      removeAutoSubscriptionCreationAsync

      +
      CompletableFuture<Void> removeAutoSubscriptionCreationAsync(String topic)
      +
      Removes the autoSubscriptionCreation policy for a given topic asynchronously.
      +
      +
      Parameters:
      +
      topic - Topic name
      +
      +
      +
      • +
    • +
      +

      setDispatcherPauseOnAckStatePersistent

      +
      CompletableFuture<Void> setDispatcherPauseOnAckStatePersistent(String topic)
      +
      After enabling this feature, Pulsar will stop delivery messages to clients if the cursor metadata is too large to + # persist, it will help to reduce the duplicates caused by the ack state that can not be fully persistent.
      +
      +
      • +
    • +
      +

      removeDispatcherPauseOnAckStatePersistent

      +
      CompletableFuture<Void> removeDispatcherPauseOnAckStatePersistent(String topic)
      +
      Removes the dispatcherPauseOnAckStatePersistentEnabled policy for a given topic asynchronously.
      +
      +
      • +
    • +
      +

      getDispatcherPauseOnAckStatePersistent

      +
      CompletableFuture<Boolean> getDispatcherPauseOnAckStatePersistent(String topic, + boolean applied)
      +
      Get the dispatcherPauseOnAckStatePersistentEnabled policy for a given topic asynchronously.
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/Topics.QueryParam.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/Topics.QueryParam.html new file mode 100644 index 000000000000..81649531daa2 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/Topics.QueryParam.html @@ -0,0 +1,261 @@ + + + + +Topics.QueryParam (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.client.admin
+

Enum Class Topics.QueryParam

+
+
java.lang.Object +
java.lang.Enum<Topics.QueryParam> +
org.apache.pulsar.client.admin.Topics.QueryParam
+
+
+
+
+
All Implemented Interfaces:
+
Serializable, Comparable<Topics.QueryParam>, Constable
+
+
+
Enclosing interface:
+
Topics
+
+
+
public static enum Topics.QueryParam +extends Enum<Topics.QueryParam>
+
+
+ +
+
+
    + +
  • +
    +

    Enum Constant Details

    + +
    +
    • + +
  • +
    +

    Field Details

    +
      +
    • +
      +

      value

      +
      public final String value
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      values

      +
      public static Topics.QueryParam[] values()
      +
      Returns an array containing the constants of this enum class, in +the order they are declared.
      +
      +
      Returns:
      +
      an array containing the constants of this enum class, in the order they are declared
      +
      +
      +
      • +
    • +
      +

      valueOf

      +
      public static Topics.QueryParam valueOf(String name)
      +
      Returns the enum constant of this class with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this class. (Extraneous whitespace characters are +not permitted.)
      +
      +
      Parameters:
      +
      name - the name of the enum constant to be returned.
      +
      Returns:
      +
      the enum constant with the specified name
      +
      Throws:
      +
      IllegalArgumentException - if this enum class has no constant with the specified name
      +
      NullPointerException - if the argument is null
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/Topics.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/Topics.html new file mode 100644 index 000000000000..ca10986b3463 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/Topics.html @@ -0,0 +1,8962 @@ + + + + +Topics (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.client.admin
+

Interface Topics

+
+
+
+
public interface Topics
+
Admin interface for Topics management.
+
+
+ +
+
+ +
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/Transactions.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/Transactions.html new file mode 100644 index 000000000000..e862eb0dbb7c --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/Transactions.html @@ -0,0 +1,983 @@ + + + + +Transactions (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.client.admin
+

Interface Transactions

+
+
+
+
public interface Transactions
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      listTransactionCoordinators

      +
      List<TransactionCoordinatorInfo> listTransactionCoordinators() + throws PulsarAdminException
      +
      List transaction coordinators.
      +
      +
      Returns:
      +
      the transaction coordinators list.
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      listTransactionCoordinatorsAsync

      +
      CompletableFuture<List<TransactionCoordinatorInfo>> listTransactionCoordinatorsAsync()
      +
      List transaction coordinators.
      +
      +
      Returns:
      +
      the future of the transaction coordinators list.
      +
      +
      +
      • +
    • +
      +

      getCoordinatorStatsByIdAsync

      +
      CompletableFuture<TransactionCoordinatorStats> getCoordinatorStatsByIdAsync(int coordinatorId)
      +
      Get transaction metadataStore stats.
      +
      +
      Parameters:
      +
      coordinatorId - the id which get transaction coordinator
      +
      Returns:
      +
      the future of transaction metadata store stats.
      +
      +
      +
      • +
    • +
      +

      getCoordinatorStatsById

      +
      TransactionCoordinatorStats getCoordinatorStatsById(int coordinatorId) + throws PulsarAdminException
      +
      Get transaction metadataStore stats.
      +
      +
      Parameters:
      +
      coordinatorId - the id which get transaction coordinator
      +
      Returns:
      +
      the transaction metadata store stats.
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getCoordinatorStatsAsync

      +
      CompletableFuture<Map<Integer,TransactionCoordinatorStats>> getCoordinatorStatsAsync()
      +
      Get transaction metadataStore stats.
      +
      +
      Returns:
      +
      the map future of transaction metadata store stats.
      +
      +
      +
      • +
    • +
      +

      getCoordinatorStats

      +
      Map<Integer,TransactionCoordinatorStats> getCoordinatorStats() + throws PulsarAdminException
      +
      Get transaction metadataStore stats.
      +
      +
      Returns:
      +
      the map of transaction metadata store stats.
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getTransactionInBufferStatsAsync

      +
      CompletableFuture<TransactionInBufferStats> getTransactionInBufferStatsAsync(org.apache.pulsar.client.api.transaction.TxnID txnID, + String topic)
      +
      Get transaction in buffer stats.
      +
      +
      Parameters:
      +
      txnID - the txnId
      +
      topic - the produce topic
      +
      Returns:
      +
      the future stats of transaction in buffer.
      +
      +
      +
      • +
    • +
      +

      getTransactionInBufferStats

      +
      TransactionInBufferStats getTransactionInBufferStats(org.apache.pulsar.client.api.transaction.TxnID txnID, + String topic) + throws PulsarAdminException
      +
      Get transaction in buffer stats.
      +
      +
      Parameters:
      +
      txnID - the txnId
      +
      topic - the produce topic
      +
      Returns:
      +
      the stats of transaction in buffer.
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getTransactionInPendingAckStatsAsync

      +
      CompletableFuture<TransactionInPendingAckStats> getTransactionInPendingAckStatsAsync(org.apache.pulsar.client.api.transaction.TxnID txnID, + String topic, + String subName)
      +
      Get transaction in pending ack stats.
      +
      +
      Parameters:
      +
      txnID - the txnId
      +
      topic - the ack topic
      +
      subName - the subscription name of this transaction ack
      +
      Returns:
      +
      the future stats of transaction in pending ack.
      +
      +
      +
      • +
    • +
      +

      getTransactionInPendingAckStats

      +
      TransactionInPendingAckStats getTransactionInPendingAckStats(org.apache.pulsar.client.api.transaction.TxnID txnID, + String topic, + String subName) + throws PulsarAdminException
      +
      Get transaction in pending ack stats.
      +
      +
      Parameters:
      +
      txnID - the txnId
      +
      topic - the ack topic
      +
      subName - the subscription name of this transaction ack
      +
      Returns:
      +
      the stats of transaction in pending ack.
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getTransactionMetadataAsync

      +
      CompletableFuture<TransactionMetadata> getTransactionMetadataAsync(org.apache.pulsar.client.api.transaction.TxnID txnID)
      +
      Get transaction metadata.
      +
      +
      Parameters:
      +
      txnID - the ID of this transaction
      +
      Returns:
      +
      the future metadata of this transaction.
      +
      +
      +
      • +
    • +
      +

      getTransactionMetadata

      +
      TransactionMetadata getTransactionMetadata(org.apache.pulsar.client.api.transaction.TxnID txnID) + throws PulsarAdminException
      +
      Get transaction metadata.
      +
      +
      Parameters:
      +
      txnID - the ID of this transaction
      +
      Returns:
      +
      the metadata of this transaction.
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getTransactionBufferStatsAsync

      +
      CompletableFuture<TransactionBufferStats> getTransactionBufferStatsAsync(String topic, + boolean lowWaterMarks, + boolean segmentStats)
      +
      Get transaction buffer stats.
      +
      +
      Parameters:
      +
      topic - the topic of getting transaction buffer stats
      +
      lowWaterMarks - Whether to get information about lowWaterMarks stored in transaction pending ack.
      +
      segmentStats - Whether to get segment statistics.
      +
      Returns:
      +
      the future stats of transaction buffer in topic.
      +
      +
      +
      • +
    • +
      +

      getTransactionBufferStatsAsync

      +
      default CompletableFuture<TransactionBufferStats> getTransactionBufferStatsAsync(String topic, + boolean lowWaterMarks)
      +
      Get transaction buffer stats.
      +
      +
      Parameters:
      +
      topic - the topic of getting transaction buffer stats
      +
      lowWaterMarks - Whether to get information about lowWaterMarks stored in transaction pending ack.
      +
      Returns:
      +
      the future stats of transaction buffer in topic.
      +
      +
      +
      • +
    • +
      +

      getTransactionBufferStatsAsync

      +
      default CompletableFuture<TransactionBufferStats> getTransactionBufferStatsAsync(String topic)
      +
      Get transaction buffer stats.
      +
      +
      Parameters:
      +
      topic - the topic of getting transaction buffer stats
      +
      Returns:
      +
      the future stats of transaction buffer in topic.
      +
      +
      +
      • +
    • +
      +

      getTransactionBufferStats

      +
      TransactionBufferStats getTransactionBufferStats(String topic, + boolean lowWaterMarks, + boolean segmentStats) + throws PulsarAdminException
      +
      Get transaction buffer stats.
      +
      +
      Parameters:
      +
      topic - the topic of getting transaction buffer stats
      +
      lowWaterMarks - Whether to get information about lowWaterMarks stored in transaction buffer.
      +
      segmentStats - Whether to get segment statistics.
      +
      Returns:
      +
      the stats of transaction buffer in topic.
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getTransactionBufferStats

      +
      default TransactionBufferStats getTransactionBufferStats(String topic, + boolean lowWaterMarks) + throws PulsarAdminException
      +
      Get transaction buffer stats.
      +
      +
      Parameters:
      +
      topic - the topic of getting transaction buffer stats
      +
      lowWaterMarks - Whether to get information about lowWaterMarks stored in transaction buffer.
      +
      Returns:
      +
      the stats of transaction buffer in topic.
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getTransactionBufferStats

      +
      default TransactionBufferStats getTransactionBufferStats(String topic) + throws PulsarAdminException
      +
      Get transaction buffer stats.
      +
      +
      Parameters:
      +
      topic - the topic of getting transaction buffer stats
      +
      Returns:
      +
      the stats of transaction buffer in topic.
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getPendingAckStatsAsync

      +
      CompletableFuture<TransactionPendingAckStats> getPendingAckStatsAsync(String topic, + String subName, + boolean lowWaterMarks)
      +
      Get transaction pending ack stats.
      +
      +
      Parameters:
      +
      topic - the topic of this transaction pending ack stats
      +
      subName - the subscription name of this transaction pending ack stats
      +
      lowWaterMarks - Whether to get information about lowWaterMarks stored in transaction pending ack.
      +
      Returns:
      +
      the stats of transaction pending ack.
      +
      +
      +
      • +
    • +
      +

      getPendingAckStatsAsync

      +
      default CompletableFuture<TransactionPendingAckStats> getPendingAckStatsAsync(String topic, + String subName)
      +
      Get transaction pending ack stats.
      +
      +
      Parameters:
      +
      topic - the topic of this transaction pending ack stats
      +
      subName - the subscription name of this transaction pending ack stats
      +
      Returns:
      +
      the stats of transaction pending ack.
      +
      +
      +
      • +
    • +
      +

      getPendingAckStats

      +
      TransactionPendingAckStats getPendingAckStats(String topic, + String subName, + boolean lowWaterMarks) + throws PulsarAdminException
      +
      Get transaction pending ack stats.
      +
      +
      Parameters:
      +
      topic - the topic of this transaction pending ack stats
      +
      subName - the subscription name of this transaction pending ack stats
      +
      lowWaterMarks - Whether to get information about lowWaterMarks stored in transaction pending ack.
      +
      Returns:
      +
      the stats of transaction pending ack.
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getPendingAckStats

      +
      default TransactionPendingAckStats getPendingAckStats(String topic, + String subName) + throws PulsarAdminException
      +
      Get transaction pending ack stats.
      +
      +
      Parameters:
      +
      topic - the topic of this transaction pending ack stats
      +
      subName - the subscription name of this transaction pending ack stats
      +
      Returns:
      +
      the stats of transaction pending ack.
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getSlowTransactionsByCoordinatorIdAsync

      +
      CompletableFuture<Map<String,TransactionMetadata>> getSlowTransactionsByCoordinatorIdAsync(Integer coordinatorId, + long timeout, + TimeUnit timeUnit)
      +
      Get slow transactions by coordinator id.
      +
      +
      Parameters:
      +
      coordinatorId - the coordinator id of getting slow transaction status.
      +
      timeout - the timeout
      +
      timeUnit - the timeout timeUnit
      +
      Returns:
      +
      the future metadata of slow transactions.
      +
      +
      +
      • +
    • +
      +

      getSlowTransactionsByCoordinatorId

      +
      Map<String,TransactionMetadata> getSlowTransactionsByCoordinatorId(Integer coordinatorId, + long timeout, + TimeUnit timeUnit) + throws PulsarAdminException
      +
      Get slow transactions by coordinator id.
      +
      +
      Parameters:
      +
      coordinatorId - the coordinator id of getting slow transaction status.
      +
      timeout - the timeout
      +
      timeUnit - the timeout timeUnit
      +
      Returns:
      +
      the metadata of slow transactions.
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getSlowTransactionsAsync

      +
      CompletableFuture<Map<String,TransactionMetadata>> getSlowTransactionsAsync(long timeout, + TimeUnit timeUnit)
      +
      Get slow transactions.
      +
      +
      Parameters:
      +
      timeout - the timeout
      +
      timeUnit - the timeout timeUnit
      +
      Returns:
      +
      the future metadata of slow transactions.
      +
      +
      +
      • +
    • +
      +

      getSlowTransactions

      +
      Map<String,TransactionMetadata> getSlowTransactions(long timeout, + TimeUnit timeUnit) + throws PulsarAdminException
      +
      Get slow transactions.
      +
      +
      Parameters:
      +
      timeout - the timeout
      +
      timeUnit - the timeout timeUnit
      +
      Returns:
      +
      the metadata of slow transactions.
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getCoordinatorInternalStatsAsync

      +
      CompletableFuture<TransactionCoordinatorInternalStats> getCoordinatorInternalStatsAsync(int coordinatorId, + boolean metadata)
      +
      Get transaction coordinator internal stats.
      +
      +
      Parameters:
      +
      coordinatorId - the coordinator ID
      +
      metadata - is get ledger metadata
      +
      Returns:
      +
      the future internal stats of this coordinator
      +
      +
      +
      • +
    • +
      +

      getCoordinatorInternalStats

      +
      TransactionCoordinatorInternalStats getCoordinatorInternalStats(int coordinatorId, + boolean metadata) + throws PulsarAdminException
      +
      Get transaction coordinator internal stats.
      +
      +
      Parameters:
      +
      coordinatorId - the coordinator ID
      +
      metadata - whether to obtain ledger metadata
      +
      Returns:
      +
      the internal stats of this coordinator
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getPendingAckInternalStatsAsync

      +
      CompletableFuture<TransactionPendingAckInternalStats> getPendingAckInternalStatsAsync(String topic, + String subName, + boolean metadata)
      +
      Get pending ack internal stats.
      +
      +
      Parameters:
      +
      topic - the topic of get pending ack internal stats
      +
      subName - the subscription name of this pending ack
      +
      metadata - whether to obtain ledger metadata
      +
      Returns:
      +
      the future internal stats of pending ack
      +
      +
      +
      • +
    • +
      +

      getPendingAckInternalStats

      +
      TransactionPendingAckInternalStats getPendingAckInternalStats(String topic, + String subName, + boolean metadata) + throws PulsarAdminException
      +
      Get pending ack internal stats.
      +
      +
      Parameters:
      +
      topic - the topic of get pending ack internal stats
      +
      subName - the subscription name of this pending ack
      +
      metadata - whether to obtain ledger metadata
      +
      Returns:
      +
      the internal stats of pending ack
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getTransactionBufferInternalStatsAsync

      +
      CompletableFuture<TransactionBufferInternalStats> getTransactionBufferInternalStatsAsync(String topic, + boolean metadata)
      +
      Get transaction buffer internal stats asynchronously.
      +
      +
      Parameters:
      +
      topic - the topic to get transaction buffer internal stats from
      +
      metadata - whether to obtain ledger metadata
      +
      Returns:
      +
      the future internal stats of transaction buffer
      +
      +
      +
      • +
    • +
      +

      getTransactionBufferInternalStats

      +
      TransactionBufferInternalStats getTransactionBufferInternalStats(String topic, + boolean metadata) + throws PulsarAdminException
      +
      Get transaction buffer internal stats.
      +
      +
      Parameters:
      +
      topic - the topic to get transaction buffer internal stats from
      +
      metadata - whether to obtain ledger metadata
      +
      Returns:
      +
      the internal stats of transaction buffer
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      scaleTransactionCoordinators

      +
      void scaleTransactionCoordinators(int replicas) + throws PulsarAdminException
      +
      Sets the scale of the transaction coordinators. + And currently, we can only support scale-up.
      +
      +
      Parameters:
      +
      replicas - the new transaction coordinators size.
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      scaleTransactionCoordinatorsAsync

      +
      CompletableFuture<Void> scaleTransactionCoordinatorsAsync(int replicas)
      +
      Asynchronously sets the size of the transaction coordinators. + And currently, we can only support scale-up.
      +
      +
      Parameters:
      +
      replicas - the new transaction coordinators size.
      +
      Returns:
      +
      a future that can be used to track when the transaction coordinator number is updated.
      +
      +
      +
      • +
    • +
      +

      getPositionStatsInPendingAck

      +
      PositionInPendingAckStats getPositionStatsInPendingAck(String topic, + String subName, + Long ledgerId, + Long entryId, + Integer batchIndex) + throws PulsarAdminException
      +
      Get the position stats in transaction pending ack.
      +
      +
      Parameters:
      +
      topic - the topic of checking position in pending ack state
      +
      subName - the subscription name of this pending ack
      +
      ledgerId - the ledger id of the message position.
      +
      entryId - the entry id of the message position.
      +
      batchIndex - the batch index of the message position, `null` means not batch message.
      +
      Returns:
      +
      PositionInPendingAckStats a state identified whether the position state.
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      getPositionStatsInPendingAckAsync

      +
      CompletableFuture<PositionInPendingAckStats> getPositionStatsInPendingAckAsync(String topic, + String subName, + Long ledgerId, + Long entryId, + Integer batchIndex)
      +
      Get the position stats in transaction pending ack.
      +
      +
      Parameters:
      +
      topic - the topic of checking position in pending ack state
      +
      subName - the subscription name of this pending ack
      +
      ledgerId - the ledger id of the message position.
      +
      entryId - the entry id of the message position.
      +
      batchIndex - the batch index of the message position, `null` means not batch message.
      +
      Returns:
      +
      PositionInPendingAckStats a state identified whether the position state.
      +
      +
      +
      • +
    • +
      +

      abortTransaction

      +
      void abortTransaction(org.apache.pulsar.client.api.transaction.TxnID txnID) + throws PulsarAdminException
      +
      Abort a transaction.
      +
      +
      Parameters:
      +
      txnID - the txnId
      +
      Throws:
      +
      PulsarAdminException
      +
      +
      +
      • +
    • +
      +

      abortTransactionAsync

      +
      CompletableFuture<Void> abortTransactionAsync(org.apache.pulsar.client.api.transaction.TxnID txnID)
      +
      Asynchronously abort a transaction.
      +
      +
      Parameters:
      +
      txnID - the txnId
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/Worker.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/Worker.html new file mode 100644 index 000000000000..962356d15167 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/Worker.html @@ -0,0 +1,333 @@ + + + + +Worker (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.client.admin
+

Interface Worker

+
+
+
+
public interface Worker
+
Admin interface for worker stats management.
+
+
+ +
+
+ +
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Bookies.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Bookies.html new file mode 100644 index 000000000000..bf779972c294 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Bookies.html @@ -0,0 +1,87 @@ + + + + +Uses of Interface org.apache.pulsar.client.admin.Bookies (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.client.admin.Bookies

+
+
Packages that use Bookies
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/BrokerStats.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/BrokerStats.html new file mode 100644 index 000000000000..286f8fadf6c8 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/BrokerStats.html @@ -0,0 +1,87 @@ + + + + +Uses of Interface org.apache.pulsar.client.admin.BrokerStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.client.admin.BrokerStats

+
+
Packages that use BrokerStats
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Brokers.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Brokers.html new file mode 100644 index 000000000000..8bd62cd981be --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Brokers.html @@ -0,0 +1,87 @@ + + + + +Uses of Interface org.apache.pulsar.client.admin.Brokers (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.client.admin.Brokers

+
+
Packages that use Brokers
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Clusters.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Clusters.html new file mode 100644 index 000000000000..27c7e9ebe6d8 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Clusters.html @@ -0,0 +1,87 @@ + + + + +Uses of Interface org.apache.pulsar.client.admin.Clusters (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.client.admin.Clusters

+
+
Packages that use Clusters
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Functions.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Functions.html new file mode 100644 index 000000000000..4870a632341b --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Functions.html @@ -0,0 +1,87 @@ + + + + +Uses of Interface org.apache.pulsar.client.admin.Functions (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.client.admin.Functions

+
+
Packages that use Functions
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/GetStatsOptions.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/GetStatsOptions.html new file mode 100644 index 000000000000..40638f2702bd --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/GetStatsOptions.html @@ -0,0 +1,104 @@ + + + + +Uses of Class org.apache.pulsar.client.admin.GetStatsOptions (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.client.admin.GetStatsOptions

+
+
Packages that use GetStatsOptions
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/GrantTopicPermissionOptions.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/GrantTopicPermissionOptions.html new file mode 100644 index 000000000000..91a7da75554d --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/GrantTopicPermissionOptions.html @@ -0,0 +1,94 @@ + + + + +Uses of Class org.apache.pulsar.client.admin.GrantTopicPermissionOptions (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.client.admin.GrantTopicPermissionOptions

+
+
Packages that use GrantTopicPermissionOptions
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/ListNamespaceTopicsOptions.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/ListNamespaceTopicsOptions.html new file mode 100644 index 000000000000..99eb88dfd4e3 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/ListNamespaceTopicsOptions.html @@ -0,0 +1,105 @@ + + + + +Uses of Class org.apache.pulsar.client.admin.ListNamespaceTopicsOptions (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.client.admin.ListNamespaceTopicsOptions

+
+
Packages that use ListNamespaceTopicsOptions
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/ListTopicsOptions.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/ListTopicsOptions.html new file mode 100644 index 000000000000..ca04f771b944 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/ListTopicsOptions.html @@ -0,0 +1,119 @@ + + + + +Uses of Class org.apache.pulsar.client.admin.ListTopicsOptions (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.client.admin.ListTopicsOptions

+
+
Packages that use ListTopicsOptions
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/LongRunningProcessStatus.Status.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/LongRunningProcessStatus.Status.html new file mode 100644 index 000000000000..c0e9b29b369b --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/LongRunningProcessStatus.Status.html @@ -0,0 +1,139 @@ + + + + +Uses of Enum Class org.apache.pulsar.client.admin.LongRunningProcessStatus.Status (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Enum Class
org.apache.pulsar.client.admin.LongRunningProcessStatus.Status

+
+
Packages that use LongRunningProcessStatus.Status
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
org.apache.pulsar.client.admin.utils
+
+
Helpers which provide useful functionality for the implementation of Pulsar Client API.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/LongRunningProcessStatus.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/LongRunningProcessStatus.html new file mode 100644 index 000000000000..3fa6729e68f0 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/LongRunningProcessStatus.html @@ -0,0 +1,106 @@ + + + + +Uses of Class org.apache.pulsar.client.admin.LongRunningProcessStatus (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.client.admin.LongRunningProcessStatus

+
+
Packages that use LongRunningProcessStatus
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Lookup.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Lookup.html new file mode 100644 index 000000000000..dd55ef43049e --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Lookup.html @@ -0,0 +1,87 @@ + + + + +Uses of Interface org.apache.pulsar.client.admin.Lookup (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.client.admin.Lookup

+
+
Packages that use Lookup
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Mode.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Mode.html new file mode 100644 index 000000000000..53555df22297 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Mode.html @@ -0,0 +1,100 @@ + + + + +Uses of Enum Class org.apache.pulsar.client.admin.Mode (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Enum Class
org.apache.pulsar.client.admin.Mode

+
+
Packages that use Mode
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Namespaces.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Namespaces.html new file mode 100644 index 000000000000..8273def7db5c --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Namespaces.html @@ -0,0 +1,87 @@ + + + + +Uses of Interface org.apache.pulsar.client.admin.Namespaces (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.client.admin.Namespaces

+
+
Packages that use Namespaces
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/NonPersistentTopics.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/NonPersistentTopics.html new file mode 100644 index 000000000000..e2aa0372c86f --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/NonPersistentTopics.html @@ -0,0 +1,91 @@ + + + + +Uses of Interface org.apache.pulsar.client.admin.NonPersistentTopics (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.client.admin.NonPersistentTopics

+
+
Packages that use NonPersistentTopics
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/OffloadProcessStatus.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/OffloadProcessStatus.html new file mode 100644 index 000000000000..1a20e442c69c --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/OffloadProcessStatus.html @@ -0,0 +1,129 @@ + + + + +Uses of Interface org.apache.pulsar.client.admin.OffloadProcessStatus (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.client.admin.OffloadProcessStatus

+
+
Packages that use OffloadProcessStatus
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
org.apache.pulsar.client.admin.utils
+
+
Helpers which provide useful functionality for the implementation of Pulsar Client API.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Packages.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Packages.html new file mode 100644 index 000000000000..30631cf6094f --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Packages.html @@ -0,0 +1,87 @@ + + + + +Uses of Interface org.apache.pulsar.client.admin.Packages (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.client.admin.Packages

+
+
Packages that use Packages
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Properties.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Properties.html new file mode 100644 index 000000000000..85d5549bed02 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Properties.html @@ -0,0 +1,91 @@ + + + + +Uses of Interface org.apache.pulsar.client.admin.Properties (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.client.admin.Properties

+
+
Packages that use Properties
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/ProxyStats.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/ProxyStats.html new file mode 100644 index 000000000000..0806f94cc4d1 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/ProxyStats.html @@ -0,0 +1,87 @@ + + + + +Uses of Interface org.apache.pulsar.client.admin.ProxyStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.client.admin.ProxyStats

+
+
Packages that use ProxyStats
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/PulsarAdmin.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/PulsarAdmin.html new file mode 100644 index 000000000000..2e91757f31b2 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/PulsarAdmin.html @@ -0,0 +1,87 @@ + + + + +Uses of Interface org.apache.pulsar.client.admin.PulsarAdmin (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.client.admin.PulsarAdmin

+
+
Packages that use PulsarAdmin
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/PulsarAdminBuilder.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/PulsarAdminBuilder.html new file mode 100644 index 000000000000..75308070b6fb --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/PulsarAdminBuilder.html @@ -0,0 +1,266 @@ + + + + +Uses of Interface org.apache.pulsar.client.admin.PulsarAdminBuilder (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.client.admin.PulsarAdminBuilder

+
+
Packages that use PulsarAdminBuilder
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
org.apache.pulsar.client.admin.utils
+
+
Helpers which provide useful functionality for the implementation of Pulsar Client API.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/PulsarAdminException.ConflictException.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/PulsarAdminException.ConflictException.html new file mode 100644 index 000000000000..9c4ca0a9d105 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/PulsarAdminException.ConflictException.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.client.admin.PulsarAdminException.ConflictException (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.client.admin.PulsarAdminException.ConflictException

+
+No usage of org.apache.pulsar.client.admin.PulsarAdminException.ConflictException
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/PulsarAdminException.ConnectException.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/PulsarAdminException.ConnectException.html new file mode 100644 index 000000000000..f3f54c57fcc1 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/PulsarAdminException.ConnectException.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.client.admin.PulsarAdminException.ConnectException (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.client.admin.PulsarAdminException.ConnectException

+
+No usage of org.apache.pulsar.client.admin.PulsarAdminException.ConnectException
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/PulsarAdminException.GettingAuthenticationDataException.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/PulsarAdminException.GettingAuthenticationDataException.html new file mode 100644 index 000000000000..23bb330f7fa9 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/PulsarAdminException.GettingAuthenticationDataException.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.client.admin.PulsarAdminException.GettingAuthenticationDataException (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.client.admin.PulsarAdminException.GettingAuthenticationDataException

+
+No usage of org.apache.pulsar.client.admin.PulsarAdminException.GettingAuthenticationDataException
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/PulsarAdminException.HttpErrorException.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/PulsarAdminException.HttpErrorException.html new file mode 100644 index 000000000000..38e7628a0a8b --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/PulsarAdminException.HttpErrorException.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.client.admin.PulsarAdminException.HttpErrorException (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.client.admin.PulsarAdminException.HttpErrorException

+
+No usage of org.apache.pulsar.client.admin.PulsarAdminException.HttpErrorException
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/PulsarAdminException.NotAllowedException.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/PulsarAdminException.NotAllowedException.html new file mode 100644 index 000000000000..70e5fcda2963 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/PulsarAdminException.NotAllowedException.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.client.admin.PulsarAdminException.NotAllowedException (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.client.admin.PulsarAdminException.NotAllowedException

+
+No usage of org.apache.pulsar.client.admin.PulsarAdminException.NotAllowedException
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/PulsarAdminException.NotAuthorizedException.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/PulsarAdminException.NotAuthorizedException.html new file mode 100644 index 000000000000..dcc87e0e0312 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/PulsarAdminException.NotAuthorizedException.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.client.admin.PulsarAdminException.NotAuthorizedException (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.client.admin.PulsarAdminException.NotAuthorizedException

+
+No usage of org.apache.pulsar.client.admin.PulsarAdminException.NotAuthorizedException
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/PulsarAdminException.NotFoundException.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/PulsarAdminException.NotFoundException.html new file mode 100644 index 000000000000..4c7713a43f55 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/PulsarAdminException.NotFoundException.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.client.admin.PulsarAdminException.NotFoundException (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.client.admin.PulsarAdminException.NotFoundException

+
+No usage of org.apache.pulsar.client.admin.PulsarAdminException.NotFoundException
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/PulsarAdminException.PreconditionFailedException.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/PulsarAdminException.PreconditionFailedException.html new file mode 100644 index 000000000000..a8b196a032f3 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/PulsarAdminException.PreconditionFailedException.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.client.admin.PulsarAdminException.PreconditionFailedException (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.client.admin.PulsarAdminException.PreconditionFailedException

+
+No usage of org.apache.pulsar.client.admin.PulsarAdminException.PreconditionFailedException
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/PulsarAdminException.ServerSideErrorException.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/PulsarAdminException.ServerSideErrorException.html new file mode 100644 index 000000000000..27c0afe0f066 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/PulsarAdminException.ServerSideErrorException.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.client.admin.PulsarAdminException.ServerSideErrorException (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.client.admin.PulsarAdminException.ServerSideErrorException

+
+No usage of org.apache.pulsar.client.admin.PulsarAdminException.ServerSideErrorException
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/PulsarAdminException.TimeoutException.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/PulsarAdminException.TimeoutException.html new file mode 100644 index 000000000000..a0aeb6b7db1e --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/PulsarAdminException.TimeoutException.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.client.admin.PulsarAdminException.TimeoutException (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.client.admin.PulsarAdminException.TimeoutException

+
+No usage of org.apache.pulsar.client.admin.PulsarAdminException.TimeoutException
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/PulsarAdminException.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/PulsarAdminException.html new file mode 100644 index 000000000000..a79140080749 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/PulsarAdminException.html @@ -0,0 +1,4093 @@ + + + + +Uses of Class org.apache.pulsar.client.admin.PulsarAdminException (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.client.admin.PulsarAdminException

+
+
Packages that use PulsarAdminException
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/ResourceGroups.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/ResourceGroups.html new file mode 100644 index 000000000000..ca271075ddf2 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/ResourceGroups.html @@ -0,0 +1,87 @@ + + + + +Uses of Interface org.apache.pulsar.client.admin.ResourceGroups (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.client.admin.ResourceGroups

+
+
Packages that use ResourceGroups
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/ResourceQuotas.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/ResourceQuotas.html new file mode 100644 index 000000000000..ac6a0d763921 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/ResourceQuotas.html @@ -0,0 +1,87 @@ + + + + +Uses of Interface org.apache.pulsar.client.admin.ResourceQuotas (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.client.admin.ResourceQuotas

+
+
Packages that use ResourceQuotas
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/RevokeTopicPermissionOptions.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/RevokeTopicPermissionOptions.html new file mode 100644 index 000000000000..4a8fb72e49a4 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/RevokeTopicPermissionOptions.html @@ -0,0 +1,94 @@ + + + + +Uses of Class org.apache.pulsar.client.admin.RevokeTopicPermissionOptions (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.client.admin.RevokeTopicPermissionOptions

+
+
Packages that use RevokeTopicPermissionOptions
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Schemas.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Schemas.html new file mode 100644 index 000000000000..edf5f0b868f7 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Schemas.html @@ -0,0 +1,87 @@ + + + + +Uses of Interface org.apache.pulsar.client.admin.Schemas (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.client.admin.Schemas

+
+
Packages that use Schemas
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Sink.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Sink.html new file mode 100644 index 000000000000..7e11a7aca2b2 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Sink.html @@ -0,0 +1,91 @@ + + + + +Uses of Interface org.apache.pulsar.client.admin.Sink (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.client.admin.Sink

+
+
Packages that use Sink
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Sinks.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Sinks.html new file mode 100644 index 000000000000..4fe6769bf359 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Sinks.html @@ -0,0 +1,100 @@ + + + + +Uses of Interface org.apache.pulsar.client.admin.Sinks (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.client.admin.Sinks

+
+
Packages that use Sinks
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Source.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Source.html new file mode 100644 index 000000000000..015b6a2de49a --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Source.html @@ -0,0 +1,91 @@ + + + + +Uses of Interface org.apache.pulsar.client.admin.Source (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.client.admin.Source

+
+
Packages that use Source
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Sources.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Sources.html new file mode 100644 index 000000000000..bad4037f6e95 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Sources.html @@ -0,0 +1,100 @@ + + + + +Uses of Interface org.apache.pulsar.client.admin.Sources (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.client.admin.Sources

+
+
Packages that use Sources
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Tenants.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Tenants.html new file mode 100644 index 000000000000..cab435fff7e5 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Tenants.html @@ -0,0 +1,87 @@ + + + + +Uses of Interface org.apache.pulsar.client.admin.Tenants (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.client.admin.Tenants

+
+
Packages that use Tenants
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/TopicPolicies.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/TopicPolicies.html new file mode 100644 index 000000000000..d4037e17964a --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/TopicPolicies.html @@ -0,0 +1,94 @@ + + + + +Uses of Interface org.apache.pulsar.client.admin.TopicPolicies (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.client.admin.TopicPolicies

+
+
Packages that use TopicPolicies
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Topics.QueryParam.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Topics.QueryParam.html new file mode 100644 index 000000000000..8aac73059892 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Topics.QueryParam.html @@ -0,0 +1,119 @@ + + + + +Uses of Enum Class org.apache.pulsar.client.admin.Topics.QueryParam (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Enum Class
org.apache.pulsar.client.admin.Topics.QueryParam

+
+
Packages that use Topics.QueryParam
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Topics.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Topics.html new file mode 100644 index 000000000000..59ea5ad4467a --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Topics.html @@ -0,0 +1,87 @@ + + + + +Uses of Interface org.apache.pulsar.client.admin.Topics (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.client.admin.Topics

+
+
Packages that use Topics
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Transactions.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Transactions.html new file mode 100644 index 000000000000..b2c105460bf0 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Transactions.html @@ -0,0 +1,87 @@ + + + + +Uses of Interface org.apache.pulsar.client.admin.Transactions (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.client.admin.Transactions

+
+
Packages that use Transactions
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Worker.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Worker.html new file mode 100644 index 000000000000..64efcc7f4059 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/class-use/Worker.html @@ -0,0 +1,87 @@ + + + + +Uses of Interface org.apache.pulsar.client.admin.Worker (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.client.admin.Worker

+
+
Packages that use Worker
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/package-summary.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/package-summary.html new file mode 100644 index 000000000000..57849fcb2855 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/package-summary.html @@ -0,0 +1,275 @@ + + + + +org.apache.pulsar.client.admin (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Package org.apache.pulsar.client.admin

+
+
+
package org.apache.pulsar.client.admin
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/package-tree.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/package-tree.html new file mode 100644 index 000000000000..e9ab4eb30cb6 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/package-tree.html @@ -0,0 +1,164 @@ + + + + +org.apache.pulsar.client.admin Class Hierarchy (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package org.apache.pulsar.client.admin

+
+Package Hierarchies: + +
+

Class Hierarchy

+ +
+
+

Interface Hierarchy

+ +
+
+

Enum Class Hierarchy

+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/package-use.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/package-use.html new file mode 100644 index 000000000000..674597a01f3d --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/package-use.html @@ -0,0 +1,241 @@ + + + + +Uses of Package org.apache.pulsar.client.admin (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Package
org.apache.pulsar.client.admin

+
+
Packages that use org.apache.pulsar.client.admin
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
org.apache.pulsar.client.admin.utils
+
+
Helpers which provide useful functionality for the implementation of Pulsar Client API.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/utils/DefaultImplementation.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/utils/DefaultImplementation.html new file mode 100644 index 000000000000..d68e7d904d1e --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/utils/DefaultImplementation.html @@ -0,0 +1,191 @@ + + + + +DefaultImplementation (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.client.admin.utils
+

Class DefaultImplementation

+
+
java.lang.Object +
org.apache.pulsar.client.admin.utils.DefaultImplementation
+
+
+
+
public class DefaultImplementation +extends Object
+
Helper class for class instantiations and it also contains methods to work with schemas.
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      DefaultImplementation

      +
      public DefaultImplementation()
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    + +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/utils/ReflectionUtils.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/utils/ReflectionUtils.html new file mode 100644 index 000000000000..03366f4b274f --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/utils/ReflectionUtils.html @@ -0,0 +1,177 @@ + + + + +ReflectionUtils (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.client.admin.utils
+

Class ReflectionUtils

+
+
java.lang.Object +
org.apache.pulsar.client.admin.utils.ReflectionUtils
+
+
+
+
public class ReflectionUtils +extends Object
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      ReflectionUtils

      +
      public ReflectionUtils()
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      newBuilder

      +
      public static <T> T newBuilder(String className)
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/utils/class-use/DefaultImplementation.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/utils/class-use/DefaultImplementation.html new file mode 100644 index 000000000000..711adf08fe82 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/utils/class-use/DefaultImplementation.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.client.admin.utils.DefaultImplementation (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.client.admin.utils.DefaultImplementation

+
+No usage of org.apache.pulsar.client.admin.utils.DefaultImplementation
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/utils/class-use/ReflectionUtils.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/utils/class-use/ReflectionUtils.html new file mode 100644 index 000000000000..4cb27a018778 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/utils/class-use/ReflectionUtils.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.client.admin.utils.ReflectionUtils (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.client.admin.utils.ReflectionUtils

+
+No usage of org.apache.pulsar.client.admin.utils.ReflectionUtils
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/utils/package-summary.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/utils/package-summary.html new file mode 100644 index 000000000000..cf6b6b0bf75a --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/utils/package-summary.html @@ -0,0 +1,114 @@ + + + + +org.apache.pulsar.client.admin.utils (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Package org.apache.pulsar.client.admin.utils

+
+
+
package org.apache.pulsar.client.admin.utils
+
+
Helpers which provide useful functionality for the implementation of Pulsar Client API.
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/utils/package-tree.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/utils/package-tree.html new file mode 100644 index 000000000000..c22b6c25ca25 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/utils/package-tree.html @@ -0,0 +1,77 @@ + + + + +org.apache.pulsar.client.admin.utils Class Hierarchy (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package org.apache.pulsar.client.admin.utils

+
+Package Hierarchies: + +
+

Class Hierarchy

+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/client/admin/utils/package-use.html b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/utils/package-use.html new file mode 100644 index 000000000000..a1f9138be6ef --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/client/admin/utils/package-use.html @@ -0,0 +1,62 @@ + + + + +Uses of Package org.apache.pulsar.client.admin.utils (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Package
org.apache.pulsar.client.admin.utils

+
+No usage of org.apache.pulsar.client.admin.utils
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/conf/InternalConfigurationData.html b/static/api/admin/4.0.x/org/apache/pulsar/common/conf/InternalConfigurationData.html new file mode 100644 index 000000000000..87d9f78be3a7 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/conf/InternalConfigurationData.html @@ -0,0 +1,312 @@ + + + + +InternalConfigurationData (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.conf
+

Class InternalConfigurationData

+
+
java.lang.Object +
org.apache.pulsar.common.conf.InternalConfigurationData
+
+
+
+
public class InternalConfigurationData +extends Object
+
Internal configuration data.
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      InternalConfigurationData

      +
      public InternalConfigurationData()
      +
      +
      • +
    • +
      +

      InternalConfigurationData

      +
      public InternalConfigurationData(String zookeeperServers, + String configurationMetadataStoreUrl, + String ledgersRootPath, + String bookkeeperMetadataServiceUri, + String stateStorageServiceUrl)
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getZookeeperServers

      +
      @Deprecated +public String getZookeeperServers()
      +
      Deprecated.
      +
      +
      • +
    • +
      +

      setZookeeperServers

      +
      @Deprecated +public void setZookeeperServers(String zookeeperServers)
      +
      Deprecated.
      +
      +
      • +
    • +
      +

      getConfigurationStoreServers

      +
      @Deprecated +public String getConfigurationStoreServers()
      +
      Deprecated.
      +
      +
      • +
    • +
      +

      setConfigurationStoreServers

      +
      @Deprecated +public void setConfigurationStoreServers(String configurationStoreServers)
      +
      Deprecated.
      +
      +
      • +
    • +
      +

      getMetadataStoreUrl

      +
      public String getMetadataStoreUrl()
      +
      +
      • +
    • +
      +

      getConfigurationMetadataStoreUrl

      +
      public String getConfigurationMetadataStoreUrl()
      +
      +
      • +
    • +
      +

      getLedgersRootPath

      +
      @Deprecated +public String getLedgersRootPath()
      +
      Deprecated.
      +
      +
      • +
    • +
      +

      getBookkeeperMetadataServiceUri

      +
      public String getBookkeeperMetadataServiceUri()
      +
      +
      • +
    • +
      +

      getStateStorageServiceUrl

      +
      public String getStateStorageServiceUrl()
      +
      +
      • +
    • +
      +

      equals

      +
      public boolean equals(Object obj)
      +
      +
      Overrides:
      +
      equals in class Object
      +
      +
      +
      • +
    • +
      +

      hashCode

      +
      public int hashCode()
      +
      +
      Overrides:
      +
      hashCode in class Object
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/conf/class-use/InternalConfigurationData.html b/static/api/admin/4.0.x/org/apache/pulsar/common/conf/class-use/InternalConfigurationData.html new file mode 100644 index 000000000000..adbec39a1f4f --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/conf/class-use/InternalConfigurationData.html @@ -0,0 +1,100 @@ + + + + +Uses of Class org.apache.pulsar.common.conf.InternalConfigurationData (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.conf.InternalConfigurationData

+
+
Packages that use InternalConfigurationData
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/conf/package-summary.html b/static/api/admin/4.0.x/org/apache/pulsar/common/conf/package-summary.html new file mode 100644 index 000000000000..4cd279aadd14 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/conf/package-summary.html @@ -0,0 +1,101 @@ + + + + +org.apache.pulsar.common.conf (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Package org.apache.pulsar.common.conf

+
+
+
package org.apache.pulsar.common.conf
+
+
Classes for internal configuration.
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/conf/package-tree.html b/static/api/admin/4.0.x/org/apache/pulsar/common/conf/package-tree.html new file mode 100644 index 000000000000..ed7a8901e898 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/conf/package-tree.html @@ -0,0 +1,76 @@ + + + + +org.apache.pulsar.common.conf Class Hierarchy (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package org.apache.pulsar.common.conf

+
+Package Hierarchies: + +
+

Class Hierarchy

+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/conf/package-use.html b/static/api/admin/4.0.x/org/apache/pulsar/common/conf/package-use.html new file mode 100644 index 000000000000..8311e139c736 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/conf/package-use.html @@ -0,0 +1,86 @@ + + + + +Uses of Package org.apache.pulsar.common.conf (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Package
org.apache.pulsar.common.conf

+
+
Packages that use org.apache.pulsar.common.conf
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/functions/AuthenticationConfig.html b/static/api/admin/4.0.x/org/apache/pulsar/common/functions/AuthenticationConfig.html new file mode 100644 index 000000000000..71bbe45febde --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/functions/AuthenticationConfig.html @@ -0,0 +1,151 @@ + + + + +AuthenticationConfig (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.functions
+

Class AuthenticationConfig

+
+
java.lang.Object +
org.apache.pulsar.common.functions.AuthenticationConfig
+
+
+
+
public class AuthenticationConfig +extends Object
+
Configuration to aggregate various authentication params.
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      AuthenticationConfig

      +
      public AuthenticationConfig()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/functions/ConsumerConfig.html b/static/api/admin/4.0.x/org/apache/pulsar/common/functions/ConsumerConfig.html new file mode 100644 index 000000000000..a65a4dc6907b --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/functions/ConsumerConfig.html @@ -0,0 +1,151 @@ + + + + +ConsumerConfig (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.functions
+

Class ConsumerConfig

+
+
java.lang.Object +
org.apache.pulsar.common.functions.ConsumerConfig
+
+
+
+
public class ConsumerConfig +extends Object
+
Configuration of a consumer.
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      ConsumerConfig

      +
      public ConsumerConfig(String schemaType)
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/functions/CryptoConfig.html b/static/api/admin/4.0.x/org/apache/pulsar/common/functions/CryptoConfig.html new file mode 100644 index 000000000000..1b3f68670ed3 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/functions/CryptoConfig.html @@ -0,0 +1,151 @@ + + + + +CryptoConfig (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.functions
+

Class CryptoConfig

+
+
java.lang.Object +
org.apache.pulsar.common.functions.CryptoConfig
+
+
+
+
public class CryptoConfig +extends Object
+
Configuration of the producer inside the function.
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      CryptoConfig

      +
      public CryptoConfig()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/functions/FunctionConfig.ProcessingGuarantees.html b/static/api/admin/4.0.x/org/apache/pulsar/common/functions/FunctionConfig.ProcessingGuarantees.html new file mode 100644 index 000000000000..16bdde0803dc --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/functions/FunctionConfig.ProcessingGuarantees.html @@ -0,0 +1,257 @@ + + + + +FunctionConfig.ProcessingGuarantees (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.functions
+

Enum Class FunctionConfig.ProcessingGuarantees

+
+
java.lang.Object +
java.lang.Enum<FunctionConfig.ProcessingGuarantees> +
org.apache.pulsar.common.functions.FunctionConfig.ProcessingGuarantees
+
+
+
+
+
All Implemented Interfaces:
+
Serializable, Comparable<FunctionConfig.ProcessingGuarantees>, Constable
+
+
+
Enclosing class:
+
FunctionConfig
+
+
+
public static enum FunctionConfig.ProcessingGuarantees +extends Enum<FunctionConfig.ProcessingGuarantees>
+
Definition of possible processing guarantees.
+
+
+ +
+
+ +
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/functions/FunctionConfig.Runtime.html b/static/api/admin/4.0.x/org/apache/pulsar/common/functions/FunctionConfig.Runtime.html new file mode 100644 index 000000000000..57eed302d9c3 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/functions/FunctionConfig.Runtime.html @@ -0,0 +1,249 @@ + + + + +FunctionConfig.Runtime (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.functions
+

Enum Class FunctionConfig.Runtime

+
+
java.lang.Object +
java.lang.Enum<FunctionConfig.Runtime> +
org.apache.pulsar.common.functions.FunctionConfig.Runtime
+
+
+
+
+
All Implemented Interfaces:
+
Serializable, Comparable<FunctionConfig.Runtime>, Constable
+
+
+
Enclosing class:
+
FunctionConfig
+
+
+
public static enum FunctionConfig.Runtime +extends Enum<FunctionConfig.Runtime>
+
Definition of possible runtime environments.
+
+
+ +
+
+
    + +
  • +
    +

    Enum Constant Details

    + +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      values

      +
      public static FunctionConfig.Runtime[] values()
      +
      Returns an array containing the constants of this enum class, in +the order they are declared.
      +
      +
      Returns:
      +
      an array containing the constants of this enum class, in the order they are declared
      +
      +
      +
      • +
    • +
      +

      valueOf

      +
      public static FunctionConfig.Runtime valueOf(String name)
      +
      Returns the enum constant of this class with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this class. (Extraneous whitespace characters are +not permitted.)
      +
      +
      Parameters:
      +
      name - the name of the enum constant to be returned.
      +
      Returns:
      +
      the enum constant with the specified name
      +
      Throws:
      +
      IllegalArgumentException - if this enum class has no constant with the specified name
      +
      NullPointerException - if the argument is null
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/functions/FunctionConfig.html b/static/api/admin/4.0.x/org/apache/pulsar/common/functions/FunctionConfig.html new file mode 100644 index 000000000000..4ea76cde9000 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/functions/FunctionConfig.html @@ -0,0 +1,173 @@ + + + + +FunctionConfig (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.functions
+

Class FunctionConfig

+
+
java.lang.Object +
org.apache.pulsar.common.functions.FunctionConfig
+
+
+
+
public class FunctionConfig +extends Object
+
Configuration of Pulsar Function.
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      FunctionConfig

      +
      public FunctionConfig()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/functions/FunctionDefinition.html b/static/api/admin/4.0.x/org/apache/pulsar/common/functions/FunctionDefinition.html new file mode 100644 index 000000000000..ebb74ec50aaa --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/functions/FunctionDefinition.html @@ -0,0 +1,151 @@ + + + + +FunctionDefinition (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.functions
+

Class FunctionDefinition

+
+
java.lang.Object +
org.apache.pulsar.common.functions.FunctionDefinition
+
+
+
+
public class FunctionDefinition +extends Object
+
Basic information about a Pulsar function.
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      FunctionDefinition

      +
      public FunctionDefinition()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/functions/FunctionState.html b/static/api/admin/4.0.x/org/apache/pulsar/common/functions/FunctionState.html new file mode 100644 index 000000000000..9bc47b159979 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/functions/FunctionState.html @@ -0,0 +1,151 @@ + + + + +FunctionState (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.functions
+

Class FunctionState

+
+
java.lang.Object +
org.apache.pulsar.common.functions.FunctionState
+
+
+
+
public class FunctionState +extends Object
+
Function state.
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      FunctionState

      +
      public FunctionState()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/functions/ProducerConfig.html b/static/api/admin/4.0.x/org/apache/pulsar/common/functions/ProducerConfig.html new file mode 100644 index 000000000000..be7c3f4954ee --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/functions/ProducerConfig.html @@ -0,0 +1,151 @@ + + + + +ProducerConfig (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.functions
+

Class ProducerConfig

+
+
java.lang.Object +
org.apache.pulsar.common.functions.ProducerConfig
+
+
+
+
public class ProducerConfig +extends Object
+
Configuration of the producer inside the function.
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      ProducerConfig

      +
      public ProducerConfig()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/functions/Resources.html b/static/api/admin/4.0.x/org/apache/pulsar/common/functions/Resources.html new file mode 100644 index 000000000000..86b526316c54 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/functions/Resources.html @@ -0,0 +1,187 @@ + + + + +Resources (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.functions
+

Class Resources

+
+
java.lang.Object +
org.apache.pulsar.common.functions.Resources
+
+
+
+
public class Resources +extends Object
+
Class representing resources, such as CPU, RAM, and disk size.
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      Resources

      +
      public Resources()
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getDefaultResources

      +
      public static Resources getDefaultResources()
      +
      +
      • +
    • +
      +

      mergeWithDefault

      +
      public static Resources mergeWithDefault(Resources resources)
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/functions/UpdateOptions.html b/static/api/admin/4.0.x/org/apache/pulsar/common/functions/UpdateOptions.html new file mode 100644 index 000000000000..275a49285b12 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/functions/UpdateOptions.html @@ -0,0 +1,152 @@ + + + + +UpdateOptions (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.functions
+

Interface UpdateOptions

+
+
+
+
public interface UpdateOptions
+
+
+
    + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    boolean
    +
    isUpdateAuthData()
    +
     
    +
    void
    +
    setUpdateAuthData(boolean updateAuthData)
    +
     
    +
    +
    +
    +
    +
    • +
+
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      isUpdateAuthData

      +
      boolean isUpdateAuthData()
      +
      +
      • +
    • +
      +

      setUpdateAuthData

      +
      void setUpdateAuthData(boolean updateAuthData)
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/functions/WindowConfig.ProcessingGuarantees.html b/static/api/admin/4.0.x/org/apache/pulsar/common/functions/WindowConfig.ProcessingGuarantees.html new file mode 100644 index 000000000000..1b9ea4a31ca3 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/functions/WindowConfig.ProcessingGuarantees.html @@ -0,0 +1,243 @@ + + + + +WindowConfig.ProcessingGuarantees (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.functions
+

Enum Class WindowConfig.ProcessingGuarantees

+
+
java.lang.Object +
java.lang.Enum<WindowConfig.ProcessingGuarantees> +
org.apache.pulsar.common.functions.WindowConfig.ProcessingGuarantees
+
+
+
+
+
All Implemented Interfaces:
+
Serializable, Comparable<WindowConfig.ProcessingGuarantees>, Constable
+
+
+
Enclosing class:
+
WindowConfig
+
+
+
public static enum WindowConfig.ProcessingGuarantees +extends Enum<WindowConfig.ProcessingGuarantees>
+
This is a semantic option that windows can provide, + forcing the semantics of the FunctionConfig.ProcessingGuarantees to be equal to MANUAL, + and then letting the windows function handle the semantic timing by itself.
+
+
+ +
+
+
    + +
  • +
    +

    Enum Constant Details

    + +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      values

      +
      public static WindowConfig.ProcessingGuarantees[] values()
      +
      Returns an array containing the constants of this enum class, in +the order they are declared.
      +
      +
      Returns:
      +
      an array containing the constants of this enum class, in the order they are declared
      +
      +
      +
      • +
    • +
      +

      valueOf

      +
      public static WindowConfig.ProcessingGuarantees valueOf(String name)
      +
      Returns the enum constant of this class with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this class. (Extraneous whitespace characters are +not permitted.)
      +
      +
      Parameters:
      +
      name - the name of the enum constant to be returned.
      +
      Returns:
      +
      the enum constant with the specified name
      +
      Throws:
      +
      IllegalArgumentException - if this enum class has no constant with the specified name
      +
      NullPointerException - if the argument is null
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/functions/WindowConfig.html b/static/api/admin/4.0.x/org/apache/pulsar/common/functions/WindowConfig.html new file mode 100644 index 000000000000..77cd019faf3f --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/functions/WindowConfig.html @@ -0,0 +1,207 @@ + + + + +WindowConfig (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.functions
+

Class WindowConfig

+
+
java.lang.Object +
org.apache.pulsar.common.functions.WindowConfig
+
+
+
+
public class WindowConfig +extends Object
+
Configuration of a windowing function.
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    + +
    +
    • + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      WindowConfig

      +
      public WindowConfig()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/functions/WorkerInfo.html b/static/api/admin/4.0.x/org/apache/pulsar/common/functions/WorkerInfo.html new file mode 100644 index 000000000000..28853b61b5e2 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/functions/WorkerInfo.html @@ -0,0 +1,191 @@ + + + + +WorkerInfo (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.functions
+

Class WorkerInfo

+
+
java.lang.Object +
org.apache.pulsar.common.functions.WorkerInfo
+
+
+
+
public class WorkerInfo +extends Object
+
Worker information.
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      WorkerInfo

      +
      public WorkerInfo()
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    + +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/functions/class-use/AuthenticationConfig.html b/static/api/admin/4.0.x/org/apache/pulsar/common/functions/class-use/AuthenticationConfig.html new file mode 100644 index 000000000000..5193809f36f1 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/functions/class-use/AuthenticationConfig.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.common.functions.AuthenticationConfig (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.functions.AuthenticationConfig

+
+No usage of org.apache.pulsar.common.functions.AuthenticationConfig
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/functions/class-use/ConsumerConfig.html b/static/api/admin/4.0.x/org/apache/pulsar/common/functions/class-use/ConsumerConfig.html new file mode 100644 index 000000000000..e79d9509604d --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/functions/class-use/ConsumerConfig.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.common.functions.ConsumerConfig (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.functions.ConsumerConfig

+
+No usage of org.apache.pulsar.common.functions.ConsumerConfig
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/functions/class-use/CryptoConfig.html b/static/api/admin/4.0.x/org/apache/pulsar/common/functions/class-use/CryptoConfig.html new file mode 100644 index 000000000000..023061cfb860 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/functions/class-use/CryptoConfig.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.common.functions.CryptoConfig (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.functions.CryptoConfig

+
+No usage of org.apache.pulsar.common.functions.CryptoConfig
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/functions/class-use/FunctionConfig.ProcessingGuarantees.html b/static/api/admin/4.0.x/org/apache/pulsar/common/functions/class-use/FunctionConfig.ProcessingGuarantees.html new file mode 100644 index 000000000000..8b314baf89a5 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/functions/class-use/FunctionConfig.ProcessingGuarantees.html @@ -0,0 +1,97 @@ + + + + +Uses of Enum Class org.apache.pulsar.common.functions.FunctionConfig.ProcessingGuarantees (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Enum Class
org.apache.pulsar.common.functions.FunctionConfig.ProcessingGuarantees

+
+
Packages that use FunctionConfig.ProcessingGuarantees
+
+
Package
+
Description
+
org.apache.pulsar.common.functions
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/functions/class-use/FunctionConfig.Runtime.html b/static/api/admin/4.0.x/org/apache/pulsar/common/functions/class-use/FunctionConfig.Runtime.html new file mode 100644 index 000000000000..41f7306e18e6 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/functions/class-use/FunctionConfig.Runtime.html @@ -0,0 +1,97 @@ + + + + +Uses of Enum Class org.apache.pulsar.common.functions.FunctionConfig.Runtime (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Enum Class
org.apache.pulsar.common.functions.FunctionConfig.Runtime

+
+
Packages that use FunctionConfig.Runtime
+
+
Package
+
Description
+
org.apache.pulsar.common.functions
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/functions/class-use/FunctionConfig.html b/static/api/admin/4.0.x/org/apache/pulsar/common/functions/class-use/FunctionConfig.html new file mode 100644 index 000000000000..ebe4fd3b7563 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/functions/class-use/FunctionConfig.html @@ -0,0 +1,186 @@ + + + + +Uses of Class org.apache.pulsar.common.functions.FunctionConfig (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.functions.FunctionConfig

+
+
Packages that use FunctionConfig
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/functions/class-use/FunctionDefinition.html b/static/api/admin/4.0.x/org/apache/pulsar/common/functions/class-use/FunctionDefinition.html new file mode 100644 index 000000000000..0281478b54c0 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/functions/class-use/FunctionDefinition.html @@ -0,0 +1,94 @@ + + + + +Uses of Class org.apache.pulsar.common.functions.FunctionDefinition (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.functions.FunctionDefinition

+
+
Packages that use FunctionDefinition
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/functions/class-use/FunctionState.html b/static/api/admin/4.0.x/org/apache/pulsar/common/functions/class-use/FunctionState.html new file mode 100644 index 000000000000..4070c5e248ab --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/functions/class-use/FunctionState.html @@ -0,0 +1,128 @@ + + + + +Uses of Class org.apache.pulsar.common.functions.FunctionState (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.functions.FunctionState

+
+
Packages that use FunctionState
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/functions/class-use/ProducerConfig.html b/static/api/admin/4.0.x/org/apache/pulsar/common/functions/class-use/ProducerConfig.html new file mode 100644 index 000000000000..92d70fcfaa63 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/functions/class-use/ProducerConfig.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.common.functions.ProducerConfig (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.functions.ProducerConfig

+
+No usage of org.apache.pulsar.common.functions.ProducerConfig
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/functions/class-use/Resources.html b/static/api/admin/4.0.x/org/apache/pulsar/common/functions/class-use/Resources.html new file mode 100644 index 000000000000..15c84a9bf355 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/functions/class-use/Resources.html @@ -0,0 +1,101 @@ + + + + +Uses of Class org.apache.pulsar.common.functions.Resources (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.functions.Resources

+
+
Packages that use Resources
+
+
Package
+
Description
+
org.apache.pulsar.common.functions
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/functions/class-use/UpdateOptions.html b/static/api/admin/4.0.x/org/apache/pulsar/common/functions/class-use/UpdateOptions.html new file mode 100644 index 000000000000..4214dc5626b2 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/functions/class-use/UpdateOptions.html @@ -0,0 +1,168 @@ + + + + +Uses of Interface org.apache.pulsar.common.functions.UpdateOptions (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.common.functions.UpdateOptions

+
+
Packages that use UpdateOptions
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/functions/class-use/WindowConfig.ProcessingGuarantees.html b/static/api/admin/4.0.x/org/apache/pulsar/common/functions/class-use/WindowConfig.ProcessingGuarantees.html new file mode 100644 index 000000000000..7e16d683e652 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/functions/class-use/WindowConfig.ProcessingGuarantees.html @@ -0,0 +1,97 @@ + + + + +Uses of Enum Class org.apache.pulsar.common.functions.WindowConfig.ProcessingGuarantees (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Enum Class
org.apache.pulsar.common.functions.WindowConfig.ProcessingGuarantees

+
+
Packages that use WindowConfig.ProcessingGuarantees
+
+
Package
+
Description
+
org.apache.pulsar.common.functions
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/functions/class-use/WindowConfig.html b/static/api/admin/4.0.x/org/apache/pulsar/common/functions/class-use/WindowConfig.html new file mode 100644 index 000000000000..73cc3ab08835 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/functions/class-use/WindowConfig.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.common.functions.WindowConfig (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.functions.WindowConfig

+
+No usage of org.apache.pulsar.common.functions.WindowConfig
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/functions/class-use/WorkerInfo.html b/static/api/admin/4.0.x/org/apache/pulsar/common/functions/class-use/WorkerInfo.html new file mode 100644 index 000000000000..f670cc1d1597 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/functions/class-use/WorkerInfo.html @@ -0,0 +1,133 @@ + + + + +Uses of Class org.apache.pulsar.common.functions.WorkerInfo (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.functions.WorkerInfo

+
+
Packages that use WorkerInfo
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
org.apache.pulsar.common.functions
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/functions/package-summary.html b/static/api/admin/4.0.x/org/apache/pulsar/common/functions/package-summary.html new file mode 100644 index 000000000000..7bf6f982bbc9 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/functions/package-summary.html @@ -0,0 +1,155 @@ + + + + +org.apache.pulsar.common.functions (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Package org.apache.pulsar.common.functions

+
+
+
package org.apache.pulsar.common.functions
+
+
Implementation of policies.
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/functions/package-tree.html b/static/api/admin/4.0.x/org/apache/pulsar/common/functions/package-tree.html new file mode 100644 index 000000000000..1b6df359b71e --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/functions/package-tree.html @@ -0,0 +1,107 @@ + + + + +org.apache.pulsar.common.functions Class Hierarchy (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package org.apache.pulsar.common.functions

+
+Package Hierarchies: + +
+

Class Hierarchy

+ +
+
+

Interface Hierarchy

+ +
+
+

Enum Class Hierarchy

+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/functions/package-use.html b/static/api/admin/4.0.x/org/apache/pulsar/common/functions/package-use.html new file mode 100644 index 000000000000..48b27114f6fd --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/functions/package-use.html @@ -0,0 +1,135 @@ + + + + +Uses of Package org.apache.pulsar.common.functions (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Package
org.apache.pulsar.common.functions

+
+
Packages that use org.apache.pulsar.common.functions
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
org.apache.pulsar.common.functions
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/io/BatchSourceConfig.html b/static/api/admin/4.0.x/org/apache/pulsar/common/io/BatchSourceConfig.html new file mode 100644 index 000000000000..4642bef2aa41 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/io/BatchSourceConfig.html @@ -0,0 +1,205 @@ + + + + +BatchSourceConfig (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.io
+

Class BatchSourceConfig

+
+
java.lang.Object +
org.apache.pulsar.common.io.BatchSourceConfig
+
+
+
+
public class BatchSourceConfig +extends Object
+
Pulsar Batch Source configuration.
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    +
      +
    • +
      +

      BATCHSOURCE_CONFIG_KEY

      +
      public static final String BATCHSOURCE_CONFIG_KEY
      +
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      BATCHSOURCE_CLASSNAME_KEY

      +
      public static final String BATCHSOURCE_CLASSNAME_KEY
      +
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      BatchSourceConfig

      +
      public BatchSourceConfig()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/io/ConnectorDefinition.html b/static/api/admin/4.0.x/org/apache/pulsar/common/io/ConnectorDefinition.html new file mode 100644 index 000000000000..f5979c847124 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/io/ConnectorDefinition.html @@ -0,0 +1,151 @@ + + + + +ConnectorDefinition (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.io
+

Class ConnectorDefinition

+
+
java.lang.Object +
org.apache.pulsar.common.io.ConnectorDefinition
+
+
+
+
public class ConnectorDefinition +extends Object
+
Basic information about a Pulsar connector.
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      ConnectorDefinition

      +
      public ConnectorDefinition()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/io/SinkConfig.html b/static/api/admin/4.0.x/org/apache/pulsar/common/io/SinkConfig.html new file mode 100644 index 000000000000..51a6d5031faf --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/io/SinkConfig.html @@ -0,0 +1,151 @@ + + + + +SinkConfig (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.io
+

Class SinkConfig

+
+
java.lang.Object +
org.apache.pulsar.common.io.SinkConfig
+
+
+
+
public class SinkConfig +extends Object
+
Configuration of Pulsar Sink.
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      SinkConfig

      +
      public SinkConfig()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/io/SourceConfig.html b/static/api/admin/4.0.x/org/apache/pulsar/common/io/SourceConfig.html new file mode 100644 index 000000000000..e543b15f21e5 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/io/SourceConfig.html @@ -0,0 +1,151 @@ + + + + +SourceConfig (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.io
+

Class SourceConfig

+
+
java.lang.Object +
org.apache.pulsar.common.io.SourceConfig
+
+
+
+
public class SourceConfig +extends Object
+
Pulsar source configuration.
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      SourceConfig

      +
      public SourceConfig()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/io/class-use/BatchSourceConfig.html b/static/api/admin/4.0.x/org/apache/pulsar/common/io/class-use/BatchSourceConfig.html new file mode 100644 index 000000000000..6ca9c4b6d57a --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/io/class-use/BatchSourceConfig.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.common.io.BatchSourceConfig (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.io.BatchSourceConfig

+
+No usage of org.apache.pulsar.common.io.BatchSourceConfig
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/io/class-use/ConnectorDefinition.html b/static/api/admin/4.0.x/org/apache/pulsar/common/io/class-use/ConnectorDefinition.html new file mode 100644 index 000000000000..fe7402bafc47 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/io/class-use/ConnectorDefinition.html @@ -0,0 +1,109 @@ + + + + +Uses of Class org.apache.pulsar.common.io.ConnectorDefinition (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.io.ConnectorDefinition

+
+
Packages that use ConnectorDefinition
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/io/class-use/SinkConfig.html b/static/api/admin/4.0.x/org/apache/pulsar/common/io/class-use/SinkConfig.html new file mode 100644 index 000000000000..bba3276991e4 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/io/class-use/SinkConfig.html @@ -0,0 +1,186 @@ + + + + +Uses of Class org.apache.pulsar.common.io.SinkConfig (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.io.SinkConfig

+
+
Packages that use SinkConfig
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/io/class-use/SourceConfig.html b/static/api/admin/4.0.x/org/apache/pulsar/common/io/class-use/SourceConfig.html new file mode 100644 index 000000000000..3013d137fbfa --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/io/class-use/SourceConfig.html @@ -0,0 +1,186 @@ + + + + +Uses of Class org.apache.pulsar.common.io.SourceConfig (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.io.SourceConfig

+
+
Packages that use SourceConfig
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/io/package-summary.html b/static/api/admin/4.0.x/org/apache/pulsar/common/io/package-summary.html new file mode 100644 index 000000000000..f25d6fd402ed --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/io/package-summary.html @@ -0,0 +1,113 @@ + + + + +org.apache.pulsar.common.io (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Package org.apache.pulsar.common.io

+
+
+
package org.apache.pulsar.common.io
+
+
Implementation of policies.
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/io/package-tree.html b/static/api/admin/4.0.x/org/apache/pulsar/common/io/package-tree.html new file mode 100644 index 000000000000..12bf04a92c2d --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/io/package-tree.html @@ -0,0 +1,79 @@ + + + + +org.apache.pulsar.common.io Class Hierarchy (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package org.apache.pulsar.common.io

+
+Package Hierarchies: + +
+

Class Hierarchy

+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/io/package-use.html b/static/api/admin/4.0.x/org/apache/pulsar/common/io/package-use.html new file mode 100644 index 000000000000..ed1288060e0b --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/io/package-use.html @@ -0,0 +1,94 @@ + + + + +Uses of Package org.apache.pulsar.common.io (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Package
org.apache.pulsar.common.io

+
+
Packages that use org.apache.pulsar.common.io
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/naming/TopicDomain.html b/static/api/admin/4.0.x/org/apache/pulsar/common/naming/TopicDomain.html new file mode 100644 index 000000000000..a2b83ca24103 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/naming/TopicDomain.html @@ -0,0 +1,268 @@ + + + + +TopicDomain (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.naming
+

Enum Class TopicDomain

+
+
java.lang.Object +
java.lang.Enum<TopicDomain> +
org.apache.pulsar.common.naming.TopicDomain
+
+
+
+
+
All Implemented Interfaces:
+
Serializable, Comparable<TopicDomain>, Constable
+
+
+
public enum TopicDomain +extends Enum<TopicDomain>
+
Enumeration showing if a topic is persistent.
+
+
+ +
+
+
    + +
  • +
    +

    Enum Constant Details

    +
      +
    • +
      +

      persistent

      +
      public static final TopicDomain persistent
      +
      +
      • +
    • +
      +

      non_persistent

      +
      public static final TopicDomain non_persistent
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      values

      +
      public static TopicDomain[] values()
      +
      Returns an array containing the constants of this enum class, in +the order they are declared.
      +
      +
      Returns:
      +
      an array containing the constants of this enum class, in the order they are declared
      +
      +
      +
      • +
    • +
      +

      valueOf

      +
      public static TopicDomain valueOf(String name)
      +
      Returns the enum constant of this class with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this class. (Extraneous whitespace characters are +not permitted.)
      +
      +
      Parameters:
      +
      name - the name of the enum constant to be returned.
      +
      Returns:
      +
      the enum constant with the specified name
      +
      Throws:
      +
      IllegalArgumentException - if this enum class has no constant with the specified name
      +
      NullPointerException - if the argument is null
      +
      +
      +
      • +
    • +
      +

      value

      +
      public String value()
      +
      +
      • +
    • +
      +

      getEnum

      +
      public static TopicDomain getEnum(String value)
      +
      +
      • +
    • +
      +

      toString

      +
      public String toString()
      +
      +
      Overrides:
      +
      toString in class Enum<TopicDomain>
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/naming/TopicVersion.html b/static/api/admin/4.0.x/org/apache/pulsar/common/naming/TopicVersion.html new file mode 100644 index 000000000000..c08e9a53fc75 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/naming/TopicVersion.html @@ -0,0 +1,236 @@ + + + + +TopicVersion (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.naming
+

Enum Class TopicVersion

+
+
java.lang.Object +
java.lang.Enum<TopicVersion> +
org.apache.pulsar.common.naming.TopicVersion
+
+
+
+
+
All Implemented Interfaces:
+
Serializable, Comparable<TopicVersion>, Constable
+
+
+
public enum TopicVersion +extends Enum<TopicVersion>
+
+
+ +
+
+
    + +
  • +
    +

    Enum Constant Details

    + +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      values

      +
      public static TopicVersion[] values()
      +
      Returns an array containing the constants of this enum class, in +the order they are declared.
      +
      +
      Returns:
      +
      an array containing the constants of this enum class, in the order they are declared
      +
      +
      +
      • +
    • +
      +

      valueOf

      +
      public static TopicVersion valueOf(String name)
      +
      Returns the enum constant of this class with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this class. (Extraneous whitespace characters are +not permitted.)
      +
      +
      Parameters:
      +
      name - the name of the enum constant to be returned.
      +
      Returns:
      +
      the enum constant with the specified name
      +
      Throws:
      +
      IllegalArgumentException - if this enum class has no constant with the specified name
      +
      NullPointerException - if the argument is null
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/naming/class-use/TopicDomain.html b/static/api/admin/4.0.x/org/apache/pulsar/common/naming/class-use/TopicDomain.html new file mode 100644 index 000000000000..bd4e551a6a38 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/naming/class-use/TopicDomain.html @@ -0,0 +1,157 @@ + + + + +Uses of Enum Class org.apache.pulsar.common.naming.TopicDomain (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Enum Class
org.apache.pulsar.common.naming.TopicDomain

+
+
Packages that use TopicDomain
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
org.apache.pulsar.common.naming
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/naming/class-use/TopicVersion.html b/static/api/admin/4.0.x/org/apache/pulsar/common/naming/class-use/TopicVersion.html new file mode 100644 index 000000000000..ac76ebabbbb5 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/naming/class-use/TopicVersion.html @@ -0,0 +1,127 @@ + + + + +Uses of Enum Class org.apache.pulsar.common.naming.TopicVersion (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Enum Class
org.apache.pulsar.common.naming.TopicVersion

+
+
Packages that use TopicVersion
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
org.apache.pulsar.common.naming
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/naming/package-summary.html b/static/api/admin/4.0.x/org/apache/pulsar/common/naming/package-summary.html new file mode 100644 index 000000000000..fca277df1d92 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/naming/package-summary.html @@ -0,0 +1,103 @@ + + + + +org.apache.pulsar.common.naming (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Package org.apache.pulsar.common.naming

+
+
+
package org.apache.pulsar.common.naming
+
+
Implementation of policies.
+
+
+
    +
  • +
    +
    Enum Classes
    +
    +
    Class
    +
    Description
    +
    TopicDomain
    +
    +
    Enumeration showing if a topic is persistent.
    +
    +
    TopicVersion
    +
     
    +
    +
    +
    • +
+
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/naming/package-tree.html b/static/api/admin/4.0.x/org/apache/pulsar/common/naming/package-tree.html new file mode 100644 index 000000000000..f5e5ef9bd53f --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/naming/package-tree.html @@ -0,0 +1,81 @@ + + + + +org.apache.pulsar.common.naming Class Hierarchy (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package org.apache.pulsar.common.naming

+
+Package Hierarchies: + +
+

Enum Class Hierarchy

+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/naming/package-use.html b/static/api/admin/4.0.x/org/apache/pulsar/common/naming/package-use.html new file mode 100644 index 000000000000..b3d4e9160e92 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/naming/package-use.html @@ -0,0 +1,107 @@ + + + + +Uses of Package org.apache.pulsar.common.naming (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Package
org.apache.pulsar.common.naming

+
+
Packages that use org.apache.pulsar.common.naming
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
org.apache.pulsar.common.naming
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/partition/PartitionedTopicMetadata.html b/static/api/admin/4.0.x/org/apache/pulsar/common/partition/PartitionedTopicMetadata.html new file mode 100644 index 000000000000..7fdd6b0ff6b4 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/partition/PartitionedTopicMetadata.html @@ -0,0 +1,253 @@ + + + + +PartitionedTopicMetadata (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.partition
+

Class PartitionedTopicMetadata

+
+
java.lang.Object +
org.apache.pulsar.common.partition.PartitionedTopicMetadata
+
+
+
+
public class PartitionedTopicMetadata +extends Object
+
Metadata of a partitioned topic.
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    +
      +
    • +
      +

      MEDIA_TYPE

      +
      public static final String MEDIA_TYPE
      +
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      partitions

      +
      public int partitions
      +
      +
      • +
    • +
      +

      deleted

      +
      public boolean deleted
      +
      +
      • +
    • +
      +

      properties

      +
      public Map<String,String> properties
      +
      +
      • +
    • +
      +

      NON_PARTITIONED

      +
      public static final int NON_PARTITIONED
      +
      A topic with '0' partitions is treated like non-partitioned topic.
      +
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      PartitionedTopicMetadata

      +
      public PartitionedTopicMetadata()
      +
      +
      • +
    • +
      +

      PartitionedTopicMetadata

      +
      public PartitionedTopicMetadata(int partitions)
      +
      +
      • +
    • +
      +

      PartitionedTopicMetadata

      +
      public PartitionedTopicMetadata(int partitions, + Map<String,String> properties)
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/partition/class-use/PartitionedTopicMetadata.html b/static/api/admin/4.0.x/org/apache/pulsar/common/partition/class-use/PartitionedTopicMetadata.html new file mode 100644 index 000000000000..23f3bb196555 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/partition/class-use/PartitionedTopicMetadata.html @@ -0,0 +1,148 @@ + + + + +Uses of Class org.apache.pulsar.common.partition.PartitionedTopicMetadata (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.partition.PartitionedTopicMetadata

+
+
Packages that use PartitionedTopicMetadata
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/partition/package-summary.html b/static/api/admin/4.0.x/org/apache/pulsar/common/partition/package-summary.html new file mode 100644 index 000000000000..f36dbee59290 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/partition/package-summary.html @@ -0,0 +1,101 @@ + + + + +org.apache.pulsar.common.partition (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Package org.apache.pulsar.common.partition

+
+
+
package org.apache.pulsar.common.partition
+
+
Implementation of policies.
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/partition/package-tree.html b/static/api/admin/4.0.x/org/apache/pulsar/common/partition/package-tree.html new file mode 100644 index 000000000000..1eb7169f1c39 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/partition/package-tree.html @@ -0,0 +1,76 @@ + + + + +org.apache.pulsar.common.partition Class Hierarchy (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package org.apache.pulsar.common.partition

+
+Package Hierarchies: + +
+

Class Hierarchy

+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/partition/package-use.html b/static/api/admin/4.0.x/org/apache/pulsar/common/partition/package-use.html new file mode 100644 index 000000000000..543f3e82f476 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/partition/package-use.html @@ -0,0 +1,103 @@ + + + + +Uses of Package org.apache.pulsar.common.partition (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Package
org.apache.pulsar.common.partition

+
+
Packages that use org.apache.pulsar.common.partition
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/AutoFailoverPolicy.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/AutoFailoverPolicy.html new file mode 100644 index 000000000000..ccbbfe081229 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/AutoFailoverPolicy.html @@ -0,0 +1,216 @@ + + + + +AutoFailoverPolicy (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies
+

Class AutoFailoverPolicy

+
+
java.lang.Object +
org.apache.pulsar.common.policies.AutoFailoverPolicy
+
+
+
+
Direct Known Subclasses:
+
MinAvailablePolicy
+
+
+
public abstract class AutoFailoverPolicy +extends Object
+
Basic definition of an auto-failover policy.
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      AutoFailoverPolicy

      +
      public AutoFailoverPolicy()
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      shouldFailoverToSecondary

      +
      public abstract boolean shouldFailoverToSecondary(SortedSet<BrokerStatus> brokerStatus)
      +
      Checks to see whether the new namespace ownership should be failed over to the secondary brokers.
      +
      +
      Parameters:
      +
      brokerStatus -
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      shouldFailoverToSecondary

      +
      public abstract boolean shouldFailoverToSecondary(int totalPrimaryCandidates)
      +
      +
      • +
    • +
      +

      isBrokerAvailable

      +
      public abstract boolean isBrokerAvailable(BrokerStatus brokerStatus)
      +
      Determine whether a broker is considered available or not.
      +
      +
      Parameters:
      +
      brokerStatus -
      +
      Returns:
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/class-use/AutoFailoverPolicy.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/class-use/AutoFailoverPolicy.html new file mode 100644 index 000000000000..b6588cc6a6b6 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/class-use/AutoFailoverPolicy.html @@ -0,0 +1,100 @@ + + + + +Uses of Class org.apache.pulsar.common.policies.AutoFailoverPolicy (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.policies.AutoFailoverPolicy

+
+
Packages that use AutoFailoverPolicy
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.impl
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/AuthAction.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/AuthAction.html new file mode 100644 index 000000000000..69d986a1e324 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/AuthAction.html @@ -0,0 +1,287 @@ + + + + +AuthAction (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Enum Class AuthAction

+
+
java.lang.Object +
java.lang.Enum<AuthAction> +
org.apache.pulsar.common.policies.data.AuthAction
+
+
+
+
+
All Implemented Interfaces:
+
Serializable, Comparable<AuthAction>, Constable
+
+
+
public enum AuthAction +extends Enum<AuthAction>
+
Authorization action for Pulsar policies.
+
+
+ +
+
+
    + +
  • +
    +

    Enum Constant Details

    +
      +
    • +
      +

      produce

      +
      public static final AuthAction produce
      +
      Permission to produce/publish messages.
      +
      +
      • +
    • +
      +

      consume

      +
      public static final AuthAction consume
      +
      Permission to consume messages.
      +
      +
      • +
    • +
      +

      functions

      +
      public static final AuthAction functions
      +
      Permissions for functions ops.
      +
      +
      • +
    • +
      +

      sources

      +
      public static final AuthAction sources
      +
      Permissions for sources ops.
      +
      +
      • +
    • +
      +

      sinks

      +
      public static final AuthAction sinks
      +
      Permissions for sinks ops.
      +
      +
      • +
    • +
      +

      packages

      +
      public static final AuthAction packages
      +
      Permissions for packages ops.
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      values

      +
      public static AuthAction[] values()
      +
      Returns an array containing the constants of this enum class, in +the order they are declared.
      +
      +
      Returns:
      +
      an array containing the constants of this enum class, in the order they are declared
      +
      +
      +
      • +
    • +
      +

      valueOf

      +
      public static AuthAction valueOf(String name)
      +
      Returns the enum constant of this class with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this class. (Extraneous whitespace characters are +not permitted.)
      +
      +
      Parameters:
      +
      name - the name of the enum constant to be returned.
      +
      Returns:
      +
      the enum constant with the specified name
      +
      Throws:
      +
      IllegalArgumentException - if this enum class has no constant with the specified name
      +
      NullPointerException - if the argument is null
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/AuthPolicies.Builder.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/AuthPolicies.Builder.html new file mode 100644 index 000000000000..98d7faa98dab --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/AuthPolicies.Builder.html @@ -0,0 +1,174 @@ + + + + +AuthPolicies.Builder (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Interface AuthPolicies.Builder

+
+
+
+
Enclosing interface:
+
AuthPolicies
+
+
+
public static interface AuthPolicies.Builder
+
+
+ +
+
+ +
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/AuthPolicies.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/AuthPolicies.html new file mode 100644 index 000000000000..dd6ecdedd9cb --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/AuthPolicies.html @@ -0,0 +1,186 @@ + + + + +AuthPolicies (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Interface AuthPolicies

+
+
+
+
public interface AuthPolicies
+
Authentication policies.
+
+
+ +
+
+ +
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/AutoFailoverPolicyData.Builder.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/AutoFailoverPolicyData.Builder.html new file mode 100644 index 000000000000..3e23da93b740 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/AutoFailoverPolicyData.Builder.html @@ -0,0 +1,165 @@ + + + + +AutoFailoverPolicyData.Builder (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Interface AutoFailoverPolicyData.Builder

+
+
+
+
Enclosing interface:
+
AutoFailoverPolicyData
+
+
+
public static interface AutoFailoverPolicyData.Builder
+
+
+ +
+
+ +
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/AutoFailoverPolicyData.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/AutoFailoverPolicyData.html new file mode 100644 index 000000000000..04eb2dfab05b --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/AutoFailoverPolicyData.html @@ -0,0 +1,185 @@ + + + + +AutoFailoverPolicyData (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Interface AutoFailoverPolicyData

+
+
+
+
public interface AutoFailoverPolicyData
+
+
+ +
+
+ +
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/AutoFailoverPolicyType.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/AutoFailoverPolicyType.html new file mode 100644 index 000000000000..4b8083aad1bc --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/AutoFailoverPolicyType.html @@ -0,0 +1,238 @@ + + + + +AutoFailoverPolicyType (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Enum Class AutoFailoverPolicyType

+
+
java.lang.Object +
java.lang.Enum<AutoFailoverPolicyType> +
org.apache.pulsar.common.policies.data.AutoFailoverPolicyType
+
+
+
+
+
All Implemented Interfaces:
+
Serializable, Comparable<AutoFailoverPolicyType>, Constable
+
+
+
public enum AutoFailoverPolicyType +extends Enum<AutoFailoverPolicyType>
+
The policy type of auto failover.
+
+
+ +
+
+
    + +
  • +
    +

    Enum Constant Details

    + +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      values

      +
      public static AutoFailoverPolicyType[] values()
      +
      Returns an array containing the constants of this enum class, in +the order they are declared.
      +
      +
      Returns:
      +
      an array containing the constants of this enum class, in the order they are declared
      +
      +
      +
      • +
    • +
      +

      valueOf

      +
      public static AutoFailoverPolicyType valueOf(String name)
      +
      Returns the enum constant of this class with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this class. (Extraneous whitespace characters are +not permitted.)
      +
      +
      Parameters:
      +
      name - the name of the enum constant to be returned.
      +
      Returns:
      +
      the enum constant with the specified name
      +
      Throws:
      +
      IllegalArgumentException - if this enum class has no constant with the specified name
      +
      NullPointerException - if the argument is null
      +
      +
      +
      • +
    • +
      +

      fromString

      +
      public static AutoFailoverPolicyType fromString(String autoFailoverPolicyTypeName)
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/AutoSubscriptionCreationOverride.Builder.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/AutoSubscriptionCreationOverride.Builder.html new file mode 100644 index 000000000000..3c5059a3354f --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/AutoSubscriptionCreationOverride.Builder.html @@ -0,0 +1,160 @@ + + + + +AutoSubscriptionCreationOverride.Builder (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Interface AutoSubscriptionCreationOverride.Builder

+
+
+
+
All Known Implementing Classes:
+
AutoSubscriptionCreationOverrideImpl.AutoSubscriptionCreationOverrideImplBuilder
+
+
+
Enclosing interface:
+
AutoSubscriptionCreationOverride
+
+
+
public static interface AutoSubscriptionCreationOverride.Builder
+
+
+ +
+
+ +
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/AutoSubscriptionCreationOverride.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/AutoSubscriptionCreationOverride.html new file mode 100644 index 000000000000..49a7496f4e9c --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/AutoSubscriptionCreationOverride.html @@ -0,0 +1,172 @@ + + + + +AutoSubscriptionCreationOverride (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Interface AutoSubscriptionCreationOverride

+
+
+
+
All Known Implementing Classes:
+
AutoSubscriptionCreationOverrideImpl
+
+
+
public interface AutoSubscriptionCreationOverride
+
Override of autoSubscriptionCreation settings on a namespace level.
+
+
+ +
+
+ +
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/AutoTopicCreationOverride.Builder.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/AutoTopicCreationOverride.Builder.html new file mode 100644 index 000000000000..0345eb64f81f --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/AutoTopicCreationOverride.Builder.html @@ -0,0 +1,178 @@ + + + + +AutoTopicCreationOverride.Builder (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Interface AutoTopicCreationOverride.Builder

+
+
+
+
All Known Implementing Classes:
+
AutoTopicCreationOverrideImpl.AutoTopicCreationOverrideImplBuilder
+
+
+
Enclosing interface:
+
AutoTopicCreationOverride
+
+
+
public static interface AutoTopicCreationOverride.Builder
+
+
+ +
+
+ +
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/AutoTopicCreationOverride.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/AutoTopicCreationOverride.html new file mode 100644 index 000000000000..7124262638d6 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/AutoTopicCreationOverride.html @@ -0,0 +1,190 @@ + + + + +AutoTopicCreationOverride (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Interface AutoTopicCreationOverride

+
+
+
+
All Known Implementing Classes:
+
AutoTopicCreationOverrideImpl
+
+
+
public interface AutoTopicCreationOverride
+
Override of autoTopicCreation settings on a namespace level.
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      isAllowAutoTopicCreation

      +
      boolean isAllowAutoTopicCreation()
      +
      +
      • +
    • +
      +

      getTopicType

      +
      String getTopicType()
      +
      +
      • +
    • +
      +

      getDefaultNumPartitions

      +
      Integer getDefaultNumPartitions()
      +
      +
      • +
    • +
      +

      builder

      +
      static AutoTopicCreationOverride.Builder builder()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BacklogQuota.BacklogQuotaType.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BacklogQuota.BacklogQuotaType.html new file mode 100644 index 000000000000..bff8a352eb70 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BacklogQuota.BacklogQuotaType.html @@ -0,0 +1,241 @@ + + + + +BacklogQuota.BacklogQuotaType (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Enum Class BacklogQuota.BacklogQuotaType

+
+
java.lang.Object +
java.lang.Enum<BacklogQuota.BacklogQuotaType> +
org.apache.pulsar.common.policies.data.BacklogQuota.BacklogQuotaType
+
+
+
+
+
All Implemented Interfaces:
+
Serializable, Comparable<BacklogQuota.BacklogQuotaType>, Constable
+
+
+
Enclosing interface:
+
BacklogQuota
+
+
+
public static enum BacklogQuota.BacklogQuotaType +extends Enum<BacklogQuota.BacklogQuotaType>
+
Identifier to a backlog quota configuration (an instance of BacklogQuota).
+
+
+ +
+
+
    + +
  • +
    +

    Enum Constant Details

    + +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      values

      +
      public static BacklogQuota.BacklogQuotaType[] values()
      +
      Returns an array containing the constants of this enum class, in +the order they are declared.
      +
      +
      Returns:
      +
      an array containing the constants of this enum class, in the order they are declared
      +
      +
      +
      • +
    • +
      +

      valueOf

      +
      public static BacklogQuota.BacklogQuotaType valueOf(String name)
      +
      Returns the enum constant of this class with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this class. (Extraneous whitespace characters are +not permitted.)
      +
      +
      Parameters:
      +
      name - the name of the enum constant to be returned.
      +
      Returns:
      +
      the enum constant with the specified name
      +
      Throws:
      +
      IllegalArgumentException - if this enum class has no constant with the specified name
      +
      NullPointerException - if the argument is null
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BacklogQuota.Builder.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BacklogQuota.Builder.html new file mode 100644 index 000000000000..cfe40232d0f4 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BacklogQuota.Builder.html @@ -0,0 +1,178 @@ + + + + +BacklogQuota.Builder (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Interface BacklogQuota.Builder

+
+
+
+
All Known Implementing Classes:
+
BacklogQuotaImpl.BacklogQuotaImplBuilder
+
+
+
Enclosing interface:
+
BacklogQuota
+
+
+
public static interface BacklogQuota.Builder
+
+
+ +
+
+ +
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BacklogQuota.RetentionPolicy.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BacklogQuota.RetentionPolicy.html new file mode 100644 index 000000000000..1d586d1149ae --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BacklogQuota.RetentionPolicy.html @@ -0,0 +1,258 @@ + + + + +BacklogQuota.RetentionPolicy (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Enum Class BacklogQuota.RetentionPolicy

+
+
java.lang.Object +
java.lang.Enum<BacklogQuota.RetentionPolicy> +
org.apache.pulsar.common.policies.data.BacklogQuota.RetentionPolicy
+
+
+
+
+
All Implemented Interfaces:
+
Serializable, Comparable<BacklogQuota.RetentionPolicy>, Constable
+
+
+
Enclosing interface:
+
BacklogQuota
+
+
+
public static enum BacklogQuota.RetentionPolicy +extends Enum<BacklogQuota.RetentionPolicy>
+
Enumeration type determines how to retain backlog against the resource shortages.
+
+
+ +
+
+
    + +
  • +
    +

    Enum Constant Details

    +
      +
    • +
      +

      producer_request_hold

      +
      public static final BacklogQuota.RetentionPolicy producer_request_hold
      +
      Policy which holds producer's send request until the resource becomes available (or holding times out).
      +
      +
      • +
    • +
      +

      producer_exception

      +
      public static final BacklogQuota.RetentionPolicy producer_exception
      +
      Policy which throws javax.jms.ResourceAllocationException to the producer.
      +
      +
      • +
    • +
      +

      consumer_backlog_eviction

      +
      public static final BacklogQuota.RetentionPolicy consumer_backlog_eviction
      +
      Policy which evicts the oldest message from the slowest consumer's backlog.
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      values

      +
      public static BacklogQuota.RetentionPolicy[] values()
      +
      Returns an array containing the constants of this enum class, in +the order they are declared.
      +
      +
      Returns:
      +
      an array containing the constants of this enum class, in the order they are declared
      +
      +
      +
      • +
    • +
      +

      valueOf

      +
      public static BacklogQuota.RetentionPolicy valueOf(String name)
      +
      Returns the enum constant of this class with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this class. (Extraneous whitespace characters are +not permitted.)
      +
      +
      Parameters:
      +
      name - the name of the enum constant to be returned.
      +
      Returns:
      +
      the enum constant with the specified name
      +
      Throws:
      +
      IllegalArgumentException - if this enum class has no constant with the specified name
      +
      NullPointerException - if the argument is null
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BacklogQuota.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BacklogQuota.html new file mode 100644 index 000000000000..0f6aafab5d45 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BacklogQuota.html @@ -0,0 +1,236 @@ + + + + +BacklogQuota (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Interface BacklogQuota

+
+
+
+
All Known Implementing Classes:
+
BacklogQuotaImpl
+
+
+
public interface BacklogQuota
+
Unit of a backlog quota configuration for a scoped resource in a Pulsar instance. + +

A scoped resource is identified by a BacklogQuota.BacklogQuotaType enumeration type which is containing two attributes: + limit representing a quota limit in bytes and policy for backlog retention policy.

+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getLimit

      +
      @Deprecated +long getLimit()
      +
      Deprecated.
      +
      Gets quota limit in size. + Remains for compatible
      +
      +
      Returns:
      +
      quota limit in bytes
      +
      +
      +
      • +
    • +
      +

      getLimitSize

      +
      long getLimitSize()
      +
      Gets quota limit in size.
      +
      +
      Returns:
      +
      quota limit in bytes
      +
      +
      +
      • +
    • +
      +

      getLimitTime

      +
      int getLimitTime()
      +
      Gets quota limit in time.
      +
      +
      Returns:
      +
      quota limit in second
      +
      +
      +
      • +
    • +
      +

      getPolicy

      +
      BacklogQuota.RetentionPolicy getPolicy()
      +
      +
      • +
    • +
      +

      builder

      +
      static BacklogQuota.Builder builder()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BookieAffinityGroupData.Builder.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BookieAffinityGroupData.Builder.html new file mode 100644 index 000000000000..9ceb5f010627 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BookieAffinityGroupData.Builder.html @@ -0,0 +1,169 @@ + + + + +BookieAffinityGroupData.Builder (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Interface BookieAffinityGroupData.Builder

+
+
+
+
All Known Implementing Classes:
+
BookieAffinityGroupDataImpl.BookieAffinityGroupDataImplBuilder
+
+
+
Enclosing interface:
+
BookieAffinityGroupData
+
+
+
public static interface BookieAffinityGroupData.Builder
+
+
+ +
+
+ +
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BookieAffinityGroupData.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BookieAffinityGroupData.html new file mode 100644 index 000000000000..2fbc18a0af07 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BookieAffinityGroupData.html @@ -0,0 +1,181 @@ + + + + +BookieAffinityGroupData (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Interface BookieAffinityGroupData

+
+
+
+
All Known Implementing Classes:
+
BookieAffinityGroupDataImpl
+
+
+
public interface BookieAffinityGroupData
+
Description of a BookKeeper's affinity group.
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getBookkeeperAffinityGroupPrimary

      +
      String getBookkeeperAffinityGroupPrimary()
      +
      +
      • +
    • +
      +

      getBookkeeperAffinityGroupSecondary

      +
      String getBookkeeperAffinityGroupSecondary()
      +
      +
      • +
    • +
      +

      builder

      +
      static BookieAffinityGroupData.Builder builder()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BookieInfo.Builder.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BookieInfo.Builder.html new file mode 100644 index 000000000000..fbf4f1d041b4 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BookieInfo.Builder.html @@ -0,0 +1,169 @@ + + + + +BookieInfo.Builder (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Interface BookieInfo.Builder

+
+
+
+
All Known Implementing Classes:
+
BookieInfoImpl.BookieInfoImplBuilder
+
+
+
Enclosing interface:
+
BookieInfo
+
+
+
public static interface BookieInfo.Builder
+
+
+ +
+
+ +
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BookieInfo.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BookieInfo.html new file mode 100644 index 000000000000..2cc09340b9df --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BookieInfo.html @@ -0,0 +1,181 @@ + + + + +BookieInfo (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Interface BookieInfo

+
+
+
+
All Known Implementing Classes:
+
BookieInfoImpl
+
+
+
public interface BookieInfo
+
Bookie information.
+
+
+
    + +
  • +
    +

    Nested Class Summary

    +
    Nested Classes
    +
    +
    Modifier and Type
    +
    Interface
    +
    Description
    +
    static interface 
    +
    BookieInfo.Builder
    +
     
    +
    +
    +
    • + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    static BookieInfo.Builder
    +
    builder()
    +
     
    +
    String
    +
    getHostname()
    +
     
    +
    String
    +
    getRack()
    +
     
    +
    +
    +
    +
    +
    • +
+
+
+
    + +
  • +
    +

    Method Details

    + +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BookiesClusterInfo.Builder.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BookiesClusterInfo.Builder.html new file mode 100644 index 000000000000..80b5c3410eef --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BookiesClusterInfo.Builder.html @@ -0,0 +1,160 @@ + + + + +BookiesClusterInfo.Builder (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Interface BookiesClusterInfo.Builder

+
+
+
+
All Known Implementing Classes:
+
BookiesClusterInfoImpl.BookiesClusterInfoImplBuilder
+
+
+
Enclosing interface:
+
BookiesClusterInfo
+
+
+
public static interface BookiesClusterInfo.Builder
+
+
+ +
+
+ +
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BookiesClusterInfo.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BookiesClusterInfo.html new file mode 100644 index 000000000000..906c7514dbec --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BookiesClusterInfo.html @@ -0,0 +1,172 @@ + + + + +BookiesClusterInfo (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Interface BookiesClusterInfo

+
+
+
+
All Known Implementing Classes:
+
BookiesClusterInfoImpl
+
+
+
public interface BookiesClusterInfo
+
Raw bookies information.
+
+
+ +
+
+ +
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BookiesRackConfiguration.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BookiesRackConfiguration.html new file mode 100644 index 000000000000..4b7268569018 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BookiesRackConfiguration.html @@ -0,0 +1,240 @@ + + + + +BookiesRackConfiguration (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Class BookiesRackConfiguration

+
+
java.lang.Object +
java.util.AbstractMap<String,Map<String,BookieInfo>> +
java.util.TreeMap<String,Map<String,BookieInfo>> +
org.apache.pulsar.common.policies.data.BookiesRackConfiguration
+
+
+
+
+
+
All Implemented Interfaces:
+
Serializable, Cloneable, Map<String,Map<String,BookieInfo>>, NavigableMap<String,Map<String,BookieInfo>>, SequencedMap<String,Map<String,BookieInfo>>, SortedMap<String,Map<String,BookieInfo>>
+
+
+
public class BookiesRackConfiguration +extends TreeMap<String,Map<String,BookieInfo>>
+
The rack configuration map for bookies.
+
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      BookiesRackConfiguration

      +
      public BookiesRackConfiguration()
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    + +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BrokerAssignment.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BrokerAssignment.html new file mode 100644 index 000000000000..fdc4336954ff --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BrokerAssignment.html @@ -0,0 +1,245 @@ + + + + +BrokerAssignment (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Enum Class BrokerAssignment

+
+
java.lang.Object +
java.lang.Enum<BrokerAssignment> +
org.apache.pulsar.common.policies.data.BrokerAssignment
+
+
+
+
+
All Implemented Interfaces:
+
Serializable, Comparable<BrokerAssignment>, Constable
+
+
+
public enum BrokerAssignment +extends Enum<BrokerAssignment>
+
Definition of possible broker assignments.
+
+
+ +
+
+
    + +
  • +
    +

    Enum Constant Details

    + +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      values

      +
      public static BrokerAssignment[] values()
      +
      Returns an array containing the constants of this enum class, in +the order they are declared.
      +
      +
      Returns:
      +
      an array containing the constants of this enum class, in the order they are declared
      +
      +
      +
      • +
    • +
      +

      valueOf

      +
      public static BrokerAssignment valueOf(String name)
      +
      Returns the enum constant of this class with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this class. (Extraneous whitespace characters are +not permitted.)
      +
      +
      Parameters:
      +
      name - the name of the enum constant to be returned.
      +
      Returns:
      +
      the enum constant with the specified name
      +
      Throws:
      +
      IllegalArgumentException - if this enum class has no constant with the specified name
      +
      NullPointerException - if the argument is null
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BrokerInfo.Builder.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BrokerInfo.Builder.html new file mode 100644 index 000000000000..b156cced338f --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BrokerInfo.Builder.html @@ -0,0 +1,169 @@ + + + + +BrokerInfo.Builder (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Interface BrokerInfo.Builder

+
+
+
+
All Known Implementing Classes:
+
BrokerInfoImpl.BrokerInfoImplBuilder
+
+
+
Enclosing interface:
+
BrokerInfo
+
+
+
public static interface BrokerInfo.Builder
+
+
+ +
+
+ +
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BrokerInfo.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BrokerInfo.html new file mode 100644 index 000000000000..a3b21bc07f8f --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BrokerInfo.html @@ -0,0 +1,181 @@ + + + + +BrokerInfo (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Interface BrokerInfo

+
+
+
+
All Known Implementing Classes:
+
BrokerInfoImpl
+
+
+
public interface BrokerInfo
+
Broker Information.
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getServiceUrl

      +
      String getServiceUrl()
      +
      +
      • +
    • +
      +

      getBrokerId

      +
      String getBrokerId()
      +
      +
      • +
    • +
      +

      builder

      +
      static BrokerInfo.Builder builder()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BrokerNamespaceIsolationData.Builder.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BrokerNamespaceIsolationData.Builder.html new file mode 100644 index 000000000000..543d5535233e --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BrokerNamespaceIsolationData.Builder.html @@ -0,0 +1,183 @@ + + + + +BrokerNamespaceIsolationData.Builder (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Interface BrokerNamespaceIsolationData.Builder

+
+
+
+
Enclosing interface:
+
BrokerNamespaceIsolationData
+
+
+
public static interface BrokerNamespaceIsolationData.Builder
+
+
+ +
+
+ +
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BrokerNamespaceIsolationData.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BrokerNamespaceIsolationData.html new file mode 100644 index 000000000000..3d1c0509e741 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BrokerNamespaceIsolationData.html @@ -0,0 +1,194 @@ + + + + +BrokerNamespaceIsolationData (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Interface BrokerNamespaceIsolationData

+
+
+
+
public interface BrokerNamespaceIsolationData
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    + +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BrokerStatus.Builder.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BrokerStatus.Builder.html new file mode 100644 index 000000000000..9770bd860b63 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BrokerStatus.Builder.html @@ -0,0 +1,178 @@ + + + + +BrokerStatus.Builder (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Interface BrokerStatus.Builder

+
+
+
+
All Known Implementing Classes:
+
BrokerStatusImpl.BrokerStatusImplBuilder
+
+
+
Enclosing interface:
+
BrokerStatus
+
+
+
public static interface BrokerStatus.Builder
+
+
+ +
+
+ +
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BrokerStatus.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BrokerStatus.html new file mode 100644 index 000000000000..87ee132673de --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BrokerStatus.html @@ -0,0 +1,198 @@ + + + + +BrokerStatus (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Interface BrokerStatus

+
+
+
+
All Superinterfaces:
+
Comparable<BrokerStatus>
+
+
+
All Known Implementing Classes:
+
BrokerStatusImpl
+
+
+
public interface BrokerStatus +extends Comparable<BrokerStatus>
+
Information about the broker status.
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getBrokerAddress

      +
      String getBrokerAddress()
      +
      +
      • +
    • +
      +

      isActive

      +
      boolean isActive()
      +
      +
      • +
    • +
      +

      getLoadFactor

      +
      int getLoadFactor()
      +
      +
      • +
    • +
      +

      builder

      +
      static BrokerStatus.Builder builder()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BundlesData.Builder.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BundlesData.Builder.html new file mode 100644 index 000000000000..150989aa0934 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BundlesData.Builder.html @@ -0,0 +1,169 @@ + + + + +BundlesData.Builder (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Interface BundlesData.Builder

+
+
+
+
All Known Implementing Classes:
+
BundlesDataImpl.BundlesDataImplBuilder
+
+
+
Enclosing interface:
+
BundlesData
+
+
+
public static interface BundlesData.Builder
+
+
+ +
+
+ +
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BundlesData.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BundlesData.html new file mode 100644 index 000000000000..062a39772790 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/BundlesData.html @@ -0,0 +1,181 @@ + + + + +BundlesData (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Interface BundlesData

+
+
+
+
All Known Implementing Classes:
+
BundlesDataImpl
+
+
+
public interface BundlesData
+
Holder for bundles.
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getBoundaries

      +
      List<String> getBoundaries()
      +
      +
      • +
    • +
      +

      getNumBundles

      +
      int getNumBundles()
      +
      +
      • +
    • +
      +

      builder

      +
      static BundlesData.Builder builder()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/ClusterData.Builder.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/ClusterData.Builder.html new file mode 100644 index 000000000000..cbe3536483c0 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/ClusterData.Builder.html @@ -0,0 +1,363 @@ + + + + +ClusterData.Builder (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Interface ClusterData.Builder

+
+
+
+
Enclosing interface:
+
ClusterData
+
+
+
public static interface ClusterData.Builder
+
+
+ +
+
+ +
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/ClusterData.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/ClusterData.html new file mode 100644 index 000000000000..f7f155a93411 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/ClusterData.html @@ -0,0 +1,383 @@ + + + + +ClusterData (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Interface ClusterData

+
+
+
+
public interface ClusterData
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getServiceUrl

      +
      String getServiceUrl()
      +
      +
      • +
    • +
      +

      getServiceUrlTls

      +
      String getServiceUrlTls()
      +
      +
      • +
    • +
      +

      getBrokerServiceUrl

      +
      String getBrokerServiceUrl()
      +
      +
      • +
    • +
      +

      getBrokerServiceUrlTls

      +
      String getBrokerServiceUrlTls()
      +
      +
      • +
    • +
      +

      getProxyServiceUrl

      +
      String getProxyServiceUrl()
      +
      +
      • +
    • +
      +

      getProxyProtocol

      +
      org.apache.pulsar.client.api.ProxyProtocol getProxyProtocol()
      +
      +
      • +
    • +
      +

      getPeerClusterNames

      +
      LinkedHashSet<String> getPeerClusterNames()
      +
      +
      • +
    • +
      +

      getAuthenticationPlugin

      +
      String getAuthenticationPlugin()
      +
      +
      • +
    • +
      +

      getAuthenticationParameters

      +
      String getAuthenticationParameters()
      +
      +
      • +
    • +
      +

      isBrokerClientTlsEnabled

      +
      boolean isBrokerClientTlsEnabled()
      +
      +
      • +
    • +
      +

      isTlsAllowInsecureConnection

      +
      boolean isTlsAllowInsecureConnection()
      +
      +
      • +
    • +
      +

      isBrokerClientTlsEnabledWithKeyStore

      +
      boolean isBrokerClientTlsEnabledWithKeyStore()
      +
      +
      • +
    • +
      +

      getBrokerClientTlsTrustStoreType

      +
      String getBrokerClientTlsTrustStoreType()
      +
      +
      • +
    • +
      +

      getBrokerClientTlsTrustStore

      +
      String getBrokerClientTlsTrustStore()
      +
      +
      • +
    • +
      +

      getBrokerClientTlsTrustStorePassword

      +
      String getBrokerClientTlsTrustStorePassword()
      +
      +
      • +
    • +
      +

      getBrokerClientTrustCertsFilePath

      +
      String getBrokerClientTrustCertsFilePath()
      +
      +
      • +
    • +
      +

      getBrokerClientCertificateFilePath

      +
      String getBrokerClientCertificateFilePath()
      +
      +
      • +
    • +
      +

      getBrokerClientKeyFilePath

      +
      String getBrokerClientKeyFilePath()
      +
      +
      • +
    • +
      +

      getBrokerClientTlsKeyStoreType

      +
      String getBrokerClientTlsKeyStoreType()
      +
      +
      • +
    • +
      +

      getBrokerClientTlsKeyStorePassword

      +
      String getBrokerClientTlsKeyStorePassword()
      +
      +
      • +
    • +
      +

      getBrokerClientTlsKeyStore

      +
      String getBrokerClientTlsKeyStore()
      +
      +
      • +
    • +
      +

      getBrokerClientSslFactoryPlugin

      +
      String getBrokerClientSslFactoryPlugin()
      +
      +
      • +
    • +
      +

      getBrokerClientSslFactoryPluginParams

      +
      String getBrokerClientSslFactoryPluginParams()
      +
      +
      • +
    • +
      +

      getListenerName

      +
      String getListenerName()
      +
      +
      • +
    • +
      +

      clone

      +
      ClusterData.Builder clone()
      +
      +
      • +
    • +
      +

      builder

      +
      static ClusterData.Builder builder()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/ClusterPolicies.Builder.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/ClusterPolicies.Builder.html new file mode 100644 index 000000000000..c6755a864178 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/ClusterPolicies.Builder.html @@ -0,0 +1,165 @@ + + + + +ClusterPolicies.Builder (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Interface ClusterPolicies.Builder

+
+
+
+
Enclosing interface:
+
ClusterPolicies
+
+
+
public static interface ClusterPolicies.Builder
+
+
+ +
+
+ +
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/ClusterPolicies.ClusterUrl.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/ClusterPolicies.ClusterUrl.html new file mode 100644 index 000000000000..b132b8ba2713 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/ClusterPolicies.ClusterUrl.html @@ -0,0 +1,181 @@ + + + + +ClusterPolicies.ClusterUrl (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Class ClusterPolicies.ClusterUrl

+
+
java.lang.Object +
org.apache.pulsar.common.policies.data.ClusterPolicies.ClusterUrl
+
+
+
+
Enclosing interface:
+
ClusterPolicies
+
+
+
public static class ClusterPolicies.ClusterUrl +extends Object
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      ClusterUrl

      +
      public ClusterUrl()
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      isEmpty

      +
      public boolean isEmpty()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/ClusterPolicies.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/ClusterPolicies.html new file mode 100644 index 000000000000..7d93365a798a --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/ClusterPolicies.html @@ -0,0 +1,188 @@ + + + + +ClusterPolicies (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Interface ClusterPolicies

+
+
+
+
public interface ClusterPolicies
+
+
+ +
+
+ +
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/CompactionStats.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/CompactionStats.html new file mode 100644 index 000000000000..6befdeb69863 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/CompactionStats.html @@ -0,0 +1,183 @@ + + + + +CompactionStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Interface CompactionStats

+
+
+
+
public interface CompactionStats
+
Statistics about compaction.
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getLastCompactionRemovedEventCount

      +
      long getLastCompactionRemovedEventCount()
      +
      The removed event count of last compaction.
      +
      +
      • +
    • +
      +

      getLastCompactionSucceedTimestamp

      +
      long getLastCompactionSucceedTimestamp()
      +
      The timestamp of last succeed compaction.
      +
      +
      • +
    • +
      +

      getLastCompactionFailedTimestamp

      +
      long getLastCompactionFailedTimestamp()
      +
      The timestamp of last failed compaction.
      +
      +
      • +
    • +
      +

      getLastCompactionDurationTimeInMills

      +
      long getLastCompactionDurationTimeInMills()
      +
      The duration time of last compaction.
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/ConsumerStats.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/ConsumerStats.html new file mode 100644 index 000000000000..178bccc3155c --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/ConsumerStats.html @@ -0,0 +1,486 @@ + + + + +ConsumerStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Interface ConsumerStats

+
+
+
+
public interface ConsumerStats
+
Consumer statistics.
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getAppId

      +
      String getAppId()
      +
      the app id.
      +
      +
      • +
    • +
      +

      getMsgRateOut

      +
      double getMsgRateOut()
      +
      Total rate of messages delivered to the consumer (msg/s).
      +
      +
      • +
    • +
      +

      getMsgThroughputOut

      +
      double getMsgThroughputOut()
      +
      Total throughput delivered to the consumer (bytes/s).
      +
      +
      • +
    • +
      +

      getBytesOutCounter

      +
      long getBytesOutCounter()
      +
      Total bytes delivered to consumer (bytes).
      +
      +
      • +
    • +
      +

      getMsgOutCounter

      +
      long getMsgOutCounter()
      +
      Total messages delivered to consumer (msg).
      +
      +
      • +
    • +
      +

      getMsgRateRedeliver

      +
      double getMsgRateRedeliver()
      +
      Total rate of messages redelivered by this consumer (msg/s).
      +
      +
      • +
    • +
      +

      getMessageAckRate

      +
      double getMessageAckRate()
      +
      Total rate of message ack(msg/s).
      +
      +
      • +
    • +
      +

      getChunkedMessageRate

      +
      double getChunkedMessageRate()
      +
      The total rate of chunked messages delivered to this consumer.
      +
      +
      • +
    • +
      +

      getConsumerName

      +
      String getConsumerName()
      +
      Name of the consumer.
      +
      +
      • +
    • +
      +

      getAvailablePermits

      +
      int getAvailablePermits()
      +
      Number of available message permits for the consumer.
      +
      +
      • +
    • +
      +

      getUnackedMessages

      +
      int getUnackedMessages()
      +
      Number of unacknowledged messages for the consumer, where an unacknowledged message is one that has been + sent to the consumer but not yet acknowledged. This field is only meaningful when using a + SubscriptionType that tracks individual message acknowledgement, like + SubscriptionType.Shared or + SubscriptionType.Key_Shared.
      +
      +
      • +
    • +
      +

      getAvgMessagesPerEntry

      +
      int getAvgMessagesPerEntry()
      +
      Number of average messages per entry for the consumer consumed.
      +
      +
      • +
    • +
      +

      isBlockedConsumerOnUnackedMsgs

      +
      boolean isBlockedConsumerOnUnackedMsgs()
      +
      Flag to verify if consumer is blocked due to reaching threshold of unacked messages.
      +
      +
      • +
    • +
      +

      getReadPositionWhenJoining

      +
      @Deprecated +String getReadPositionWhenJoining()
      +
      Deprecated.
      +
      The read position of the cursor when the consumer joining.
      +
      +
      • +
    • +
      +

      getDrainingHashesCount

      +
      int getDrainingHashesCount()
      +
      For Key_Shared subscription in AUTO_SPLIT ordered mode: + Retrieves the current number of hashes in the draining state for this consumer.
      +
      +
      Returns:
      +
      the current number of hashes in the draining state for this consumer
      +
      +
      +
      • +
    • +
      +

      getDrainingHashesClearedTotal

      +
      long getDrainingHashesClearedTotal()
      +
      For Key_Shared subscription in AUTO_SPLIT ordered mode: + Retrieves the total number of hashes cleared from the draining state since the consumer connected.
      +
      +
      Returns:
      +
      the total number of hashes cleared from the draining state since the consumer connected
      +
      +
      +
      • +
    • +
      +

      getDrainingHashesUnackedMessages

      +
      int getDrainingHashesUnackedMessages()
      +
      For Key_Shared subscription in AUTO_SPLIT ordered mode: + Retrieves the total number of unacked messages for all draining hashes for this consumer.
      +
      +
      Returns:
      +
      the total number of unacked messages for all draining hashes for this consumer
      +
      +
      +
      • +
    • +
      +

      getDrainingHashes

      +
      List<DrainingHash> getDrainingHashes()
      +
      For Key_Shared subscription in AUTO_SPLIT ordered mode: + Retrieves the draining hashes for this consumer.
      +
      +
      Returns:
      +
      a list of draining hashes for this consumer
      +
      +
      +
      • +
    • +
      +

      getAddress

      +
      String getAddress()
      +
      Address of this consumer.
      +
      +
      • +
    • +
      +

      getConnectedSince

      +
      String getConnectedSince()
      +
      Timestamp of connection.
      +
      +
      • +
    • +
      +

      getClientVersion

      +
      String getClientVersion()
      +
      Client library version.
      +
      +
      • +
    • +
      +

      getLastAckedTimestamp

      +
      long getLastAckedTimestamp()
      +
      +
      • +
    • +
      +

      getLastConsumedTimestamp

      +
      long getLastConsumedTimestamp()
      +
      +
      • +
    • +
      +

      getLastConsumedFlowTimestamp

      +
      long getLastConsumedFlowTimestamp()
      +
      +
      • +
    • +
      +

      getKeyHashRangeArrays

      +
      List<int[]> getKeyHashRangeArrays()
      +
      Hash ranges assigned to this consumer if in Key_Shared subscription mode. + This format and field is used when `subscriptionKeySharedUseClassicPersistentImplementation` is set to `false` + (default).
      +
      +
      • +
    • +
      +

      getKeyHashRanges

      +
      @Deprecated +List<String> getKeyHashRanges()
      +
      Deprecated.
      +
      Hash ranges assigned to this consumer if in Key_Shared subscription mode. + This format and field is used when `subscriptionKeySharedUseClassicPersistentImplementation` is set to `true`.
      +
      +
      • +
    • +
      +

      getMetadata

      +
      Map<String,String> getMetadata()
      +
      Metadata (key/value strings) associated with this consumer.
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/DelayedDeliveryPolicies.Builder.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/DelayedDeliveryPolicies.Builder.html new file mode 100644 index 000000000000..2ce92e626b1c --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/DelayedDeliveryPolicies.Builder.html @@ -0,0 +1,178 @@ + + + + +DelayedDeliveryPolicies.Builder (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Interface DelayedDeliveryPolicies.Builder

+
+
+
+
All Known Implementing Classes:
+
DelayedDeliveryPoliciesImpl.DelayedDeliveryPoliciesImplBuilder
+
+
+
Enclosing interface:
+
DelayedDeliveryPolicies
+
+
+
public static interface DelayedDeliveryPolicies.Builder
+
+
+ +
+
+ +
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/DelayedDeliveryPolicies.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/DelayedDeliveryPolicies.html new file mode 100644 index 000000000000..0a567796554a --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/DelayedDeliveryPolicies.html @@ -0,0 +1,190 @@ + + + + +DelayedDeliveryPolicies (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Interface DelayedDeliveryPolicies

+
+
+
+
All Known Implementing Classes:
+
DelayedDeliveryPoliciesImpl
+
+
+
public interface DelayedDeliveryPolicies
+
Definition of the delayed delivery policy.
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getTickTime

      +
      long getTickTime()
      +
      +
      • +
    • +
      +

      isActive

      +
      boolean isActive()
      +
      +
      • +
    • +
      +

      getMaxDeliveryDelayInMillis

      +
      long getMaxDeliveryDelayInMillis()
      +
      +
      • +
    • +
      +

      builder

      +
      static DelayedDeliveryPolicies.Builder builder()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/DispatchRate.Builder.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/DispatchRate.Builder.html new file mode 100644 index 000000000000..56ebe4ffac72 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/DispatchRate.Builder.html @@ -0,0 +1,187 @@ + + + + +DispatchRate.Builder (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Interface DispatchRate.Builder

+
+
+
+
All Known Implementing Classes:
+
DispatchRateImpl.DispatchRateImplBuilder
+
+
+
Enclosing interface:
+
DispatchRate
+
+
+
public static interface DispatchRate.Builder
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      dispatchThrottlingRateInMsg

      +
      DispatchRate.Builder dispatchThrottlingRateInMsg(int dispatchThrottlingRateMsg)
      +
      +
      • +
    • +
      +

      dispatchThrottlingRateInByte

      +
      DispatchRate.Builder dispatchThrottlingRateInByte(long dispatchThrottlingRateBytes)
      +
      +
      • +
    • +
      +

      relativeToPublishRate

      +
      DispatchRate.Builder relativeToPublishRate(boolean relativeToPublishRate)
      +
      +
      • +
    • +
      +

      ratePeriodInSecond

      +
      DispatchRate.Builder ratePeriodInSecond(int ratePeriodInSeconds)
      +
      +
      • +
    • +
      +

      build

      +
      DispatchRate build()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/DispatchRate.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/DispatchRate.html new file mode 100644 index 000000000000..c05c83fc6576 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/DispatchRate.html @@ -0,0 +1,199 @@ + + + + +DispatchRate (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Interface DispatchRate

+
+
+
+
All Known Implementing Classes:
+
DispatchRateImpl
+
+
+
public interface DispatchRate
+
Dispatch rate.
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getDispatchThrottlingRateInMsg

      +
      int getDispatchThrottlingRateInMsg()
      +
      +
      • +
    • +
      +

      getDispatchThrottlingRateInByte

      +
      long getDispatchThrottlingRateInByte()
      +
      +
      • +
    • +
      +

      isRelativeToPublishRate

      +
      boolean isRelativeToPublishRate()
      +
      +
      • +
    • +
      +

      getRatePeriodInSecond

      +
      int getRatePeriodInSecond()
      +
      +
      • +
    • +
      +

      builder

      +
      static DispatchRate.Builder builder()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/DrainingHash.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/DrainingHash.html new file mode 100644 index 000000000000..5a597a8584e9 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/DrainingHash.html @@ -0,0 +1,191 @@ + + + + +DrainingHash (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Interface DrainingHash

+
+
+
+
public interface DrainingHash
+
Contains information about a draining hash in a Key_Shared subscription.
+
+
See Also:
+
+ +
+
+
+
+
    + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    int
    +
    getBlockedAttempts()
    +
    +
    Get the number of times the hash has blocked an attempted delivery of a message.
    +
    +
    int
    +
    getHash()
    +
    +
    Get the sticky key hash value of the draining hash.
    +
    +
    int
    +
    getUnackMsgs()
    +
    +
    Get number of unacknowledged messages for the draining hash.
    +
    +
    +
    +
    +
    +
    • +
+
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getHash

      +
      int getHash()
      +
      Get the sticky key hash value of the draining hash.
      +
      +
      Returns:
      +
      the sticky hash value
      +
      +
      +
      • +
    • +
      +

      getUnackMsgs

      +
      int getUnackMsgs()
      +
      Get number of unacknowledged messages for the draining hash.
      +
      +
      Returns:
      +
      number of unacknowledged messages
      +
      +
      +
      • +
    • +
      +

      getBlockedAttempts

      +
      int getBlockedAttempts()
      +
      Get the number of times the hash has blocked an attempted delivery of a message.
      +
      +
      Returns:
      +
      number of times the hash has blocked an attempted delivery of a message
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/EntryFilters.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/EntryFilters.html new file mode 100644 index 000000000000..1151339223b0 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/EntryFilters.html @@ -0,0 +1,150 @@ + + + + +EntryFilters (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Class EntryFilters

+
+
java.lang.Object +
org.apache.pulsar.common.policies.data.EntryFilters
+
+
+
+
public class EntryFilters +extends Object
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      EntryFilters

      +
      public EntryFilters()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/ErrorData.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/ErrorData.html new file mode 100644 index 000000000000..ca11c46066c6 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/ErrorData.html @@ -0,0 +1,188 @@ + + + + +ErrorData (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Class ErrorData

+
+
java.lang.Object +
org.apache.pulsar.common.policies.data.ErrorData
+
+
+
+
public class ErrorData +extends Object
+
Class holding data in case of error responses.
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    +
      +
    • +
      +

      reason

      +
      public String reason
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      ErrorData

      +
      public ErrorData()
      +
      +
      • +
    • +
      +

      ErrorData

      +
      public ErrorData(String reason)
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/ExceptionInformation.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/ExceptionInformation.html new file mode 100644 index 000000000000..49d00c123803 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/ExceptionInformation.html @@ -0,0 +1,151 @@ + + + + +ExceptionInformation (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Class ExceptionInformation

+
+
java.lang.Object +
org.apache.pulsar.common.policies.data.ExceptionInformation
+
+
+
+
public class ExceptionInformation +extends Object
+
Exception information.
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      ExceptionInformation

      +
      public ExceptionInformation()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/FailureDomain.Builder.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/FailureDomain.Builder.html new file mode 100644 index 000000000000..b5f82e312464 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/FailureDomain.Builder.html @@ -0,0 +1,156 @@ + + + + +FailureDomain.Builder (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Interface FailureDomain.Builder

+
+
+
+
Enclosing interface:
+
FailureDomain
+
+
+
public static interface FailureDomain.Builder
+
+
+ +
+
+ +
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/FailureDomain.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/FailureDomain.html new file mode 100644 index 000000000000..968deb21152e --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/FailureDomain.html @@ -0,0 +1,167 @@ + + + + +FailureDomain (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Interface FailureDomain

+
+
+
+
public interface FailureDomain
+
+
+
    + +
  • +
    +

    Nested Class Summary

    +
    Nested Classes
    +
    +
    Modifier and Type
    +
    Interface
    +
    Description
    +
    static interface 
    +
    FailureDomain.Builder
    +
     
    +
    +
    +
    • + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    static FailureDomain.Builder
    +
    builder()
    +
     
    +
    Set<String>
    +
    getBrokers()
    +
     
    +
    +
    +
    +
    +
    • +
+
+
+ +
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/FunctionInstanceStats.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/FunctionInstanceStats.html new file mode 100644 index 000000000000..f14f7bd29c05 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/FunctionInstanceStats.html @@ -0,0 +1,152 @@ + + + + +FunctionInstanceStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Interface FunctionInstanceStats

+
+
+
+
public interface FunctionInstanceStats
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    + +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/FunctionInstanceStatsData.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/FunctionInstanceStatsData.html new file mode 100644 index 000000000000..b5f8fa48348d --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/FunctionInstanceStatsData.html @@ -0,0 +1,169 @@ + + + + +FunctionInstanceStatsData (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Interface FunctionInstanceStatsData

+
+
+
+
All Superinterfaces:
+
FunctionInstanceStatsDataBase
+
+
+
public interface FunctionInstanceStatsData +extends FunctionInstanceStatsDataBase
+
+
+ +
+
+ +
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/FunctionInstanceStatsDataBase.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/FunctionInstanceStatsDataBase.html new file mode 100644 index 000000000000..b34c13833015 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/FunctionInstanceStatsDataBase.html @@ -0,0 +1,183 @@ + + + + +FunctionInstanceStatsDataBase (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Interface FunctionInstanceStatsDataBase

+
+
+
+
All Known Subinterfaces:
+
FunctionInstanceStatsData
+
+
+
public interface FunctionInstanceStatsDataBase
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getReceivedTotal

      +
      long getReceivedTotal()
      +
      +
      • +
    • +
      +

      getProcessedSuccessfullyTotal

      +
      long getProcessedSuccessfullyTotal()
      +
      +
      • +
    • +
      +

      getSystemExceptionsTotal

      +
      long getSystemExceptionsTotal()
      +
      +
      • +
    • +
      +

      getUserExceptionsTotal

      +
      long getUserExceptionsTotal()
      +
      +
      • +
    • +
      +

      getAvgProcessLatency

      +
      Double getAvgProcessLatency()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/FunctionStats.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/FunctionStats.html new file mode 100644 index 000000000000..7a95ecd3b34f --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/FunctionStats.html @@ -0,0 +1,215 @@ + + + + +FunctionStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Interface FunctionStats

+
+
+
+
public interface FunctionStats
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      calculateOverall

      +
      FunctionStats calculateOverall()
      +
      +
      • +
    • +
      +

      getReceivedTotal

      +
      long getReceivedTotal()
      +
      +
      • +
    • +
      +

      getProcessedSuccessfullyTotal

      +
      long getProcessedSuccessfullyTotal()
      +
      +
      • +
    • +
      +

      getSystemExceptionsTotal

      +
      long getSystemExceptionsTotal()
      +
      +
      • +
    • +
      +

      getUserExceptionsTotal

      +
      long getUserExceptionsTotal()
      +
      +
      • +
    • +
      +

      getAvgProcessLatency

      +
      Double getAvgProcessLatency()
      +
      +
      • +
    • +
      +

      getOneMin

      +
      FunctionInstanceStatsDataBase getOneMin()
      +
      +
      • +
    • +
      +

      getLastInvocation

      +
      Long getLastInvocation()
      +
      +
      • +
    • +
      +

      getInstances

      +
      List<? extends FunctionInstanceStats> getInstances()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/FunctionStatus.FunctionInstanceStatus.FunctionInstanceStatusData.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/FunctionStatus.FunctionInstanceStatus.FunctionInstanceStatusData.html new file mode 100644 index 000000000000..ed6d889f49c3 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/FunctionStatus.FunctionInstanceStatus.FunctionInstanceStatusData.html @@ -0,0 +1,283 @@ + + + + +FunctionStatus.FunctionInstanceStatus.FunctionInstanceStatusData (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Class FunctionStatus.FunctionInstanceStatus.FunctionInstanceStatusData

+
+
java.lang.Object +
org.apache.pulsar.common.policies.data.FunctionStatus.FunctionInstanceStatus.FunctionInstanceStatusData
+
+
+
+
Enclosing class:
+
FunctionStatus.FunctionInstanceStatus
+
+
+
public static class FunctionStatus.FunctionInstanceStatus.FunctionInstanceStatusData +extends Object
+
Function instance status data.
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    +
      +
    • +
      +

      running

      +
      public boolean running
      +
      +
      • +
    • +
      +

      error

      +
      public String error
      +
      +
      • +
    • +
      +

      numRestarts

      +
      public long numRestarts
      +
      +
      • +
    • +
      +

      numReceived

      +
      public long numReceived
      +
      +
      • +
    • +
      +

      numSuccessfullyProcessed

      +
      public long numSuccessfullyProcessed
      +
      +
      • +
    • +
      +

      numUserExceptions

      +
      public long numUserExceptions
      +
      +
      • +
    • +
      +

      latestUserExceptions

      +
      public List<ExceptionInformation> latestUserExceptions
      +
      +
      • +
    • +
      +

      numSystemExceptions

      +
      public long numSystemExceptions
      +
      +
      • +
    • +
      +

      latestSystemExceptions

      +
      public List<ExceptionInformation> latestSystemExceptions
      +
      +
      • +
    • +
      +

      averageLatency

      +
      public double averageLatency
      +
      +
      • +
    • +
      +

      lastInvocationTime

      +
      public long lastInvocationTime
      +
      +
      • +
    • +
      +

      workerId

      +
      public String workerId
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      FunctionInstanceStatusData

      +
      public FunctionInstanceStatusData()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/FunctionStatus.FunctionInstanceStatus.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/FunctionStatus.FunctionInstanceStatus.html new file mode 100644 index 000000000000..5545357d600b --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/FunctionStatus.FunctionInstanceStatus.html @@ -0,0 +1,210 @@ + + + + +FunctionStatus.FunctionInstanceStatus (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Class FunctionStatus.FunctionInstanceStatus

+
+
java.lang.Object +
org.apache.pulsar.common.policies.data.FunctionStatus.FunctionInstanceStatus
+
+
+
+
Enclosing class:
+
FunctionStatus
+
+
+
public static class FunctionStatus.FunctionInstanceStatus +extends Object
+
Function instance status.
+
+
+ +
+
+ +
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/FunctionStatus.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/FunctionStatus.html new file mode 100644 index 000000000000..35696f5669dd --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/FunctionStatus.html @@ -0,0 +1,242 @@ + + + + +FunctionStatus (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Class FunctionStatus

+
+
java.lang.Object +
org.apache.pulsar.common.policies.data.FunctionStatus
+
+
+
+
public class FunctionStatus +extends Object
+
Data lass containing status of Pulsar Function.
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    + +
    +
    • + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      FunctionStatus

      +
      public FunctionStatus()
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    + +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/InactiveTopicDeleteMode.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/InactiveTopicDeleteMode.html new file mode 100644 index 000000000000..9ed3e22488ee --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/InactiveTopicDeleteMode.html @@ -0,0 +1,243 @@ + + + + +InactiveTopicDeleteMode (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Enum Class InactiveTopicDeleteMode

+
+
java.lang.Object +
java.lang.Enum<InactiveTopicDeleteMode> +
org.apache.pulsar.common.policies.data.InactiveTopicDeleteMode
+
+
+
+
+
All Implemented Interfaces:
+
Serializable, Comparable<InactiveTopicDeleteMode>, Constable
+
+
+
public enum InactiveTopicDeleteMode +extends Enum<InactiveTopicDeleteMode>
+
Inactive topic deletion mode.
+
+
+ +
+
+
    + +
  • +
    +

    Enum Constant Details

    +
      +
    • +
      +

      delete_when_no_subscriptions

      +
      public static final InactiveTopicDeleteMode delete_when_no_subscriptions
      +
      The topic can be deleted when no subscriptions and no active producers.
      +
      +
      • +
    • +
      +

      delete_when_subscriptions_caught_up

      +
      public static final InactiveTopicDeleteMode delete_when_subscriptions_caught_up
      +
      The topic can be deleted when all subscriptions catchup and no active producers.
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      values

      +
      public static InactiveTopicDeleteMode[] values()
      +
      Returns an array containing the constants of this enum class, in +the order they are declared.
      +
      +
      Returns:
      +
      an array containing the constants of this enum class, in the order they are declared
      +
      +
      +
      • +
    • +
      +

      valueOf

      +
      public static InactiveTopicDeleteMode valueOf(String name)
      +
      Returns the enum constant of this class with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this class. (Extraneous whitespace characters are +not permitted.)
      +
      +
      Parameters:
      +
      name - the name of the enum constant to be returned.
      +
      Returns:
      +
      the enum constant with the specified name
      +
      Throws:
      +
      IllegalArgumentException - if this enum class has no constant with the specified name
      +
      NullPointerException - if the argument is null
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/InactiveTopicPolicies.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/InactiveTopicPolicies.html new file mode 100644 index 000000000000..a999eba6a38a --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/InactiveTopicPolicies.html @@ -0,0 +1,151 @@ + + + + +InactiveTopicPolicies (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Class InactiveTopicPolicies

+
+
java.lang.Object +
org.apache.pulsar.common.policies.data.InactiveTopicPolicies
+
+
+
+
public class InactiveTopicPolicies +extends Object
+
Definition of the inactive topic policy.
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      InactiveTopicPolicies

      +
      public InactiveTopicPolicies()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/ManagedLedgerInternalStats.CursorStats.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/ManagedLedgerInternalStats.CursorStats.html new file mode 100644 index 000000000000..c19a338ef819 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/ManagedLedgerInternalStats.CursorStats.html @@ -0,0 +1,319 @@ + + + + +ManagedLedgerInternalStats.CursorStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Class ManagedLedgerInternalStats.CursorStats

+
+
java.lang.Object +
org.apache.pulsar.common.policies.data.ManagedLedgerInternalStats.CursorStats
+
+
+
+
Enclosing class:
+
ManagedLedgerInternalStats
+
+
+
public static class ManagedLedgerInternalStats.CursorStats +extends Object
+
Pulsar cursor statistics.
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    +
      +
    • +
      +

      markDeletePosition

      +
      public String markDeletePosition
      +
      +
      • +
    • +
      +

      readPosition

      +
      public String readPosition
      +
      +
      • +
    • +
      +

      waitingReadOp

      +
      public boolean waitingReadOp
      +
      +
      • +
    • +
      +

      pendingReadOps

      +
      public int pendingReadOps
      +
      +
      • +
    • +
      +

      messagesConsumedCounter

      +
      public long messagesConsumedCounter
      +
      +
      • +
    • +
      +

      cursorLedger

      +
      public long cursorLedger
      +
      +
      • +
    • +
      +

      cursorLedgerLastEntry

      +
      public long cursorLedgerLastEntry
      +
      +
      • +
    • +
      +

      individuallyDeletedMessages

      +
      public String individuallyDeletedMessages
      +
      +
      • +
    • +
      +

      lastLedgerSwitchTimestamp

      +
      public String lastLedgerSwitchTimestamp
      +
      +
      • +
    • +
      +

      state

      +
      public String state
      +
      +
      • +
    • +
      +

      active

      +
      public boolean active
      +
      +
      • +
    • +
      +

      numberOfEntriesSinceFirstNotAckedMessage

      +
      public long numberOfEntriesSinceFirstNotAckedMessage
      +
      +
      • +
    • +
      +

      totalNonContiguousDeletedMessagesRange

      +
      public int totalNonContiguousDeletedMessagesRange
      +
      +
      • +
    • +
      +

      subscriptionHavePendingRead

      +
      public boolean subscriptionHavePendingRead
      +
      +
      • +
    • +
      +

      subscriptionHavePendingReplayRead

      +
      public boolean subscriptionHavePendingReplayRead
      +
      +
      • +
    • +
      +

      properties

      +
      public Map<String,Long> properties
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      CursorStats

      +
      public CursorStats()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/ManagedLedgerInternalStats.LedgerInfo.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/ManagedLedgerInternalStats.LedgerInfo.html new file mode 100644 index 000000000000..75b43003d61f --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/ManagedLedgerInternalStats.LedgerInfo.html @@ -0,0 +1,229 @@ + + + + +ManagedLedgerInternalStats.LedgerInfo (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Class ManagedLedgerInternalStats.LedgerInfo

+
+
java.lang.Object +
org.apache.pulsar.common.policies.data.ManagedLedgerInternalStats.LedgerInfo
+
+
+
+
Enclosing class:
+
ManagedLedgerInternalStats
+
+
+
public static class ManagedLedgerInternalStats.LedgerInfo +extends Object
+
Ledger information.
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    +
      +
    • +
      +

      ledgerId

      +
      public long ledgerId
      +
      +
      • +
    • +
      +

      entries

      +
      public long entries
      +
      +
      • +
    • +
      +

      size

      +
      public long size
      +
      +
      • +
    • +
      +

      offloaded

      +
      public boolean offloaded
      +
      +
      • +
    • +
      +

      metadata

      +
      public String metadata
      +
      +
      • +
    • +
      +

      underReplicated

      +
      public boolean underReplicated
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      LedgerInfo

      +
      public LedgerInfo()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/ManagedLedgerInternalStats.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/ManagedLedgerInternalStats.html new file mode 100644 index 000000000000..780c5f33b594 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/ManagedLedgerInternalStats.html @@ -0,0 +1,355 @@ + + + + +ManagedLedgerInternalStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Class ManagedLedgerInternalStats

+
+
java.lang.Object +
org.apache.pulsar.common.policies.data.ManagedLedgerInternalStats
+
+
+
+
Direct Known Subclasses:
+
PersistentTopicInternalStats
+
+
+
public class ManagedLedgerInternalStats +extends Object
+
ManagedLedger internal statistics.
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    +
      +
    • +
      +

      entriesAddedCounter

      +
      public long entriesAddedCounter
      +
      Messages published since this broker loaded this managedLedger.
      +
      +
      • +
    • +
      +

      numberOfEntries

      +
      public long numberOfEntries
      +
      The total number of entries being tracked.
      +
      +
      • +
    • +
      +

      totalSize

      +
      public long totalSize
      +
      The total storage size of all messages (in bytes).
      +
      +
      • +
    • +
      +

      currentLedgerEntries

      +
      public long currentLedgerEntries
      +
      The count of messages written to the ledger that is currently open for writing.
      +
      +
      • +
    • +
      +

      currentLedgerSize

      +
      public long currentLedgerSize
      +
      The size of messages written to the ledger that is currently open for writing (in bytes).
      +
      +
      • +
    • +
      +

      lastLedgerCreatedTimestamp

      +
      public String lastLedgerCreatedTimestamp
      +
      The time when the last ledger is created.
      +
      +
      • +
    • +
      +

      lastLedgerCreationFailureTimestamp

      +
      public String lastLedgerCreationFailureTimestamp
      +
      The time when the last ledger failed.
      +
      +
      • +
    • +
      +

      waitingCursorsCount

      +
      public int waitingCursorsCount
      +
      The number of cursors that are "caught up" and waiting for a new message to be published.
      +
      +
      • +
    • +
      +

      pendingAddEntriesCount

      +
      public int pendingAddEntriesCount
      +
      The number of messages that complete (asynchronous) write requests.
      +
      +
      • +
    • +
      +

      lastConfirmedEntry

      +
      public String lastConfirmedEntry
      +
      The ledgerid: entryid of the last message that is written successfully. + If the entryid is -1, then the ledger is open, yet no entries are written.
      +
      +
      • +
    • +
      +

      state

      +
      public String state
      +
      The state of this ledger for writing. + The state LedgerOpened means that a ledger is open for saving published messages.
      +
      +
      • +
    • +
      +

      ledgers

      +
      public List<ManagedLedgerInternalStats.LedgerInfo> ledgers
      +
      The ordered list of all ledgers for this topic holding messages.
      +
      +
      • +
    • +
      +

      cursors

      +
      public Map<String,ManagedLedgerInternalStats.CursorStats> cursors
      +
      The list of all cursors on this topic. Each subscription in the topic stats has a cursor.
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      ManagedLedgerInternalStats

      +
      public ManagedLedgerInternalStats()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/NamespaceIsolationData.Builder.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/NamespaceIsolationData.Builder.html new file mode 100644 index 000000000000..d4233afd9b63 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/NamespaceIsolationData.Builder.html @@ -0,0 +1,192 @@ + + + + +NamespaceIsolationData.Builder (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Interface NamespaceIsolationData.Builder

+
+
+
+
Enclosing interface:
+
NamespaceIsolationData
+
+
+
public static interface NamespaceIsolationData.Builder
+
+
+ +
+
+ +
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/NamespaceIsolationData.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/NamespaceIsolationData.html new file mode 100644 index 000000000000..ede40d75787c --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/NamespaceIsolationData.html @@ -0,0 +1,212 @@ + + + + +NamespaceIsolationData (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Interface NamespaceIsolationData

+
+
+
+
public interface NamespaceIsolationData
+
+
+ +
+
+ +
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/NamespaceIsolationPolicyUnloadScope.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/NamespaceIsolationPolicyUnloadScope.html new file mode 100644 index 000000000000..d6af3600a0ed --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/NamespaceIsolationPolicyUnloadScope.html @@ -0,0 +1,254 @@ + + + + +NamespaceIsolationPolicyUnloadScope (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Enum Class NamespaceIsolationPolicyUnloadScope

+
+
java.lang.Object +
java.lang.Enum<NamespaceIsolationPolicyUnloadScope> +
org.apache.pulsar.common.policies.data.NamespaceIsolationPolicyUnloadScope
+
+
+
+
+
All Implemented Interfaces:
+
Serializable, Comparable<NamespaceIsolationPolicyUnloadScope>, Constable
+
+
+
public enum NamespaceIsolationPolicyUnloadScope +extends Enum<NamespaceIsolationPolicyUnloadScope>
+
The type of unload to perform while setting the isolation policy.
+
+
+ +
+
+ +
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/NamespaceOwnershipStatus.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/NamespaceOwnershipStatus.html new file mode 100644 index 000000000000..34649593f196 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/NamespaceOwnershipStatus.html @@ -0,0 +1,241 @@ + + + + +NamespaceOwnershipStatus (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Class NamespaceOwnershipStatus

+
+
java.lang.Object +
org.apache.pulsar.common.policies.data.NamespaceOwnershipStatus
+
+
+
+
public class NamespaceOwnershipStatus +extends Object
+
Information about the namespace's ownership.
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    +
      +
    • +
      +

      broker_assignment

      +
      public BrokerAssignment broker_assignment
      +
      +
      • +
    • +
      +

      is_controlled

      +
      public boolean is_controlled
      +
      +
      • +
    • +
      +

      is_active

      +
      public boolean is_active
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      NamespaceOwnershipStatus

      +
      public NamespaceOwnershipStatus()
      +
      +
      • +
    • +
      +

      NamespaceOwnershipStatus

      +
      public NamespaceOwnershipStatus(BrokerAssignment brokerStatus, + boolean controlled, + boolean active)
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    + +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/NonPersistentPartitionedTopicStats.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/NonPersistentPartitionedTopicStats.html new file mode 100644 index 000000000000..a051a9242bcf --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/NonPersistentPartitionedTopicStats.html @@ -0,0 +1,168 @@ + + + + +NonPersistentPartitionedTopicStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Interface NonPersistentPartitionedTopicStats

+
+
+
+
All Superinterfaces:
+
PartitionedTopicStats, TopicStats
+
+
+
public interface NonPersistentPartitionedTopicStats +extends PartitionedTopicStats
+
Statistics for a non-persistent partitioned topic.
+
+
+ +
+
+ +
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/NonPersistentPublisherStats.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/NonPersistentPublisherStats.html new file mode 100644 index 000000000000..fd35d67252c0 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/NonPersistentPublisherStats.html @@ -0,0 +1,157 @@ + + + + +NonPersistentPublisherStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Interface NonPersistentPublisherStats

+
+
+
+
All Superinterfaces:
+
PublisherStats
+
+
+
public interface NonPersistentPublisherStats +extends PublisherStats
+
Non-persistent publisher statistics.
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getMsgDropRate

      +
      double getMsgDropRate()
      +
      for non-persistent topic: broker drops msg if publisher publishes messages more than configured max inflight + messages per connection.
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/NonPersistentReplicatorStats.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/NonPersistentReplicatorStats.html new file mode 100644 index 000000000000..0177cb2d2534 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/NonPersistentReplicatorStats.html @@ -0,0 +1,167 @@ + + + + +NonPersistentReplicatorStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Interface NonPersistentReplicatorStats

+
+
+
+
All Superinterfaces:
+
ReplicatorStats
+
+
+
public interface NonPersistentReplicatorStats +extends ReplicatorStats
+
Statistics for a non-persistent replicator.
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getMsgDropRate

      +
      double getMsgDropRate()
      +
      for non-persistent topic: broker drops msg for replicator if replicator connection is not writable.
      +
      +
      • +
    • +
      +

      getMsgDropCount

      +
      long getMsgDropCount()
      +
      Total number of messages dropped by the broker for the replicator.
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/NonPersistentSubscriptionStats.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/NonPersistentSubscriptionStats.html new file mode 100644 index 000000000000..e77504180507 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/NonPersistentSubscriptionStats.html @@ -0,0 +1,157 @@ + + + + +NonPersistentSubscriptionStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Interface NonPersistentSubscriptionStats

+
+
+
+
All Superinterfaces:
+
SubscriptionStats
+
+
+
public interface NonPersistentSubscriptionStats +extends SubscriptionStats
+
Statistics for subscription to non-persistent topics.
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getMsgDropRate

      +
      double getMsgDropRate()
      +
      for non-persistent topic: broker drops msg for subscription if none of the consumer available for message + delivery.
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/NonPersistentTopicStats.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/NonPersistentTopicStats.html new file mode 100644 index 000000000000..b99bb8fe6570 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/NonPersistentTopicStats.html @@ -0,0 +1,205 @@ + + + + +NonPersistentTopicStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Interface NonPersistentTopicStats

+
+
+
+
All Superinterfaces:
+
TopicStats
+
+
+
public interface NonPersistentTopicStats +extends TopicStats
+
Statistics for a non-persistent topic.
+
+
+ +
+
+ +
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/OffloadPolicies.Builder.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/OffloadPolicies.Builder.html new file mode 100644 index 000000000000..b01792b436a1 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/OffloadPolicies.Builder.html @@ -0,0 +1,408 @@ + + + + +OffloadPolicies.Builder (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Interface OffloadPolicies.Builder

+
+
+
+
Enclosing interface:
+
OffloadPolicies
+
+
+
public static interface OffloadPolicies.Builder
+
+
+ +
+
+ +
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/OffloadPolicies.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/OffloadPolicies.html new file mode 100644 index 000000000000..ad06803bf579 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/OffloadPolicies.html @@ -0,0 +1,419 @@ + + + + +OffloadPolicies (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Interface OffloadPolicies

+
+
+
+
public interface OffloadPolicies
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getOffloadersDirectory

      +
      String getOffloadersDirectory()
      +
      +
      • +
    • +
      +

      getManagedLedgerOffloadDriver

      +
      String getManagedLedgerOffloadDriver()
      +
      +
      • +
    • +
      +

      getManagedLedgerOffloadMaxThreads

      +
      Integer getManagedLedgerOffloadMaxThreads()
      +
      +
      • +
    • +
      +

      getManagedLedgerOffloadPrefetchRounds

      +
      Integer getManagedLedgerOffloadPrefetchRounds()
      +
      +
      • +
    • +
      +

      getManagedLedgerOffloadThresholdInBytes

      +
      Long getManagedLedgerOffloadThresholdInBytes()
      +
      +
      • +
    • +
      +

      getManagedLedgerOffloadThresholdInSeconds

      +
      Long getManagedLedgerOffloadThresholdInSeconds()
      +
      +
      • +
    • +
      +

      getManagedLedgerOffloadDeletionLagInMillis

      +
      Long getManagedLedgerOffloadDeletionLagInMillis()
      +
      +
      • +
    • +
      +

      getManagedLedgerOffloadedReadPriority

      +
      OffloadedReadPriority getManagedLedgerOffloadedReadPriority()
      +
      +
      • +
    • +
      +

      getS3ManagedLedgerOffloadRegion

      +
      String getS3ManagedLedgerOffloadRegion()
      +
      +
      • +
    • +
      +

      getS3ManagedLedgerOffloadBucket

      +
      String getS3ManagedLedgerOffloadBucket()
      +
      +
      • +
    • +
      +

      getS3ManagedLedgerOffloadServiceEndpoint

      +
      String getS3ManagedLedgerOffloadServiceEndpoint()
      +
      +
      • +
    • +
      +

      getS3ManagedLedgerOffloadMaxBlockSizeInBytes

      +
      Integer getS3ManagedLedgerOffloadMaxBlockSizeInBytes()
      +
      +
      • +
    • +
      +

      getS3ManagedLedgerOffloadReadBufferSizeInBytes

      +
      Integer getS3ManagedLedgerOffloadReadBufferSizeInBytes()
      +
      +
      • +
    • +
      +

      getS3ManagedLedgerOffloadCredentialId

      +
      String getS3ManagedLedgerOffloadCredentialId()
      +
      +
      • +
    • +
      +

      getS3ManagedLedgerOffloadCredentialSecret

      +
      String getS3ManagedLedgerOffloadCredentialSecret()
      +
      +
      • +
    • +
      +

      getS3ManagedLedgerOffloadRole

      +
      String getS3ManagedLedgerOffloadRole()
      +
      +
      • +
    • +
      +

      getS3ManagedLedgerOffloadRoleSessionName

      +
      String getS3ManagedLedgerOffloadRoleSessionName()
      +
      +
      • +
    • +
      +

      getGcsManagedLedgerOffloadRegion

      +
      String getGcsManagedLedgerOffloadRegion()
      +
      +
      • +
    • +
      +

      getGcsManagedLedgerOffloadBucket

      +
      String getGcsManagedLedgerOffloadBucket()
      +
      +
      • +
    • +
      +

      getGcsManagedLedgerOffloadMaxBlockSizeInBytes

      +
      Integer getGcsManagedLedgerOffloadMaxBlockSizeInBytes()
      +
      +
      • +
    • +
      +

      getGcsManagedLedgerOffloadReadBufferSizeInBytes

      +
      Integer getGcsManagedLedgerOffloadReadBufferSizeInBytes()
      +
      +
      • +
    • +
      +

      getGcsManagedLedgerOffloadServiceAccountKeyFile

      +
      String getGcsManagedLedgerOffloadServiceAccountKeyFile()
      +
      +
      • +
    • +
      +

      getFileSystemProfilePath

      +
      String getFileSystemProfilePath()
      +
      +
      • +
    • +
      +

      getFileSystemURI

      +
      String getFileSystemURI()
      +
      +
      • +
    • +
      +

      getManagedLedgerOffloadBucket

      +
      String getManagedLedgerOffloadBucket()
      +
      +
      • +
    • +
      +

      getManagedLedgerOffloadRegion

      +
      String getManagedLedgerOffloadRegion()
      +
      +
      • +
    • +
      +

      getManagedLedgerOffloadServiceEndpoint

      +
      String getManagedLedgerOffloadServiceEndpoint()
      +
      +
      • +
    • +
      +

      getManagedLedgerOffloadMaxBlockSizeInBytes

      +
      Integer getManagedLedgerOffloadMaxBlockSizeInBytes()
      +
      +
      • +
    • +
      +

      getManagedLedgerOffloadReadBufferSizeInBytes

      +
      Integer getManagedLedgerOffloadReadBufferSizeInBytes()
      +
      +
      • +
    • +
      +

      builder

      +
      static OffloadPolicies.Builder builder()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/OffloadedReadPriority.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/OffloadedReadPriority.html new file mode 100644 index 000000000000..86aeb294b870 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/OffloadedReadPriority.html @@ -0,0 +1,288 @@ + + + + +OffloadedReadPriority (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Enum Class OffloadedReadPriority

+
+
java.lang.Object +
java.lang.Enum<OffloadedReadPriority> +
org.apache.pulsar.common.policies.data.OffloadedReadPriority
+
+
+
+
+
All Implemented Interfaces:
+
Serializable, Comparable<OffloadedReadPriority>, Constable
+
+
+
@Public +@Stable +public enum OffloadedReadPriority +extends Enum<OffloadedReadPriority>
+
+
+ +
+
+
    + +
  • +
    +

    Enum Constant Details

    +
      +
    • +
      +

      BOOKKEEPER_FIRST

      +
      public static final OffloadedReadPriority BOOKKEEPER_FIRST
      +
      For offloaded messages, readers will try to read from bookkeeper at first, + if messages not exist at bookkeeper then read from offloaded storage.
      +
      +
      • +
    • +
      +

      TIERED_STORAGE_FIRST

      +
      public static final OffloadedReadPriority TIERED_STORAGE_FIRST
      +
      For offloaded messages, readers will try to read from offloaded storage first, + even they are still exist in bookkeeper.
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      values

      +
      public static OffloadedReadPriority[] values()
      +
      Returns an array containing the constants of this enum class, in +the order they are declared.
      +
      +
      Returns:
      +
      an array containing the constants of this enum class, in the order they are declared
      +
      +
      +
      • +
    • +
      +

      valueOf

      +
      public static OffloadedReadPriority valueOf(String name)
      +
      Returns the enum constant of this class with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this class. (Extraneous whitespace characters are +not permitted.)
      +
      +
      Parameters:
      +
      name - the name of the enum constant to be returned.
      +
      Returns:
      +
      the enum constant with the specified name
      +
      Throws:
      +
      IllegalArgumentException - if this enum class has no constant with the specified name
      +
      NullPointerException - if the argument is null
      +
      +
      +
      • +
    • +
      +

      equalsName

      +
      public boolean equalsName(String otherName)
      +
      +
      • +
    • +
      +

      toString

      +
      public String toString()
      +
      +
      Overrides:
      +
      toString in class Enum<OffloadedReadPriority>
      +
      +
      +
      • +
    • +
      +

      fromString

      +
      public static OffloadedReadPriority fromString(String str)
      +
      +
      • +
    • +
      +

      getValue

      +
      public String getValue()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/PartitionedTopicInternalStats.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/PartitionedTopicInternalStats.html new file mode 100644 index 000000000000..f596528a2c66 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/PartitionedTopicInternalStats.html @@ -0,0 +1,224 @@ + + + + +PartitionedTopicInternalStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Class PartitionedTopicInternalStats

+
+
java.lang.Object +
org.apache.pulsar.common.policies.data.PartitionedTopicInternalStats
+
+
+
+
public class PartitionedTopicInternalStats +extends Object
+
Internal statistics for a partitioned topic.
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    + +
    +
    • + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      PartitionedTopicInternalStats

      +
      public PartitionedTopicInternalStats()
      +
      +
      • +
    • +
      +

      PartitionedTopicInternalStats

      +
      public PartitionedTopicInternalStats(PartitionedTopicMetadata metadata)
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      reset

      +
      public void reset()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/PartitionedTopicStats.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/PartitionedTopicStats.html new file mode 100644 index 000000000000..3292858c7b65 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/PartitionedTopicStats.html @@ -0,0 +1,174 @@ + + + + +PartitionedTopicStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Interface PartitionedTopicStats

+
+
+
+
All Superinterfaces:
+
TopicStats
+
+
+
All Known Subinterfaces:
+
NonPersistentPartitionedTopicStats
+
+
+
public interface PartitionedTopicStats +extends TopicStats
+
Statistics for a partitioned topic.
+
+
+ +
+
+ +
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/PersistencePolicies.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/PersistencePolicies.html new file mode 100644 index 000000000000..58b0225ad969 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/PersistencePolicies.html @@ -0,0 +1,270 @@ + + + + +PersistencePolicies (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Class PersistencePolicies

+
+
java.lang.Object +
org.apache.pulsar.common.policies.data.PersistencePolicies
+
+
+
+
public class PersistencePolicies +extends Object
+
Configuration of bookkeeper persistence policies.
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      PersistencePolicies

      +
      public PersistencePolicies()
      +
      +
      • +
    • +
      +

      PersistencePolicies

      +
      public PersistencePolicies(int bookkeeperEnsemble, + int bookkeeperWriteQuorum, + int bookkeeperAckQuorum, + double managedLedgerMaxMarkDeleteRate)
      +
      +
      • +
    • +
      +

      PersistencePolicies

      +
      public PersistencePolicies(int bookkeeperEnsemble, + int bookkeeperWriteQuorum, + int bookkeeperAckQuorum, + double managedLedgerMaxMarkDeleteRate, + String managedLedgerStorageClassName)
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getBookkeeperEnsemble

      +
      public int getBookkeeperEnsemble()
      +
      +
      • +
    • +
      +

      getBookkeeperWriteQuorum

      +
      public int getBookkeeperWriteQuorum()
      +
      +
      • +
    • +
      +

      getBookkeeperAckQuorum

      +
      public int getBookkeeperAckQuorum()
      +
      +
      • +
    • +
      +

      getManagedLedgerMaxMarkDeleteRate

      +
      public double getManagedLedgerMaxMarkDeleteRate()
      +
      +
      • +
    • +
      +

      getManagedLedgerStorageClassName

      +
      public String getManagedLedgerStorageClassName()
      +
      +
      • +
    • +
      +

      hashCode

      +
      public int hashCode()
      +
      +
      Overrides:
      +
      hashCode in class Object
      +
      +
      +
      • +
    • +
      +

      equals

      +
      public boolean equals(Object obj)
      +
      +
      Overrides:
      +
      equals in class Object
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/PersistentTopicInternalStats.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/PersistentTopicInternalStats.html new file mode 100644 index 000000000000..6c8d4cf01cd9 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/PersistentTopicInternalStats.html @@ -0,0 +1,203 @@ + + + + +PersistentTopicInternalStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Class PersistentTopicInternalStats

+
+
java.lang.Object +
org.apache.pulsar.common.policies.data.ManagedLedgerInternalStats +
org.apache.pulsar.common.policies.data.PersistentTopicInternalStats
+
+
+
+
+
public class PersistentTopicInternalStats +extends ManagedLedgerInternalStats
+
Persistent topic internal statistics.
+
+
+ +
+
+ +
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/Policies.BundleType.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/Policies.BundleType.html new file mode 100644 index 000000000000..78a7f321ead9 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/Policies.BundleType.html @@ -0,0 +1,240 @@ + + + + +Policies.BundleType (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Enum Class Policies.BundleType

+
+
java.lang.Object +
java.lang.Enum<Policies.BundleType> +
org.apache.pulsar.common.policies.data.Policies.BundleType
+
+
+
+
+
All Implemented Interfaces:
+
Serializable, Comparable<Policies.BundleType>, Constable
+
+
+
Enclosing class:
+
Policies
+
+
+
public static enum Policies.BundleType +extends Enum<Policies.BundleType>
+
+
+ +
+
+
    + +
  • +
    +

    Enum Constant Details

    + +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      values

      +
      public static Policies.BundleType[] values()
      +
      Returns an array containing the constants of this enum class, in +the order they are declared.
      +
      +
      Returns:
      +
      an array containing the constants of this enum class, in the order they are declared
      +
      +
      +
      • +
    • +
      +

      valueOf

      +
      public static Policies.BundleType valueOf(String name)
      +
      Returns the enum constant of this class with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this class. (Extraneous whitespace characters are +not permitted.)
      +
      +
      Parameters:
      +
      name - the name of the enum constant to be returned.
      +
      Returns:
      +
      the enum constant with the specified name
      +
      Throws:
      +
      IllegalArgumentException - if this enum class has no constant with the specified name
      +
      NullPointerException - if the argument is null
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/Policies.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/Policies.html new file mode 100644 index 000000000000..822a1889ae39 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/Policies.html @@ -0,0 +1,695 @@ + + + + +Policies (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Class Policies

+
+
java.lang.Object +
org.apache.pulsar.common.policies.data.Policies
+
+
+
+
public class Policies +extends Object
+
Definition of Pulsar policies.
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    +
      +
    • +
      +

      auth_policies

      +
      public final AuthPolicies auth_policies
      +
      +
      • +
    • +
      +

      replication_clusters

      +
      public Set<String> replication_clusters
      +
      +
      • +
    • +
      +

      allowed_clusters

      +
      public Set<String> allowed_clusters
      +
      +
      • +
    • +
      +

      bundles

      +
      public BundlesData bundles
      +
      +
      • +
    • +
      +

      backlog_quota_map

      +
      public Map<BacklogQuota.BacklogQuotaType,BacklogQuota> backlog_quota_map
      +
      +
      • +
    • +
      +

      clusterDispatchRate

      +
      @Deprecated +public Map<String,DispatchRateImpl> clusterDispatchRate
      +
      Deprecated.
      +
      +
      • +
    • +
      +

      topicDispatchRate

      +
      public Map<String,DispatchRateImpl> topicDispatchRate
      +
      +
      • +
    • +
      +

      subscriptionDispatchRate

      +
      public Map<String,DispatchRateImpl> subscriptionDispatchRate
      +
      +
      • +
    • +
      +

      replicatorDispatchRate

      +
      public Map<String,DispatchRateImpl> replicatorDispatchRate
      +
      +
      • +
    • +
      +

      clusterSubscribeRate

      +
      public Map<String,SubscribeRate> clusterSubscribeRate
      +
      +
      • +
    • +
      +

      persistence

      +
      public PersistencePolicies persistence
      +
      +
      • +
    • +
      +

      deduplicationEnabled

      +
      public Boolean deduplicationEnabled
      +
      +
      • +
    • +
      +

      autoTopicCreationOverride

      +
      public AutoTopicCreationOverride autoTopicCreationOverride
      +
      +
      • +
    • +
      +

      autoSubscriptionCreationOverride

      +
      public AutoSubscriptionCreationOverride autoSubscriptionCreationOverride
      +
      +
      • +
    • +
      +

      publishMaxMessageRate

      +
      public Map<String,PublishRate> publishMaxMessageRate
      +
      +
      • +
    • +
      +

      latency_stats_sample_rate

      +
      public Map<String,Integer> latency_stats_sample_rate
      +
      +
      • +
    • +
      +

      message_ttl_in_seconds

      +
      public Integer message_ttl_in_seconds
      +
      +
      • +
    • +
      +

      subscription_expiration_time_minutes

      +
      public Integer subscription_expiration_time_minutes
      +
      +
      • +
    • +
      +

      retention_policies

      +
      public RetentionPolicies retention_policies
      +
      +
      • +
    • +
      +

      deleted

      +
      public boolean deleted
      +
      +
      • +
    • +
      +

      FIRST_BOUNDARY

      +
      public static final String FIRST_BOUNDARY
      +
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      LAST_BOUNDARY

      +
      public static final String LAST_BOUNDARY
      +
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      encryption_required

      +
      public boolean encryption_required
      +
      +
      • +
    • +
      +

      delayed_delivery_policies

      +
      public DelayedDeliveryPolicies delayed_delivery_policies
      +
      +
      • +
    • +
      +

      inactive_topic_policies

      +
      public InactiveTopicPolicies inactive_topic_policies
      +
      +
      • +
    • +
      +

      subscription_auth_mode

      +
      public SubscriptionAuthMode subscription_auth_mode
      +
      +
      • +
    • +
      +

      max_producers_per_topic

      +
      public Integer max_producers_per_topic
      +
      +
      • +
    • +
      +

      max_consumers_per_topic

      +
      public Integer max_consumers_per_topic
      +
      +
      • +
    • +
      +

      max_consumers_per_subscription

      +
      public Integer max_consumers_per_subscription
      +
      +
      • +
    • +
      +

      max_unacked_messages_per_consumer

      +
      public Integer max_unacked_messages_per_consumer
      +
      +
      • +
    • +
      +

      max_unacked_messages_per_subscription

      +
      public Integer max_unacked_messages_per_subscription
      +
      +
      • +
    • +
      +

      max_subscriptions_per_topic

      +
      public Integer max_subscriptions_per_topic
      +
      +
      • +
    • +
      +

      compaction_threshold

      +
      public Long compaction_threshold
      +
      +
      • +
    • +
      +

      offload_threshold

      +
      public long offload_threshold
      +
      +
      • +
    • +
      +

      offload_threshold_in_seconds

      +
      public long offload_threshold_in_seconds
      +
      +
      • +
    • +
      +

      offload_deletion_lag_ms

      +
      public Long offload_deletion_lag_ms
      +
      +
      • +
    • +
      +

      max_topics_per_namespace

      +
      public Integer max_topics_per_namespace
      +
      +
      • +
    • +
      +

      schema_auto_update_compatibility_strategy

      +
      @Deprecated +public SchemaAutoUpdateCompatibilityStrategy schema_auto_update_compatibility_strategy
      +
      Deprecated.
      +
      +
      • +
    • +
      +

      schema_compatibility_strategy

      +
      public SchemaCompatibilityStrategy schema_compatibility_strategy
      +
      +
      • +
    • +
      +

      is_allow_auto_update_schema

      +
      public Boolean is_allow_auto_update_schema
      +
      +
      • +
    • +
      +

      schema_validation_enforced

      +
      public boolean schema_validation_enforced
      +
      +
      • +
    • +
      +

      offload_policies

      +
      public OffloadPolicies offload_policies
      +
      +
      • +
    • +
      +

      deduplicationSnapshotIntervalSeconds

      +
      public Integer deduplicationSnapshotIntervalSeconds
      +
      +
      • +
    • +
      +

      subscription_types_enabled

      +
      public Set<String> subscription_types_enabled
      +
      +
      • +
    • +
      +

      properties

      +
      public Map<String,String> properties
      +
      +
      • +
    • +
      +

      resource_group_name

      +
      public String resource_group_name
      +
      +
      • +
    • +
      +

      migrated

      +
      public boolean migrated
      +
      +
      • +
    • +
      +

      dispatcherPauseOnAckStatePersistentEnabled

      +
      public Boolean dispatcherPauseOnAckStatePersistentEnabled
      +
      +
      • +
    • +
      +

      entryFilters

      +
      public EntryFilters entryFilters
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      Policies

      +
      public Policies()
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      hashCode

      +
      public int hashCode()
      +
      +
      Overrides:
      +
      hashCode in class Object
      +
      +
      +
      • +
    • +
      +

      equals

      +
      public boolean equals(Object obj)
      +
      +
      Overrides:
      +
      equals in class Object
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/PublishRate.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/PublishRate.html new file mode 100644 index 000000000000..2937cc6326bc --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/PublishRate.html @@ -0,0 +1,252 @@ + + + + +PublishRate (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Class PublishRate

+
+
java.lang.Object +
org.apache.pulsar.common.policies.data.PublishRate
+
+
+
+
public class PublishRate +extends Object
+
Publish-rate to manage publish throttling.
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    +
      +
    • +
      +

      publishThrottlingRateInMsg

      +
      public int publishThrottlingRateInMsg
      +
      +
      • +
    • +
      +

      publishThrottlingRateInByte

      +
      public long publishThrottlingRateInByte
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      PublishRate

      +
      public PublishRate()
      +
      +
      • +
    • +
      +

      PublishRate

      +
      public PublishRate(int dispatchThrottlingRateInMsg, + long dispatchThrottlingRateInByte)
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    + +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/PublisherStats.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/PublisherStats.html new file mode 100644 index 000000000000..1f8274e31174 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/PublisherStats.html @@ -0,0 +1,280 @@ + + + + +PublisherStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Interface PublisherStats

+
+
+
+
All Known Subinterfaces:
+
NonPersistentPublisherStats
+
+
+
public interface PublisherStats
+
Statistics about a publisher.
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getAccessMode

      +
      org.apache.pulsar.client.api.ProducerAccessMode getAccessMode()
      +
      +
      • +
    • +
      +

      getMsgRateIn

      +
      double getMsgRateIn()
      +
      Total rate of messages published by this publisher (msg/s).
      +
      +
      • +
    • +
      +

      getMsgThroughputIn

      +
      double getMsgThroughputIn()
      +
      Total throughput of messages published by this publisher (byte/s).
      +
      +
      • +
    • +
      +

      getAverageMsgSize

      +
      double getAverageMsgSize()
      +
      Average message size published by this publisher.
      +
      +
      • +
    • +
      +

      getChunkedMessageRate

      +
      double getChunkedMessageRate()
      +
      The total rate of chunked messages published by this publisher.
      +
      +
      • +
    • +
      +

      getProducerId

      +
      long getProducerId()
      +
      Id of this publisher.
      +
      +
      • +
    • +
      +

      isSupportsPartialProducer

      +
      boolean isSupportsPartialProducer()
      +
      Whether partial producer is supported at client.
      +
      +
      • +
    • +
      +

      getProducerName

      +
      String getProducerName()
      +
      Producer name.
      +
      +
      • +
    • +
      +

      getAddress

      +
      String getAddress()
      +
      Address of this publisher.
      +
      +
      • +
    • +
      +

      getConnectedSince

      +
      String getConnectedSince()
      +
      Timestamp of connection.
      +
      +
      • +
    • +
      +

      getClientVersion

      +
      String getClientVersion()
      +
      Client library version.
      +
      +
      • +
    • +
      +

      getMetadata

      +
      Map<String,String> getMetadata()
      +
      Metadata (key/value strings) associated with this publisher.
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/RawBookieInfo.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/RawBookieInfo.html new file mode 100644 index 000000000000..7b9407fe76d7 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/RawBookieInfo.html @@ -0,0 +1,151 @@ + + + + +RawBookieInfo (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Class RawBookieInfo

+
+
java.lang.Object +
org.apache.pulsar.common.policies.data.RawBookieInfo
+
+
+
+
public class RawBookieInfo +extends Object
+
Bookie information.
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      RawBookieInfo

      +
      public RawBookieInfo()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/ReplicatorStats.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/ReplicatorStats.html new file mode 100644 index 000000000000..f8f3dc62acd6 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/ReplicatorStats.html @@ -0,0 +1,353 @@ + + + + +ReplicatorStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Interface ReplicatorStats

+
+
+
+
All Known Subinterfaces:
+
NonPersistentReplicatorStats
+
+
+
public interface ReplicatorStats
+
Statistics about a replicator.
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getMsgRateIn

      +
      @Deprecated +double getMsgRateIn()
      +
      Deprecated.
      +
      Total rate of messages received from the remote cluster (msg/s).
      +
      +
      • +
    • +
      +

      getMsgInCount

      +
      long getMsgInCount()
      +
      Total number of messages received from the remote cluster.
      +
      +
      • +
    • +
      +

      getMsgThroughputIn

      +
      @Deprecated +double getMsgThroughputIn()
      +
      Deprecated.
      +
      Total throughput received from the remote cluster (bytes/s).
      +
      +
      • +
    • +
      +

      getBytesInCount

      +
      long getBytesInCount()
      +
      Total number of bytes received from the remote cluster.
      +
      +
      • +
    • +
      +

      getMsgRateOut

      +
      @Deprecated +double getMsgRateOut()
      +
      Deprecated.
      +
      Total rate of messages delivered to the replication-subscriber (msg/s).
      +
      +
      • +
    • +
      +

      getMsgOutCount

      +
      long getMsgOutCount()
      +
      Total number of messages sent to the remote cluster.
      +
      +
      • +
    • +
      +

      getMsgThroughputOut

      +
      @Deprecated +double getMsgThroughputOut()
      +
      Deprecated.
      +
      Total throughput delivered to the replication-subscriber (bytes/s).
      +
      +
      • +
    • +
      +

      getBytesOutCount

      +
      long getBytesOutCount()
      +
      Total number of bytes sent to the remote cluster.
      +
      +
      • +
    • +
      +

      getMsgRateExpired

      +
      @Deprecated +double getMsgRateExpired()
      +
      Deprecated.
      +
      Total rate of messages expired (msg/s).
      +
      +
      • +
    • +
      +

      getMsgExpiredCount

      +
      long getMsgExpiredCount()
      +
      Total number of messages expired.
      +
      +
      • +
    • +
      +

      getReplicationBacklog

      +
      long getReplicationBacklog()
      +
      Number of messages pending to be replicated to remote cluster.
      +
      +
      • +
    • +
      +

      isConnected

      +
      boolean isConnected()
      +
      is the replication-subscriber up and running to replicate to remote cluster.
      +
      +
      • +
    • +
      +

      getReplicationDelayInSeconds

      +
      long getReplicationDelayInSeconds()
      +
      Time in seconds from the time a message was produced to the time when it is about to be replicated.
      +
      +
      • +
    • +
      +

      getInboundConnection

      +
      String getInboundConnection()
      +
      Address of incoming replication connection.
      +
      +
      • +
    • +
      +

      getInboundConnectedSince

      +
      String getInboundConnectedSince()
      +
      Timestamp of incoming connection establishment time.
      +
      +
      • +
    • +
      +

      getOutboundConnection

      +
      String getOutboundConnection()
      +
      Address of outbound replication connection.
      +
      +
      • +
    • +
      +

      getOutboundConnectedSince

      +
      String getOutboundConnectedSince()
      +
      Timestamp of outbound connection establishment time.
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/ResourceGroup.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/ResourceGroup.html new file mode 100644 index 000000000000..d39998dfab1b --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/ResourceGroup.html @@ -0,0 +1,150 @@ + + + + +ResourceGroup (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Class ResourceGroup

+
+
java.lang.Object +
org.apache.pulsar.common.policies.data.ResourceGroup
+
+
+
+
public class ResourceGroup +extends Object
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      ResourceGroup

      +
      public ResourceGroup()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/ResourceQuota.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/ResourceQuota.html new file mode 100644 index 000000000000..13e15771e1c5 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/ResourceQuota.html @@ -0,0 +1,210 @@ + + + + +ResourceQuota (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Class ResourceQuota

+
+
java.lang.Object +
org.apache.pulsar.common.policies.data.ResourceQuota
+
+
+
+
public class ResourceQuota +extends Object
+
Resource quota for a namespace or namespace bundle.
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      ResourceQuota

      +
      public ResourceQuota()
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getDynamic

      +
      public boolean getDynamic()
      +
      +
      • +
    • +
      +

      add

      +
      public void add(ResourceQuota quota)
      +
      Add quota.
      +
      +
      Parameters:
      +
      quota - ResourceQuota to add
      +
      +
      +
      • +
    • +
      +

      substract

      +
      public void substract(ResourceQuota quota)
      +
      Substract quota.
      +
      +
      Parameters:
      +
      quota - ResourceQuota to substract
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/RetentionPolicies.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/RetentionPolicies.html new file mode 100644 index 000000000000..d635d19175b9 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/RetentionPolicies.html @@ -0,0 +1,242 @@ + + + + +RetentionPolicies (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Class RetentionPolicies

+
+
java.lang.Object +
org.apache.pulsar.common.policies.data.RetentionPolicies
+
+
+
+
public class RetentionPolicies +extends Object
+
Definition of the retention policy. + +

When you set a retention policy you must set **both** a *size limit* and a *time limit*. + In the case where you don't want to limit by either time or size, the value must be set to `-1`. + Retention policy will be effectively disabled and it won't prevent the deletion of acknowledged + messages when either size or time limit is set to `0`. + Infinite retention can be achieved by setting both time and size limits to `-1`.

+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      RetentionPolicies

      +
      public RetentionPolicies()
      +
      +
      • +
    • +
      +

      RetentionPolicies

      +
      public RetentionPolicies(int retentionTimeInMinutes, + long retentionSizeInMB)
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getRetentionTimeInMinutes

      +
      public int getRetentionTimeInMinutes()
      +
      +
      • +
    • +
      +

      getRetentionSizeInMB

      +
      public long getRetentionSizeInMB()
      +
      +
      • +
    • +
      +

      equals

      +
      public boolean equals(Object o)
      +
      +
      Overrides:
      +
      equals in class Object
      +
      +
      +
      • +
    • +
      +

      hashCode

      +
      public int hashCode()
      +
      +
      Overrides:
      +
      hashCode in class Object
      +
      +
      +
      • +
    • +
      +

      toString

      +
      public String toString()
      +
      +
      Overrides:
      +
      toString in class Object
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/SchemaAutoUpdateCompatibilityStrategy.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/SchemaAutoUpdateCompatibilityStrategy.html new file mode 100644 index 000000000000..62c0a9ac386b --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/SchemaAutoUpdateCompatibilityStrategy.html @@ -0,0 +1,318 @@ + + + + +SchemaAutoUpdateCompatibilityStrategy (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Enum Class SchemaAutoUpdateCompatibilityStrategy

+
+
java.lang.Object +
java.lang.Enum<SchemaAutoUpdateCompatibilityStrategy> +
org.apache.pulsar.common.policies.data.SchemaAutoUpdateCompatibilityStrategy
+
+
+
+
+
All Implemented Interfaces:
+
Serializable, Comparable<SchemaAutoUpdateCompatibilityStrategy>, Constable
+
+
+
public enum SchemaAutoUpdateCompatibilityStrategy +extends Enum<SchemaAutoUpdateCompatibilityStrategy>
+
Strategy to use when checking an auto-updated schema for compatibility to the current schema.
+
+
+ +
+
+
    + +
  • +
    +

    Enum Constant Details

    +
      +
    • +
      +

      AutoUpdateDisabled

      +
      public static final SchemaAutoUpdateCompatibilityStrategy AutoUpdateDisabled
      +
      Don't allow any auto updates.
      +
      +
      • +
    • +
      +

      Backward

      +
      public static final SchemaAutoUpdateCompatibilityStrategy Backward
      +
      Messages written in the previous schema can be read by the new schema. + To be backward compatible, the new schema must not add any new fields that + don't have default values. However, it may remove fields.
      +
      +
      • +
    • +
      +

      Forward

      +
      public static final SchemaAutoUpdateCompatibilityStrategy Forward
      +
      Messages written in the new schema can be read by the previous schema. + To be forward compatible, the new schema must not remove any fields which + don't have default values in the previous schema. However, it may add new fields.
      +
      +
      • +
    • +
      +

      Full

      +
      public static final SchemaAutoUpdateCompatibilityStrategy Full
      +
      Backward and Forward.
      +
      +
      • +
    • +
      +

      AlwaysCompatible

      +
      public static final SchemaAutoUpdateCompatibilityStrategy AlwaysCompatible
      +
      Always Compatible - The new schema will not be checked for compatibility against + old schemas. In other words, new schemas will always be marked assumed compatible.
      +
      +
      • +
    • +
      +

      BackwardTransitive

      +
      public static final SchemaAutoUpdateCompatibilityStrategy BackwardTransitive
      +
      Be similar to Backward. BackwardTransitive ensure all previous version schema can + be read by the new schema.
      +
      +
      • +
    • +
      +

      ForwardTransitive

      +
      public static final SchemaAutoUpdateCompatibilityStrategy ForwardTransitive
      +
      Be similar to Forward, ForwardTransitive ensure new schema can be ready by all previous + version schema.
      +
      +
      • +
    • +
      +

      FullTransitive

      +
      public static final SchemaAutoUpdateCompatibilityStrategy FullTransitive
      +
      BackwardTransitive and ForwardTransitive.
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      values

      +
      public static SchemaAutoUpdateCompatibilityStrategy[] values()
      +
      Returns an array containing the constants of this enum class, in +the order they are declared.
      +
      +
      Returns:
      +
      an array containing the constants of this enum class, in the order they are declared
      +
      +
      +
      • +
    • +
      +

      valueOf

      +
      public static SchemaAutoUpdateCompatibilityStrategy valueOf(String name)
      +
      Returns the enum constant of this class with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this class. (Extraneous whitespace characters are +not permitted.)
      +
      +
      Parameters:
      +
      name - the name of the enum constant to be returned.
      +
      Returns:
      +
      the enum constant with the specified name
      +
      Throws:
      +
      IllegalArgumentException - if this enum class has no constant with the specified name
      +
      NullPointerException - if the argument is null
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/SchemaCompatibilityStrategy.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/SchemaCompatibilityStrategy.html new file mode 100644 index 000000000000..85407eedd305 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/SchemaCompatibilityStrategy.html @@ -0,0 +1,342 @@ + + + + +SchemaCompatibilityStrategy (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Enum Class SchemaCompatibilityStrategy

+
+
java.lang.Object +
java.lang.Enum<SchemaCompatibilityStrategy> +
org.apache.pulsar.common.policies.data.SchemaCompatibilityStrategy
+
+
+
+
+
All Implemented Interfaces:
+
Serializable, Comparable<SchemaCompatibilityStrategy>, Constable
+
+
+
public enum SchemaCompatibilityStrategy +extends Enum<SchemaCompatibilityStrategy>
+
Pulsar Schema compatibility strategy.
+
+
+ +
+
+
    + +
  • +
    +

    Enum Constant Details

    +
      +
    • +
      +

      UNDEFINED

      +
      public static final SchemaCompatibilityStrategy UNDEFINED
      +
      Undefined.
      +
      +
      • +
    • +
      +

      ALWAYS_INCOMPATIBLE

      +
      public static final SchemaCompatibilityStrategy ALWAYS_INCOMPATIBLE
      +
      Always incompatible.
      +
      +
      • +
    • +
      +

      ALWAYS_COMPATIBLE

      +
      public static final SchemaCompatibilityStrategy ALWAYS_COMPATIBLE
      +
      Always compatible.
      +
      +
      • +
    • +
      +

      BACKWARD

      +
      public static final SchemaCompatibilityStrategy BACKWARD
      +
      Messages written by an old schema can be read by a new schema.
      +
      +
      • +
    • +
      +

      FORWARD

      +
      public static final SchemaCompatibilityStrategy FORWARD
      +
      Messages written by a new schema can be read by an old schema.
      +
      +
      • +
    • +
      +

      FULL

      +
      public static final SchemaCompatibilityStrategy FULL
      +
      Equivalent to both FORWARD and BACKWARD.
      +
      +
      • +
    • +
      +

      BACKWARD_TRANSITIVE

      +
      public static final SchemaCompatibilityStrategy BACKWARD_TRANSITIVE
      +
      Be similar to BACKWARD, BACKWARD_TRANSITIVE ensure all previous version schema can + be read by the new schema.
      +
      +
      • +
    • +
      +

      FORWARD_TRANSITIVE

      +
      public static final SchemaCompatibilityStrategy FORWARD_TRANSITIVE
      +
      Be similar to FORWARD, FORWARD_TRANSITIVE ensure new schema can be ready by all previous + version schema.
      +
      +
      • +
    • +
      +

      FULL_TRANSITIVE

      +
      public static final SchemaCompatibilityStrategy FULL_TRANSITIVE
      +
      Equivalent to both FORWARD_TRANSITIVE and BACKWARD_TRANSITIVE.
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      values

      +
      public static SchemaCompatibilityStrategy[] values()
      +
      Returns an array containing the constants of this enum class, in +the order they are declared.
      +
      +
      Returns:
      +
      an array containing the constants of this enum class, in the order they are declared
      +
      +
      +
      • +
    • +
      +

      valueOf

      +
      public static SchemaCompatibilityStrategy valueOf(String name)
      +
      Returns the enum constant of this class with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this class. (Extraneous whitespace characters are +not permitted.)
      +
      +
      Parameters:
      +
      name - the name of the enum constant to be returned.
      +
      Returns:
      +
      the enum constant with the specified name
      +
      Throws:
      +
      IllegalArgumentException - if this enum class has no constant with the specified name
      +
      NullPointerException - if the argument is null
      +
      +
      +
      • +
    • +
      +

      isUndefined

      +
      public static boolean isUndefined(SchemaCompatibilityStrategy strategy)
      +
      +
      • +
    • +
      +

      fromAutoUpdatePolicy

      +
      public static SchemaCompatibilityStrategy fromAutoUpdatePolicy(SchemaAutoUpdateCompatibilityStrategy strategy)
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/SchemaMetadata.Entry.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/SchemaMetadata.Entry.html new file mode 100644 index 000000000000..a1700c71b320 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/SchemaMetadata.Entry.html @@ -0,0 +1,185 @@ + + + + +SchemaMetadata.Entry (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Class SchemaMetadata.Entry

+
+
java.lang.Object +
org.apache.pulsar.common.policies.data.SchemaMetadata.Entry
+
+
+
+
Enclosing class:
+
SchemaMetadata
+
+
+
public static class SchemaMetadata.Entry +extends Object
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      Entry

      +
      public Entry()
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    + +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/SchemaMetadata.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/SchemaMetadata.html new file mode 100644 index 000000000000..4799038222b9 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/SchemaMetadata.html @@ -0,0 +1,204 @@ + + + + +SchemaMetadata (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Class SchemaMetadata

+
+
java.lang.Object +
org.apache.pulsar.common.policies.data.SchemaMetadata
+
+
+
+
public class SchemaMetadata +extends Object
+
Schema metadata info.
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    + +
    +
    • + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      SchemaMetadata

      +
      public SchemaMetadata()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/SegmentStats.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/SegmentStats.html new file mode 100644 index 000000000000..9e85bd414825 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/SegmentStats.html @@ -0,0 +1,198 @@ + + + + +SegmentStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Class SegmentStats

+
+
java.lang.Object +
org.apache.pulsar.common.policies.data.SegmentStats
+
+
+
+
public class SegmentStats +extends Object
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    +
      +
    • +
      +

      lastTxnID

      +
      public String lastTxnID
      +
      +
      • +
    • +
      +

      persistentPosition

      +
      public String persistentPosition
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      SegmentStats

      +
      public SegmentStats(String lastTxnID, + String persistentPosition)
      +
      +
      • +
    • +
      +

      SegmentStats

      +
      public SegmentStats()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/SegmentsStats.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/SegmentsStats.html new file mode 100644 index 000000000000..26d73dd09ef2 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/SegmentsStats.html @@ -0,0 +1,218 @@ + + + + +SegmentsStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Class SegmentsStats

+
+
java.lang.Object +
org.apache.pulsar.common.policies.data.SegmentsStats
+
+
+
+
public class SegmentsStats +extends Object
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    +
      +
    • +
      +

      segmentsSize

      +
      public long segmentsSize
      +
      +
      • +
    • +
      +

      currentSegmentCapacity

      +
      public long currentSegmentCapacity
      +
      +
      • +
    • +
      +

      unsealedAbortTxnIDSize

      +
      public long unsealedAbortTxnIDSize
      +
      +
      • +
    • +
      +

      segmentStats

      +
      public List<SegmentStats> segmentStats
      +
      +
      • +
    • +
      +

      lastTookSnapshotSegmentTimestamp

      +
      public long lastTookSnapshotSegmentTimestamp
      +
      The last snapshot segment timestamps of this transaction buffer.
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      SegmentsStats

      +
      public SegmentsStats()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/SinkStatus.SinkInstanceStatus.SinkInstanceStatusData.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/SinkStatus.SinkInstanceStatus.SinkInstanceStatusData.html new file mode 100644 index 000000000000..e65532702a75 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/SinkStatus.SinkInstanceStatus.SinkInstanceStatusData.html @@ -0,0 +1,274 @@ + + + + +SinkStatus.SinkInstanceStatus.SinkInstanceStatusData (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Class SinkStatus.SinkInstanceStatus.SinkInstanceStatusData

+
+
java.lang.Object +
org.apache.pulsar.common.policies.data.SinkStatus.SinkInstanceStatus.SinkInstanceStatusData
+
+
+
+
Enclosing class:
+
SinkStatus.SinkInstanceStatus
+
+
+
public static class SinkStatus.SinkInstanceStatus.SinkInstanceStatusData +extends Object
+
Status data of a Sink instance.
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    +
      +
    • +
      +

      running

      +
      public boolean running
      +
      +
      • +
    • +
      +

      error

      +
      public String error
      +
      +
      • +
    • +
      +

      numRestarts

      +
      public long numRestarts
      +
      +
      • +
    • +
      +

      numReadFromPulsar

      +
      public long numReadFromPulsar
      +
      +
      • +
    • +
      +

      numSystemExceptions

      +
      public long numSystemExceptions
      +
      +
      • +
    • +
      +

      latestSystemExceptions

      +
      public List<ExceptionInformation> latestSystemExceptions
      +
      +
      • +
    • +
      +

      numSinkExceptions

      +
      public long numSinkExceptions
      +
      +
      • +
    • +
      +

      latestSinkExceptions

      +
      public List<ExceptionInformation> latestSinkExceptions
      +
      +
      • +
    • +
      +

      numWrittenToSink

      +
      public long numWrittenToSink
      +
      +
      • +
    • +
      +

      lastReceivedTime

      +
      public long lastReceivedTime
      +
      +
      • +
    • +
      +

      workerId

      +
      public String workerId
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      SinkInstanceStatusData

      +
      public SinkInstanceStatusData()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/SinkStatus.SinkInstanceStatus.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/SinkStatus.SinkInstanceStatus.html new file mode 100644 index 000000000000..5b359c7faec0 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/SinkStatus.SinkInstanceStatus.html @@ -0,0 +1,210 @@ + + + + +SinkStatus.SinkInstanceStatus (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Class SinkStatus.SinkInstanceStatus

+
+
java.lang.Object +
org.apache.pulsar.common.policies.data.SinkStatus.SinkInstanceStatus
+
+
+
+
Enclosing class:
+
SinkStatus
+
+
+
public static class SinkStatus.SinkInstanceStatus +extends Object
+
Status of a Sink instance.
+
+
+ +
+
+ +
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/SinkStatus.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/SinkStatus.html new file mode 100644 index 000000000000..8abba4eba366 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/SinkStatus.html @@ -0,0 +1,242 @@ + + + + +SinkStatus (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Class SinkStatus

+
+
java.lang.Object +
org.apache.pulsar.common.policies.data.SinkStatus
+
+
+
+
public class SinkStatus +extends Object
+
Status of Pulsar Sink.
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    +
      +
    • +
      +

      numInstances

      +
      public int numInstances
      +
      +
      • +
    • +
      +

      numRunning

      +
      public int numRunning
      +
      +
      • +
    • +
      +

      instances

      +
      public List<SinkStatus.SinkInstanceStatus> instances
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      SinkStatus

      +
      public SinkStatus()
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    + +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/SnapshotSystemTopicInternalStats.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/SnapshotSystemTopicInternalStats.html new file mode 100644 index 000000000000..a4455f179830 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/SnapshotSystemTopicInternalStats.html @@ -0,0 +1,188 @@ + + + + +SnapshotSystemTopicInternalStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Class SnapshotSystemTopicInternalStats

+
+
java.lang.Object +
org.apache.pulsar.common.policies.data.SnapshotSystemTopicInternalStats
+
+
+
+
public class SnapshotSystemTopicInternalStats +extends Object
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    +
      +
    • +
      +

      managedLedgerName

      +
      public String managedLedgerName
      +
      +
      • +
    • +
      +

      managedLedgerInternalStats

      +
      public ManagedLedgerInternalStats managedLedgerInternalStats
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      SnapshotSystemTopicInternalStats

      +
      public SnapshotSystemTopicInternalStats()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/SourceStatus.SourceInstanceStatus.SourceInstanceStatusData.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/SourceStatus.SourceInstanceStatus.SourceInstanceStatusData.html new file mode 100644 index 000000000000..6ae986941fac --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/SourceStatus.SourceInstanceStatus.SourceInstanceStatusData.html @@ -0,0 +1,274 @@ + + + + +SourceStatus.SourceInstanceStatus.SourceInstanceStatusData (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Class SourceStatus.SourceInstanceStatus.SourceInstanceStatusData

+
+
java.lang.Object +
org.apache.pulsar.common.policies.data.SourceStatus.SourceInstanceStatus.SourceInstanceStatusData
+
+
+
+
Enclosing class:
+
SourceStatus.SourceInstanceStatus
+
+
+
public static class SourceStatus.SourceInstanceStatus.SourceInstanceStatusData +extends Object
+
Source instance status data.
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    +
      +
    • +
      +

      running

      +
      public boolean running
      +
      +
      • +
    • +
      +

      error

      +
      public String error
      +
      +
      • +
    • +
      +

      numRestarts

      +
      public long numRestarts
      +
      +
      • +
    • +
      +

      numReceivedFromSource

      +
      public long numReceivedFromSource
      +
      +
      • +
    • +
      +

      numSystemExceptions

      +
      public long numSystemExceptions
      +
      +
      • +
    • +
      +

      latestSystemExceptions

      +
      public List<ExceptionInformation> latestSystemExceptions
      +
      +
      • +
    • +
      +

      numSourceExceptions

      +
      public long numSourceExceptions
      +
      +
      • +
    • +
      +

      latestSourceExceptions

      +
      public List<ExceptionInformation> latestSourceExceptions
      +
      +
      • +
    • +
      +

      numWritten

      +
      public long numWritten
      +
      +
      • +
    • +
      +

      lastReceivedTime

      +
      public long lastReceivedTime
      +
      +
      • +
    • +
      +

      workerId

      +
      public String workerId
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      SourceInstanceStatusData

      +
      public SourceInstanceStatusData()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/SourceStatus.SourceInstanceStatus.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/SourceStatus.SourceInstanceStatus.html new file mode 100644 index 000000000000..6189d356288b --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/SourceStatus.SourceInstanceStatus.html @@ -0,0 +1,210 @@ + + + + +SourceStatus.SourceInstanceStatus (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Class SourceStatus.SourceInstanceStatus

+
+
java.lang.Object +
org.apache.pulsar.common.policies.data.SourceStatus.SourceInstanceStatus
+
+
+
+
Enclosing class:
+
SourceStatus
+
+
+
public static class SourceStatus.SourceInstanceStatus +extends Object
+
Source instance status.
+
+
+ +
+
+ +
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/SourceStatus.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/SourceStatus.html new file mode 100644 index 000000000000..11120dd0233b --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/SourceStatus.html @@ -0,0 +1,242 @@ + + + + +SourceStatus (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Class SourceStatus

+
+
java.lang.Object +
org.apache.pulsar.common.policies.data.SourceStatus
+
+
+
+
public class SourceStatus +extends Object
+
Source status.
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    + +
    +
    • + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      SourceStatus

      +
      public SourceStatus()
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    + +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/SubscribeRate.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/SubscribeRate.html new file mode 100644 index 000000000000..7292e79947fb --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/SubscribeRate.html @@ -0,0 +1,252 @@ + + + + +SubscribeRate (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Class SubscribeRate

+
+
java.lang.Object +
org.apache.pulsar.common.policies.data.SubscribeRate
+
+
+
+
public class SubscribeRate +extends Object
+
Information about subscription rate.
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    +
      +
    • +
      +

      subscribeThrottlingRatePerConsumer

      +
      public int subscribeThrottlingRatePerConsumer
      +
      +
      • +
    • +
      +

      ratePeriodInSecond

      +
      public int ratePeriodInSecond
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      SubscribeRate

      +
      public SubscribeRate()
      +
      +
      • +
    • +
      +

      SubscribeRate

      +
      public SubscribeRate(int subscribeThrottlingRatePerConsumer, + int ratePeriodInSecond)
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    + +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/SubscriptionAuthMode.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/SubscriptionAuthMode.html new file mode 100644 index 000000000000..b887c254aad2 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/SubscriptionAuthMode.html @@ -0,0 +1,243 @@ + + + + +SubscriptionAuthMode (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Enum Class SubscriptionAuthMode

+
+
java.lang.Object +
java.lang.Enum<SubscriptionAuthMode> +
org.apache.pulsar.common.policies.data.SubscriptionAuthMode
+
+
+
+
+
All Implemented Interfaces:
+
Serializable, Comparable<SubscriptionAuthMode>, Constable
+
+
+
public enum SubscriptionAuthMode +extends Enum<SubscriptionAuthMode>
+
Subscription authorization for Pulsar policies.
+
+
+ +
+
+
    + +
  • +
    +

    Enum Constant Details

    +
      +
    • +
      +

      None

      +
      public static final SubscriptionAuthMode None
      +
      Every subscription name can be used by every role.
      +
      +
      • +
    • +
      +

      Prefix

      +
      public static final SubscriptionAuthMode Prefix
      +
      Subscription name with auth role prefix can be used by the role.
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      values

      +
      public static SubscriptionAuthMode[] values()
      +
      Returns an array containing the constants of this enum class, in +the order they are declared.
      +
      +
      Returns:
      +
      an array containing the constants of this enum class, in the order they are declared
      +
      +
      +
      • +
    • +
      +

      valueOf

      +
      public static SubscriptionAuthMode valueOf(String name)
      +
      Returns the enum constant of this class with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this class. (Extraneous whitespace characters are +not permitted.)
      +
      +
      Parameters:
      +
      name - the name of the enum constant to be returned.
      +
      Returns:
      +
      the enum constant with the specified name
      +
      Throws:
      +
      IllegalArgumentException - if this enum class has no constant with the specified name
      +
      NullPointerException - if the argument is null
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/SubscriptionStats.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/SubscriptionStats.html new file mode 100644 index 000000000000..959889921d88 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/SubscriptionStats.html @@ -0,0 +1,637 @@ + + + + +SubscriptionStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Interface SubscriptionStats

+
+
+
+
All Known Subinterfaces:
+
NonPersistentSubscriptionStats
+
+
+
public interface SubscriptionStats
+
Statistics about subscription.
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getMsgRateOut

      +
      double getMsgRateOut()
      +
      Total rate of messages delivered on this subscription (msg/s).
      +
      +
      • +
    • +
      +

      getMsgThroughputOut

      +
      double getMsgThroughputOut()
      +
      Total throughput delivered on this subscription (bytes/s).
      +
      +
      • +
    • +
      +

      getBytesOutCounter

      +
      long getBytesOutCounter()
      +
      Total bytes delivered to consumer (bytes).
      +
      +
      • +
    • +
      +

      getMsgOutCounter

      +
      long getMsgOutCounter()
      +
      Total messages delivered to consumer (msg).
      +
      +
      • +
    • +
      +

      getMsgRateRedeliver

      +
      double getMsgRateRedeliver()
      +
      Total rate of messages redelivered on this subscription (msg/s).
      +
      +
      • +
    • +
      +

      getMessageAckRate

      +
      double getMessageAckRate()
      +
      Total rate of message ack(msg/s).
      +
      +
      • +
    • +
      +

      getChunkedMessageRate

      +
      double getChunkedMessageRate()
      +
      Chunked message dispatch rate.
      +
      +
      • +
    • +
      +

      getMsgBacklog

      +
      long getMsgBacklog()
      +
      Number of entries in the subscription backlog.
      +
      +
      • +
    • +
      +

      getBacklogSize

      +
      long getBacklogSize()
      +
      Size of backlog in byte.
      +
      +
      • +
    • +
      +

      getEarliestMsgPublishTimeInBacklog

      +
      long getEarliestMsgPublishTimeInBacklog()
      +
      Get the publish time of the earliest message in the backlog.
      +
      +
      • +
    • +
      +

      getMsgBacklogNoDelayed

      +
      long getMsgBacklogNoDelayed()
      +
      Number of entries in the subscription backlog that do not contain the delay messages.
      +
      +
      • +
    • +
      +

      isBlockedSubscriptionOnUnackedMsgs

      +
      boolean isBlockedSubscriptionOnUnackedMsgs()
      +
      Flag to verify if subscription is blocked due to reaching threshold of unacked messages.
      +
      +
      • +
    • +
      +

      getMsgDelayed

      +
      long getMsgDelayed()
      +
      Number of delayed messages currently being tracked.
      +
      +
      • +
    • +
      +

      getMsgInReplay

      +
      long getMsgInReplay()
      +
      Number of messages registered for replay.
      +
      +
      • +
    • +
      +

      getUnackedMessages

      +
      long getUnackedMessages()
      +
      Number of unacknowledged messages for the subscription, where an unacknowledged message is one that has been + sent to a consumer but not yet acknowledged. Calculated by summing all ConsumerStats.getUnackedMessages() + for this subscription. See ConsumerStats.getUnackedMessages() for additional details.
      +
      +
      • +
    • +
      +

      getType

      +
      String getType()
      +
      The subscription type as defined by SubscriptionType.
      +
      +
      • +
    • +
      +

      getActiveConsumerName

      +
      String getActiveConsumerName()
      +
      The name of the consumer that is active for single active consumer subscriptions i.e. failover or exclusive.
      +
      +
      • +
    • +
      +

      getMsgRateExpired

      +
      double getMsgRateExpired()
      +
      Total rate of messages expired on this subscription (msg/s).
      +
      +
      • +
    • +
      +

      getTotalMsgExpired

      +
      long getTotalMsgExpired()
      +
      Total messages expired on this subscription.
      +
      +
      • +
    • +
      +

      getLastExpireTimestamp

      +
      long getLastExpireTimestamp()
      +
      Last message expire execution timestamp.
      +
      +
      • +
    • +
      +

      getLastConsumedFlowTimestamp

      +
      long getLastConsumedFlowTimestamp()
      +
      Last received consume flow command timestamp.
      +
      +
      • +
    • +
      +

      getLastConsumedTimestamp

      +
      long getLastConsumedTimestamp()
      +
      Last consume message timestamp.
      +
      +
      • +
    • +
      +

      getLastAckedTimestamp

      +
      long getLastAckedTimestamp()
      +
      Last acked message timestamp.
      +
      +
      • +
    • +
      +

      getLastMarkDeleteAdvancedTimestamp

      +
      long getLastMarkDeleteAdvancedTimestamp()
      +
      Last MarkDelete position advanced timesetamp.
      +
      +
      • +
    • +
      +

      getConsumers

      +
      List<? extends ConsumerStats> getConsumers()
      +
      List of connected consumers on this subscription w/ their stats.
      +
      +
      • +
    • +
      +

      isDurable

      +
      boolean isDurable()
      +
      Tells whether this subscription is durable or ephemeral (eg.: from a reader).
      +
      +
      • +
    • +
      +

      isReplicated

      +
      boolean isReplicated()
      +
      Mark that the subscription state is kept in sync across different regions.
      +
      +
      • +
    • +
      +

      isAllowOutOfOrderDelivery

      +
      boolean isAllowOutOfOrderDelivery()
      +
      Whether out of order delivery is allowed on the Key_Shared subscription.
      +
      +
      • +
    • +
      +

      getKeySharedMode

      +
      String getKeySharedMode()
      +
      Whether the Key_Shared subscription mode is AUTO_SPLIT or STICKY.
      +
      +
      • +
    • +
      +

      getConsumersAfterMarkDeletePosition

      +
      Map<String,String> getConsumersAfterMarkDeletePosition()
      +
      This is for Key_Shared subscription to get the recentJoinedConsumers in the Key_Shared subscription.
      +
      +
      • +
    • +
      +

      getDrainingHashesCount

      +
      int getDrainingHashesCount()
      +
      For Key_Shared subscription in AUTO_SPLIT ordered mode: + Retrieves the current number of hashes in the draining state.
      +
      +
      Returns:
      +
      the current number of hashes in the draining state
      +
      +
      +
      • +
    • +
      +

      getDrainingHashesClearedTotal

      +
      long getDrainingHashesClearedTotal()
      +
      For Key_Shared subscription in AUTO_SPLIT ordered mode: + Retrieves the total number of hashes cleared from the draining state for the connected consumers.
      +
      +
      Returns:
      +
      the total number of hashes cleared from the draining state for the connected consumers
      +
      +
      +
      • +
    • +
      +

      getDrainingHashesUnackedMessages

      +
      int getDrainingHashesUnackedMessages()
      +
      For Key_Shared subscription in AUTO_SPLIT ordered mode: + Retrieves the total number of unacked messages for all draining hashes.
      +
      +
      Returns:
      +
      the total number of unacked messages for all draining hashes
      +
      +
      +
      • +
    • +
      +

      getSubscriptionProperties

      +
      Map<String,String> getSubscriptionProperties()
      +
      SubscriptionProperties (key/value strings) associated with this subscribe.
      +
      +
      • +
    • +
      +

      getNonContiguousDeletedMessagesRanges

      +
      int getNonContiguousDeletedMessagesRanges()
      +
      The number of non-contiguous deleted messages ranges.
      +
      +
      • +
    • +
      +

      getNonContiguousDeletedMessagesRangesSerializedSize

      +
      int getNonContiguousDeletedMessagesRangesSerializedSize()
      +
      The serialized size of non-contiguous deleted messages ranges.
      +
      +
      • +
    • +
      +

      getFilterProcessedMsgCount

      +
      long getFilterProcessedMsgCount()
      +
      +
      • +
    • +
      +

      getFilterAcceptedMsgCount

      +
      long getFilterAcceptedMsgCount()
      +
      +
      • +
    • +
      +

      getFilterRejectedMsgCount

      +
      long getFilterRejectedMsgCount()
      +
      +
      • +
    • +
      +

      getFilterRescheduledMsgCount

      +
      long getFilterRescheduledMsgCount()
      +
      +
      • +
    • +
      +

      getDelayedMessageIndexSizeInBytes

      +
      long getDelayedMessageIndexSizeInBytes()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/TenantInfo.Builder.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/TenantInfo.Builder.html new file mode 100644 index 000000000000..8080c06021e6 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/TenantInfo.Builder.html @@ -0,0 +1,165 @@ + + + + +TenantInfo.Builder (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Interface TenantInfo.Builder

+
+
+
+
Enclosing interface:
+
TenantInfo
+
+
+
public static interface TenantInfo.Builder
+
+
+ +
+
+ +
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/TenantInfo.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/TenantInfo.html new file mode 100644 index 000000000000..1f41e75d04ef --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/TenantInfo.html @@ -0,0 +1,176 @@ + + + + +TenantInfo (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Interface TenantInfo

+
+
+
+
public interface TenantInfo
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    + +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/TopicHashPositions.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/TopicHashPositions.html new file mode 100644 index 000000000000..71906bda0017 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/TopicHashPositions.html @@ -0,0 +1,150 @@ + + + + +TopicHashPositions (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Class TopicHashPositions

+
+
java.lang.Object +
org.apache.pulsar.common.policies.data.TopicHashPositions
+
+
+
+
public class TopicHashPositions +extends Object
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      TopicHashPositions

      +
      public TopicHashPositions()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/TopicStats.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/TopicStats.html new file mode 100644 index 000000000000..8499bb75aa22 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/TopicStats.html @@ -0,0 +1,487 @@ + + + + +TopicStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Interface TopicStats

+
+
+
+
All Known Subinterfaces:
+
NonPersistentPartitionedTopicStats, NonPersistentTopicStats, PartitionedTopicStats
+
+
+
public interface TopicStats
+
Statistics for a Pulsar topic.
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getMsgRateIn

      +
      double getMsgRateIn()
      +
      Total rate of messages published on the topic (msg/s).
      +
      +
      • +
    • +
      +

      getMsgThroughputIn

      +
      double getMsgThroughputIn()
      +
      Total throughput of messages published on the topic (byte/s).
      +
      +
      • +
    • +
      +

      getMsgRateOut

      +
      double getMsgRateOut()
      +
      Total rate of messages dispatched for the topic (msg/s).
      +
      +
      • +
    • +
      +

      getMsgThroughputOut

      +
      double getMsgThroughputOut()
      +
      Total throughput of messages dispatched for the topic (byte/s).
      +
      +
      • +
    • +
      +

      getBytesInCounter

      +
      long getBytesInCounter()
      +
      Total bytes published to the topic (bytes).
      +
      +
      • +
    • +
      +

      getMsgInCounter

      +
      long getMsgInCounter()
      +
      Total messages published to the topic (msg).
      +
      +
      • +
    • +
      +

      getBytesOutCounter

      +
      long getBytesOutCounter()
      +
      Total bytes delivered to consumer (bytes).
      +
      +
      • +
    • +
      +

      getMsgOutCounter

      +
      long getMsgOutCounter()
      +
      Total messages delivered to consumer (msg).
      +
      +
      • +
    • +
      +

      getAverageMsgSize

      +
      double getAverageMsgSize()
      +
      Average size of published messages (bytes).
      +
      +
      • +
    • +
      +

      isMsgChunkPublished

      +
      boolean isMsgChunkPublished()
      +
      Topic has chunked message published on it.
      +
      +
      • +
    • +
      +

      getStorageSize

      +
      long getStorageSize()
      +
      Space used to store the messages for the topic (bytes).
      +
      +
      • +
    • +
      +

      getBacklogSize

      +
      long getBacklogSize()
      +
      Get estimated total unconsumed or backlog size in bytes.
      +
      +
      • +
    • +
      +

      getEarliestMsgPublishTimeInBacklogs

      +
      long getEarliestMsgPublishTimeInBacklogs()
      +
      Get the publish time of the earliest message over all the backlogs.
      +
      +
      • +
    • +
      +

      getBacklogQuotaLimitSize

      +
      long getBacklogQuotaLimitSize()
      +
      the size in bytes of the topic backlog quota.
      +
      +
      • +
    • +
      +

      getBacklogQuotaLimitTime

      +
      long getBacklogQuotaLimitTime()
      +
      the topic backlog age quota, in seconds.
      +
      +
      • +
    • +
      +

      getOldestBacklogMessageAgeSeconds

      +
      long getOldestBacklogMessageAgeSeconds()
      +
      Age of oldest unacknowledged message, as recorded in last backlog quota check interval. +

      + The age of the oldest unacknowledged (i.e. backlog) message, measured by the time elapsed from its published + time, in seconds. This value is recorded every backlog quota check interval, hence it represents the value + seen in the last check. +

      +
      +
      • +
    • +
      +

      getOldestBacklogMessageSubscriptionName

      +
      String getOldestBacklogMessageSubscriptionName()
      +
      The subscription name containing oldest unacknowledged message as recorded in last backlog quota check. +

      + The name of the subscription containing the oldest unacknowledged message. This value is recorded every backlog + quota check interval, hence it represents the value seen in the last check. +

      +
      +
      • +
    • +
      +

      getOffloadedStorageSize

      +
      long getOffloadedStorageSize()
      +
      Space used to store the offloaded messages for the topic/.
      +
      +
      • +
    • +
      +

      getPublishers

      +
      List<? extends PublisherStats> getPublishers()
      +
      List of connected publishers on this topic w/ their stats.
      +
      +
      • +
    • +
      +

      getWaitingPublishers

      +
      int getWaitingPublishers()
      +
      +
      • +
    • +
      +

      getSubscriptions

      +
      Map<String,? extends SubscriptionStats> getSubscriptions()
      +
      Map of subscriptions with their individual statistics.
      +
      +
      • +
    • +
      +

      getReplication

      +
      Map<String,? extends ReplicatorStats> getReplication()
      +
      Map of replication statistics by remote cluster context.
      +
      +
      • +
    • +
      +

      getDeduplicationStatus

      +
      String getDeduplicationStatus()
      +
      +
      • +
    • +
      +

      getTopicEpoch

      +
      Long getTopicEpoch()
      +
      The topic epoch or empty if not set.
      +
      +
      • +
    • +
      +

      getNonContiguousDeletedMessagesRanges

      +
      int getNonContiguousDeletedMessagesRanges()
      +
      The number of non-contiguous deleted messages ranges.
      +
      +
      • +
    • +
      +

      getNonContiguousDeletedMessagesRangesSerializedSize

      +
      int getNonContiguousDeletedMessagesRangesSerializedSize()
      +
      The serialized size of non-contiguous deleted messages ranges.
      +
      +
      • +
    • +
      +

      getCompaction

      +
      CompactionStats getCompaction()
      +
      The compaction stats.
      +
      +
      • +
    • +
      +

      getOwnerBroker

      +
      String getOwnerBroker()
      +
      The broker that owns this topic.
      +
      +
      • +
    • +
      +

      getDelayedMessageIndexSizeInBytes

      +
      long getDelayedMessageIndexSizeInBytes()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/TopicType.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/TopicType.html new file mode 100644 index 000000000000..f48baed13398 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/TopicType.html @@ -0,0 +1,259 @@ + + + + +TopicType (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Enum Class TopicType

+
+
java.lang.Object +
java.lang.Enum<TopicType> +
org.apache.pulsar.common.policies.data.TopicType
+
+
+
+
+
All Implemented Interfaces:
+
Serializable, Comparable<TopicType>, Constable
+
+
+
public enum TopicType +extends Enum<TopicType>
+
Topic types -- partitioned or non-partitioned.
+
+
+ +
+
+
    + +
  • +
    +

    Enum Constant Details

    +
      +
    • +
      +

      PARTITIONED

      +
      public static final TopicType PARTITIONED
      +
      +
      • +
    • +
      +

      NON_PARTITIONED

      +
      public static final TopicType NON_PARTITIONED
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      values

      +
      public static TopicType[] values()
      +
      Returns an array containing the constants of this enum class, in +the order they are declared.
      +
      +
      Returns:
      +
      an array containing the constants of this enum class, in the order they are declared
      +
      +
      +
      • +
    • +
      +

      valueOf

      +
      public static TopicType valueOf(String name)
      +
      Returns the enum constant of this class with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this class. (Extraneous whitespace characters are +not permitted.)
      +
      +
      Parameters:
      +
      name - the name of the enum constant to be returned.
      +
      Returns:
      +
      the enum constant with the specified name
      +
      Throws:
      +
      IllegalArgumentException - if this enum class has no constant with the specified name
      +
      NullPointerException - if the argument is null
      +
      +
      +
      • +
    • +
      +

      toString

      +
      public String toString()
      +
      +
      Overrides:
      +
      toString in class Enum<TopicType>
      +
      +
      +
      • +
    • +
      +

      isValidTopicType

      +
      public static boolean isValidTopicType(String type)
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/TransactionBufferInternalStats.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/TransactionBufferInternalStats.html new file mode 100644 index 000000000000..0c268bca5c7f --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/TransactionBufferInternalStats.html @@ -0,0 +1,206 @@ + + + + +TransactionBufferInternalStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Class TransactionBufferInternalStats

+
+
java.lang.Object +
org.apache.pulsar.common.policies.data.TransactionBufferInternalStats
+
+
+
+
public class TransactionBufferInternalStats +extends Object
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    + +
    +
    • + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      TransactionBufferInternalStats

      +
      public TransactionBufferInternalStats()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/TransactionBufferStats.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/TransactionBufferStats.html new file mode 100644 index 000000000000..ca2e38a44732 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/TransactionBufferStats.html @@ -0,0 +1,275 @@ + + + + +TransactionBufferStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Class TransactionBufferStats

+
+
java.lang.Object +
org.apache.pulsar.common.policies.data.TransactionBufferStats
+
+
+
+
public class TransactionBufferStats +extends Object
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    +
      +
    • +
      +

      state

      +
      public String state
      +
      The state of this transaction buffer.
      +
      +
      • +
    • +
      +

      maxReadPosition

      +
      public String maxReadPosition
      +
      The max read position of this transaction buffer.
      +
      +
      • +
    • +
      +

      lastSnapshotTimestamps

      +
      public long lastSnapshotTimestamps
      +
      The last snapshot timestamps of this transaction buffer.
      +
      +
      • +
    • +
      +

      lowWaterMarks

      +
      public Map<Long,Long> lowWaterMarks
      +
      (Optional) The lowWaterMark details of the transaction buffer.
      +
      +
      • +
    • +
      +

      ongoingTxnSize

      +
      public long ongoingTxnSize
      +
      The total number of ongoing transactions in this transaction buffer.
      +
      +
      • +
    • +
      +

      recoverStartTime

      +
      public long recoverStartTime
      +
      +
      • +
    • +
      +

      recoverEndTime

      +
      public long recoverEndTime
      +
      +
      • +
    • +
      +

      totalAbortedTransactions

      +
      public long totalAbortedTransactions
      +
      +
      • +
    • +
      +

      snapshotType

      +
      public String snapshotType
      +
      +
      • +
    • +
      +

      segmentsStats

      +
      public SegmentsStats segmentsStats
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      TransactionBufferStats

      +
      public TransactionBufferStats()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/TransactionCoordinatorInfo.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/TransactionCoordinatorInfo.html new file mode 100644 index 000000000000..b8387e3db9f0 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/TransactionCoordinatorInfo.html @@ -0,0 +1,151 @@ + + + + +TransactionCoordinatorInfo (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Class TransactionCoordinatorInfo

+
+
java.lang.Object +
org.apache.pulsar.common.policies.data.TransactionCoordinatorInfo
+
+
+
+
public class TransactionCoordinatorInfo +extends Object
+
Transaction coordinator information.
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      TransactionCoordinatorInfo

      +
      public TransactionCoordinatorInfo()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/TransactionCoordinatorInternalStats.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/TransactionCoordinatorInternalStats.html new file mode 100644 index 000000000000..fe48deda77a0 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/TransactionCoordinatorInternalStats.html @@ -0,0 +1,183 @@ + + + + +TransactionCoordinatorInternalStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Class TransactionCoordinatorInternalStats

+
+
java.lang.Object +
org.apache.pulsar.common.policies.data.TransactionCoordinatorInternalStats
+
+
+
+
public class TransactionCoordinatorInternalStats +extends Object
+
Transaction coordinator internal stats.
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    +
      +
    • +
      +

      transactionLogStats

      +
      public TransactionLogStats transactionLogStats
      +
      The transaction coordinator log stats.
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      TransactionCoordinatorInternalStats

      +
      public TransactionCoordinatorInternalStats()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/TransactionCoordinatorStats.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/TransactionCoordinatorStats.html new file mode 100644 index 000000000000..a9d15e080d8a --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/TransactionCoordinatorStats.html @@ -0,0 +1,237 @@ + + + + +TransactionCoordinatorStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Class TransactionCoordinatorStats

+
+
java.lang.Object +
org.apache.pulsar.common.policies.data.TransactionCoordinatorStats
+
+
+
+
public class TransactionCoordinatorStats +extends Object
+
Transaction coordinator stats.
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    +
      +
    • +
      +

      state

      +
      public String state
      +
      The state of this transaction metadataStore.
      +
      +
      • +
    • +
      +

      leastSigBits

      +
      public long leastSigBits
      +
      The sequenceId of transaction metadataStore.
      +
      +
      • +
    • +
      +

      lowWaterMark

      +
      public long lowWaterMark
      +
      The low water mark of transaction metadataStore.
      +
      +
      • +
    • +
      +

      ongoingTxnSize

      +
      public long ongoingTxnSize
      +
      The total number of ongoing transactions in this transaction coordinator.
      +
      +
      • +
    • +
      +

      recoverStartTime

      +
      public long recoverStartTime
      +
      +
      • +
    • +
      +

      recoverEndTime

      +
      public long recoverEndTime
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      TransactionCoordinatorStats

      +
      public TransactionCoordinatorStats()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/TransactionCoordinatorStatus.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/TransactionCoordinatorStatus.html new file mode 100644 index 000000000000..4e73ec3191e5 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/TransactionCoordinatorStatus.html @@ -0,0 +1,207 @@ + + + + +TransactionCoordinatorStatus (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Class TransactionCoordinatorStatus

+
+
java.lang.Object +
org.apache.pulsar.common.policies.data.TransactionCoordinatorStatus
+
+
+
+
public class TransactionCoordinatorStatus +extends Object
+
Transaction coordinator status.
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    +
      +
    • +
      +

      state

      +
      public String state
      +
      The state of this transaction metadataStore.
      +
      +
      • +
    • +
      +

      leastSigBits

      +
      public long leastSigBits
      +
      The sequenceId of transaction metadataStore.
      +
      +
      • +
    • +
      +

      lowWaterMark

      +
      public long lowWaterMark
      +
      The low water mark of transaction metadataStore.
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      TransactionCoordinatorStatus

      +
      public TransactionCoordinatorStatus()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/TransactionInBufferStats.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/TransactionInBufferStats.html new file mode 100644 index 000000000000..99e961850aed --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/TransactionInBufferStats.html @@ -0,0 +1,194 @@ + + + + +TransactionInBufferStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Class TransactionInBufferStats

+
+
java.lang.Object +
org.apache.pulsar.common.policies.data.TransactionInBufferStats
+
+
+
+
public class TransactionInBufferStats +extends Object
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    +
      +
    • +
      +

      startPosition

      +
      public String startPosition
      +
      The start position of this transaction in transaction buffer.
      +
      +
      • +
    • +
      +

      aborted

      +
      public boolean aborted
      +
      The flag of this transaction have been aborted.
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      TransactionInBufferStats

      +
      public TransactionInBufferStats()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/TransactionInPendingAckStats.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/TransactionInPendingAckStats.html new file mode 100644 index 000000000000..689796d41830 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/TransactionInPendingAckStats.html @@ -0,0 +1,182 @@ + + + + +TransactionInPendingAckStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Class TransactionInPendingAckStats

+
+
java.lang.Object +
org.apache.pulsar.common.policies.data.TransactionInPendingAckStats
+
+
+
+
public class TransactionInPendingAckStats +extends Object
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    +
      +
    • +
      +

      cumulativeAckPosition

      +
      public String cumulativeAckPosition
      +
      The position of this transaction cumulative ack.
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      TransactionInPendingAckStats

      +
      public TransactionInPendingAckStats()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/TransactionLogStats.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/TransactionLogStats.html new file mode 100644 index 000000000000..398c4d2f2f7f --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/TransactionLogStats.html @@ -0,0 +1,195 @@ + + + + +TransactionLogStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Class TransactionLogStats

+
+
java.lang.Object +
org.apache.pulsar.common.policies.data.TransactionLogStats
+
+
+
+
public class TransactionLogStats +extends Object
+
Transaction log stats.
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    +
      +
    • +
      +

      managedLedgerName

      +
      public String managedLedgerName
      +
      The managed ledger name.
      +
      +
      • +
    • +
      +

      managedLedgerInternalStats

      +
      public ManagedLedgerInternalStats managedLedgerInternalStats
      +
      The manage ledger internal stats.
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      TransactionLogStats

      +
      public TransactionLogStats()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/TransactionMetadata.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/TransactionMetadata.html new file mode 100644 index 000000000000..6e9d2464c6b5 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/TransactionMetadata.html @@ -0,0 +1,254 @@ + + + + +TransactionMetadata (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Class TransactionMetadata

+
+
java.lang.Object +
org.apache.pulsar.common.policies.data.TransactionMetadata
+
+
+
+
public class TransactionMetadata +extends Object
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    +
      +
    • +
      +

      txnId

      +
      public String txnId
      +
      The txnId of this transaction.
      +
      +
      • +
    • +
      +

      status

      +
      public String status
      +
      The status of this transaction.
      +
      +
      • +
    • +
      +

      openTimestamp

      +
      public long openTimestamp
      +
      The open time of this transaction.
      +
      +
      • +
    • +
      +

      timeoutAt

      +
      public long timeoutAt
      +
      The timeout of this transaction.
      +
      +
      • +
    • +
      +

      producedPartitions

      +
      public Map<String,TransactionInBufferStats> producedPartitions
      +
      The producedPartitions of this transaction.
      +
      +
      • +
    • +
      +

      ackedPartitions

      +
      public Map<String,Map<String,TransactionInPendingAckStats>> ackedPartitions
      +
      The ackedPartitions of this transaction.
      +
      +
      • +
    • +
      +

      owner

      +
      public String owner
      +
      The owner of this transaction.
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      TransactionMetadata

      +
      public TransactionMetadata()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/TransactionPendingAckInternalStats.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/TransactionPendingAckInternalStats.html new file mode 100644 index 000000000000..a47b30c63ae2 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/TransactionPendingAckInternalStats.html @@ -0,0 +1,183 @@ + + + + +TransactionPendingAckInternalStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Class TransactionPendingAckInternalStats

+
+
java.lang.Object +
org.apache.pulsar.common.policies.data.TransactionPendingAckInternalStats
+
+
+
+
public class TransactionPendingAckInternalStats +extends Object
+
Transaction pending ack internal stats.
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    +
      +
    • +
      +

      pendingAckLogStats

      +
      public TransactionLogStats pendingAckLogStats
      +
      The transaction pending ack log stats.
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      TransactionPendingAckInternalStats

      +
      public TransactionPendingAckInternalStats()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/TransactionPendingAckStats.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/TransactionPendingAckStats.html new file mode 100644 index 000000000000..4db0a2f94f4d --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/TransactionPendingAckStats.html @@ -0,0 +1,224 @@ + + + + +TransactionPendingAckStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Class TransactionPendingAckStats

+
+
java.lang.Object +
org.apache.pulsar.common.policies.data.TransactionPendingAckStats
+
+
+
+
public class TransactionPendingAckStats +extends Object
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    +
      +
    • +
      +

      state

      +
      public String state
      +
      The state of this pending ack.
      +
      +
      • +
    • +
      +

      lowWaterMarks

      +
      public Map<Long,Long> lowWaterMarks
      +
      (Optional) The lowWaterMark details of the transaction pending ack.
      +
      +
      • +
    • +
      +

      ongoingTxnSize

      +
      public long ongoingTxnSize
      +
      The total number of ongoing transactions in this transaction pending ack.
      +
      +
      • +
    • +
      +

      recoverStartTime

      +
      public long recoverStartTime
      +
      +
      • +
    • +
      +

      recoverEndTime

      +
      public long recoverEndTime
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      TransactionPendingAckStats

      +
      public TransactionPendingAckStats()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/ValidateResult.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/ValidateResult.html new file mode 100644 index 000000000000..78b30fdc0e1d --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/ValidateResult.html @@ -0,0 +1,159 @@ + + + + +ValidateResult (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Class ValidateResult

+
+
java.lang.Object +
org.apache.pulsar.common.policies.data.ValidateResult
+
+
+
+
public class ValidateResult +extends Object
+
+
+ +
+
+ +
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/WorkerFunctionInstanceStats.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/WorkerFunctionInstanceStats.html new file mode 100644 index 000000000000..08ba703b1d35 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/WorkerFunctionInstanceStats.html @@ -0,0 +1,192 @@ + + + + +WorkerFunctionInstanceStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data
+

Class WorkerFunctionInstanceStats

+
+
java.lang.Object +
org.apache.pulsar.common.policies.data.WorkerFunctionInstanceStats
+
+
+
+
public class WorkerFunctionInstanceStats +extends Object
+
Data class holding statistics about a function.
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    + +
    +
    • + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      WorkerFunctionInstanceStats

      +
      public WorkerFunctionInstanceStats()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/AuthAction.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/AuthAction.html new file mode 100644 index 000000000000..d2d27c67530a --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/AuthAction.html @@ -0,0 +1,188 @@ + + + + +Uses of Enum Class org.apache.pulsar.common.policies.data.AuthAction (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Enum Class
org.apache.pulsar.common.policies.data.AuthAction

+
+
Packages that use AuthAction
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/AuthPolicies.Builder.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/AuthPolicies.Builder.html new file mode 100644 index 000000000000..b1a717b4a260 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/AuthPolicies.Builder.html @@ -0,0 +1,98 @@ + + + + +Uses of Interface org.apache.pulsar.common.policies.data.AuthPolicies.Builder (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.common.policies.data.AuthPolicies.Builder

+
+
Packages that use AuthPolicies.Builder
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/AuthPolicies.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/AuthPolicies.html new file mode 100644 index 000000000000..f2faf57251f2 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/AuthPolicies.html @@ -0,0 +1,98 @@ + + + + +Uses of Interface org.apache.pulsar.common.policies.data.AuthPolicies (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.common.policies.data.AuthPolicies

+
+
Packages that use AuthPolicies
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/AutoFailoverPolicyData.Builder.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/AutoFailoverPolicyData.Builder.html new file mode 100644 index 000000000000..22aa603daa1f --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/AutoFailoverPolicyData.Builder.html @@ -0,0 +1,95 @@ + + + + +Uses of Interface org.apache.pulsar.common.policies.data.AutoFailoverPolicyData.Builder (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.common.policies.data.AutoFailoverPolicyData.Builder

+
+
Packages that use AutoFailoverPolicyData.Builder
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/AutoFailoverPolicyData.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/AutoFailoverPolicyData.html new file mode 100644 index 000000000000..61f3f7aa6d40 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/AutoFailoverPolicyData.html @@ -0,0 +1,128 @@ + + + + +Uses of Interface org.apache.pulsar.common.policies.data.AutoFailoverPolicyData (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.common.policies.data.AutoFailoverPolicyData

+
+
Packages that use AutoFailoverPolicyData
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
org.apache.pulsar.common.policies.impl
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/AutoFailoverPolicyType.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/AutoFailoverPolicyType.html new file mode 100644 index 000000000000..13ac6ad78d0d --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/AutoFailoverPolicyType.html @@ -0,0 +1,112 @@ + + + + +Uses of Enum Class org.apache.pulsar.common.policies.data.AutoFailoverPolicyType (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Enum Class
org.apache.pulsar.common.policies.data.AutoFailoverPolicyType

+
+
Packages that use AutoFailoverPolicyType
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/AutoSubscriptionCreationOverride.Builder.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/AutoSubscriptionCreationOverride.Builder.html new file mode 100644 index 000000000000..016e9dcee784 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/AutoSubscriptionCreationOverride.Builder.html @@ -0,0 +1,108 @@ + + + + +Uses of Interface org.apache.pulsar.common.policies.data.AutoSubscriptionCreationOverride.Builder (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.common.policies.data.AutoSubscriptionCreationOverride.Builder

+
+
Packages that use AutoSubscriptionCreationOverride.Builder
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
org.apache.pulsar.common.policies.data.impl
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/AutoSubscriptionCreationOverride.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/AutoSubscriptionCreationOverride.html new file mode 100644 index 000000000000..43da9a517518 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/AutoSubscriptionCreationOverride.html @@ -0,0 +1,187 @@ + + + + +Uses of Interface org.apache.pulsar.common.policies.data.AutoSubscriptionCreationOverride (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.common.policies.data.AutoSubscriptionCreationOverride

+
+
Packages that use AutoSubscriptionCreationOverride
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
org.apache.pulsar.common.policies.data.impl
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/AutoTopicCreationOverride.Builder.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/AutoTopicCreationOverride.Builder.html new file mode 100644 index 000000000000..843451ed2079 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/AutoTopicCreationOverride.Builder.html @@ -0,0 +1,114 @@ + + + + +Uses of Interface org.apache.pulsar.common.policies.data.AutoTopicCreationOverride.Builder (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.common.policies.data.AutoTopicCreationOverride.Builder

+
+
Packages that use AutoTopicCreationOverride.Builder
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
org.apache.pulsar.common.policies.data.impl
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/AutoTopicCreationOverride.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/AutoTopicCreationOverride.html new file mode 100644 index 000000000000..bd7f8c19624f --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/AutoTopicCreationOverride.html @@ -0,0 +1,172 @@ + + + + +Uses of Interface org.apache.pulsar.common.policies.data.AutoTopicCreationOverride (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.common.policies.data.AutoTopicCreationOverride

+
+
Packages that use AutoTopicCreationOverride
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
org.apache.pulsar.common.policies.data.impl
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BacklogQuota.BacklogQuotaType.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BacklogQuota.BacklogQuotaType.html new file mode 100644 index 000000000000..f4b5c94cab26 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BacklogQuota.BacklogQuotaType.html @@ -0,0 +1,218 @@ + + + + +Uses of Enum Class org.apache.pulsar.common.policies.data.BacklogQuota.BacklogQuotaType (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Enum Class
org.apache.pulsar.common.policies.data.BacklogQuota.BacklogQuotaType

+
+
Packages that use BacklogQuota.BacklogQuotaType
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BacklogQuota.Builder.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BacklogQuota.Builder.html new file mode 100644 index 000000000000..6d52a22ebb83 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BacklogQuota.Builder.html @@ -0,0 +1,114 @@ + + + + +Uses of Interface org.apache.pulsar.common.policies.data.BacklogQuota.Builder (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.common.policies.data.BacklogQuota.Builder

+
+
Packages that use BacklogQuota.Builder
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
org.apache.pulsar.common.policies.data.impl
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BacklogQuota.RetentionPolicy.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BacklogQuota.RetentionPolicy.html new file mode 100644 index 000000000000..ec3fb7d31d88 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BacklogQuota.RetentionPolicy.html @@ -0,0 +1,148 @@ + + + + +Uses of Enum Class org.apache.pulsar.common.policies.data.BacklogQuota.RetentionPolicy (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Enum Class
org.apache.pulsar.common.policies.data.BacklogQuota.RetentionPolicy

+
+
Packages that use BacklogQuota.RetentionPolicy
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
org.apache.pulsar.common.policies.data.impl
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BacklogQuota.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BacklogQuota.html new file mode 100644 index 000000000000..6c3509045c2d --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BacklogQuota.html @@ -0,0 +1,220 @@ + + + + +Uses of Interface org.apache.pulsar.common.policies.data.BacklogQuota (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.common.policies.data.BacklogQuota

+
+
Packages that use BacklogQuota
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
org.apache.pulsar.common.policies.data.impl
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BookieAffinityGroupData.Builder.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BookieAffinityGroupData.Builder.html new file mode 100644 index 000000000000..3e463add9af4 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BookieAffinityGroupData.Builder.html @@ -0,0 +1,111 @@ + + + + +Uses of Interface org.apache.pulsar.common.policies.data.BookieAffinityGroupData.Builder (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.common.policies.data.BookieAffinityGroupData.Builder

+
+
Packages that use BookieAffinityGroupData.Builder
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
org.apache.pulsar.common.policies.data.impl
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BookieAffinityGroupData.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BookieAffinityGroupData.html new file mode 100644 index 000000000000..0fee0cd36782 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BookieAffinityGroupData.html @@ -0,0 +1,156 @@ + + + + +Uses of Interface org.apache.pulsar.common.policies.data.BookieAffinityGroupData (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.common.policies.data.BookieAffinityGroupData

+
+
Packages that use BookieAffinityGroupData
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
org.apache.pulsar.common.policies.data.impl
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BookieInfo.Builder.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BookieInfo.Builder.html new file mode 100644 index 000000000000..3ee585923865 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BookieInfo.Builder.html @@ -0,0 +1,111 @@ + + + + +Uses of Interface org.apache.pulsar.common.policies.data.BookieInfo.Builder (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.common.policies.data.BookieInfo.Builder

+
+
Packages that use BookieInfo.Builder
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
org.apache.pulsar.common.policies.data.impl
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BookieInfo.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BookieInfo.html new file mode 100644 index 000000000000..0b650939e3d3 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BookieInfo.html @@ -0,0 +1,176 @@ + + + + +Uses of Interface org.apache.pulsar.common.policies.data.BookieInfo (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.common.policies.data.BookieInfo

+
+
Packages that use BookieInfo
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
org.apache.pulsar.common.policies.data.impl
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BookiesClusterInfo.Builder.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BookiesClusterInfo.Builder.html new file mode 100644 index 000000000000..3055b0fa09c7 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BookiesClusterInfo.Builder.html @@ -0,0 +1,108 @@ + + + + +Uses of Interface org.apache.pulsar.common.policies.data.BookiesClusterInfo.Builder (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.common.policies.data.BookiesClusterInfo.Builder

+
+
Packages that use BookiesClusterInfo.Builder
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
org.apache.pulsar.common.policies.data.impl
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BookiesClusterInfo.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BookiesClusterInfo.html new file mode 100644 index 000000000000..9546925d0cb7 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BookiesClusterInfo.html @@ -0,0 +1,136 @@ + + + + +Uses of Interface org.apache.pulsar.common.policies.data.BookiesClusterInfo (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.common.policies.data.BookiesClusterInfo

+
+
Packages that use BookiesClusterInfo
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
org.apache.pulsar.common.policies.data.impl
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BookiesRackConfiguration.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BookiesRackConfiguration.html new file mode 100644 index 000000000000..e876c1959833 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BookiesRackConfiguration.html @@ -0,0 +1,100 @@ + + + + +Uses of Class org.apache.pulsar.common.policies.data.BookiesRackConfiguration (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.policies.data.BookiesRackConfiguration

+
+
Packages that use BookiesRackConfiguration
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BrokerAssignment.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BrokerAssignment.html new file mode 100644 index 000000000000..66609262b8da --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BrokerAssignment.html @@ -0,0 +1,117 @@ + + + + +Uses of Enum Class org.apache.pulsar.common.policies.data.BrokerAssignment (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Enum Class
org.apache.pulsar.common.policies.data.BrokerAssignment

+
+
Packages that use BrokerAssignment
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BrokerInfo.Builder.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BrokerInfo.Builder.html new file mode 100644 index 000000000000..09f0f90c6827 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BrokerInfo.Builder.html @@ -0,0 +1,111 @@ + + + + +Uses of Interface org.apache.pulsar.common.policies.data.BrokerInfo.Builder (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.common.policies.data.BrokerInfo.Builder

+
+
Packages that use BrokerInfo.Builder
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
org.apache.pulsar.common.policies.data.impl
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BrokerInfo.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BrokerInfo.html new file mode 100644 index 000000000000..652d6d6d82d4 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BrokerInfo.html @@ -0,0 +1,136 @@ + + + + +Uses of Interface org.apache.pulsar.common.policies.data.BrokerInfo (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.common.policies.data.BrokerInfo

+
+
Packages that use BrokerInfo
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
org.apache.pulsar.common.policies.data.impl
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BrokerNamespaceIsolationData.Builder.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BrokerNamespaceIsolationData.Builder.html new file mode 100644 index 000000000000..f3c4fa15e1f3 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BrokerNamespaceIsolationData.Builder.html @@ -0,0 +1,101 @@ + + + + +Uses of Interface org.apache.pulsar.common.policies.data.BrokerNamespaceIsolationData.Builder (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.common.policies.data.BrokerNamespaceIsolationData.Builder

+
+
Packages that use BrokerNamespaceIsolationData.Builder
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BrokerNamespaceIsolationData.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BrokerNamespaceIsolationData.html new file mode 100644 index 000000000000..b9ff2d18513f --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BrokerNamespaceIsolationData.html @@ -0,0 +1,130 @@ + + + + +Uses of Interface org.apache.pulsar.common.policies.data.BrokerNamespaceIsolationData (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.common.policies.data.BrokerNamespaceIsolationData

+
+
Packages that use BrokerNamespaceIsolationData
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BrokerStatus.Builder.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BrokerStatus.Builder.html new file mode 100644 index 000000000000..9fb634fd242d --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BrokerStatus.Builder.html @@ -0,0 +1,114 @@ + + + + +Uses of Interface org.apache.pulsar.common.policies.data.BrokerStatus.Builder (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.common.policies.data.BrokerStatus.Builder

+
+
Packages that use BrokerStatus.Builder
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
org.apache.pulsar.common.policies.data.impl
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BrokerStatus.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BrokerStatus.html new file mode 100644 index 000000000000..8d0950cbbcbd --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BrokerStatus.html @@ -0,0 +1,174 @@ + + + + +Uses of Interface org.apache.pulsar.common.policies.data.BrokerStatus (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.common.policies.data.BrokerStatus

+
+
Packages that use BrokerStatus
+
+
Package
+
Description
+
org.apache.pulsar.common.policies
+
+
Implementation of policies.
+
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
org.apache.pulsar.common.policies.data.impl
+
 
+
org.apache.pulsar.common.policies.impl
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BundlesData.Builder.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BundlesData.Builder.html new file mode 100644 index 000000000000..60178b38d0c0 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BundlesData.Builder.html @@ -0,0 +1,111 @@ + + + + +Uses of Interface org.apache.pulsar.common.policies.data.BundlesData.Builder (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.common.policies.data.BundlesData.Builder

+
+
Packages that use BundlesData.Builder
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
org.apache.pulsar.common.policies.data.impl
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BundlesData.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BundlesData.html new file mode 100644 index 000000000000..0acffc5748b4 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/BundlesData.html @@ -0,0 +1,163 @@ + + + + +Uses of Interface org.apache.pulsar.common.policies.data.BundlesData (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.common.policies.data.BundlesData

+
+
Packages that use BundlesData
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
org.apache.pulsar.common.policies.data.impl
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/ClusterData.Builder.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/ClusterData.Builder.html new file mode 100644 index 000000000000..c65cae8bf4cf --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/ClusterData.Builder.html @@ -0,0 +1,164 @@ + + + + +Uses of Interface org.apache.pulsar.common.policies.data.ClusterData.Builder (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.common.policies.data.ClusterData.Builder

+
+
Packages that use ClusterData.Builder
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/ClusterData.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/ClusterData.html new file mode 100644 index 000000000000..4f4532db081c --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/ClusterData.html @@ -0,0 +1,148 @@ + + + + +Uses of Interface org.apache.pulsar.common.policies.data.ClusterData (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.common.policies.data.ClusterData

+
+
Packages that use ClusterData
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/ClusterPolicies.Builder.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/ClusterPolicies.Builder.html new file mode 100644 index 000000000000..e939c258be9b --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/ClusterPolicies.Builder.html @@ -0,0 +1,98 @@ + + + + +Uses of Interface org.apache.pulsar.common.policies.data.ClusterPolicies.Builder (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.common.policies.data.ClusterPolicies.Builder

+
+
Packages that use ClusterPolicies.Builder
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/ClusterPolicies.ClusterUrl.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/ClusterPolicies.ClusterUrl.html new file mode 100644 index 000000000000..e4f18f856991 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/ClusterPolicies.ClusterUrl.html @@ -0,0 +1,125 @@ + + + + +Uses of Class org.apache.pulsar.common.policies.data.ClusterPolicies.ClusterUrl (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.policies.data.ClusterPolicies.ClusterUrl

+
+
Packages that use ClusterPolicies.ClusterUrl
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/ClusterPolicies.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/ClusterPolicies.html new file mode 100644 index 000000000000..b3e12ce165c7 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/ClusterPolicies.html @@ -0,0 +1,118 @@ + + + + +Uses of Interface org.apache.pulsar.common.policies.data.ClusterPolicies (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.common.policies.data.ClusterPolicies

+
+
Packages that use ClusterPolicies
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/CompactionStats.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/CompactionStats.html new file mode 100644 index 000000000000..d3104fd50ed6 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/CompactionStats.html @@ -0,0 +1,91 @@ + + + + +Uses of Interface org.apache.pulsar.common.policies.data.CompactionStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.common.policies.data.CompactionStats

+
+
Packages that use CompactionStats
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/ConsumerStats.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/ConsumerStats.html new file mode 100644 index 000000000000..71410a06f124 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/ConsumerStats.html @@ -0,0 +1,91 @@ + + + + +Uses of Interface org.apache.pulsar.common.policies.data.ConsumerStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.common.policies.data.ConsumerStats

+
+
Packages that use ConsumerStats
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/DelayedDeliveryPolicies.Builder.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/DelayedDeliveryPolicies.Builder.html new file mode 100644 index 000000000000..bd4f1b5b3f43 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/DelayedDeliveryPolicies.Builder.html @@ -0,0 +1,114 @@ + + + + +Uses of Interface org.apache.pulsar.common.policies.data.DelayedDeliveryPolicies.Builder (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.common.policies.data.DelayedDeliveryPolicies.Builder

+
+
Packages that use DelayedDeliveryPolicies.Builder
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
org.apache.pulsar.common.policies.data.impl
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/DelayedDeliveryPolicies.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/DelayedDeliveryPolicies.html new file mode 100644 index 000000000000..b118fdc32997 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/DelayedDeliveryPolicies.html @@ -0,0 +1,243 @@ + + + + +Uses of Interface org.apache.pulsar.common.policies.data.DelayedDeliveryPolicies (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.common.policies.data.DelayedDeliveryPolicies

+
+
Packages that use DelayedDeliveryPolicies
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
org.apache.pulsar.common.policies.data.impl
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/DispatchRate.Builder.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/DispatchRate.Builder.html new file mode 100644 index 000000000000..0c404828decc --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/DispatchRate.Builder.html @@ -0,0 +1,117 @@ + + + + +Uses of Interface org.apache.pulsar.common.policies.data.DispatchRate.Builder (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.common.policies.data.DispatchRate.Builder

+
+
Packages that use DispatchRate.Builder
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
org.apache.pulsar.common.policies.data.impl
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/DispatchRate.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/DispatchRate.html new file mode 100644 index 000000000000..e6221e0def4c --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/DispatchRate.html @@ -0,0 +1,478 @@ + + + + +Uses of Interface org.apache.pulsar.common.policies.data.DispatchRate (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.common.policies.data.DispatchRate

+
+
Packages that use DispatchRate
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
org.apache.pulsar.common.policies.data.impl
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/DrainingHash.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/DrainingHash.html new file mode 100644 index 000000000000..36a464571729 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/DrainingHash.html @@ -0,0 +1,92 @@ + + + + +Uses of Interface org.apache.pulsar.common.policies.data.DrainingHash (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.common.policies.data.DrainingHash

+
+
Packages that use DrainingHash
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/EntryFilters.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/EntryFilters.html new file mode 100644 index 000000000000..775101e85464 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/EntryFilters.html @@ -0,0 +1,160 @@ + + + + +Uses of Class org.apache.pulsar.common.policies.data.EntryFilters (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.policies.data.EntryFilters

+
+
Packages that use EntryFilters
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/ErrorData.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/ErrorData.html new file mode 100644 index 000000000000..c9d6112e7a62 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/ErrorData.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.common.policies.data.ErrorData (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.policies.data.ErrorData

+
+No usage of org.apache.pulsar.common.policies.data.ErrorData
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/ExceptionInformation.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/ExceptionInformation.html new file mode 100644 index 000000000000..13d6c549be29 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/ExceptionInformation.html @@ -0,0 +1,104 @@ + + + + +Uses of Class org.apache.pulsar.common.policies.data.ExceptionInformation (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.policies.data.ExceptionInformation

+
+
Packages that use ExceptionInformation
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/FailureDomain.Builder.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/FailureDomain.Builder.html new file mode 100644 index 000000000000..725f04f9f197 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/FailureDomain.Builder.html @@ -0,0 +1,92 @@ + + + + +Uses of Interface org.apache.pulsar.common.policies.data.FailureDomain.Builder (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.common.policies.data.FailureDomain.Builder

+
+
Packages that use FailureDomain.Builder
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/FailureDomain.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/FailureDomain.html new file mode 100644 index 000000000000..146d51c39461 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/FailureDomain.html @@ -0,0 +1,164 @@ + + + + +Uses of Interface org.apache.pulsar.common.policies.data.FailureDomain (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.common.policies.data.FailureDomain

+
+
Packages that use FailureDomain
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/FunctionInstanceStats.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/FunctionInstanceStats.html new file mode 100644 index 000000000000..78742bb15ae9 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/FunctionInstanceStats.html @@ -0,0 +1,89 @@ + + + + +Uses of Interface org.apache.pulsar.common.policies.data.FunctionInstanceStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.common.policies.data.FunctionInstanceStats

+
+
Packages that use FunctionInstanceStats
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/FunctionInstanceStatsData.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/FunctionInstanceStatsData.html new file mode 100644 index 000000000000..05ffe3e48791 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/FunctionInstanceStatsData.html @@ -0,0 +1,133 @@ + + + + +Uses of Interface org.apache.pulsar.common.policies.data.FunctionInstanceStatsData (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.common.policies.data.FunctionInstanceStatsData

+
+
Packages that use FunctionInstanceStatsData
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/FunctionInstanceStatsDataBase.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/FunctionInstanceStatsDataBase.html new file mode 100644 index 000000000000..249d91409f42 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/FunctionInstanceStatsDataBase.html @@ -0,0 +1,101 @@ + + + + +Uses of Interface org.apache.pulsar.common.policies.data.FunctionInstanceStatsDataBase (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.common.policies.data.FunctionInstanceStatsDataBase

+
+
Packages that use FunctionInstanceStatsDataBase
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/FunctionStats.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/FunctionStats.html new file mode 100644 index 000000000000..cdd662c44743 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/FunctionStats.html @@ -0,0 +1,122 @@ + + + + +Uses of Interface org.apache.pulsar.common.policies.data.FunctionStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.common.policies.data.FunctionStats

+
+
Packages that use FunctionStats
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/FunctionStatus.FunctionInstanceStatus.FunctionInstanceStatusData.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/FunctionStatus.FunctionInstanceStatus.FunctionInstanceStatusData.html new file mode 100644 index 000000000000..887381ea82ec --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/FunctionStatus.FunctionInstanceStatus.FunctionInstanceStatusData.html @@ -0,0 +1,124 @@ + + + + +Uses of Class org.apache.pulsar.common.policies.data.FunctionStatus.FunctionInstanceStatus.FunctionInstanceStatusData (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.policies.data.FunctionStatus.FunctionInstanceStatus.FunctionInstanceStatusData

+
+
Packages that use FunctionStatus.FunctionInstanceStatus.FunctionInstanceStatusData
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/FunctionStatus.FunctionInstanceStatus.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/FunctionStatus.FunctionInstanceStatus.html new file mode 100644 index 000000000000..69fc969ca209 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/FunctionStatus.FunctionInstanceStatus.html @@ -0,0 +1,98 @@ + + + + +Uses of Class org.apache.pulsar.common.policies.data.FunctionStatus.FunctionInstanceStatus (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.policies.data.FunctionStatus.FunctionInstanceStatus

+
+
Packages that use FunctionStatus.FunctionInstanceStatus
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/FunctionStatus.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/FunctionStatus.html new file mode 100644 index 000000000000..c1edd12f98fd --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/FunctionStatus.html @@ -0,0 +1,104 @@ + + + + +Uses of Class org.apache.pulsar.common.policies.data.FunctionStatus (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.policies.data.FunctionStatus

+
+
Packages that use FunctionStatus
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/InactiveTopicDeleteMode.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/InactiveTopicDeleteMode.html new file mode 100644 index 000000000000..0a54b927956f --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/InactiveTopicDeleteMode.html @@ -0,0 +1,97 @@ + + + + +Uses of Enum Class org.apache.pulsar.common.policies.data.InactiveTopicDeleteMode (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Enum Class
org.apache.pulsar.common.policies.data.InactiveTopicDeleteMode

+
+
Packages that use InactiveTopicDeleteMode
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/InactiveTopicPolicies.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/InactiveTopicPolicies.html new file mode 100644 index 000000000000..e16d85039bae --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/InactiveTopicPolicies.html @@ -0,0 +1,216 @@ + + + + +Uses of Class org.apache.pulsar.common.policies.data.InactiveTopicPolicies (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.policies.data.InactiveTopicPolicies

+
+
Packages that use InactiveTopicPolicies
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/ManagedLedgerInternalStats.CursorStats.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/ManagedLedgerInternalStats.CursorStats.html new file mode 100644 index 000000000000..dbbc060b0854 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/ManagedLedgerInternalStats.CursorStats.html @@ -0,0 +1,91 @@ + + + + +Uses of Class org.apache.pulsar.common.policies.data.ManagedLedgerInternalStats.CursorStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.policies.data.ManagedLedgerInternalStats.CursorStats

+
+
Packages that use ManagedLedgerInternalStats.CursorStats
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/ManagedLedgerInternalStats.LedgerInfo.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/ManagedLedgerInternalStats.LedgerInfo.html new file mode 100644 index 000000000000..27299c5de838 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/ManagedLedgerInternalStats.LedgerInfo.html @@ -0,0 +1,103 @@ + + + + +Uses of Class org.apache.pulsar.common.policies.data.ManagedLedgerInternalStats.LedgerInfo (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.policies.data.ManagedLedgerInternalStats.LedgerInfo

+
+
Packages that use ManagedLedgerInternalStats.LedgerInfo
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/ManagedLedgerInternalStats.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/ManagedLedgerInternalStats.html new file mode 100644 index 000000000000..cf3010cc59ca --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/ManagedLedgerInternalStats.html @@ -0,0 +1,105 @@ + + + + +Uses of Class org.apache.pulsar.common.policies.data.ManagedLedgerInternalStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.policies.data.ManagedLedgerInternalStats

+
+
Packages that use ManagedLedgerInternalStats
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/NamespaceIsolationData.Builder.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/NamespaceIsolationData.Builder.html new file mode 100644 index 000000000000..4f04f2e0169e --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/NamespaceIsolationData.Builder.html @@ -0,0 +1,104 @@ + + + + +Uses of Interface org.apache.pulsar.common.policies.data.NamespaceIsolationData.Builder (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.common.policies.data.NamespaceIsolationData.Builder

+
+
Packages that use NamespaceIsolationData.Builder
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/NamespaceIsolationData.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/NamespaceIsolationData.html new file mode 100644 index 000000000000..ba251572d16e --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/NamespaceIsolationData.html @@ -0,0 +1,164 @@ + + + + +Uses of Interface org.apache.pulsar.common.policies.data.NamespaceIsolationData (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.common.policies.data.NamespaceIsolationData

+
+
Packages that use NamespaceIsolationData
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/NamespaceIsolationPolicyUnloadScope.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/NamespaceIsolationPolicyUnloadScope.html new file mode 100644 index 000000000000..fae5411d5929 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/NamespaceIsolationPolicyUnloadScope.html @@ -0,0 +1,112 @@ + + + + +Uses of Enum Class org.apache.pulsar.common.policies.data.NamespaceIsolationPolicyUnloadScope (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Enum Class
org.apache.pulsar.common.policies.data.NamespaceIsolationPolicyUnloadScope

+
+
Packages that use NamespaceIsolationPolicyUnloadScope
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/NamespaceOwnershipStatus.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/NamespaceOwnershipStatus.html new file mode 100644 index 000000000000..2247ddf38ba1 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/NamespaceOwnershipStatus.html @@ -0,0 +1,96 @@ + + + + +Uses of Class org.apache.pulsar.common.policies.data.NamespaceOwnershipStatus (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.policies.data.NamespaceOwnershipStatus

+
+
Packages that use NamespaceOwnershipStatus
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/NonPersistentPartitionedTopicStats.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/NonPersistentPartitionedTopicStats.html new file mode 100644 index 000000000000..8dd00851b068 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/NonPersistentPartitionedTopicStats.html @@ -0,0 +1,62 @@ + + + + +Uses of Interface org.apache.pulsar.common.policies.data.NonPersistentPartitionedTopicStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.common.policies.data.NonPersistentPartitionedTopicStats

+
+No usage of org.apache.pulsar.common.policies.data.NonPersistentPartitionedTopicStats
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/NonPersistentPublisherStats.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/NonPersistentPublisherStats.html new file mode 100644 index 000000000000..6c1732379ab1 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/NonPersistentPublisherStats.html @@ -0,0 +1,91 @@ + + + + +Uses of Interface org.apache.pulsar.common.policies.data.NonPersistentPublisherStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.common.policies.data.NonPersistentPublisherStats

+
+
Packages that use NonPersistentPublisherStats
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/NonPersistentReplicatorStats.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/NonPersistentReplicatorStats.html new file mode 100644 index 000000000000..c9e6286c76d2 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/NonPersistentReplicatorStats.html @@ -0,0 +1,91 @@ + + + + +Uses of Interface org.apache.pulsar.common.policies.data.NonPersistentReplicatorStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.common.policies.data.NonPersistentReplicatorStats

+
+
Packages that use NonPersistentReplicatorStats
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/NonPersistentSubscriptionStats.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/NonPersistentSubscriptionStats.html new file mode 100644 index 000000000000..acdee8a1a4cc --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/NonPersistentSubscriptionStats.html @@ -0,0 +1,91 @@ + + + + +Uses of Interface org.apache.pulsar.common.policies.data.NonPersistentSubscriptionStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.common.policies.data.NonPersistentSubscriptionStats

+
+
Packages that use NonPersistentSubscriptionStats
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/NonPersistentTopicStats.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/NonPersistentTopicStats.html new file mode 100644 index 000000000000..a04f2c9a86d6 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/NonPersistentTopicStats.html @@ -0,0 +1,138 @@ + + + + +Uses of Interface org.apache.pulsar.common.policies.data.NonPersistentTopicStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.common.policies.data.NonPersistentTopicStats

+
+
Packages that use NonPersistentTopicStats
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/OffloadPolicies.Builder.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/OffloadPolicies.Builder.html new file mode 100644 index 000000000000..2d49b99f0cc4 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/OffloadPolicies.Builder.html @@ -0,0 +1,176 @@ + + + + +Uses of Interface org.apache.pulsar.common.policies.data.OffloadPolicies.Builder (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.common.policies.data.OffloadPolicies.Builder

+
+
Packages that use OffloadPolicies.Builder
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/OffloadPolicies.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/OffloadPolicies.html new file mode 100644 index 000000000000..7b78a2191cd3 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/OffloadPolicies.html @@ -0,0 +1,225 @@ + + + + +Uses of Interface org.apache.pulsar.common.policies.data.OffloadPolicies (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.common.policies.data.OffloadPolicies

+
+
Packages that use OffloadPolicies
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/OffloadedReadPriority.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/OffloadedReadPriority.html new file mode 100644 index 000000000000..98034ef4245a --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/OffloadedReadPriority.html @@ -0,0 +1,112 @@ + + + + +Uses of Enum Class org.apache.pulsar.common.policies.data.OffloadedReadPriority (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Enum Class
org.apache.pulsar.common.policies.data.OffloadedReadPriority

+
+
Packages that use OffloadedReadPriority
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/PartitionedTopicInternalStats.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/PartitionedTopicInternalStats.html new file mode 100644 index 000000000000..463b6afbdcd8 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/PartitionedTopicInternalStats.html @@ -0,0 +1,100 @@ + + + + +Uses of Class org.apache.pulsar.common.policies.data.PartitionedTopicInternalStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.policies.data.PartitionedTopicInternalStats

+
+
Packages that use PartitionedTopicInternalStats
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/PartitionedTopicStats.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/PartitionedTopicStats.html new file mode 100644 index 000000000000..3dfa0d5e9bf2 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/PartitionedTopicStats.html @@ -0,0 +1,146 @@ + + + + +Uses of Interface org.apache.pulsar.common.policies.data.PartitionedTopicStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.common.policies.data.PartitionedTopicStats

+
+
Packages that use PartitionedTopicStats
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/PersistencePolicies.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/PersistencePolicies.html new file mode 100644 index 000000000000..db995d3b5a2d --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/PersistencePolicies.html @@ -0,0 +1,216 @@ + + + + +Uses of Class org.apache.pulsar.common.policies.data.PersistencePolicies (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.policies.data.PersistencePolicies

+
+
Packages that use PersistencePolicies
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/PersistentTopicInternalStats.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/PersistentTopicInternalStats.html new file mode 100644 index 000000000000..97e88f566fe6 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/PersistentTopicInternalStats.html @@ -0,0 +1,142 @@ + + + + +Uses of Class org.apache.pulsar.common.policies.data.PersistentTopicInternalStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.policies.data.PersistentTopicInternalStats

+
+
Packages that use PersistentTopicInternalStats
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/Policies.BundleType.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/Policies.BundleType.html new file mode 100644 index 000000000000..2105a64231d5 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/Policies.BundleType.html @@ -0,0 +1,97 @@ + + + + +Uses of Enum Class org.apache.pulsar.common.policies.data.Policies.BundleType (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Enum Class
org.apache.pulsar.common.policies.data.Policies.BundleType

+
+
Packages that use Policies.BundleType
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/Policies.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/Policies.html new file mode 100644 index 000000000000..7128c0ab96b7 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/Policies.html @@ -0,0 +1,118 @@ + + + + +Uses of Class org.apache.pulsar.common.policies.data.Policies (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.policies.data.Policies

+
+
Packages that use Policies
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/PublishRate.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/PublishRate.html new file mode 100644 index 000000000000..d543a65c6d2a --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/PublishRate.html @@ -0,0 +1,206 @@ + + + + +Uses of Class org.apache.pulsar.common.policies.data.PublishRate (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.policies.data.PublishRate

+
+
Packages that use PublishRate
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/PublisherStats.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/PublisherStats.html new file mode 100644 index 000000000000..682a2840a1cf --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/PublisherStats.html @@ -0,0 +1,102 @@ + + + + +Uses of Interface org.apache.pulsar.common.policies.data.PublisherStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.common.policies.data.PublisherStats

+
+
Packages that use PublisherStats
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/RawBookieInfo.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/RawBookieInfo.html new file mode 100644 index 000000000000..f97a60476ade --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/RawBookieInfo.html @@ -0,0 +1,114 @@ + + + + +Uses of Class org.apache.pulsar.common.policies.data.RawBookieInfo (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.policies.data.RawBookieInfo

+
+
Packages that use RawBookieInfo
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
org.apache.pulsar.common.policies.data.impl
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/ReplicatorStats.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/ReplicatorStats.html new file mode 100644 index 000000000000..db60931a6296 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/ReplicatorStats.html @@ -0,0 +1,102 @@ + + + + +Uses of Interface org.apache.pulsar.common.policies.data.ReplicatorStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.common.policies.data.ReplicatorStats

+
+
Packages that use ReplicatorStats
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/ResourceGroup.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/ResourceGroup.html new file mode 100644 index 000000000000..a8b8a385695f --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/ResourceGroup.html @@ -0,0 +1,130 @@ + + + + +Uses of Class org.apache.pulsar.common.policies.data.ResourceGroup (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.policies.data.ResourceGroup

+
+
Packages that use ResourceGroup
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/ResourceQuota.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/ResourceQuota.html new file mode 100644 index 000000000000..4669aef717ab --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/ResourceQuota.html @@ -0,0 +1,167 @@ + + + + +Uses of Class org.apache.pulsar.common.policies.data.ResourceQuota (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.policies.data.ResourceQuota

+
+
Packages that use ResourceQuota
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/RetentionPolicies.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/RetentionPolicies.html new file mode 100644 index 000000000000..d38ee93c7863 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/RetentionPolicies.html @@ -0,0 +1,216 @@ + + + + +Uses of Class org.apache.pulsar.common.policies.data.RetentionPolicies (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.policies.data.RetentionPolicies

+
+
Packages that use RetentionPolicies
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/SchemaAutoUpdateCompatibilityStrategy.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/SchemaAutoUpdateCompatibilityStrategy.html new file mode 100644 index 000000000000..8b219c70f6e7 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/SchemaAutoUpdateCompatibilityStrategy.html @@ -0,0 +1,147 @@ + + + + +Uses of Enum Class org.apache.pulsar.common.policies.data.SchemaAutoUpdateCompatibilityStrategy (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Enum Class
org.apache.pulsar.common.policies.data.SchemaAutoUpdateCompatibilityStrategy

+
+
Packages that use SchemaAutoUpdateCompatibilityStrategy
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/SchemaCompatibilityStrategy.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/SchemaCompatibilityStrategy.html new file mode 100644 index 000000000000..6e70315cb7cd --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/SchemaCompatibilityStrategy.html @@ -0,0 +1,193 @@ + + + + +Uses of Enum Class org.apache.pulsar.common.policies.data.SchemaCompatibilityStrategy (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Enum Class
org.apache.pulsar.common.policies.data.SchemaCompatibilityStrategy

+
+
Packages that use SchemaCompatibilityStrategy
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/SchemaMetadata.Entry.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/SchemaMetadata.Entry.html new file mode 100644 index 000000000000..f61ce8f79cb8 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/SchemaMetadata.Entry.html @@ -0,0 +1,98 @@ + + + + +Uses of Class org.apache.pulsar.common.policies.data.SchemaMetadata.Entry (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.policies.data.SchemaMetadata.Entry

+
+
Packages that use SchemaMetadata.Entry
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/SchemaMetadata.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/SchemaMetadata.html new file mode 100644 index 000000000000..6758abc00e6a --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/SchemaMetadata.html @@ -0,0 +1,100 @@ + + + + +Uses of Class org.apache.pulsar.common.policies.data.SchemaMetadata (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.policies.data.SchemaMetadata

+
+
Packages that use SchemaMetadata
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/SegmentStats.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/SegmentStats.html new file mode 100644 index 000000000000..0458ef61f886 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/SegmentStats.html @@ -0,0 +1,89 @@ + + + + +Uses of Class org.apache.pulsar.common.policies.data.SegmentStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.policies.data.SegmentStats

+
+
Packages that use SegmentStats
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/SegmentsStats.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/SegmentsStats.html new file mode 100644 index 000000000000..bd3f5dbf6cb4 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/SegmentsStats.html @@ -0,0 +1,89 @@ + + + + +Uses of Class org.apache.pulsar.common.policies.data.SegmentsStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.policies.data.SegmentsStats

+
+
Packages that use SegmentsStats
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/SinkStatus.SinkInstanceStatus.SinkInstanceStatusData.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/SinkStatus.SinkInstanceStatus.SinkInstanceStatusData.html new file mode 100644 index 000000000000..3fa542c86f53 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/SinkStatus.SinkInstanceStatus.SinkInstanceStatusData.html @@ -0,0 +1,124 @@ + + + + +Uses of Class org.apache.pulsar.common.policies.data.SinkStatus.SinkInstanceStatus.SinkInstanceStatusData (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.policies.data.SinkStatus.SinkInstanceStatus.SinkInstanceStatusData

+
+
Packages that use SinkStatus.SinkInstanceStatus.SinkInstanceStatusData
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/SinkStatus.SinkInstanceStatus.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/SinkStatus.SinkInstanceStatus.html new file mode 100644 index 000000000000..5974dd27b3e9 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/SinkStatus.SinkInstanceStatus.html @@ -0,0 +1,98 @@ + + + + +Uses of Class org.apache.pulsar.common.policies.data.SinkStatus.SinkInstanceStatus (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.policies.data.SinkStatus.SinkInstanceStatus

+
+
Packages that use SinkStatus.SinkInstanceStatus
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/SinkStatus.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/SinkStatus.html new file mode 100644 index 000000000000..e945e3e6d823 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/SinkStatus.html @@ -0,0 +1,104 @@ + + + + +Uses of Class org.apache.pulsar.common.policies.data.SinkStatus (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.policies.data.SinkStatus

+
+
Packages that use SinkStatus
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/SnapshotSystemTopicInternalStats.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/SnapshotSystemTopicInternalStats.html new file mode 100644 index 000000000000..7eb25651df23 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/SnapshotSystemTopicInternalStats.html @@ -0,0 +1,95 @@ + + + + +Uses of Class org.apache.pulsar.common.policies.data.SnapshotSystemTopicInternalStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.policies.data.SnapshotSystemTopicInternalStats

+
+
Packages that use SnapshotSystemTopicInternalStats
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/SourceStatus.SourceInstanceStatus.SourceInstanceStatusData.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/SourceStatus.SourceInstanceStatus.SourceInstanceStatusData.html new file mode 100644 index 000000000000..c1d29f161c6a --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/SourceStatus.SourceInstanceStatus.SourceInstanceStatusData.html @@ -0,0 +1,124 @@ + + + + +Uses of Class org.apache.pulsar.common.policies.data.SourceStatus.SourceInstanceStatus.SourceInstanceStatusData (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.policies.data.SourceStatus.SourceInstanceStatus.SourceInstanceStatusData

+
+
Packages that use SourceStatus.SourceInstanceStatus.SourceInstanceStatusData
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/SourceStatus.SourceInstanceStatus.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/SourceStatus.SourceInstanceStatus.html new file mode 100644 index 000000000000..77e001369141 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/SourceStatus.SourceInstanceStatus.html @@ -0,0 +1,98 @@ + + + + +Uses of Class org.apache.pulsar.common.policies.data.SourceStatus.SourceInstanceStatus (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.policies.data.SourceStatus.SourceInstanceStatus

+
+
Packages that use SourceStatus.SourceInstanceStatus
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/SourceStatus.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/SourceStatus.html new file mode 100644 index 000000000000..99f44cb0e5bf --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/SourceStatus.html @@ -0,0 +1,104 @@ + + + + +Uses of Class org.apache.pulsar.common.policies.data.SourceStatus (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.policies.data.SourceStatus

+
+
Packages that use SourceStatus
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/SubscribeRate.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/SubscribeRate.html new file mode 100644 index 000000000000..81abc4243908 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/SubscribeRate.html @@ -0,0 +1,234 @@ + + + + +Uses of Class org.apache.pulsar.common.policies.data.SubscribeRate (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.policies.data.SubscribeRate

+
+
Packages that use SubscribeRate
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/SubscriptionAuthMode.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/SubscriptionAuthMode.html new file mode 100644 index 000000000000..2bdc90732b43 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/SubscriptionAuthMode.html @@ -0,0 +1,153 @@ + + + + +Uses of Enum Class org.apache.pulsar.common.policies.data.SubscriptionAuthMode (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Enum Class
org.apache.pulsar.common.policies.data.SubscriptionAuthMode

+
+
Packages that use SubscriptionAuthMode
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/SubscriptionStats.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/SubscriptionStats.html new file mode 100644 index 000000000000..e59a6ca80317 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/SubscriptionStats.html @@ -0,0 +1,102 @@ + + + + +Uses of Interface org.apache.pulsar.common.policies.data.SubscriptionStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.common.policies.data.SubscriptionStats

+
+
Packages that use SubscriptionStats
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/TenantInfo.Builder.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/TenantInfo.Builder.html new file mode 100644 index 000000000000..21b93a2392d8 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/TenantInfo.Builder.html @@ -0,0 +1,95 @@ + + + + +Uses of Interface org.apache.pulsar.common.policies.data.TenantInfo.Builder (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.common.policies.data.TenantInfo.Builder

+
+
Packages that use TenantInfo.Builder
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/TenantInfo.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/TenantInfo.html new file mode 100644 index 000000000000..e814fe827655 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/TenantInfo.html @@ -0,0 +1,168 @@ + + + + +Uses of Interface org.apache.pulsar.common.policies.data.TenantInfo (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.common.policies.data.TenantInfo

+
+
Packages that use TenantInfo
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/TopicHashPositions.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/TopicHashPositions.html new file mode 100644 index 000000000000..fee6017c34e6 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/TopicHashPositions.html @@ -0,0 +1,104 @@ + + + + +Uses of Class org.apache.pulsar.common.policies.data.TopicHashPositions (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.policies.data.TopicHashPositions

+
+
Packages that use TopicHashPositions
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/TopicStats.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/TopicStats.html new file mode 100644 index 000000000000..917eb2462669 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/TopicStats.html @@ -0,0 +1,186 @@ + + + + +Uses of Interface org.apache.pulsar.common.policies.data.TopicStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.common.policies.data.TopicStats

+
+
Packages that use TopicStats
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/TopicType.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/TopicType.html new file mode 100644 index 000000000000..efee233b87a6 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/TopicType.html @@ -0,0 +1,97 @@ + + + + +Uses of Enum Class org.apache.pulsar.common.policies.data.TopicType (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Enum Class
org.apache.pulsar.common.policies.data.TopicType

+
+
Packages that use TopicType
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/TransactionBufferInternalStats.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/TransactionBufferInternalStats.html new file mode 100644 index 000000000000..d5fc921592e4 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/TransactionBufferInternalStats.html @@ -0,0 +1,102 @@ + + + + +Uses of Class org.apache.pulsar.common.policies.data.TransactionBufferInternalStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.policies.data.TransactionBufferInternalStats

+
+
Packages that use TransactionBufferInternalStats
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/TransactionBufferStats.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/TransactionBufferStats.html new file mode 100644 index 000000000000..5c680abd011c --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/TransactionBufferStats.html @@ -0,0 +1,126 @@ + + + + +Uses of Class org.apache.pulsar.common.policies.data.TransactionBufferStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.policies.data.TransactionBufferStats

+
+
Packages that use TransactionBufferStats
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/TransactionCoordinatorInfo.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/TransactionCoordinatorInfo.html new file mode 100644 index 000000000000..c7371ac65c35 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/TransactionCoordinatorInfo.html @@ -0,0 +1,94 @@ + + + + +Uses of Class org.apache.pulsar.common.policies.data.TransactionCoordinatorInfo (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.policies.data.TransactionCoordinatorInfo

+
+
Packages that use TransactionCoordinatorInfo
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/TransactionCoordinatorInternalStats.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/TransactionCoordinatorInternalStats.html new file mode 100644 index 000000000000..d4835dc69704 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/TransactionCoordinatorInternalStats.html @@ -0,0 +1,102 @@ + + + + +Uses of Class org.apache.pulsar.common.policies.data.TransactionCoordinatorInternalStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.policies.data.TransactionCoordinatorInternalStats

+
+
Packages that use TransactionCoordinatorInternalStats
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/TransactionCoordinatorStats.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/TransactionCoordinatorStats.html new file mode 100644 index 000000000000..d906a056207e --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/TransactionCoordinatorStats.html @@ -0,0 +1,110 @@ + + + + +Uses of Class org.apache.pulsar.common.policies.data.TransactionCoordinatorStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.policies.data.TransactionCoordinatorStats

+
+
Packages that use TransactionCoordinatorStats
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/TransactionCoordinatorStatus.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/TransactionCoordinatorStatus.html new file mode 100644 index 000000000000..931474c4f639 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/TransactionCoordinatorStatus.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.common.policies.data.TransactionCoordinatorStatus (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.policies.data.TransactionCoordinatorStatus

+
+No usage of org.apache.pulsar.common.policies.data.TransactionCoordinatorStatus
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/TransactionInBufferStats.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/TransactionInBufferStats.html new file mode 100644 index 000000000000..8cb355997e91 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/TransactionInBufferStats.html @@ -0,0 +1,122 @@ + + + + +Uses of Class org.apache.pulsar.common.policies.data.TransactionInBufferStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.policies.data.TransactionInBufferStats

+
+
Packages that use TransactionInBufferStats
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/TransactionInPendingAckStats.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/TransactionInPendingAckStats.html new file mode 100644 index 000000000000..901652054c75 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/TransactionInPendingAckStats.html @@ -0,0 +1,124 @@ + + + + +Uses of Class org.apache.pulsar.common.policies.data.TransactionInPendingAckStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.policies.data.TransactionInPendingAckStats

+
+
Packages that use TransactionInPendingAckStats
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/TransactionLogStats.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/TransactionLogStats.html new file mode 100644 index 000000000000..ca0be71401bc --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/TransactionLogStats.html @@ -0,0 +1,96 @@ + + + + +Uses of Class org.apache.pulsar.common.policies.data.TransactionLogStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.policies.data.TransactionLogStats

+
+
Packages that use TransactionLogStats
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/TransactionMetadata.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/TransactionMetadata.html new file mode 100644 index 000000000000..89faf26e89fa --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/TransactionMetadata.html @@ -0,0 +1,126 @@ + + + + +Uses of Class org.apache.pulsar.common.policies.data.TransactionMetadata (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.policies.data.TransactionMetadata

+
+
Packages that use TransactionMetadata
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/TransactionPendingAckInternalStats.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/TransactionPendingAckInternalStats.html new file mode 100644 index 000000000000..b1a12cd52376 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/TransactionPendingAckInternalStats.html @@ -0,0 +1,104 @@ + + + + +Uses of Class org.apache.pulsar.common.policies.data.TransactionPendingAckInternalStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.policies.data.TransactionPendingAckInternalStats

+
+
Packages that use TransactionPendingAckInternalStats
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/TransactionPendingAckStats.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/TransactionPendingAckStats.html new file mode 100644 index 000000000000..bb5b754712bf --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/TransactionPendingAckStats.html @@ -0,0 +1,116 @@ + + + + +Uses of Class org.apache.pulsar.common.policies.data.TransactionPendingAckStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.policies.data.TransactionPendingAckStats

+
+
Packages that use TransactionPendingAckStats
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/ValidateResult.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/ValidateResult.html new file mode 100644 index 000000000000..7e93e52fd84b --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/ValidateResult.html @@ -0,0 +1,108 @@ + + + + +Uses of Class org.apache.pulsar.common.policies.data.ValidateResult (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.policies.data.ValidateResult

+
+
Packages that use ValidateResult
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
org.apache.pulsar.common.policies.data.impl
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/WorkerFunctionInstanceStats.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/WorkerFunctionInstanceStats.html new file mode 100644 index 000000000000..f3607e9502ea --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/class-use/WorkerFunctionInstanceStats.html @@ -0,0 +1,94 @@ + + + + +Uses of Class org.apache.pulsar.common.policies.data.WorkerFunctionInstanceStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.policies.data.WorkerFunctionInstanceStats

+
+
Packages that use WorkerFunctionInstanceStats
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/AutoSubscriptionCreationOverrideImpl.AutoSubscriptionCreationOverrideImplBuilder.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/AutoSubscriptionCreationOverrideImpl.AutoSubscriptionCreationOverrideImplBuilder.html new file mode 100644 index 000000000000..dcf0dffeacc0 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/AutoSubscriptionCreationOverrideImpl.AutoSubscriptionCreationOverrideImplBuilder.html @@ -0,0 +1,203 @@ + + + + +AutoSubscriptionCreationOverrideImpl.AutoSubscriptionCreationOverrideImplBuilder (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data.impl
+

Class AutoSubscriptionCreationOverrideImpl.AutoSubscriptionCreationOverrideImplBuilder

+
+
java.lang.Object +
org.apache.pulsar.common.policies.data.impl.AutoSubscriptionCreationOverrideImpl.AutoSubscriptionCreationOverrideImplBuilder
+
+
+
+
All Implemented Interfaces:
+
AutoSubscriptionCreationOverride.Builder
+
+
+
Enclosing class:
+
AutoSubscriptionCreationOverrideImpl
+
+
+
public static class AutoSubscriptionCreationOverrideImpl.AutoSubscriptionCreationOverrideImplBuilder +extends Object +implements AutoSubscriptionCreationOverride.Builder
+
+
+ +
+
+ +
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/AutoSubscriptionCreationOverrideImpl.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/AutoSubscriptionCreationOverrideImpl.html new file mode 100644 index 000000000000..e6e984de1e9c --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/AutoSubscriptionCreationOverrideImpl.html @@ -0,0 +1,204 @@ + + + + +AutoSubscriptionCreationOverrideImpl (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data.impl
+

Class AutoSubscriptionCreationOverrideImpl

+
+
java.lang.Object +
org.apache.pulsar.common.policies.data.impl.AutoSubscriptionCreationOverrideImpl
+
+
+
+
All Implemented Interfaces:
+
AutoSubscriptionCreationOverride
+
+
+
public class AutoSubscriptionCreationOverrideImpl +extends Object +implements AutoSubscriptionCreationOverride
+
Override of autoSubscriptionCreation settings on a topic or namespace level.
+
+
+ +
+
+ +
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/AutoTopicCreationOverrideImpl.AutoTopicCreationOverrideImplBuilder.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/AutoTopicCreationOverrideImpl.AutoTopicCreationOverrideImplBuilder.html new file mode 100644 index 000000000000..cc95a3f1637b --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/AutoTopicCreationOverrideImpl.AutoTopicCreationOverrideImplBuilder.html @@ -0,0 +1,229 @@ + + + + +AutoTopicCreationOverrideImpl.AutoTopicCreationOverrideImplBuilder (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data.impl
+

Class AutoTopicCreationOverrideImpl.AutoTopicCreationOverrideImplBuilder

+
+
java.lang.Object +
org.apache.pulsar.common.policies.data.impl.AutoTopicCreationOverrideImpl.AutoTopicCreationOverrideImplBuilder
+
+
+
+
All Implemented Interfaces:
+
AutoTopicCreationOverride.Builder
+
+
+
Enclosing class:
+
AutoTopicCreationOverrideImpl
+
+
+
public static class AutoTopicCreationOverrideImpl.AutoTopicCreationOverrideImplBuilder +extends Object +implements AutoTopicCreationOverride.Builder
+
+
+ +
+
+ +
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/AutoTopicCreationOverrideImpl.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/AutoTopicCreationOverrideImpl.html new file mode 100644 index 000000000000..88c9ee7e7d05 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/AutoTopicCreationOverrideImpl.html @@ -0,0 +1,213 @@ + + + + +AutoTopicCreationOverrideImpl (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data.impl
+

Class AutoTopicCreationOverrideImpl

+
+
java.lang.Object +
org.apache.pulsar.common.policies.data.impl.AutoTopicCreationOverrideImpl
+
+
+
+
All Implemented Interfaces:
+
AutoTopicCreationOverride
+
+
+
public final class AutoTopicCreationOverrideImpl +extends Object +implements AutoTopicCreationOverride
+
Override of autoTopicCreation settings on a namespace level.
+
+
+ +
+
+ +
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/BacklogQuotaImpl.BacklogQuotaImplBuilder.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/BacklogQuotaImpl.BacklogQuotaImplBuilder.html new file mode 100644 index 000000000000..066442b5cd8f --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/BacklogQuotaImpl.BacklogQuotaImplBuilder.html @@ -0,0 +1,229 @@ + + + + +BacklogQuotaImpl.BacklogQuotaImplBuilder (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data.impl
+

Class BacklogQuotaImpl.BacklogQuotaImplBuilder

+
+
java.lang.Object +
org.apache.pulsar.common.policies.data.impl.BacklogQuotaImpl.BacklogQuotaImplBuilder
+
+
+
+
All Implemented Interfaces:
+
BacklogQuota.Builder
+
+
+
Enclosing class:
+
BacklogQuotaImpl
+
+
+
public static class BacklogQuotaImpl.BacklogQuotaImplBuilder +extends Object +implements BacklogQuota.Builder
+
+
+ +
+
+ +
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/BacklogQuotaImpl.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/BacklogQuotaImpl.html new file mode 100644 index 000000000000..fc4b78263abd --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/BacklogQuotaImpl.html @@ -0,0 +1,354 @@ + + + + +BacklogQuotaImpl (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data.impl
+

Class BacklogQuotaImpl

+
+
java.lang.Object +
org.apache.pulsar.common.policies.data.impl.BacklogQuotaImpl
+
+
+
+
All Implemented Interfaces:
+
BacklogQuota
+
+
+
public class BacklogQuotaImpl +extends Object +implements BacklogQuota
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    +
      +
    • +
      +

      BYTES_IN_GIGABYTE

      +
      public static final long BYTES_IN_GIGABYTE
      +
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Constructor Details

    + +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getLimit

      +
      @Deprecated +public long getLimit()
      +
      Deprecated.
      +
      Description copied from interface: BacklogQuota
      +
      Gets quota limit in size. + Remains for compatible
      +
      +
      Specified by:
      +
      getLimit in interface BacklogQuota
      +
      Returns:
      +
      quota limit in bytes
      +
      +
      +
      • +
    • +
      +

      setLimit

      +
      @Deprecated +public void setLimit(long limit)
      +
      Deprecated.
      +
      +
      • +
    • +
      +

      getLimitSize

      +
      public long getLimitSize()
      +
      Description copied from interface: BacklogQuota
      +
      Gets quota limit in size.
      +
      +
      Specified by:
      +
      getLimitSize in interface BacklogQuota
      +
      Returns:
      +
      quota limit in bytes
      +
      +
      +
      • +
    • +
      +

      setLimitSize

      +
      public void setLimitSize(long limitSize)
      +
      +
      • +
    • +
      +

      getLimitTime

      +
      public int getLimitTime()
      +
      Description copied from interface: BacklogQuota
      +
      Gets quota limit in time.
      +
      +
      Specified by:
      +
      getLimitTime in interface BacklogQuota
      +
      Returns:
      +
      quota limit in second
      +
      +
      +
      • +
    • +
      +

      setLimitTime

      +
      public void setLimitTime(int limitTime)
      +
      +
      • +
    • +
      +

      getPolicy

      +
      public BacklogQuota.RetentionPolicy getPolicy()
      +
      +
      Specified by:
      +
      getPolicy in interface BacklogQuota
      +
      +
      +
      • +
    • +
      +

      setPolicy

      +
      public void setPolicy(BacklogQuota.RetentionPolicy policy)
      +
      +
      • +
    • +
      +

      builder

      +
      public static BacklogQuotaImpl.BacklogQuotaImplBuilder builder()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/BookieAffinityGroupDataImpl.BookieAffinityGroupDataImplBuilder.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/BookieAffinityGroupDataImpl.BookieAffinityGroupDataImplBuilder.html new file mode 100644 index 000000000000..eb0de1d8e6f9 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/BookieAffinityGroupDataImpl.BookieAffinityGroupDataImplBuilder.html @@ -0,0 +1,216 @@ + + + + +BookieAffinityGroupDataImpl.BookieAffinityGroupDataImplBuilder (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data.impl
+

Class BookieAffinityGroupDataImpl.BookieAffinityGroupDataImplBuilder

+
+
java.lang.Object +
org.apache.pulsar.common.policies.data.impl.BookieAffinityGroupDataImpl.BookieAffinityGroupDataImplBuilder
+
+
+
+
All Implemented Interfaces:
+
BookieAffinityGroupData.Builder
+
+
+
Enclosing class:
+
BookieAffinityGroupDataImpl
+
+
+
public static class BookieAffinityGroupDataImpl.BookieAffinityGroupDataImplBuilder +extends Object +implements BookieAffinityGroupData.Builder
+
+
+ +
+
+ +
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/BookieAffinityGroupDataImpl.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/BookieAffinityGroupDataImpl.html new file mode 100644 index 000000000000..6416e777c5fd --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/BookieAffinityGroupDataImpl.html @@ -0,0 +1,204 @@ + + + + +BookieAffinityGroupDataImpl (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data.impl
+

Class BookieAffinityGroupDataImpl

+
+
java.lang.Object +
org.apache.pulsar.common.policies.data.impl.BookieAffinityGroupDataImpl
+
+
+
+
All Implemented Interfaces:
+
BookieAffinityGroupData
+
+
+
public final class BookieAffinityGroupDataImpl +extends Object +implements BookieAffinityGroupData
+
Description of a BookKeeper's affinity group.
+
+
+ +
+
+ +
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/BookieInfoImpl.BookieInfoImplBuilder.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/BookieInfoImpl.BookieInfoImplBuilder.html new file mode 100644 index 000000000000..3becba8065d3 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/BookieInfoImpl.BookieInfoImplBuilder.html @@ -0,0 +1,228 @@ + + + + +BookieInfoImpl.BookieInfoImplBuilder (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data.impl
+

Class BookieInfoImpl.BookieInfoImplBuilder

+
+
java.lang.Object +
org.apache.pulsar.common.policies.data.impl.BookieInfoImpl.BookieInfoImplBuilder
+
+
+
+
All Implemented Interfaces:
+
BookieInfo.Builder
+
+
+
Enclosing class:
+
BookieInfoImpl
+
+
+
public static class BookieInfoImpl.BookieInfoImplBuilder +extends Object +implements BookieInfo.Builder
+
+
+ +
+
+ +
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/BookieInfoImpl.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/BookieInfoImpl.html new file mode 100644 index 000000000000..43cd920dd680 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/BookieInfoImpl.html @@ -0,0 +1,204 @@ + + + + +BookieInfoImpl (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data.impl
+

Class BookieInfoImpl

+
+
java.lang.Object +
org.apache.pulsar.common.policies.data.impl.BookieInfoImpl
+
+
+
+
All Implemented Interfaces:
+
BookieInfo
+
+
+
public final class BookieInfoImpl +extends Object +implements BookieInfo
+
Bookie information.
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      BookieInfoImpl

      +
      public BookieInfoImpl()
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    + +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/BookiesClusterInfoImpl.BookiesClusterInfoImplBuilder.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/BookiesClusterInfoImpl.BookiesClusterInfoImplBuilder.html new file mode 100644 index 000000000000..61dea2710980 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/BookiesClusterInfoImpl.BookiesClusterInfoImplBuilder.html @@ -0,0 +1,203 @@ + + + + +BookiesClusterInfoImpl.BookiesClusterInfoImplBuilder (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data.impl
+

Class BookiesClusterInfoImpl.BookiesClusterInfoImplBuilder

+
+
java.lang.Object +
org.apache.pulsar.common.policies.data.impl.BookiesClusterInfoImpl.BookiesClusterInfoImplBuilder
+
+
+
+
All Implemented Interfaces:
+
BookiesClusterInfo.Builder
+
+
+
Enclosing class:
+
BookiesClusterInfoImpl
+
+
+
public static class BookiesClusterInfoImpl.BookiesClusterInfoImplBuilder +extends Object +implements BookiesClusterInfo.Builder
+
+
+ +
+
+ +
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/BookiesClusterInfoImpl.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/BookiesClusterInfoImpl.html new file mode 100644 index 000000000000..98a1b8f96e72 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/BookiesClusterInfoImpl.html @@ -0,0 +1,204 @@ + + + + +BookiesClusterInfoImpl (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data.impl
+

Class BookiesClusterInfoImpl

+
+
java.lang.Object +
org.apache.pulsar.common.policies.data.impl.BookiesClusterInfoImpl
+
+
+
+
All Implemented Interfaces:
+
BookiesClusterInfo
+
+
+
public final class BookiesClusterInfoImpl +extends Object +implements BookiesClusterInfo
+
Raw bookies information.
+
+
+ +
+
+ +
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/BrokerInfoImpl.BrokerInfoImplBuilder.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/BrokerInfoImpl.BrokerInfoImplBuilder.html new file mode 100644 index 000000000000..9429587adadb --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/BrokerInfoImpl.BrokerInfoImplBuilder.html @@ -0,0 +1,216 @@ + + + + +BrokerInfoImpl.BrokerInfoImplBuilder (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data.impl
+

Class BrokerInfoImpl.BrokerInfoImplBuilder

+
+
java.lang.Object +
org.apache.pulsar.common.policies.data.impl.BrokerInfoImpl.BrokerInfoImplBuilder
+
+
+
+
All Implemented Interfaces:
+
BrokerInfo.Builder
+
+
+
Enclosing class:
+
BrokerInfoImpl
+
+
+
public static class BrokerInfoImpl.BrokerInfoImplBuilder +extends Object +implements BrokerInfo.Builder
+
+
+ +
+
+ +
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/BrokerInfoImpl.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/BrokerInfoImpl.html new file mode 100644 index 000000000000..21b48902dfef --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/BrokerInfoImpl.html @@ -0,0 +1,204 @@ + + + + +BrokerInfoImpl (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data.impl
+

Class BrokerInfoImpl

+
+
java.lang.Object +
org.apache.pulsar.common.policies.data.impl.BrokerInfoImpl
+
+
+
+
All Implemented Interfaces:
+
BrokerInfo
+
+
+
public final class BrokerInfoImpl +extends Object +implements BrokerInfo
+
Broker Information.
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      BrokerInfoImpl

      +
      public BrokerInfoImpl()
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    + +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/BrokerStatusImpl.BrokerStatusImplBuilder.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/BrokerStatusImpl.BrokerStatusImplBuilder.html new file mode 100644 index 000000000000..9bd054153391 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/BrokerStatusImpl.BrokerStatusImplBuilder.html @@ -0,0 +1,229 @@ + + + + +BrokerStatusImpl.BrokerStatusImplBuilder (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data.impl
+

Class BrokerStatusImpl.BrokerStatusImplBuilder

+
+
java.lang.Object +
org.apache.pulsar.common.policies.data.impl.BrokerStatusImpl.BrokerStatusImplBuilder
+
+
+
+
All Implemented Interfaces:
+
BrokerStatus.Builder
+
+
+
Enclosing class:
+
BrokerStatusImpl
+
+
+
public static class BrokerStatusImpl.BrokerStatusImplBuilder +extends Object +implements BrokerStatus.Builder
+
+
+ +
+
+ +
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/BrokerStatusImpl.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/BrokerStatusImpl.html new file mode 100644 index 000000000000..3dbda4888e05 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/BrokerStatusImpl.html @@ -0,0 +1,217 @@ + + + + +BrokerStatusImpl (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data.impl
+

Class BrokerStatusImpl

+
+
java.lang.Object +
org.apache.pulsar.common.policies.data.impl.BrokerStatusImpl
+
+
+
+
All Implemented Interfaces:
+
Comparable<BrokerStatus>, BrokerStatus
+
+
+
public final class BrokerStatusImpl +extends Object +implements BrokerStatus
+
Information about the broker status.
+
+
+ +
+
+ +
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/BundlesDataImpl.BundlesDataImplBuilder.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/BundlesDataImpl.BundlesDataImplBuilder.html new file mode 100644 index 000000000000..b137b63ffd64 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/BundlesDataImpl.BundlesDataImplBuilder.html @@ -0,0 +1,216 @@ + + + + +BundlesDataImpl.BundlesDataImplBuilder (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data.impl
+

Class BundlesDataImpl.BundlesDataImplBuilder

+
+
java.lang.Object +
org.apache.pulsar.common.policies.data.impl.BundlesDataImpl.BundlesDataImplBuilder
+
+
+
+
All Implemented Interfaces:
+
BundlesData.Builder
+
+
+
Enclosing class:
+
BundlesDataImpl
+
+
+
public static class BundlesDataImpl.BundlesDataImplBuilder +extends Object +implements BundlesData.Builder
+
+
+ +
+
+ +
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/BundlesDataImpl.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/BundlesDataImpl.html new file mode 100644 index 000000000000..90df50323ce7 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/BundlesDataImpl.html @@ -0,0 +1,204 @@ + + + + +BundlesDataImpl (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data.impl
+

Class BundlesDataImpl

+
+
java.lang.Object +
org.apache.pulsar.common.policies.data.impl.BundlesDataImpl
+
+
+
+
All Implemented Interfaces:
+
BundlesData
+
+
+
public final class BundlesDataImpl +extends Object +implements BundlesData
+
Holder for bundles.
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      BundlesDataImpl

      +
      public BundlesDataImpl()
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    + +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/DelayedDeliveryPoliciesImpl.DelayedDeliveryPoliciesImplBuilder.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/DelayedDeliveryPoliciesImpl.DelayedDeliveryPoliciesImplBuilder.html new file mode 100644 index 000000000000..ec8f1c362ff9 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/DelayedDeliveryPoliciesImpl.DelayedDeliveryPoliciesImplBuilder.html @@ -0,0 +1,229 @@ + + + + +DelayedDeliveryPoliciesImpl.DelayedDeliveryPoliciesImplBuilder (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data.impl
+

Class DelayedDeliveryPoliciesImpl.DelayedDeliveryPoliciesImplBuilder

+
+
java.lang.Object +
org.apache.pulsar.common.policies.data.impl.DelayedDeliveryPoliciesImpl.DelayedDeliveryPoliciesImplBuilder
+
+
+
+
All Implemented Interfaces:
+
DelayedDeliveryPolicies.Builder
+
+
+
Enclosing class:
+
DelayedDeliveryPoliciesImpl
+
+
+
public static class DelayedDeliveryPoliciesImpl.DelayedDeliveryPoliciesImplBuilder +extends Object +implements DelayedDeliveryPolicies.Builder
+
+
+ +
+
+ +
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/DelayedDeliveryPoliciesImpl.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/DelayedDeliveryPoliciesImpl.html new file mode 100644 index 000000000000..4a8c58f3fbc2 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/DelayedDeliveryPoliciesImpl.html @@ -0,0 +1,204 @@ + + + + +DelayedDeliveryPoliciesImpl (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data.impl
+

Class DelayedDeliveryPoliciesImpl

+
+
java.lang.Object +
org.apache.pulsar.common.policies.data.impl.DelayedDeliveryPoliciesImpl
+
+
+
+
All Implemented Interfaces:
+
DelayedDeliveryPolicies
+
+
+
public final class DelayedDeliveryPoliciesImpl +extends Object +implements DelayedDeliveryPolicies
+
Definition of the delayed delivery policy.
+
+
+ +
+
+ +
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/DispatchRateImpl.DispatchRateImplBuilder.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/DispatchRateImpl.DispatchRateImplBuilder.html new file mode 100644 index 000000000000..b1994fde2d8d --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/DispatchRateImpl.DispatchRateImplBuilder.html @@ -0,0 +1,242 @@ + + + + +DispatchRateImpl.DispatchRateImplBuilder (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data.impl
+

Class DispatchRateImpl.DispatchRateImplBuilder

+
+
java.lang.Object +
org.apache.pulsar.common.policies.data.impl.DispatchRateImpl.DispatchRateImplBuilder
+
+
+
+
All Implemented Interfaces:
+
DispatchRate.Builder
+
+
+
Enclosing class:
+
DispatchRateImpl
+
+
+
public static class DispatchRateImpl.DispatchRateImplBuilder +extends Object +implements DispatchRate.Builder
+
+
+ +
+
+ +
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/DispatchRateImpl.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/DispatchRateImpl.html new file mode 100644 index 000000000000..8a9e56b7a8b0 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/DispatchRateImpl.html @@ -0,0 +1,213 @@ + + + + +DispatchRateImpl (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.data.impl
+

Class DispatchRateImpl

+
+
java.lang.Object +
org.apache.pulsar.common.policies.data.impl.DispatchRateImpl
+
+
+
+
All Implemented Interfaces:
+
DispatchRate
+
+
+
public final class DispatchRateImpl +extends Object +implements DispatchRate
+
Dispatch rate.
+
+
+ +
+
+ +
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/AutoSubscriptionCreationOverrideImpl.AutoSubscriptionCreationOverrideImplBuilder.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/AutoSubscriptionCreationOverrideImpl.AutoSubscriptionCreationOverrideImplBuilder.html new file mode 100644 index 000000000000..a7fece1e401b --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/AutoSubscriptionCreationOverrideImpl.AutoSubscriptionCreationOverrideImplBuilder.html @@ -0,0 +1,90 @@ + + + + +Uses of Class org.apache.pulsar.common.policies.data.impl.AutoSubscriptionCreationOverrideImpl.AutoSubscriptionCreationOverrideImplBuilder (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.policies.data.impl.AutoSubscriptionCreationOverrideImpl.AutoSubscriptionCreationOverrideImplBuilder

+
+
Packages that use AutoSubscriptionCreationOverrideImpl.AutoSubscriptionCreationOverrideImplBuilder
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data.impl
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/AutoSubscriptionCreationOverrideImpl.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/AutoSubscriptionCreationOverrideImpl.html new file mode 100644 index 000000000000..ab1383e0734a --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/AutoSubscriptionCreationOverrideImpl.html @@ -0,0 +1,87 @@ + + + + +Uses of Class org.apache.pulsar.common.policies.data.impl.AutoSubscriptionCreationOverrideImpl (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.policies.data.impl.AutoSubscriptionCreationOverrideImpl

+
+
Packages that use AutoSubscriptionCreationOverrideImpl
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data.impl
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/AutoTopicCreationOverrideImpl.AutoTopicCreationOverrideImplBuilder.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/AutoTopicCreationOverrideImpl.AutoTopicCreationOverrideImplBuilder.html new file mode 100644 index 000000000000..2ceec256b0e4 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/AutoTopicCreationOverrideImpl.AutoTopicCreationOverrideImplBuilder.html @@ -0,0 +1,96 @@ + + + + +Uses of Class org.apache.pulsar.common.policies.data.impl.AutoTopicCreationOverrideImpl.AutoTopicCreationOverrideImplBuilder (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.policies.data.impl.AutoTopicCreationOverrideImpl.AutoTopicCreationOverrideImplBuilder

+
+
Packages that use AutoTopicCreationOverrideImpl.AutoTopicCreationOverrideImplBuilder
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data.impl
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/AutoTopicCreationOverrideImpl.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/AutoTopicCreationOverrideImpl.html new file mode 100644 index 000000000000..5c76100a7707 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/AutoTopicCreationOverrideImpl.html @@ -0,0 +1,87 @@ + + + + +Uses of Class org.apache.pulsar.common.policies.data.impl.AutoTopicCreationOverrideImpl (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.policies.data.impl.AutoTopicCreationOverrideImpl

+
+
Packages that use AutoTopicCreationOverrideImpl
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data.impl
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/BacklogQuotaImpl.BacklogQuotaImplBuilder.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/BacklogQuotaImpl.BacklogQuotaImplBuilder.html new file mode 100644 index 000000000000..bbcb2ad7adb3 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/BacklogQuotaImpl.BacklogQuotaImplBuilder.html @@ -0,0 +1,96 @@ + + + + +Uses of Class org.apache.pulsar.common.policies.data.impl.BacklogQuotaImpl.BacklogQuotaImplBuilder (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.policies.data.impl.BacklogQuotaImpl.BacklogQuotaImplBuilder

+
+
Packages that use BacklogQuotaImpl.BacklogQuotaImplBuilder
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data.impl
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/BacklogQuotaImpl.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/BacklogQuotaImpl.html new file mode 100644 index 000000000000..791dd80ee608 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/BacklogQuotaImpl.html @@ -0,0 +1,87 @@ + + + + +Uses of Class org.apache.pulsar.common.policies.data.impl.BacklogQuotaImpl (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.policies.data.impl.BacklogQuotaImpl

+
+
Packages that use BacklogQuotaImpl
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data.impl
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/BookieAffinityGroupDataImpl.BookieAffinityGroupDataImplBuilder.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/BookieAffinityGroupDataImpl.BookieAffinityGroupDataImplBuilder.html new file mode 100644 index 000000000000..a93c75e4e3c5 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/BookieAffinityGroupDataImpl.BookieAffinityGroupDataImplBuilder.html @@ -0,0 +1,93 @@ + + + + +Uses of Class org.apache.pulsar.common.policies.data.impl.BookieAffinityGroupDataImpl.BookieAffinityGroupDataImplBuilder (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.policies.data.impl.BookieAffinityGroupDataImpl.BookieAffinityGroupDataImplBuilder

+
+
Packages that use BookieAffinityGroupDataImpl.BookieAffinityGroupDataImplBuilder
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data.impl
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/BookieAffinityGroupDataImpl.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/BookieAffinityGroupDataImpl.html new file mode 100644 index 000000000000..5612e25e21f4 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/BookieAffinityGroupDataImpl.html @@ -0,0 +1,87 @@ + + + + +Uses of Class org.apache.pulsar.common.policies.data.impl.BookieAffinityGroupDataImpl (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.policies.data.impl.BookieAffinityGroupDataImpl

+
+
Packages that use BookieAffinityGroupDataImpl
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data.impl
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/BookieInfoImpl.BookieInfoImplBuilder.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/BookieInfoImpl.BookieInfoImplBuilder.html new file mode 100644 index 000000000000..bf130b0006e7 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/BookieInfoImpl.BookieInfoImplBuilder.html @@ -0,0 +1,93 @@ + + + + +Uses of Class org.apache.pulsar.common.policies.data.impl.BookieInfoImpl.BookieInfoImplBuilder (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.policies.data.impl.BookieInfoImpl.BookieInfoImplBuilder

+
+
Packages that use BookieInfoImpl.BookieInfoImplBuilder
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data.impl
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/BookieInfoImpl.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/BookieInfoImpl.html new file mode 100644 index 000000000000..74183b1114b7 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/BookieInfoImpl.html @@ -0,0 +1,87 @@ + + + + +Uses of Class org.apache.pulsar.common.policies.data.impl.BookieInfoImpl (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.policies.data.impl.BookieInfoImpl

+
+
Packages that use BookieInfoImpl
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data.impl
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/BookiesClusterInfoImpl.BookiesClusterInfoImplBuilder.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/BookiesClusterInfoImpl.BookiesClusterInfoImplBuilder.html new file mode 100644 index 000000000000..239df6726be1 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/BookiesClusterInfoImpl.BookiesClusterInfoImplBuilder.html @@ -0,0 +1,90 @@ + + + + +Uses of Class org.apache.pulsar.common.policies.data.impl.BookiesClusterInfoImpl.BookiesClusterInfoImplBuilder (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.policies.data.impl.BookiesClusterInfoImpl.BookiesClusterInfoImplBuilder

+
+
Packages that use BookiesClusterInfoImpl.BookiesClusterInfoImplBuilder
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data.impl
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/BookiesClusterInfoImpl.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/BookiesClusterInfoImpl.html new file mode 100644 index 000000000000..f05ae0fe4fc9 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/BookiesClusterInfoImpl.html @@ -0,0 +1,87 @@ + + + + +Uses of Class org.apache.pulsar.common.policies.data.impl.BookiesClusterInfoImpl (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.policies.data.impl.BookiesClusterInfoImpl

+
+
Packages that use BookiesClusterInfoImpl
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data.impl
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/BrokerInfoImpl.BrokerInfoImplBuilder.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/BrokerInfoImpl.BrokerInfoImplBuilder.html new file mode 100644 index 000000000000..3799ffb31150 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/BrokerInfoImpl.BrokerInfoImplBuilder.html @@ -0,0 +1,93 @@ + + + + +Uses of Class org.apache.pulsar.common.policies.data.impl.BrokerInfoImpl.BrokerInfoImplBuilder (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.policies.data.impl.BrokerInfoImpl.BrokerInfoImplBuilder

+
+
Packages that use BrokerInfoImpl.BrokerInfoImplBuilder
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data.impl
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/BrokerInfoImpl.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/BrokerInfoImpl.html new file mode 100644 index 000000000000..94ae3636e736 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/BrokerInfoImpl.html @@ -0,0 +1,87 @@ + + + + +Uses of Class org.apache.pulsar.common.policies.data.impl.BrokerInfoImpl (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.policies.data.impl.BrokerInfoImpl

+
+
Packages that use BrokerInfoImpl
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data.impl
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/BrokerStatusImpl.BrokerStatusImplBuilder.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/BrokerStatusImpl.BrokerStatusImplBuilder.html new file mode 100644 index 000000000000..2d188f364e63 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/BrokerStatusImpl.BrokerStatusImplBuilder.html @@ -0,0 +1,96 @@ + + + + +Uses of Class org.apache.pulsar.common.policies.data.impl.BrokerStatusImpl.BrokerStatusImplBuilder (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.policies.data.impl.BrokerStatusImpl.BrokerStatusImplBuilder

+
+
Packages that use BrokerStatusImpl.BrokerStatusImplBuilder
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data.impl
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/BrokerStatusImpl.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/BrokerStatusImpl.html new file mode 100644 index 000000000000..1f7fdb67edd0 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/BrokerStatusImpl.html @@ -0,0 +1,87 @@ + + + + +Uses of Class org.apache.pulsar.common.policies.data.impl.BrokerStatusImpl (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.policies.data.impl.BrokerStatusImpl

+
+
Packages that use BrokerStatusImpl
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data.impl
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/BundlesDataImpl.BundlesDataImplBuilder.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/BundlesDataImpl.BundlesDataImplBuilder.html new file mode 100644 index 000000000000..164a5500535c --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/BundlesDataImpl.BundlesDataImplBuilder.html @@ -0,0 +1,93 @@ + + + + +Uses of Class org.apache.pulsar.common.policies.data.impl.BundlesDataImpl.BundlesDataImplBuilder (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.policies.data.impl.BundlesDataImpl.BundlesDataImplBuilder

+
+
Packages that use BundlesDataImpl.BundlesDataImplBuilder
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data.impl
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/BundlesDataImpl.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/BundlesDataImpl.html new file mode 100644 index 000000000000..80cc845d6f7e --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/BundlesDataImpl.html @@ -0,0 +1,87 @@ + + + + +Uses of Class org.apache.pulsar.common.policies.data.impl.BundlesDataImpl (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.policies.data.impl.BundlesDataImpl

+
+
Packages that use BundlesDataImpl
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data.impl
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/DelayedDeliveryPoliciesImpl.DelayedDeliveryPoliciesImplBuilder.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/DelayedDeliveryPoliciesImpl.DelayedDeliveryPoliciesImplBuilder.html new file mode 100644 index 000000000000..47812f21f1af --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/DelayedDeliveryPoliciesImpl.DelayedDeliveryPoliciesImplBuilder.html @@ -0,0 +1,96 @@ + + + + +Uses of Class org.apache.pulsar.common.policies.data.impl.DelayedDeliveryPoliciesImpl.DelayedDeliveryPoliciesImplBuilder (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.policies.data.impl.DelayedDeliveryPoliciesImpl.DelayedDeliveryPoliciesImplBuilder

+
+
Packages that use DelayedDeliveryPoliciesImpl.DelayedDeliveryPoliciesImplBuilder
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data.impl
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/DelayedDeliveryPoliciesImpl.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/DelayedDeliveryPoliciesImpl.html new file mode 100644 index 000000000000..3e68274b4949 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/DelayedDeliveryPoliciesImpl.html @@ -0,0 +1,87 @@ + + + + +Uses of Class org.apache.pulsar.common.policies.data.impl.DelayedDeliveryPoliciesImpl (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.policies.data.impl.DelayedDeliveryPoliciesImpl

+
+
Packages that use DelayedDeliveryPoliciesImpl
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data.impl
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/DispatchRateImpl.DispatchRateImplBuilder.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/DispatchRateImpl.DispatchRateImplBuilder.html new file mode 100644 index 000000000000..b221190ff1a3 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/DispatchRateImpl.DispatchRateImplBuilder.html @@ -0,0 +1,99 @@ + + + + +Uses of Class org.apache.pulsar.common.policies.data.impl.DispatchRateImpl.DispatchRateImplBuilder (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.policies.data.impl.DispatchRateImpl.DispatchRateImplBuilder

+
+
Packages that use DispatchRateImpl.DispatchRateImplBuilder
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data.impl
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/DispatchRateImpl.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/DispatchRateImpl.html new file mode 100644 index 000000000000..a299754d5fe1 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/class-use/DispatchRateImpl.html @@ -0,0 +1,128 @@ + + + + +Uses of Class org.apache.pulsar.common.policies.data.impl.DispatchRateImpl (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.policies.data.impl.DispatchRateImpl

+
+
Packages that use DispatchRateImpl
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
org.apache.pulsar.common.policies.data.impl
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/package-summary.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/package-summary.html new file mode 100644 index 000000000000..98debba5a6b7 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/package-summary.html @@ -0,0 +1,171 @@ + + + + +org.apache.pulsar.common.policies.data.impl (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Package org.apache.pulsar.common.policies.data.impl

+
+
+
package org.apache.pulsar.common.policies.data.impl
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/package-tree.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/package-tree.html new file mode 100644 index 000000000000..bfa5e431acd9 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/package-tree.html @@ -0,0 +1,97 @@ + + + + +org.apache.pulsar.common.policies.data.impl Class Hierarchy (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package org.apache.pulsar.common.policies.data.impl

+
+Package Hierarchies: + +
+

Class Hierarchy

+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/package-use.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/package-use.html new file mode 100644 index 000000000000..06a3fda056cf --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/impl/package-use.html @@ -0,0 +1,163 @@ + + + + +Uses of Package org.apache.pulsar.common.policies.data.impl (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Package
org.apache.pulsar.common.policies.data.impl

+
+
Packages that use org.apache.pulsar.common.policies.data.impl
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
org.apache.pulsar.common.policies.data.impl
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/package-summary.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/package-summary.html new file mode 100644 index 000000000000..4cc114c88c06 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/package-summary.html @@ -0,0 +1,496 @@ + + + + +org.apache.pulsar.common.policies.data (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Package org.apache.pulsar.common.policies.data

+
+
+
package org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/package-tree.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/package-tree.html new file mode 100644 index 000000000000..4aee32735890 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/package-tree.html @@ -0,0 +1,245 @@ + + + + +org.apache.pulsar.common.policies.data Class Hierarchy (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package org.apache.pulsar.common.policies.data

+
+Package Hierarchies: + +
+

Class Hierarchy

+ +
+
+

Interface Hierarchy

+ +
+
+

Enum Class Hierarchy

+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/package-use.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/package-use.html new file mode 100644 index 000000000000..e41182e8a77e --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/data/package-use.html @@ -0,0 +1,722 @@ + + + + +Uses of Package org.apache.pulsar.common.policies.data (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Package
org.apache.pulsar.common.policies.data

+
+
Packages that use org.apache.pulsar.common.policies.data
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
org.apache.pulsar.common.policies
+
+
Implementation of policies.
+
+
org.apache.pulsar.common.policies.data
+
+
Implementation of policies.
+
+
org.apache.pulsar.common.policies.data.impl
+
 
+
org.apache.pulsar.common.policies.impl
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/impl/AutoFailoverPolicyFactory.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/impl/AutoFailoverPolicyFactory.html new file mode 100644 index 000000000000..fed09ba034b4 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/impl/AutoFailoverPolicyFactory.html @@ -0,0 +1,178 @@ + + + + +AutoFailoverPolicyFactory (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.impl
+

Class AutoFailoverPolicyFactory

+
+
java.lang.Object +
org.apache.pulsar.common.policies.impl.AutoFailoverPolicyFactory
+
+
+
+
public class AutoFailoverPolicyFactory +extends Object
+
Factory to generate an instance of AutoFailoverPolicy.
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      AutoFailoverPolicyFactory

      +
      public AutoFailoverPolicyFactory()
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    + +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/impl/MinAvailablePolicy.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/impl/MinAvailablePolicy.html new file mode 100644 index 000000000000..9360deaffc52 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/impl/MinAvailablePolicy.html @@ -0,0 +1,262 @@ + + + + +MinAvailablePolicy (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.policies.impl
+

Class MinAvailablePolicy

+
+
java.lang.Object +
org.apache.pulsar.common.policies.AutoFailoverPolicy +
org.apache.pulsar.common.policies.impl.MinAvailablePolicy
+
+
+
+
+
public class MinAvailablePolicy +extends AutoFailoverPolicy
+
Implementation of min available policy.
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    +
      +
    • +
      +

      min_limit

      +
      public int min_limit
      +
      +
      • +
    • +
      +

      usage_threshold

      +
      public int usage_threshold
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Constructor Details

    + +
    +
    • + +
  • +
    +

    Method Details

    + +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/impl/class-use/AutoFailoverPolicyFactory.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/impl/class-use/AutoFailoverPolicyFactory.html new file mode 100644 index 000000000000..1dd076996d69 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/impl/class-use/AutoFailoverPolicyFactory.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.common.policies.impl.AutoFailoverPolicyFactory (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.policies.impl.AutoFailoverPolicyFactory

+
+No usage of org.apache.pulsar.common.policies.impl.AutoFailoverPolicyFactory
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/impl/class-use/MinAvailablePolicy.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/impl/class-use/MinAvailablePolicy.html new file mode 100644 index 000000000000..77005e3e55b1 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/impl/class-use/MinAvailablePolicy.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.common.policies.impl.MinAvailablePolicy (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.policies.impl.MinAvailablePolicy

+
+No usage of org.apache.pulsar.common.policies.impl.MinAvailablePolicy
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/impl/package-summary.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/impl/package-summary.html new file mode 100644 index 000000000000..55585e01ad73 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/impl/package-summary.html @@ -0,0 +1,122 @@ + + + + +org.apache.pulsar.common.policies.impl (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Package org.apache.pulsar.common.policies.impl

+
+
+
package org.apache.pulsar.common.policies.impl
+
+
Implementation of policies.
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/impl/package-tree.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/impl/package-tree.html new file mode 100644 index 000000000000..3b03b6288c0d --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/impl/package-tree.html @@ -0,0 +1,81 @@ + + + + +org.apache.pulsar.common.policies.impl Class Hierarchy (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package org.apache.pulsar.common.policies.impl

+
+Package Hierarchies: + +
+

Class Hierarchy

+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/impl/package-use.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/impl/package-use.html new file mode 100644 index 000000000000..d6103d43b097 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/impl/package-use.html @@ -0,0 +1,62 @@ + + + + +Uses of Package org.apache.pulsar.common.policies.impl (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Package
org.apache.pulsar.common.policies.impl

+
+No usage of org.apache.pulsar.common.policies.impl
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/package-summary.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/package-summary.html new file mode 100644 index 000000000000..d3928e60b5c2 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/package-summary.html @@ -0,0 +1,118 @@ + + + + +org.apache.pulsar.common.policies (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Package org.apache.pulsar.common.policies

+
+
+
package org.apache.pulsar.common.policies
+
+
Implementation of policies.
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/package-tree.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/package-tree.html new file mode 100644 index 000000000000..609cacc8f959 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/package-tree.html @@ -0,0 +1,76 @@ + + + + +org.apache.pulsar.common.policies Class Hierarchy (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package org.apache.pulsar.common.policies

+
+Package Hierarchies: + +
+

Class Hierarchy

+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/policies/package-use.html b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/package-use.html new file mode 100644 index 000000000000..7ef6c29f85c1 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/policies/package-use.html @@ -0,0 +1,88 @@ + + + + +Uses of Package org.apache.pulsar.common.policies (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Package
org.apache.pulsar.common.policies

+
+
Packages that use org.apache.pulsar.common.policies
+
+
Package
+
Description
+
org.apache.pulsar.common.policies.impl
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/protocol/schema/IsCompatibilityResponse.html b/static/api/admin/4.0.x/org/apache/pulsar/common/protocol/schema/IsCompatibilityResponse.html new file mode 100644 index 000000000000..74320ce6caae --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/protocol/schema/IsCompatibilityResponse.html @@ -0,0 +1,151 @@ + + + + +IsCompatibilityResponse (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.protocol.schema
+

Class IsCompatibilityResponse

+
+
java.lang.Object +
org.apache.pulsar.common.protocol.schema.IsCompatibilityResponse
+
+
+
+
public class IsCompatibilityResponse +extends Object
+
Response defining if a schema is compatible with existing topic's schema.
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      IsCompatibilityResponse

      +
      public IsCompatibilityResponse()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/protocol/schema/PostSchemaPayload.html b/static/api/admin/4.0.x/org/apache/pulsar/common/protocol/schema/PostSchemaPayload.html new file mode 100644 index 000000000000..541e8b42def8 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/protocol/schema/PostSchemaPayload.html @@ -0,0 +1,151 @@ + + + + +PostSchemaPayload (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.protocol.schema
+

Class PostSchemaPayload

+
+
java.lang.Object +
org.apache.pulsar.common.protocol.schema.PostSchemaPayload
+
+
+
+
public class PostSchemaPayload +extends Object
+
Payload with information about a schema.
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      PostSchemaPayload

      +
      public PostSchemaPayload()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/protocol/schema/class-use/IsCompatibilityResponse.html b/static/api/admin/4.0.x/org/apache/pulsar/common/protocol/schema/class-use/IsCompatibilityResponse.html new file mode 100644 index 000000000000..e67dbe124f6d --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/protocol/schema/class-use/IsCompatibilityResponse.html @@ -0,0 +1,114 @@ + + + + +Uses of Class org.apache.pulsar.common.protocol.schema.IsCompatibilityResponse (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.protocol.schema.IsCompatibilityResponse

+
+
Packages that use IsCompatibilityResponse
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/protocol/schema/class-use/PostSchemaPayload.html b/static/api/admin/4.0.x/org/apache/pulsar/common/protocol/schema/class-use/PostSchemaPayload.html new file mode 100644 index 000000000000..a72f9ce8840c --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/protocol/schema/class-use/PostSchemaPayload.html @@ -0,0 +1,120 @@ + + + + +Uses of Class org.apache.pulsar.common.protocol.schema.PostSchemaPayload (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.protocol.schema.PostSchemaPayload

+
+
Packages that use PostSchemaPayload
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/protocol/schema/package-summary.html b/static/api/admin/4.0.x/org/apache/pulsar/common/protocol/schema/package-summary.html new file mode 100644 index 000000000000..10ab4e6bce12 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/protocol/schema/package-summary.html @@ -0,0 +1,105 @@ + + + + +org.apache.pulsar.common.protocol.schema (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Package org.apache.pulsar.common.protocol.schema

+
+
+
package org.apache.pulsar.common.protocol.schema
+
+
Implementation of policies.
+
+
+
    +
  • +
    +
    Classes
    +
    +
    Class
    +
    Description
    +
    IsCompatibilityResponse
    +
    +
    Response defining if a schema is compatible with existing topic's schema.
    +
    +
    PostSchemaPayload
    +
    +
    Payload with information about a schema.
    +
    +
    +
    +
    • +
+
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/protocol/schema/package-tree.html b/static/api/admin/4.0.x/org/apache/pulsar/common/protocol/schema/package-tree.html new file mode 100644 index 000000000000..b155c94f567c --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/protocol/schema/package-tree.html @@ -0,0 +1,77 @@ + + + + +org.apache.pulsar.common.protocol.schema Class Hierarchy (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package org.apache.pulsar.common.protocol.schema

+
+Package Hierarchies: + +
+

Class Hierarchy

+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/protocol/schema/package-use.html b/static/api/admin/4.0.x/org/apache/pulsar/common/protocol/schema/package-use.html new file mode 100644 index 000000000000..04e10bda56d8 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/protocol/schema/package-use.html @@ -0,0 +1,90 @@ + + + + +Uses of Package org.apache.pulsar.common.protocol.schema (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Package
org.apache.pulsar.common.protocol.schema

+
+
Packages that use org.apache.pulsar.common.protocol.schema
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/stats/AllocatorStats.PoolArenaStats.html b/static/api/admin/4.0.x/org/apache/pulsar/common/stats/AllocatorStats.PoolArenaStats.html new file mode 100644 index 000000000000..586668c5a4fb --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/stats/AllocatorStats.PoolArenaStats.html @@ -0,0 +1,319 @@ + + + + +AllocatorStats.PoolArenaStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.stats
+

Class AllocatorStats.PoolArenaStats

+
+
java.lang.Object +
org.apache.pulsar.common.stats.AllocatorStats.PoolArenaStats
+
+
+
+
Enclosing class:
+
AllocatorStats
+
+
+
public static class AllocatorStats.PoolArenaStats +extends Object
+
Pool arena statistics.
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    +
      +
    • +
      +

      numSmallSubpages

      +
      public int numSmallSubpages
      +
      +
      • +
    • +
      +

      numChunkLists

      +
      public int numChunkLists
      +
      +
      • +
    • +
      +

      smallSubpages

      +
      public List<AllocatorStats.PoolSubpageStats> smallSubpages
      +
      +
      • +
    • +
      +

      chunkLists

      +
      public List<AllocatorStats.PoolChunkListStats> chunkLists
      +
      +
      • +
    • +
      +

      numAllocations

      +
      public long numAllocations
      +
      +
      • +
    • +
      +

      numSmallAllocations

      +
      public long numSmallAllocations
      +
      +
      • +
    • +
      +

      numNormalAllocations

      +
      public long numNormalAllocations
      +
      +
      • +
    • +
      +

      numHugeAllocations

      +
      public long numHugeAllocations
      +
      +
      • +
    • +
      +

      numDeallocations

      +
      public long numDeallocations
      +
      +
      • +
    • +
      +

      numSmallDeallocations

      +
      public long numSmallDeallocations
      +
      +
      • +
    • +
      +

      numNormalDeallocations

      +
      public long numNormalDeallocations
      +
      +
      • +
    • +
      +

      numHugeDeallocations

      +
      public long numHugeDeallocations
      +
      +
      • +
    • +
      +

      numActiveAllocations

      +
      public long numActiveAllocations
      +
      +
      • +
    • +
      +

      numActiveSmallAllocations

      +
      public long numActiveSmallAllocations
      +
      +
      • +
    • +
      +

      numActiveNormalAllocations

      +
      public long numActiveNormalAllocations
      +
      +
      • +
    • +
      +

      numActiveHugeAllocations

      +
      public long numActiveHugeAllocations
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      PoolArenaStats

      +
      public PoolArenaStats()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/stats/AllocatorStats.PoolChunkListStats.html b/static/api/admin/4.0.x/org/apache/pulsar/common/stats/AllocatorStats.PoolChunkListStats.html new file mode 100644 index 000000000000..d4a113fafaf9 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/stats/AllocatorStats.PoolChunkListStats.html @@ -0,0 +1,202 @@ + + + + +AllocatorStats.PoolChunkListStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.stats
+

Class AllocatorStats.PoolChunkListStats

+
+
java.lang.Object +
org.apache.pulsar.common.stats.AllocatorStats.PoolChunkListStats
+
+
+
+
Enclosing class:
+
AllocatorStats
+
+
+
public static class AllocatorStats.PoolChunkListStats +extends Object
+
Pool chunk list statistics.
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    + +
    +
    • + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      PoolChunkListStats

      +
      public PoolChunkListStats()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/stats/AllocatorStats.PoolChunkStats.html b/static/api/admin/4.0.x/org/apache/pulsar/common/stats/AllocatorStats.PoolChunkStats.html new file mode 100644 index 000000000000..c9383637ba8a --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/stats/AllocatorStats.PoolChunkStats.html @@ -0,0 +1,202 @@ + + + + +AllocatorStats.PoolChunkStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.stats
+

Class AllocatorStats.PoolChunkStats

+
+
java.lang.Object +
org.apache.pulsar.common.stats.AllocatorStats.PoolChunkStats
+
+
+
+
Enclosing class:
+
AllocatorStats
+
+
+
public static class AllocatorStats.PoolChunkStats +extends Object
+
Pool chunk statistics.
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    +
      +
    • +
      +

      usage

      +
      public int usage
      +
      +
      • +
    • +
      +

      chunkSize

      +
      public int chunkSize
      +
      +
      • +
    • +
      +

      freeBytes

      +
      public int freeBytes
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      PoolChunkStats

      +
      public PoolChunkStats()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/stats/AllocatorStats.PoolSubpageStats.html b/static/api/admin/4.0.x/org/apache/pulsar/common/stats/AllocatorStats.PoolSubpageStats.html new file mode 100644 index 000000000000..a130af105013 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/stats/AllocatorStats.PoolSubpageStats.html @@ -0,0 +1,211 @@ + + + + +AllocatorStats.PoolSubpageStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.stats
+

Class AllocatorStats.PoolSubpageStats

+
+
java.lang.Object +
org.apache.pulsar.common.stats.AllocatorStats.PoolSubpageStats
+
+
+
+
Enclosing class:
+
AllocatorStats
+
+
+
public static class AllocatorStats.PoolSubpageStats +extends Object
+
Pool subpage statistics.
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    +
      +
    • +
      +

      maxNumElements

      +
      public int maxNumElements
      +
      +
      • +
    • +
      +

      numAvailable

      +
      public int numAvailable
      +
      +
      • +
    • +
      +

      elementSize

      +
      public int elementSize
      +
      +
      • +
    • +
      +

      pageSize

      +
      public int pageSize
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      PoolSubpageStats

      +
      public PoolSubpageStats()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/stats/AllocatorStats.html b/static/api/admin/4.0.x/org/apache/pulsar/common/stats/AllocatorStats.html new file mode 100644 index 000000000000..ad04d36b116f --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/stats/AllocatorStats.html @@ -0,0 +1,284 @@ + + + + +AllocatorStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.stats
+

Class AllocatorStats

+
+
java.lang.Object +
org.apache.pulsar.common.stats.AllocatorStats
+
+
+
+
public class AllocatorStats +extends Object
+
Allocator statistics.
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    +
      +
    • +
      +

      numDirectArenas

      +
      public int numDirectArenas
      +
      +
      • +
    • +
      +

      numHeapArenas

      +
      public int numHeapArenas
      +
      +
      • +
    • +
      +

      numThreadLocalCaches

      +
      public int numThreadLocalCaches
      +
      +
      • +
    • +
      +

      normalCacheSize

      +
      public int normalCacheSize
      +
      +
      • +
    • +
      +

      smallCacheSize

      +
      public int smallCacheSize
      +
      +
      • +
    • +
      +

      usedDirectMemory

      +
      public long usedDirectMemory
      +
      +
      • +
    • +
      +

      usedHeapMemory

      +
      public long usedHeapMemory
      +
      +
      • +
    • +
      +

      directArenas

      +
      public List<AllocatorStats.PoolArenaStats> directArenas
      +
      +
      • +
    • +
      +

      heapArenas

      +
      public List<AllocatorStats.PoolArenaStats> heapArenas
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      AllocatorStats

      +
      public AllocatorStats()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/stats/AnalyzeSubscriptionBacklogResult.html b/static/api/admin/4.0.x/org/apache/pulsar/common/stats/AnalyzeSubscriptionBacklogResult.html new file mode 100644 index 000000000000..6069eb911c89 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/stats/AnalyzeSubscriptionBacklogResult.html @@ -0,0 +1,150 @@ + + + + +AnalyzeSubscriptionBacklogResult (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.stats
+

Class AnalyzeSubscriptionBacklogResult

+
+
java.lang.Object +
org.apache.pulsar.common.stats.AnalyzeSubscriptionBacklogResult
+
+
+
+
public class AnalyzeSubscriptionBacklogResult +extends Object
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      AnalyzeSubscriptionBacklogResult

      +
      public AnalyzeSubscriptionBacklogResult()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/stats/Metrics.html b/static/api/admin/4.0.x/org/apache/pulsar/common/stats/Metrics.html new file mode 100644 index 000000000000..1998f7209cec --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/stats/Metrics.html @@ -0,0 +1,287 @@ + + + + +Metrics (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.stats
+

Class Metrics

+
+
java.lang.Object +
org.apache.pulsar.common.stats.Metrics
+
+
+
+
public class Metrics +extends Object
+
WARNING : do not add any getters as the Jackson parser will output that getter. + +

You may want to use the ignore annotation provided by jackson parser if you need some getters. + +

Dimensions map should be unmodifiable and immutable

+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      Metrics

      +
      public Metrics()
      +
      +
      • +
    • +
      +

      Metrics

      +
      protected Metrics(Map<String,String> unmodifiableDimensionMap)
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      create

      +
      public static Metrics create(Map<String,String> dimensionMap)
      +
      Creates a metrics object with the dimensions map immutable.
      +
      +
      Parameters:
      +
      dimensionMap -
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      put

      +
      public void put(String metricsName, + Object value)
      +
      +
      • +
    • +
      +

      getMetrics

      +
      public Map<String,Object> getMetrics()
      +
      +
      • +
    • +
      +

      putAll

      +
      public void putAll(Map<String,Object> metrics)
      +
      +
      • +
    • +
      +

      getDimensions

      +
      public Map<String,String> getDimensions()
      +
      +
      • +
    • +
      +

      getDimension

      +
      public String getDimension(String dimensionName)
      +
      +
      • +
    • +
      +

      hashCode

      +
      public int hashCode()
      +
      +
      Overrides:
      +
      hashCode in class Object
      +
      +
      +
      • +
    • +
      +

      equals

      +
      public boolean equals(Object obj)
      +
      +
      Overrides:
      +
      equals in class Object
      +
      +
      +
      • +
    • +
      +

      toString

      +
      public String toString()
      +
      +
      Overrides:
      +
      toString in class Object
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/stats/PositionInPendingAckStats.State.html b/static/api/admin/4.0.x/org/apache/pulsar/common/stats/PositionInPendingAckStats.State.html new file mode 100644 index 000000000000..290761ea334c --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/stats/PositionInPendingAckStats.State.html @@ -0,0 +1,264 @@ + + + + +PositionInPendingAckStats.State (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.stats
+

Enum Class PositionInPendingAckStats.State

+
+
java.lang.Object +
java.lang.Enum<PositionInPendingAckStats.State> +
org.apache.pulsar.common.stats.PositionInPendingAckStats.State
+
+
+
+
+
All Implemented Interfaces:
+
Serializable, Comparable<PositionInPendingAckStats.State>, Constable
+
+
+
Enclosing class:
+
PositionInPendingAckStats
+
+
+
public static enum PositionInPendingAckStats.State +extends Enum<PositionInPendingAckStats.State>
+
+
+ +
+
+
    + +
  • +
    +

    Enum Constant Details

    + +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      values

      +
      public static PositionInPendingAckStats.State[] values()
      +
      Returns an array containing the constants of this enum class, in +the order they are declared.
      +
      +
      Returns:
      +
      an array containing the constants of this enum class, in the order they are declared
      +
      +
      +
      • +
    • +
      +

      valueOf

      +
      public static PositionInPendingAckStats.State valueOf(String name)
      +
      Returns the enum constant of this class with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this class. (Extraneous whitespace characters are +not permitted.)
      +
      +
      Parameters:
      +
      name - the name of the enum constant to be returned.
      +
      Returns:
      +
      the enum constant with the specified name
      +
      Throws:
      +
      IllegalArgumentException - if this enum class has no constant with the specified name
      +
      NullPointerException - if the argument is null
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/stats/PositionInPendingAckStats.html b/static/api/admin/4.0.x/org/apache/pulsar/common/stats/PositionInPendingAckStats.html new file mode 100644 index 000000000000..937bfad7655b --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/stats/PositionInPendingAckStats.html @@ -0,0 +1,202 @@ + + + + +PositionInPendingAckStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.common.stats
+

Class PositionInPendingAckStats

+
+
java.lang.Object +
org.apache.pulsar.common.stats.PositionInPendingAckStats
+
+
+
+
public class PositionInPendingAckStats +extends Object
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    + +
    +
    • + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      PositionInPendingAckStats

      +
      public PositionInPendingAckStats()
      +
      +
      • +
    • +
      +

      PositionInPendingAckStats

      +
      public PositionInPendingAckStats(PositionInPendingAckStats.State state)
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/stats/class-use/AllocatorStats.PoolArenaStats.html b/static/api/admin/4.0.x/org/apache/pulsar/common/stats/class-use/AllocatorStats.PoolArenaStats.html new file mode 100644 index 000000000000..61d03c8f5cbf --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/stats/class-use/AllocatorStats.PoolArenaStats.html @@ -0,0 +1,92 @@ + + + + +Uses of Class org.apache.pulsar.common.stats.AllocatorStats.PoolArenaStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.stats.AllocatorStats.PoolArenaStats

+
+
Packages that use AllocatorStats.PoolArenaStats
+
+
Package
+
Description
+
org.apache.pulsar.common.stats
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/stats/class-use/AllocatorStats.PoolChunkListStats.html b/static/api/admin/4.0.x/org/apache/pulsar/common/stats/class-use/AllocatorStats.PoolChunkListStats.html new file mode 100644 index 000000000000..f6fa988a5490 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/stats/class-use/AllocatorStats.PoolChunkListStats.html @@ -0,0 +1,89 @@ + + + + +Uses of Class org.apache.pulsar.common.stats.AllocatorStats.PoolChunkListStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.stats.AllocatorStats.PoolChunkListStats

+
+
Packages that use AllocatorStats.PoolChunkListStats
+
+
Package
+
Description
+
org.apache.pulsar.common.stats
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/stats/class-use/AllocatorStats.PoolChunkStats.html b/static/api/admin/4.0.x/org/apache/pulsar/common/stats/class-use/AllocatorStats.PoolChunkStats.html new file mode 100644 index 000000000000..22cdb4acb608 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/stats/class-use/AllocatorStats.PoolChunkStats.html @@ -0,0 +1,89 @@ + + + + +Uses of Class org.apache.pulsar.common.stats.AllocatorStats.PoolChunkStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.stats.AllocatorStats.PoolChunkStats

+
+
Packages that use AllocatorStats.PoolChunkStats
+
+
Package
+
Description
+
org.apache.pulsar.common.stats
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/stats/class-use/AllocatorStats.PoolSubpageStats.html b/static/api/admin/4.0.x/org/apache/pulsar/common/stats/class-use/AllocatorStats.PoolSubpageStats.html new file mode 100644 index 000000000000..516acce351e7 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/stats/class-use/AllocatorStats.PoolSubpageStats.html @@ -0,0 +1,89 @@ + + + + +Uses of Class org.apache.pulsar.common.stats.AllocatorStats.PoolSubpageStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.stats.AllocatorStats.PoolSubpageStats

+
+
Packages that use AllocatorStats.PoolSubpageStats
+
+
Package
+
Description
+
org.apache.pulsar.common.stats
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/stats/class-use/AllocatorStats.html b/static/api/admin/4.0.x/org/apache/pulsar/common/stats/class-use/AllocatorStats.html new file mode 100644 index 000000000000..e0390490943b --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/stats/class-use/AllocatorStats.html @@ -0,0 +1,100 @@ + + + + +Uses of Class org.apache.pulsar.common.stats.AllocatorStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.stats.AllocatorStats

+
+
Packages that use AllocatorStats
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/stats/class-use/AnalyzeSubscriptionBacklogResult.html b/static/api/admin/4.0.x/org/apache/pulsar/common/stats/class-use/AnalyzeSubscriptionBacklogResult.html new file mode 100644 index 000000000000..64c1fc7573c9 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/stats/class-use/AnalyzeSubscriptionBacklogResult.html @@ -0,0 +1,104 @@ + + + + +Uses of Class org.apache.pulsar.common.stats.AnalyzeSubscriptionBacklogResult (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.stats.AnalyzeSubscriptionBacklogResult

+
+
Packages that use AnalyzeSubscriptionBacklogResult
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/stats/class-use/Metrics.html b/static/api/admin/4.0.x/org/apache/pulsar/common/stats/class-use/Metrics.html new file mode 100644 index 000000000000..a19434fd79e6 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/stats/class-use/Metrics.html @@ -0,0 +1,114 @@ + + + + +Uses of Class org.apache.pulsar.common.stats.Metrics (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.stats.Metrics

+
+
Packages that use Metrics
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
org.apache.pulsar.common.stats
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/stats/class-use/PositionInPendingAckStats.State.html b/static/api/admin/4.0.x/org/apache/pulsar/common/stats/class-use/PositionInPendingAckStats.State.html new file mode 100644 index 000000000000..26a7276d6f08 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/stats/class-use/PositionInPendingAckStats.State.html @@ -0,0 +1,115 @@ + + + + +Uses of Enum Class org.apache.pulsar.common.stats.PositionInPendingAckStats.State (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Enum Class
org.apache.pulsar.common.stats.PositionInPendingAckStats.State

+
+
Packages that use PositionInPendingAckStats.State
+
+
Package
+
Description
+
org.apache.pulsar.common.stats
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/stats/class-use/PositionInPendingAckStats.html b/static/api/admin/4.0.x/org/apache/pulsar/common/stats/class-use/PositionInPendingAckStats.html new file mode 100644 index 000000000000..7b60c6c41101 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/stats/class-use/PositionInPendingAckStats.html @@ -0,0 +1,108 @@ + + + + +Uses of Class org.apache.pulsar.common.stats.PositionInPendingAckStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.common.stats.PositionInPendingAckStats

+
+
Packages that use PositionInPendingAckStats
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/stats/package-summary.html b/static/api/admin/4.0.x/org/apache/pulsar/common/stats/package-summary.html new file mode 100644 index 000000000000..17394a355cee --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/stats/package-summary.html @@ -0,0 +1,129 @@ + + + + +org.apache.pulsar.common.stats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Package org.apache.pulsar.common.stats

+
+
+
package org.apache.pulsar.common.stats
+
+
Implementation of policies.
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/stats/package-tree.html b/static/api/admin/4.0.x/org/apache/pulsar/common/stats/package-tree.html new file mode 100644 index 000000000000..5c1dfe4d4adb --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/stats/package-tree.html @@ -0,0 +1,97 @@ + + + + +org.apache.pulsar.common.stats Class Hierarchy (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package org.apache.pulsar.common.stats

+
+Package Hierarchies: + +
+

Class Hierarchy

+ +
+
+

Enum Class Hierarchy

+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/common/stats/package-use.html b/static/api/admin/4.0.x/org/apache/pulsar/common/stats/package-use.html new file mode 100644 index 000000000000..c2931dfacb5c --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/common/stats/package-use.html @@ -0,0 +1,129 @@ + + + + +Uses of Package org.apache.pulsar.common.stats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Package
org.apache.pulsar.common.stats

+
+
Packages that use org.apache.pulsar.common.stats
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
org.apache.pulsar.common.stats
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/packages/management/core/common/PackageMetadata.html b/static/api/admin/4.0.x/org/apache/pulsar/packages/management/core/common/PackageMetadata.html new file mode 100644 index 000000000000..c47dd4e6e3d6 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/packages/management/core/common/PackageMetadata.html @@ -0,0 +1,164 @@ + + + + +PackageMetadata (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.packages.management.core.common
+

Class PackageMetadata

+
+
java.lang.Object +
org.apache.pulsar.packages.management.core.common.PackageMetadata
+
+
+
+
All Implemented Interfaces:
+
Serializable
+
+
+
public class PackageMetadata +extends Object +implements Serializable
+
Package metadata.
+
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      PackageMetadata

      +
      public PackageMetadata()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/packages/management/core/common/PackageType.html b/static/api/admin/4.0.x/org/apache/pulsar/packages/management/core/common/PackageType.html new file mode 100644 index 000000000000..31d0acded234 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/packages/management/core/common/PackageType.html @@ -0,0 +1,276 @@ + + + + +PackageType (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.packages.management.core.common
+

Enum Class PackageType

+
+
java.lang.Object +
java.lang.Enum<PackageType> +
org.apache.pulsar.packages.management.core.common.PackageType
+
+
+
+
+
All Implemented Interfaces:
+
Serializable, Comparable<PackageType>, Constable
+
+
+
public enum PackageType +extends Enum<PackageType>
+
PackageType used to identify the package type. Currently we have three types of packages, function, sink and source.
+
+
+ +
+
+
    + +
  • +
    +

    Enum Constant Details

    +
      +
    • +
      +

      FUNCTION

      +
      public static final PackageType FUNCTION
      +
      +
      • +
    • +
      +

      SINK

      +
      public static final PackageType SINK
      +
      +
      • +
    • +
      +

      SOURCE

      +
      public static final PackageType SOURCE
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      values

      +
      public static PackageType[] values()
      +
      Returns an array containing the constants of this enum class, in +the order they are declared.
      +
      +
      Returns:
      +
      an array containing the constants of this enum class, in the order they are declared
      +
      +
      +
      • +
    • +
      +

      valueOf

      +
      public static PackageType valueOf(String name)
      +
      Returns the enum constant of this class with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this class. (Extraneous whitespace characters are +not permitted.)
      +
      +
      Parameters:
      +
      name - the name of the enum constant to be returned.
      +
      Returns:
      +
      the enum constant with the specified name
      +
      Throws:
      +
      IllegalArgumentException - if this enum class has no constant with the specified name
      +
      NullPointerException - if the argument is null
      +
      +
      +
      • +
    • +
      +

      value

      +
      public String value()
      +
      +
      • +
    • +
      +

      getEnum

      +
      public static PackageType getEnum(String value)
      +
      +
      • +
    • +
      +

      toString

      +
      public String toString()
      +
      +
      Overrides:
      +
      toString in class Enum<PackageType>
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/packages/management/core/common/class-use/PackageMetadata.html b/static/api/admin/4.0.x/org/apache/pulsar/packages/management/core/common/class-use/PackageMetadata.html new file mode 100644 index 000000000000..7adb25fa68fd --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/packages/management/core/common/class-use/PackageMetadata.html @@ -0,0 +1,132 @@ + + + + +Uses of Class org.apache.pulsar.packages.management.core.common.PackageMetadata (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.packages.management.core.common.PackageMetadata

+
+
Packages that use PackageMetadata
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/packages/management/core/common/class-use/PackageType.html b/static/api/admin/4.0.x/org/apache/pulsar/packages/management/core/common/class-use/PackageType.html new file mode 100644 index 000000000000..bed32474cd5b --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/packages/management/core/common/class-use/PackageType.html @@ -0,0 +1,100 @@ + + + + +Uses of Enum Class org.apache.pulsar.packages.management.core.common.PackageType (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Enum Class
org.apache.pulsar.packages.management.core.common.PackageType

+
+
Packages that use PackageType
+
+
Package
+
Description
+
org.apache.pulsar.packages.management.core.common
+
+
Packages management general classes.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/packages/management/core/common/package-summary.html b/static/api/admin/4.0.x/org/apache/pulsar/packages/management/core/common/package-summary.html new file mode 100644 index 000000000000..7fdc5fadb525 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/packages/management/core/common/package-summary.html @@ -0,0 +1,107 @@ + + + + +org.apache.pulsar.packages.management.core.common (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Package org.apache.pulsar.packages.management.core.common

+
+
+
package org.apache.pulsar.packages.management.core.common
+
+
Packages management general classes.
+
+
+
    +
  • +
    +
    +
    +
    +
    Class
    +
    Description
    +
    PackageMetadata
    +
    +
    Package metadata.
    +
    +
    PackageType
    +
    +
    PackageType used to identify the package type.
    +
    +
    +
    +
    +
    • +
+
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/packages/management/core/common/package-tree.html b/static/api/admin/4.0.x/org/apache/pulsar/packages/management/core/common/package-tree.html new file mode 100644 index 000000000000..7c2cb7ac11d1 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/packages/management/core/common/package-tree.html @@ -0,0 +1,90 @@ + + + + +org.apache.pulsar.packages.management.core.common Class Hierarchy (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package org.apache.pulsar.packages.management.core.common

+
+Package Hierarchies: + +
+

Class Hierarchy

+ +
+
+

Enum Class Hierarchy

+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/packages/management/core/common/package-use.html b/static/api/admin/4.0.x/org/apache/pulsar/packages/management/core/common/package-use.html new file mode 100644 index 000000000000..88b5f356fbda --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/packages/management/core/common/package-use.html @@ -0,0 +1,103 @@ + + + + +Uses of Package org.apache.pulsar.packages.management.core.common (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Package
org.apache.pulsar.packages.management.core.common

+
+
Packages that use org.apache.pulsar.packages.management.core.common
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
org.apache.pulsar.packages.management.core.common
+
+
Packages management general classes.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/packages/management/core/exceptions/PackagesManagementException.MetadataFormatException.html b/static/api/admin/4.0.x/org/apache/pulsar/packages/management/core/exceptions/PackagesManagementException.MetadataFormatException.html new file mode 100644 index 000000000000..0348c95fd02f --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/packages/management/core/exceptions/PackagesManagementException.MetadataFormatException.html @@ -0,0 +1,209 @@ + + + + +PackagesManagementException.MetadataFormatException (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.packages.management.core.exceptions
+

Class PackagesManagementException.MetadataFormatException

+
+
java.lang.Object +
java.lang.Throwable +
java.lang.Exception +
org.apache.pulsar.packages.management.core.exceptions.PackagesManagementException +
org.apache.pulsar.packages.management.core.exceptions.PackagesManagementException.MetadataFormatException
+
+
+
+
+
+
+
All Implemented Interfaces:
+
Serializable
+
+
+
Enclosing class:
+
PackagesManagementException
+
+
+
public static class PackagesManagementException.MetadataFormatException +extends PackagesManagementException
+
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      MetadataFormatException

      +
      public MetadataFormatException(String message)
      +
      Constructs an MetadataFormatException with the specified detail message.
      +
      +
      Parameters:
      +
      message - The detail message
      +
      +
      +
      • +
    • +
      +

      MetadataFormatException

      +
      public MetadataFormatException(String message, + Throwable throwable)
      +
      Constructs an MetadataFormatException with the specified detail message and the cause.
      +
      +
      Parameters:
      +
      message - The detail message
      +
      throwable - The cause
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/packages/management/core/exceptions/PackagesManagementException.NotFoundException.html b/static/api/admin/4.0.x/org/apache/pulsar/packages/management/core/exceptions/PackagesManagementException.NotFoundException.html new file mode 100644 index 000000000000..9808549c0873 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/packages/management/core/exceptions/PackagesManagementException.NotFoundException.html @@ -0,0 +1,224 @@ + + + + +PackagesManagementException.NotFoundException (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.packages.management.core.exceptions
+

Class PackagesManagementException.NotFoundException

+
+
java.lang.Object +
java.lang.Throwable +
java.lang.Exception +
org.apache.pulsar.packages.management.core.exceptions.PackagesManagementException +
org.apache.pulsar.packages.management.core.exceptions.PackagesManagementException.NotFoundException
+
+
+
+
+
+
+
All Implemented Interfaces:
+
Serializable
+
+
+
Enclosing class:
+
PackagesManagementException
+
+
+
public static class PackagesManagementException.NotFoundException +extends PackagesManagementException
+
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      NotFoundException

      +
      public NotFoundException(Throwable throwable)
      +
      Constructs an NotFoundException with the specified cause.
      +
      +
      Parameters:
      +
      throwable - The cause
      +
      +
      +
      • +
    • +
      +

      NotFoundException

      +
      public NotFoundException(String message)
      +
      Constructs an NotFoundException with the specified detail message.
      +
      +
      Parameters:
      +
      message - The detail message
      +
      +
      +
      • +
    • +
      +

      NotFoundException

      +
      public NotFoundException(String message, + Throwable throwable)
      +
      Constructs an NotFoundException with the specified detail message and the cause.
      +
      +
      Parameters:
      +
      message - The detail message
      +
      throwable - The cause
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/packages/management/core/exceptions/PackagesManagementException.html b/static/api/admin/4.0.x/org/apache/pulsar/packages/management/core/exceptions/PackagesManagementException.html new file mode 100644 index 000000000000..b44d371fef16 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/packages/management/core/exceptions/PackagesManagementException.html @@ -0,0 +1,232 @@ + + + + +PackagesManagementException (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.packages.management.core.exceptions
+

Class PackagesManagementException

+
+
java.lang.Object +
java.lang.Throwable +
java.lang.Exception +
org.apache.pulsar.packages.management.core.exceptions.PackagesManagementException
+
+
+
+
+
+
All Implemented Interfaces:
+
Serializable
+
+
+
Direct Known Subclasses:
+
PackagesManagementException.MetadataFormatException, PackagesManagementException.NotFoundException
+
+
+
public class PackagesManagementException +extends Exception
+
Packages management related exceptions.
+
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      PackagesManagementException

      +
      public PackagesManagementException(Throwable throwable)
      +
      Constructs an PackagesManagementException with the specified cause.
      +
      +
      Parameters:
      +
      throwable - The cause
      +
      +
      +
      • +
    • +
      +

      PackagesManagementException

      +
      public PackagesManagementException(String message)
      +
      Constructs an PackagesManagementException with the specified detail message.
      +
      +
      Parameters:
      +
      message - The detail message
      +
      +
      +
      • +
    • +
      +

      PackagesManagementException

      +
      public PackagesManagementException(String message, + Throwable throwable)
      +
      Constructs an PackagesManagementException with the specified detail message and the cause.
      +
      +
      Parameters:
      +
      message - The detail message
      +
      throwable - The cause
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/packages/management/core/exceptions/class-use/PackagesManagementException.MetadataFormatException.html b/static/api/admin/4.0.x/org/apache/pulsar/packages/management/core/exceptions/class-use/PackagesManagementException.MetadataFormatException.html new file mode 100644 index 000000000000..59e4f5b3c38a --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/packages/management/core/exceptions/class-use/PackagesManagementException.MetadataFormatException.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.packages.management.core.exceptions.PackagesManagementException.MetadataFormatException (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.packages.management.core.exceptions.PackagesManagementException.MetadataFormatException

+
+No usage of org.apache.pulsar.packages.management.core.exceptions.PackagesManagementException.MetadataFormatException
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/packages/management/core/exceptions/class-use/PackagesManagementException.NotFoundException.html b/static/api/admin/4.0.x/org/apache/pulsar/packages/management/core/exceptions/class-use/PackagesManagementException.NotFoundException.html new file mode 100644 index 000000000000..cbcd64a76e05 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/packages/management/core/exceptions/class-use/PackagesManagementException.NotFoundException.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.packages.management.core.exceptions.PackagesManagementException.NotFoundException (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.packages.management.core.exceptions.PackagesManagementException.NotFoundException

+
+No usage of org.apache.pulsar.packages.management.core.exceptions.PackagesManagementException.NotFoundException
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/packages/management/core/exceptions/class-use/PackagesManagementException.html b/static/api/admin/4.0.x/org/apache/pulsar/packages/management/core/exceptions/class-use/PackagesManagementException.html new file mode 100644 index 000000000000..813d6e327883 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/packages/management/core/exceptions/class-use/PackagesManagementException.html @@ -0,0 +1,92 @@ + + + + +Uses of Class org.apache.pulsar.packages.management.core.exceptions.PackagesManagementException (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.packages.management.core.exceptions.PackagesManagementException

+
+
Packages that use PackagesManagementException
+
+
Package
+
Description
+
org.apache.pulsar.packages.management.core.exceptions
+
+
Exceptions of the packages management service thrown.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/packages/management/core/exceptions/package-summary.html b/static/api/admin/4.0.x/org/apache/pulsar/packages/management/core/exceptions/package-summary.html new file mode 100644 index 000000000000..ce2c2d2145b3 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/packages/management/core/exceptions/package-summary.html @@ -0,0 +1,105 @@ + + + + +org.apache.pulsar.packages.management.core.exceptions (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Package org.apache.pulsar.packages.management.core.exceptions

+
+
+
package org.apache.pulsar.packages.management.core.exceptions
+
+
Exceptions of the packages management service thrown.
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/packages/management/core/exceptions/package-tree.html b/static/api/admin/4.0.x/org/apache/pulsar/packages/management/core/exceptions/package-tree.html new file mode 100644 index 000000000000..81651e419b66 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/packages/management/core/exceptions/package-tree.html @@ -0,0 +1,89 @@ + + + + +org.apache.pulsar.packages.management.core.exceptions Class Hierarchy (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package org.apache.pulsar.packages.management.core.exceptions

+
+Package Hierarchies: + +
+

Class Hierarchy

+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/packages/management/core/exceptions/package-use.html b/static/api/admin/4.0.x/org/apache/pulsar/packages/management/core/exceptions/package-use.html new file mode 100644 index 000000000000..29069fa371ed --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/packages/management/core/exceptions/package-use.html @@ -0,0 +1,88 @@ + + + + +Uses of Package org.apache.pulsar.packages.management.core.exceptions (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Package
org.apache.pulsar.packages.management.core.exceptions

+
+
Packages that use org.apache.pulsar.packages.management.core.exceptions
+
+
Package
+
Description
+
org.apache.pulsar.packages.management.core.exceptions
+
+
Exceptions of the packages management service thrown.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/policies/data/loadbalancer/LoadManagerReport.html b/static/api/admin/4.0.x/org/apache/pulsar/policies/data/loadbalancer/LoadManagerReport.html new file mode 100644 index 000000000000..9c55601b88cb --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/policies/data/loadbalancer/LoadManagerReport.html @@ -0,0 +1,305 @@ + + + + +LoadManagerReport (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.policies.data.loadbalancer
+

Interface LoadManagerReport

+
+
+
+
All Superinterfaces:
+
ServiceLookupData
+
+
+
public interface LoadManagerReport +extends ServiceLookupData
+
This class represents the overall load of the broker - it includes overall SystemResourceUsage and Bundle-usage.
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getCpu

      +
      ResourceUsage getCpu()
      +
      +
      • +
    • +
      +

      getMemory

      +
      ResourceUsage getMemory()
      +
      +
      • +
    • +
      +

      getDirectMemory

      +
      ResourceUsage getDirectMemory()
      +
      +
      • +
    • +
      +

      getBandwidthIn

      +
      ResourceUsage getBandwidthIn()
      +
      +
      • +
    • +
      +

      getBandwidthOut

      +
      ResourceUsage getBandwidthOut()
      +
      +
      • +
    • +
      +

      getLastUpdate

      +
      long getLastUpdate()
      +
      +
      • +
    • +
      +

      getBundleStats

      +
      Map<String,NamespaceBundleStats> getBundleStats()
      +
      +
      • +
    • +
      +

      getNumTopics

      +
      long getNumTopics()
      +
      +
      • +
    • +
      +

      getNumBundles

      +
      int getNumBundles()
      +
      +
      • +
    • +
      +

      getNumConsumers

      +
      int getNumConsumers()
      +
      +
      • +
    • +
      +

      getNumProducers

      +
      int getNumProducers()
      +
      +
      • +
    • +
      +

      getMsgThroughputIn

      +
      double getMsgThroughputIn()
      +
      +
      • +
    • +
      +

      getMsgThroughputOut

      +
      double getMsgThroughputOut()
      +
      +
      • +
    • +
      +

      getMsgRateIn

      +
      double getMsgRateIn()
      +
      +
      • +
    • +
      +

      getMsgRateOut

      +
      double getMsgRateOut()
      +
      +
      • +
    • +
      +

      getBrokerVersionString

      +
      String getBrokerVersionString()
      +
      +
      • +
    • +
      +

      isPersistentTopicsEnabled

      +
      boolean isPersistentTopicsEnabled()
      +
      +
      • +
    • +
      +

      isNonPersistentTopicsEnabled

      +
      boolean isNonPersistentTopicsEnabled()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/policies/data/loadbalancer/NamespaceBundleStats.html b/static/api/admin/4.0.x/org/apache/pulsar/policies/data/loadbalancer/NamespaceBundleStats.html new file mode 100644 index 000000000000..05a74cb71fa7 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/policies/data/loadbalancer/NamespaceBundleStats.html @@ -0,0 +1,340 @@ + + + + +NamespaceBundleStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.policies.data.loadbalancer
+

Class NamespaceBundleStats

+
+
java.lang.Object +
org.apache.pulsar.policies.data.loadbalancer.NamespaceBundleStats
+
+
+
+
All Implemented Interfaces:
+
Serializable, Comparable<NamespaceBundleStats>
+
+
+
public class NamespaceBundleStats +extends Object +implements Comparable<NamespaceBundleStats>, Serializable
+
+
See Also:
+
+ +
+
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    +
      +
    • +
      +

      msgRateIn

      +
      public double msgRateIn
      +
      +
      • +
    • +
      +

      msgThroughputIn

      +
      public double msgThroughputIn
      +
      +
      • +
    • +
      +

      msgRateOut

      +
      public double msgRateOut
      +
      +
      • +
    • +
      +

      msgThroughputOut

      +
      public double msgThroughputOut
      +
      +
      • +
    • +
      +

      consumerCount

      +
      public int consumerCount
      +
      +
      • +
    • +
      +

      producerCount

      +
      public int producerCount
      +
      +
      • +
    • +
      +

      topics

      +
      public long topics
      +
      +
      • +
    • +
      +

      cacheSize

      +
      public long cacheSize
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      NamespaceBundleStats

      +
      public NamespaceBundleStats()
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    + +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/policies/data/loadbalancer/ResourceUsage.html b/static/api/admin/4.0.x/org/apache/pulsar/policies/data/loadbalancer/ResourceUsage.html new file mode 100644 index 000000000000..cd7feeb7b606 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/policies/data/loadbalancer/ResourceUsage.html @@ -0,0 +1,243 @@ + + + + +ResourceUsage (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.policies.data.loadbalancer
+

Class ResourceUsage

+
+
java.lang.Object +
org.apache.pulsar.policies.data.loadbalancer.ResourceUsage
+
+
+
+
public class ResourceUsage +extends Object
+
POJO used to represent any system specific resource usage this is the format that load manager expects it in.
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    +
      +
    • +
      +

      usage

      +
      public final double usage
      +
      +
      • +
    • +
      +

      limit

      +
      public final double limit
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      ResourceUsage

      +
      public ResourceUsage(double usage, + double limit)
      +
      +
      • +
    • +
      +

      ResourceUsage

      +
      public ResourceUsage()
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      compareTo

      +
      public int compareTo(ResourceUsage o)
      +
      this may be wrong since we are comparing available and not the usage.
      +
      +
      Parameters:
      +
      o -
      +
      Returns:
      +
      +
      +
      • +
    • +
      +

      percentUsage

      +
      public float percentUsage()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/policies/data/loadbalancer/ServiceLookupData.html b/static/api/admin/4.0.x/org/apache/pulsar/policies/data/loadbalancer/ServiceLookupData.html new file mode 100644 index 000000000000..a1b9dac26d3d --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/policies/data/loadbalancer/ServiceLookupData.html @@ -0,0 +1,227 @@ + + + + +ServiceLookupData (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package org.apache.pulsar.policies.data.loadbalancer
+

Interface ServiceLookupData

+
+
+
+
All Known Subinterfaces:
+
LoadManagerReport
+
+
+
public interface ServiceLookupData
+
For backwards compatibility purposes.
+
+
+ +
+
+
    + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getWebServiceUrl

      +
      String getWebServiceUrl()
      +
      +
      • +
    • +
      +

      getWebServiceUrlTls

      +
      String getWebServiceUrlTls()
      +
      +
      • +
    • +
      +

      getPulsarServiceUrl

      +
      String getPulsarServiceUrl()
      +
      +
      • +
    • +
      +

      getPulsarServiceUrlTls

      +
      String getPulsarServiceUrlTls()
      +
      +
      • +
    • +
      +

      getProtocols

      +
      Map<String,String> getProtocols()
      +
      Get all the protocols advertised by the broker.
      +
      +
      Returns:
      +
      the protocols advertised by the broker.
      +
      +
      +
      • +
    • +
      +

      getProtocol

      +
      Optional<String> getProtocol(String protocol)
      +
      Get the protocol data of the given protocol.
      +
      +
      Parameters:
      +
      protocol - the protocol advertised by the broker.
      +
      Returns:
      +
      the optional protocol data advertised by the broker.
      +
      +
      +
      • +
    • +
      +

      getLoadManagerClassName

      +
      String getLoadManagerClassName()
      +
      +
      • +
    • +
      +

      getStartTimestamp

      +
      long getStartTimestamp()
      +
      +
      • +
    +
    +
    • +
+
+ +
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/policies/data/loadbalancer/class-use/LoadManagerReport.html b/static/api/admin/4.0.x/org/apache/pulsar/policies/data/loadbalancer/class-use/LoadManagerReport.html new file mode 100644 index 000000000000..a5e68975f29e --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/policies/data/loadbalancer/class-use/LoadManagerReport.html @@ -0,0 +1,100 @@ + + + + +Uses of Interface org.apache.pulsar.policies.data.loadbalancer.LoadManagerReport (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.policies.data.loadbalancer.LoadManagerReport

+
+
Packages that use LoadManagerReport
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/policies/data/loadbalancer/class-use/NamespaceBundleStats.html b/static/api/admin/4.0.x/org/apache/pulsar/policies/data/loadbalancer/class-use/NamespaceBundleStats.html new file mode 100644 index 000000000000..456f648734fa --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/policies/data/loadbalancer/class-use/NamespaceBundleStats.html @@ -0,0 +1,113 @@ + + + + +Uses of Class org.apache.pulsar.policies.data.loadbalancer.NamespaceBundleStats (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.policies.data.loadbalancer.NamespaceBundleStats

+
+
Packages that use NamespaceBundleStats
+
+
Package
+
Description
+
org.apache.pulsar.policies.data.loadbalancer
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/policies/data/loadbalancer/class-use/ResourceUsage.html b/static/api/admin/4.0.x/org/apache/pulsar/policies/data/loadbalancer/class-use/ResourceUsage.html new file mode 100644 index 000000000000..bec07be44dd8 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/policies/data/loadbalancer/class-use/ResourceUsage.html @@ -0,0 +1,112 @@ + + + + +Uses of Class org.apache.pulsar.policies.data.loadbalancer.ResourceUsage (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.apache.pulsar.policies.data.loadbalancer.ResourceUsage

+
+
Packages that use ResourceUsage
+
+
Package
+
Description
+
org.apache.pulsar.policies.data.loadbalancer
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/policies/data/loadbalancer/class-use/ServiceLookupData.html b/static/api/admin/4.0.x/org/apache/pulsar/policies/data/loadbalancer/class-use/ServiceLookupData.html new file mode 100644 index 000000000000..430d9df3b99a --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/policies/data/loadbalancer/class-use/ServiceLookupData.html @@ -0,0 +1,91 @@ + + + + +Uses of Interface org.apache.pulsar.policies.data.loadbalancer.ServiceLookupData (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Interface
org.apache.pulsar.policies.data.loadbalancer.ServiceLookupData

+
+
Packages that use ServiceLookupData
+
+
Package
+
Description
+
org.apache.pulsar.policies.data.loadbalancer
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/policies/data/loadbalancer/package-summary.html b/static/api/admin/4.0.x/org/apache/pulsar/policies/data/loadbalancer/package-summary.html new file mode 100644 index 000000000000..c954cfcc2749 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/policies/data/loadbalancer/package-summary.html @@ -0,0 +1,113 @@ + + + + +org.apache.pulsar.policies.data.loadbalancer (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Package org.apache.pulsar.policies.data.loadbalancer

+
+
+
package org.apache.pulsar.policies.data.loadbalancer
+
+
Implementation of policies.
+
+
+
    +
  • +
    +
    +
    +
    +
    Class
    +
    Description
    +
    LoadManagerReport
    +
    +
    This class represents the overall load of the broker - it includes overall SystemResourceUsage and Bundle-usage.
    +
    +
    NamespaceBundleStats
    +
     
    +
    ResourceUsage
    +
    +
    POJO used to represent any system specific resource usage this is the format that load manager expects it in.
    +
    +
    ServiceLookupData
    +
    +
    For backwards compatibility purposes.
    +
    +
    +
    +
    +
    • +
+
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/policies/data/loadbalancer/package-tree.html b/static/api/admin/4.0.x/org/apache/pulsar/policies/data/loadbalancer/package-tree.html new file mode 100644 index 000000000000..321fd5a7aa30 --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/policies/data/loadbalancer/package-tree.html @@ -0,0 +1,87 @@ + + + + +org.apache.pulsar.policies.data.loadbalancer Class Hierarchy (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package org.apache.pulsar.policies.data.loadbalancer

+
+Package Hierarchies: + +
+

Class Hierarchy

+ +
+
+

Interface Hierarchy

+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/org/apache/pulsar/policies/data/loadbalancer/package-use.html b/static/api/admin/4.0.x/org/apache/pulsar/policies/data/loadbalancer/package-use.html new file mode 100644 index 000000000000..680cafe8ba4a --- /dev/null +++ b/static/api/admin/4.0.x/org/apache/pulsar/policies/data/loadbalancer/package-use.html @@ -0,0 +1,109 @@ + + + + +Uses of Package org.apache.pulsar.policies.data.loadbalancer (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Package
org.apache.pulsar.policies.data.loadbalancer

+
+
Packages that use org.apache.pulsar.policies.data.loadbalancer
+
+
Package
+
Description
+
org.apache.pulsar.client.admin
+
 
+
org.apache.pulsar.policies.data.loadbalancer
+
+
Implementation of policies.
+
+
+
+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/overview-summary.html b/static/api/admin/4.0.x/overview-summary.html new file mode 100644 index 000000000000..de05a57255da --- /dev/null +++ b/static/api/admin/4.0.x/overview-summary.html @@ -0,0 +1,25 @@ + + + + +Pulsar Client Admin :: API 4.0.0 API + + + + + + + + + + +
+ +

index.html

+
+ + diff --git a/static/api/admin/4.0.x/overview-tree.html b/static/api/admin/4.0.x/overview-tree.html new file mode 100644 index 000000000000..3cefad8bcc55 --- /dev/null +++ b/static/api/admin/4.0.x/overview-tree.html @@ -0,0 +1,409 @@ + + + + +Class Hierarchy (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For All Packages

+
+Package Hierarchies: + +
+

Class Hierarchy

+ +
+
+

Interface Hierarchy

+ +
+
+

Enum Class Hierarchy

+ +
+
+ +
+
+ + diff --git a/static/api/admin/4.0.x/package-search-index.js b/static/api/admin/4.0.x/package-search-index.js new file mode 100644 index 000000000000..67391eb590e4 --- /dev/null +++ b/static/api/admin/4.0.x/package-search-index.js @@ -0,0 +1 @@ +packageSearchIndex = [{"l":"All Packages","u":"allpackages-index.html"},{"l":"org.apache.pulsar.client.admin"},{"l":"org.apache.pulsar.client.admin.utils"},{"l":"org.apache.pulsar.common.conf"},{"l":"org.apache.pulsar.common.functions"},{"l":"org.apache.pulsar.common.io"},{"l":"org.apache.pulsar.common.naming"},{"l":"org.apache.pulsar.common.partition"},{"l":"org.apache.pulsar.common.policies"},{"l":"org.apache.pulsar.common.policies.data"},{"l":"org.apache.pulsar.common.policies.data.impl"},{"l":"org.apache.pulsar.common.policies.impl"},{"l":"org.apache.pulsar.common.protocol.schema"},{"l":"org.apache.pulsar.common.stats"},{"l":"org.apache.pulsar.packages.management.core.common"},{"l":"org.apache.pulsar.packages.management.core.exceptions"},{"l":"org.apache.pulsar.policies.data.loadbalancer"}];updateSearchResults(); \ No newline at end of file diff --git a/static/api/admin/4.0.x/resources/glass.png b/static/api/admin/4.0.x/resources/glass.png new file mode 100644 index 0000000000000000000000000000000000000000..a7f591f467a1c0c949bbc510156a0c1afb860a6e GIT binary patch literal 499 zcmVJoRsvExf%rEN>jUL}qZ_~k#FbE+Q;{`;0FZwVNX2n-^JoI; zP;4#$8DIy*Yk-P>VN(DUKmPse7mx+ExD4O|;?E5D0Z5($mjO3`*anwQU^s{ZDK#Lz zj>~{qyaIx5K!t%=G&2IJNzg!ChRpyLkO7}Ry!QaotAHAMpbB3AF(}|_f!G-oI|uK6 z`id_dumai5K%C3Y$;tKS_iqMPHg<*|-@e`liWLAggVM!zAP#@l;=c>S03;{#04Z~5 zN_+ss=Yg6*hTr59mzMwZ@+l~q!+?ft!fF66AXT#wWavHt30bZWFCK%!BNk}LN?0Hg z1VF_nfs`Lm^DjYZ1(1uD0u4CSIr)XAaqW6IT{!St5~1{i=i}zAy76p%_|w8rh@@c0Axr!ns=D-X+|*sY6!@wacG9%)Qn*O zl0sa739kT-&_?#oVxXF6tOnqTD)cZ}2vi$`ZU8RLAlo8=_z#*P3xI~i!lEh+Pdu-L zx{d*wgjtXbnGX_Yf@Tc7Q3YhLhPvc8noGJs2DA~1DySiA&6V{5JzFt ojAY1KXm~va;tU{v7C?Xj0BHw!K;2aXV*mgE07*qoM6N<$f;4TDA^-pY literal 0 HcmV?d00001 diff --git a/static/api/admin/4.0.x/script-dir/jquery-3.6.1.min.js b/static/api/admin/4.0.x/script-dir/jquery-3.6.1.min.js new file mode 100644 index 000000000000..2c69bc908b10 --- /dev/null +++ b/static/api/admin/4.0.x/script-dir/jquery-3.6.1.min.js @@ -0,0 +1,2 @@ +/*! jQuery v3.6.1 | (c) OpenJS Foundation and other contributors | jquery.org/license */ +!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(C,e){"use strict";var t=[],r=Object.getPrototypeOf,s=t.slice,g=t.flat?function(e){return t.flat.call(e)}:function(e){return t.concat.apply([],e)},u=t.push,i=t.indexOf,n={},o=n.toString,y=n.hasOwnProperty,a=y.toString,l=a.call(Object),v={},m=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType&&"function"!=typeof e.item},x=function(e){return null!=e&&e===e.window},E=C.document,c={type:!0,src:!0,nonce:!0,noModule:!0};function b(e,t,n){var r,i,o=(n=n||E).createElement("script");if(o.text=e,t)for(r in c)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function w(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[o.call(e)]||"object":typeof e}var f="3.6.1",S=function(e,t){return new S.fn.init(e,t)};function p(e){var t=!!e&&"length"in e&&e.length,n=w(e);return!m(e)&&!x(e)&&("array"===n||0===t||"number"==typeof t&&0+~]|"+M+")"+M+"*"),U=new RegExp(M+"|>"),X=new RegExp(F),V=new RegExp("^"+I+"$"),G={ID:new RegExp("^#("+I+")"),CLASS:new RegExp("^\\.("+I+")"),TAG:new RegExp("^("+I+"|[*])"),ATTR:new RegExp("^"+W),PSEUDO:new RegExp("^"+F),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+R+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,Q=/^(?:input|select|textarea|button)$/i,J=/^h\d$/i,K=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\[\\da-fA-F]{1,6}"+M+"?|\\\\([^\\r\\n\\f])","g"),ne=function(e,t){var n="0x"+e.slice(1)-65536;return t||(n<0?String.fromCharCode(n+65536):String.fromCharCode(n>>10|55296,1023&n|56320))},re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},oe=function(){T()},ae=be(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{H.apply(t=O.call(p.childNodes),p.childNodes),t[p.childNodes.length].nodeType}catch(e){H={apply:t.length?function(e,t){L.apply(e,O.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&(T(e),e=e||C,E)){if(11!==p&&(u=Z.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&v(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return H.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&d.getElementsByClassName&&e.getElementsByClassName)return H.apply(n,e.getElementsByClassName(i)),n}if(d.qsa&&!N[t+" "]&&(!y||!y.test(t))&&(1!==p||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===p&&(U.test(t)||z.test(t))){(f=ee.test(t)&&ve(e.parentNode)||e)===e&&d.scope||((s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=S)),o=(l=h(t)).length;while(o--)l[o]=(s?"#"+s:":scope")+" "+xe(l[o]);c=l.join(",")}try{return H.apply(n,f.querySelectorAll(c)),n}catch(e){N(t,!0)}finally{s===S&&e.removeAttribute("id")}}}return g(t.replace(B,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[S]=!0,e}function ce(e){var t=C.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){var n=e.split("|"),r=n.length;while(r--)b.attrHandle[n[r]]=t}function pe(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function de(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ye(a){return le(function(o){return o=+o,le(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ve(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}for(e in d=se.support={},i=se.isXML=function(e){var t=e&&e.namespaceURI,n=e&&(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},T=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:p;return r!=C&&9===r.nodeType&&r.documentElement&&(a=(C=r).documentElement,E=!i(C),p!=C&&(n=C.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),d.scope=ce(function(e){return a.appendChild(e).appendChild(C.createElement("div")),"undefined"!=typeof e.querySelectorAll&&!e.querySelectorAll(":scope fieldset div").length}),d.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),d.getElementsByTagName=ce(function(e){return e.appendChild(C.createComment("")),!e.getElementsByTagName("*").length}),d.getElementsByClassName=K.test(C.getElementsByClassName),d.getById=ce(function(e){return a.appendChild(e).id=S,!C.getElementsByName||!C.getElementsByName(S).length}),d.getById?(b.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=d.getElementsByTagName?function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):d.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},b.find.CLASS=d.getElementsByClassName&&function(e,t){if("undefined"!=typeof t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],y=[],(d.qsa=K.test(C.querySelectorAll))&&(ce(function(e){var t;a.appendChild(e).innerHTML="",e.querySelectorAll("[msallowcapture^='']").length&&y.push("[*^$]="+M+"*(?:''|\"\")"),e.querySelectorAll("[selected]").length||y.push("\\["+M+"*(?:value|"+R+")"),e.querySelectorAll("[id~="+S+"-]").length||y.push("~="),(t=C.createElement("input")).setAttribute("name",""),e.appendChild(t),e.querySelectorAll("[name='']").length||y.push("\\["+M+"*name"+M+"*="+M+"*(?:''|\"\")"),e.querySelectorAll(":checked").length||y.push(":checked"),e.querySelectorAll("a#"+S+"+*").length||y.push(".#.+[+~]"),e.querySelectorAll("\\\f"),y.push("[\\r\\n\\f]")}),ce(function(e){e.innerHTML="";var t=C.createElement("input");t.setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),e.querySelectorAll("[name=d]").length&&y.push("name"+M+"*[*^$|!~]?="),2!==e.querySelectorAll(":enabled").length&&y.push(":enabled",":disabled"),a.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&y.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),y.push(",.*:")})),(d.matchesSelector=K.test(c=a.matches||a.webkitMatchesSelector||a.mozMatchesSelector||a.oMatchesSelector||a.msMatchesSelector))&&ce(function(e){d.disconnectedMatch=c.call(e,"*"),c.call(e,"[s!='']:x"),s.push("!=",F)}),y=y.length&&new RegExp(y.join("|")),s=s.length&&new RegExp(s.join("|")),t=K.test(a.compareDocumentPosition),v=t||K.test(a.contains)?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)while(t=t.parentNode)if(t===e)return!0;return!1},j=t?function(e,t){if(e===t)return l=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)==(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!d.sortDetached&&t.compareDocumentPosition(e)===n?e==C||e.ownerDocument==p&&v(p,e)?-1:t==C||t.ownerDocument==p&&v(p,t)?1:u?P(u,e)-P(u,t):0:4&n?-1:1)}:function(e,t){if(e===t)return l=!0,0;var n,r=0,i=e.parentNode,o=t.parentNode,a=[e],s=[t];if(!i||!o)return e==C?-1:t==C?1:i?-1:o?1:u?P(u,e)-P(u,t):0;if(i===o)return pe(e,t);n=e;while(n=n.parentNode)a.unshift(n);n=t;while(n=n.parentNode)s.unshift(n);while(a[r]===s[r])r++;return r?pe(a[r],s[r]):a[r]==p?-1:s[r]==p?1:0}),C},se.matches=function(e,t){return se(e,null,null,t)},se.matchesSelector=function(e,t){if(T(e),d.matchesSelector&&E&&!N[t+" "]&&(!s||!s.test(t))&&(!y||!y.test(t)))try{var n=c.call(e,t);if(n||d.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){N(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return G.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&X.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=m[e+" "];return t||(t=new RegExp("(^|"+M+")"+e+"("+M+"|$)"))&&m(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function j(e,n,r){return m(n)?S.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?S.grep(e,function(e){return e===n!==r}):"string"!=typeof n?S.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(S.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||D,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:q.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof S?t[0]:t,S.merge(this,S.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:E,!0)),N.test(r[1])&&S.isPlainObject(t))for(r in t)m(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=E.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):m(e)?void 0!==n.ready?n.ready(e):e(S):S.makeArray(e,this)}).prototype=S.fn,D=S(E);var L=/^(?:parents|prev(?:Until|All))/,H={children:!0,contents:!0,next:!0,prev:!0};function O(e,t){while((e=e[t])&&1!==e.nodeType);return e}S.fn.extend({has:function(e){var t=S(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,he=/^$|^module$|\/(?:java|ecma)script/i;ce=E.createDocumentFragment().appendChild(E.createElement("div")),(fe=E.createElement("input")).setAttribute("type","radio"),fe.setAttribute("checked","checked"),fe.setAttribute("name","t"),ce.appendChild(fe),v.checkClone=ce.cloneNode(!0).cloneNode(!0).lastChild.checked,ce.innerHTML="",v.noCloneChecked=!!ce.cloneNode(!0).lastChild.defaultValue,ce.innerHTML="",v.option=!!ce.lastChild;var ge={thead:[1,"","
"],col:[2,"","
"],tr:[2,"","
"],td:[3,"","
"],_default:[0,"",""]};function ye(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&A(e,t)?S.merge([e],n):n}function ve(e,t){for(var n=0,r=e.length;n",""]);var me=/<|&#?\w+;/;function xe(e,t,n,r,i){for(var o,a,s,u,l,c,f=t.createDocumentFragment(),p=[],d=0,h=e.length;d\s*$/g;function je(e,t){return A(e,"table")&&A(11!==t.nodeType?t:t.firstChild,"tr")&&S(e).children("tbody")[0]||e}function De(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function qe(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Le(e,t){var n,r,i,o,a,s;if(1===t.nodeType){if(Y.hasData(e)&&(s=Y.get(e).events))for(i in Y.remove(t,"handle events"),s)for(n=0,r=s[i].length;n").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),E.head.appendChild(r[0])},abort:function(){i&&i()}}});var Ut,Xt=[],Vt=/(=)\?(?=&|$)|\?\?/;S.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=Xt.pop()||S.expando+"_"+Ct.guid++;return this[e]=!0,e}}),S.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Vt.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Vt.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=m(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Vt,"$1"+r):!1!==e.jsonp&&(e.url+=(Et.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||S.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=C[r],C[r]=function(){o=arguments},n.always(function(){void 0===i?S(C).removeProp(r):C[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,Xt.push(r)),o&&m(i)&&i(o[0]),o=i=void 0}),"script"}),v.createHTMLDocument=((Ut=E.implementation.createHTMLDocument("").body).innerHTML="
",2===Ut.childNodes.length),S.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(v.createHTMLDocument?((r=(t=E.implementation.createHTMLDocument("")).createElement("base")).href=E.location.href,t.head.appendChild(r)):t=E),o=!n&&[],(i=N.exec(e))?[t.createElement(i[1])]:(i=xe([e],t,o),o&&o.length&&S(o).remove(),S.merge([],i.childNodes)));var r,i,o},S.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(S.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},S.expr.pseudos.animated=function(t){return S.grep(S.timers,function(e){return t===e.elem}).length},S.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=S.css(e,"position"),c=S(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=S.css(e,"top"),u=S.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),m(t)&&(t=t.call(e,n,S.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):c.css(f)}},S.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){S.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===S.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===S.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=S(e).offset()).top+=S.css(e,"borderTopWidth",!0),i.left+=S.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-S.css(r,"marginTop",!0),left:t.left-i.left-S.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===S.css(e,"position"))e=e.offsetParent;return e||re})}}),S.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;S.fn[t]=function(e){return B(this,function(e,t,n){var r;if(x(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),S.each(["top","left"],function(e,n){S.cssHooks[n]=_e(v.pixelPosition,function(e,t){if(t)return t=Be(e,n),Pe.test(t)?S(e).position()[n]+"px":t})}),S.each({Height:"height",Width:"width"},function(a,s){S.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){S.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return B(this,function(e,t,n){var r;return x(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?S.css(e,t,i):S.style(e,t,n,i)},s,n?e:void 0,n)}})}),S.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){S.fn[t]=function(e){return this.on(t,e)}}),S.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)},hover:function(e,t){return this.mouseenter(e).mouseleave(t||e)}}),S.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){S.fn[n]=function(e,t){return 0",options:{classes:{},disabled:!1,create:null},_createWidget:function(t,e){e=x(e||this.defaultElement||this)[0],this.element=x(e),this.uuid=i++,this.eventNamespace="."+this.widgetName+this.uuid,this.bindings=x(),this.hoverable=x(),this.focusable=x(),this.classesElementLookup={},e!==this&&(x.data(e,this.widgetFullName,this),this._on(!0,this.element,{remove:function(t){t.target===e&&this.destroy()}}),this.document=x(e.style?e.ownerDocument:e.document||e),this.window=x(this.document[0].defaultView||this.document[0].parentWindow)),this.options=x.widget.extend({},this.options,this._getCreateOptions(),t),this._create(),this.options.disabled&&this._setOptionDisabled(this.options.disabled),this._trigger("create",null,this._getCreateEventData()),this._init()},_getCreateOptions:function(){return{}},_getCreateEventData:x.noop,_create:x.noop,_init:x.noop,destroy:function(){var i=this;this._destroy(),x.each(this.classesElementLookup,function(t,e){i._removeClass(e,t)}),this.element.off(this.eventNamespace).removeData(this.widgetFullName),this.widget().off(this.eventNamespace).removeAttr("aria-disabled"),this.bindings.off(this.eventNamespace)},_destroy:x.noop,widget:function(){return this.element},option:function(t,e){var i,s,n,o=t;if(0===arguments.length)return x.widget.extend({},this.options);if("string"==typeof t)if(o={},t=(i=t.split(".")).shift(),i.length){for(s=o[t]=x.widget.extend({},this.options[t]),n=0;n
"),i=e.children()[0];return x("body").append(e),t=i.offsetWidth,e.css("overflow","scroll"),t===(i=i.offsetWidth)&&(i=e[0].clientWidth),e.remove(),s=t-i},getScrollInfo:function(t){var e=t.isWindow||t.isDocument?"":t.element.css("overflow-x"),i=t.isWindow||t.isDocument?"":t.element.css("overflow-y"),e="scroll"===e||"auto"===e&&t.widthC(E(s),E(n))?o.important="horizontal":o.important="vertical",c.using.call(this,t,o)}),l.offset(x.extend(u,{using:t}))})},x.ui.position={fit:{left:function(t,e){var i=e.within,s=i.isWindow?i.scrollLeft:i.offset.left,n=i.width,o=t.left-e.collisionPosition.marginLeft,l=s-o,a=o+e.collisionWidth-n-s;e.collisionWidth>n?0n?0",delay:300,options:{icons:{submenu:"ui-icon-caret-1-e"},items:"> *",menus:"ul",position:{my:"left top",at:"right top"},role:"menu",blur:null,focus:null,select:null},_create:function(){this.activeMenu=this.element,this.mouseHandled=!1,this.lastMousePosition={x:null,y:null},this.element.uniqueId().attr({role:this.options.role,tabIndex:0}),this._addClass("ui-menu","ui-widget ui-widget-content"),this._on({"mousedown .ui-menu-item":function(t){t.preventDefault(),this._activateItem(t)},"click .ui-menu-item":function(t){var e=x(t.target),i=x(x.ui.safeActiveElement(this.document[0]));!this.mouseHandled&&e.not(".ui-state-disabled").length&&(this.select(t),t.isPropagationStopped()||(this.mouseHandled=!0),e.has(".ui-menu").length?this.expand(t):!this.element.is(":focus")&&i.closest(".ui-menu").length&&(this.element.trigger("focus",[!0]),this.active&&1===this.active.parents(".ui-menu").length&&clearTimeout(this.timer)))},"mouseenter .ui-menu-item":"_activateItem","mousemove .ui-menu-item":"_activateItem",mouseleave:"collapseAll","mouseleave .ui-menu":"collapseAll",focus:function(t,e){var i=this.active||this._menuItems().first();e||this.focus(t,i)},blur:function(t){this._delay(function(){x.contains(this.element[0],x.ui.safeActiveElement(this.document[0]))||this.collapseAll(t)})},keydown:"_keydown"}),this.refresh(),this._on(this.document,{click:function(t){this._closeOnDocumentClick(t)&&this.collapseAll(t,!0),this.mouseHandled=!1}})},_activateItem:function(t){var e,i;this.previousFilter||t.clientX===this.lastMousePosition.x&&t.clientY===this.lastMousePosition.y||(this.lastMousePosition={x:t.clientX,y:t.clientY},e=x(t.target).closest(".ui-menu-item"),i=x(t.currentTarget),e[0]===i[0]&&(i.is(".ui-state-active")||(this._removeClass(i.siblings().children(".ui-state-active"),null,"ui-state-active"),this.focus(t,i))))},_destroy:function(){var t=this.element.find(".ui-menu-item").removeAttr("role aria-disabled").children(".ui-menu-item-wrapper").removeUniqueId().removeAttr("tabIndex role aria-haspopup");this.element.removeAttr("aria-activedescendant").find(".ui-menu").addBack().removeAttr("role aria-labelledby aria-expanded aria-hidden aria-disabled tabIndex").removeUniqueId().show(),t.children().each(function(){var t=x(this);t.data("ui-menu-submenu-caret")&&t.remove()})},_keydown:function(t){var e,i,s,n=!0;switch(t.keyCode){case x.ui.keyCode.PAGE_UP:this.previousPage(t);break;case x.ui.keyCode.PAGE_DOWN:this.nextPage(t);break;case x.ui.keyCode.HOME:this._move("first","first",t);break;case x.ui.keyCode.END:this._move("last","last",t);break;case x.ui.keyCode.UP:this.previous(t);break;case x.ui.keyCode.DOWN:this.next(t);break;case x.ui.keyCode.LEFT:this.collapse(t);break;case x.ui.keyCode.RIGHT:this.active&&!this.active.is(".ui-state-disabled")&&this.expand(t);break;case x.ui.keyCode.ENTER:case x.ui.keyCode.SPACE:this._activate(t);break;case x.ui.keyCode.ESCAPE:this.collapse(t);break;default:e=this.previousFilter||"",s=n=!1,i=96<=t.keyCode&&t.keyCode<=105?(t.keyCode-96).toString():String.fromCharCode(t.keyCode),clearTimeout(this.filterTimer),i===e?s=!0:i=e+i,e=this._filterMenuItems(i),(e=s&&-1!==e.index(this.active.next())?this.active.nextAll(".ui-menu-item"):e).length||(i=String.fromCharCode(t.keyCode),e=this._filterMenuItems(i)),e.length?(this.focus(t,e),this.previousFilter=i,this.filterTimer=this._delay(function(){delete this.previousFilter},1e3)):delete this.previousFilter}n&&t.preventDefault()},_activate:function(t){this.active&&!this.active.is(".ui-state-disabled")&&(this.active.children("[aria-haspopup='true']").length?this.expand(t):this.select(t))},refresh:function(){var t,e,s=this,n=this.options.icons.submenu,i=this.element.find(this.options.menus);this._toggleClass("ui-menu-icons",null,!!this.element.find(".ui-icon").length),e=i.filter(":not(.ui-menu)").hide().attr({role:this.options.role,"aria-hidden":"true","aria-expanded":"false"}).each(function(){var t=x(this),e=t.prev(),i=x("").data("ui-menu-submenu-caret",!0);s._addClass(i,"ui-menu-icon","ui-icon "+n),e.attr("aria-haspopup","true").prepend(i),t.attr("aria-labelledby",e.attr("id"))}),this._addClass(e,"ui-menu","ui-widget ui-widget-content ui-front"),(t=i.add(this.element).find(this.options.items)).not(".ui-menu-item").each(function(){var t=x(this);s._isDivider(t)&&s._addClass(t,"ui-menu-divider","ui-widget-content")}),i=(e=t.not(".ui-menu-item, .ui-menu-divider")).children().not(".ui-menu").uniqueId().attr({tabIndex:-1,role:this._itemRole()}),this._addClass(e,"ui-menu-item")._addClass(i,"ui-menu-item-wrapper"),t.filter(".ui-state-disabled").attr("aria-disabled","true"),this.active&&!x.contains(this.element[0],this.active[0])&&this.blur()},_itemRole:function(){return{menu:"menuitem",listbox:"option"}[this.options.role]},_setOption:function(t,e){var i;"icons"===t&&(i=this.element.find(".ui-menu-icon"),this._removeClass(i,null,this.options.icons.submenu)._addClass(i,null,e.submenu)),this._super(t,e)},_setOptionDisabled:function(t){this._super(t),this.element.attr("aria-disabled",String(t)),this._toggleClass(null,"ui-state-disabled",!!t)},focus:function(t,e){var i;this.blur(t,t&&"focus"===t.type),this._scrollIntoView(e),this.active=e.first(),i=this.active.children(".ui-menu-item-wrapper"),this._addClass(i,null,"ui-state-active"),this.options.role&&this.element.attr("aria-activedescendant",i.attr("id")),i=this.active.parent().closest(".ui-menu-item").children(".ui-menu-item-wrapper"),this._addClass(i,null,"ui-state-active"),t&&"keydown"===t.type?this._close():this.timer=this._delay(function(){this._close()},this.delay),(i=e.children(".ui-menu")).length&&t&&/^mouse/.test(t.type)&&this._startOpening(i),this.activeMenu=e.parent(),this._trigger("focus",t,{item:e})},_scrollIntoView:function(t){var e,i,s;this._hasScroll()&&(i=parseFloat(x.css(this.activeMenu[0],"borderTopWidth"))||0,s=parseFloat(x.css(this.activeMenu[0],"paddingTop"))||0,e=t.offset().top-this.activeMenu.offset().top-i-s,i=this.activeMenu.scrollTop(),s=this.activeMenu.height(),t=t.outerHeight(),e<0?this.activeMenu.scrollTop(i+e):s",options:{appendTo:null,autoFocus:!1,delay:300,minLength:1,position:{my:"left top",at:"left bottom",collision:"none"},source:null,change:null,close:null,focus:null,open:null,response:null,search:null,select:null},requestIndex:0,pending:0,liveRegionTimer:null,_create:function(){var i,s,n,t=this.element[0].nodeName.toLowerCase(),e="textarea"===t,t="input"===t;this.isMultiLine=e||!t&&this._isContentEditable(this.element),this.valueMethod=this.element[e||t?"val":"text"],this.isNewMenu=!0,this._addClass("ui-autocomplete-input"),this.element.attr("autocomplete","off"),this._on(this.element,{keydown:function(t){if(this.element.prop("readOnly"))s=n=i=!0;else{s=n=i=!1;var e=x.ui.keyCode;switch(t.keyCode){case e.PAGE_UP:i=!0,this._move("previousPage",t);break;case e.PAGE_DOWN:i=!0,this._move("nextPage",t);break;case e.UP:i=!0,this._keyEvent("previous",t);break;case e.DOWN:i=!0,this._keyEvent("next",t);break;case e.ENTER:this.menu.active&&(i=!0,t.preventDefault(),this.menu.select(t));break;case e.TAB:this.menu.active&&this.menu.select(t);break;case e.ESCAPE:this.menu.element.is(":visible")&&(this.isMultiLine||this._value(this.term),this.close(t),t.preventDefault());break;default:s=!0,this._searchTimeout(t)}}},keypress:function(t){if(i)return i=!1,void(this.isMultiLine&&!this.menu.element.is(":visible")||t.preventDefault());if(!s){var e=x.ui.keyCode;switch(t.keyCode){case e.PAGE_UP:this._move("previousPage",t);break;case e.PAGE_DOWN:this._move("nextPage",t);break;case e.UP:this._keyEvent("previous",t);break;case e.DOWN:this._keyEvent("next",t)}}},input:function(t){if(n)return n=!1,void t.preventDefault();this._searchTimeout(t)},focus:function(){this.selectedItem=null,this.previous=this._value()},blur:function(t){clearTimeout(this.searching),this.close(t),this._change(t)}}),this._initSource(),this.menu=x("
    ").appendTo(this._appendTo()).menu({role:null}).hide().attr({unselectable:"on"}).menu("instance"),this._addClass(this.menu.element,"ui-autocomplete","ui-front"),this._on(this.menu.element,{mousedown:function(t){t.preventDefault()},menufocus:function(t,e){var i,s;if(this.isNewMenu&&(this.isNewMenu=!1,t.originalEvent&&/^mouse/.test(t.originalEvent.type)))return this.menu.blur(),void this.document.one("mousemove",function(){x(t.target).trigger(t.originalEvent)});s=e.item.data("ui-autocomplete-item"),!1!==this._trigger("focus",t,{item:s})&&t.originalEvent&&/^key/.test(t.originalEvent.type)&&this._value(s.value),(i=e.item.attr("aria-label")||s.value)&&String.prototype.trim.call(i).length&&(clearTimeout(this.liveRegionTimer),this.liveRegionTimer=this._delay(function(){this.liveRegion.html(x("
    ").text(i))},100))},menuselect:function(t,e){var i=e.item.data("ui-autocomplete-item"),s=this.previous;this.element[0]!==x.ui.safeActiveElement(this.document[0])&&(this.element.trigger("focus"),this.previous=s,this._delay(function(){this.previous=s,this.selectedItem=i})),!1!==this._trigger("select",t,{item:i})&&this._value(i.value),this.term=this._value(),this.close(t),this.selectedItem=i}}),this.liveRegion=x("
    ",{role:"status","aria-live":"assertive","aria-relevant":"additions"}).appendTo(this.document[0].body),this._addClass(this.liveRegion,null,"ui-helper-hidden-accessible"),this._on(this.window,{beforeunload:function(){this.element.removeAttr("autocomplete")}})},_destroy:function(){clearTimeout(this.searching),this.element.removeAttr("autocomplete"),this.menu.element.remove(),this.liveRegion.remove()},_setOption:function(t,e){this._super(t,e),"source"===t&&this._initSource(),"appendTo"===t&&this.menu.element.appendTo(this._appendTo()),"disabled"===t&&e&&this.xhr&&this.xhr.abort()},_isEventTargetInWidget:function(t){var e=this.menu.element[0];return t.target===this.element[0]||t.target===e||x.contains(e,t.target)},_closeOnClickOutside:function(t){this._isEventTargetInWidget(t)||this.close()},_appendTo:function(){var t=this.options.appendTo;return t=!(t=!(t=t&&(t.jquery||t.nodeType?x(t):this.document.find(t).eq(0)))||!t[0]?this.element.closest(".ui-front, dialog"):t).length?this.document[0].body:t},_initSource:function(){var i,s,n=this;Array.isArray(this.options.source)?(i=this.options.source,this.source=function(t,e){e(x.ui.autocomplete.filter(i,t.term))}):"string"==typeof this.options.source?(s=this.options.source,this.source=function(t,e){n.xhr&&n.xhr.abort(),n.xhr=x.ajax({url:s,data:t,dataType:"json",success:function(t){e(t)},error:function(){e([])}})}):this.source=this.options.source},_searchTimeout:function(s){clearTimeout(this.searching),this.searching=this._delay(function(){var t=this.term===this._value(),e=this.menu.element.is(":visible"),i=s.altKey||s.ctrlKey||s.metaKey||s.shiftKey;t&&(e||i)||(this.selectedItem=null,this.search(null,s))},this.options.delay)},search:function(t,e){return t=null!=t?t:this._value(),this.term=this._value(),t.length").append(x("
    ").text(e.label)).appendTo(t)},_move:function(t,e){if(this.menu.element.is(":visible"))return this.menu.isFirstItem()&&/^previous/.test(t)||this.menu.isLastItem()&&/^next/.test(t)?(this.isMultiLine||this._value(this.term),void this.menu.blur()):void this.menu[t](e);this.search(null,e)},widget:function(){return this.menu.element},_value:function(){return this.valueMethod.apply(this.element,arguments)},_keyEvent:function(t,e){this.isMultiLine&&!this.menu.element.is(":visible")||(this._move(t,e),e.preventDefault())},_isContentEditable:function(t){if(!t.length)return!1;var e=t.prop("contentEditable");return"inherit"===e?this._isContentEditable(t.parent()):"true"===e}}),x.extend(x.ui.autocomplete,{escapeRegex:function(t){return t.replace(/[\-\[\]{}()*+?.,\\\^$|#\s]/g,"\\$&")},filter:function(t,e){var i=new RegExp(x.ui.autocomplete.escapeRegex(e),"i");return x.grep(t,function(t){return i.test(t.label||t.value||t)})}}),x.widget("ui.autocomplete",x.ui.autocomplete,{options:{messages:{noResults:"No search results.",results:function(t){return t+(1").text(e))},100))}});x.ui.autocomplete}); \ No newline at end of file diff --git a/static/api/admin/4.0.x/script.js b/static/api/admin/4.0.x/script.js new file mode 100644 index 000000000000..bb9c8a2415d3 --- /dev/null +++ b/static/api/admin/4.0.x/script.js @@ -0,0 +1,253 @@ +/* + * Copyright (c) 2013, 2023, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the LICENSE file that accompanied this code. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +var moduleSearchIndex; +var packageSearchIndex; +var typeSearchIndex; +var memberSearchIndex; +var tagSearchIndex; + +var oddRowColor = "odd-row-color"; +var evenRowColor = "even-row-color"; +var sortAsc = "sort-asc"; +var sortDesc = "sort-desc"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; + +function loadScripts(doc, tag) { + createElem(doc, tag, 'search.js'); + + createElem(doc, tag, 'module-search-index.js'); + createElem(doc, tag, 'package-search-index.js'); + createElem(doc, tag, 'type-search-index.js'); + createElem(doc, tag, 'member-search-index.js'); + createElem(doc, tag, 'tag-search-index.js'); +} + +function createElem(doc, tag, path) { + var script = doc.createElement(tag); + var scriptElement = doc.getElementsByTagName(tag)[0]; + script.src = pathtoroot + path; + scriptElement.parentNode.insertBefore(script, scriptElement); +} + +// Helper for making content containing release names comparable lexicographically +function makeComparable(s) { + return s.toLowerCase().replace(/(\d+)/g, + function(n, m) { + return ("000" + m).slice(-4); + }); +} + +// Switches between two styles depending on a condition +function toggleStyle(classList, condition, trueStyle, falseStyle) { + if (condition) { + classList.remove(falseStyle); + classList.add(trueStyle); + } else { + classList.remove(trueStyle); + classList.add(falseStyle); + } +} + +// Sorts the rows in a table lexicographically by the content of a specific column +function sortTable(header, columnIndex, columns) { + var container = header.parentElement; + var descending = header.classList.contains(sortAsc); + container.querySelectorAll("div.table-header").forEach( + function(header) { + header.classList.remove(sortAsc); + header.classList.remove(sortDesc); + } + ) + var cells = container.children; + var rows = []; + for (var i = columns; i < cells.length; i += columns) { + rows.push(Array.prototype.slice.call(cells, i, i + columns)); + } + var comparator = function(a, b) { + var ka = makeComparable(a[columnIndex].textContent); + var kb = makeComparable(b[columnIndex].textContent); + if (ka < kb) + return descending ? 1 : -1; + if (ka > kb) + return descending ? -1 : 1; + return 0; + }; + var sorted = rows.sort(comparator); + var visible = 0; + sorted.forEach(function(row) { + if (row[0].style.display !== 'none') { + var isEvenRow = visible++ % 2 === 0; + } + row.forEach(function(cell) { + toggleStyle(cell.classList, isEvenRow, evenRowColor, oddRowColor); + container.appendChild(cell); + }) + }); + toggleStyle(header.classList, descending, sortDesc, sortAsc); +} + +// Toggles the visibility of a table category in all tables in a page +function toggleGlobal(checkbox, selected, columns) { + var display = checkbox.checked ? '' : 'none'; + document.querySelectorAll("div.table-tabs").forEach(function(t) { + var id = t.parentElement.getAttribute("id"); + var selectedClass = id + "-tab" + selected; + // if selected is empty string it selects all uncategorized entries + var selectUncategorized = !Boolean(selected); + var visible = 0; + document.querySelectorAll('div.' + id) + .forEach(function(elem) { + if (selectUncategorized) { + if (elem.className.indexOf(selectedClass) === -1) { + elem.style.display = display; + } + } else if (elem.classList.contains(selectedClass)) { + elem.style.display = display; + } + if (elem.style.display === '') { + var isEvenRow = visible++ % (columns * 2) < columns; + toggleStyle(elem.classList, isEvenRow, evenRowColor, oddRowColor); + } + }); + var displaySection = visible === 0 ? 'none' : ''; + t.parentElement.style.display = displaySection; + document.querySelector("li#contents-" + id).style.display = displaySection; + }) +} + +// Shows the elements of a table belonging to a specific category +function show(tableId, selected, columns) { + if (tableId !== selected) { + document.querySelectorAll('div.' + tableId + ':not(.' + selected + ')') + .forEach(function(elem) { + elem.style.display = 'none'; + }); + } + document.querySelectorAll('div.' + selected) + .forEach(function(elem, index) { + elem.style.display = ''; + var isEvenRow = index % (columns * 2) < columns; + toggleStyle(elem.classList, isEvenRow, evenRowColor, oddRowColor); + }); + updateTabs(tableId, selected); +} + +function updateTabs(tableId, selected) { + document.getElementById(tableId + '.tabpanel') + .setAttribute('aria-labelledby', selected); + document.querySelectorAll('button[id^="' + tableId + '"]') + .forEach(function(tab, index) { + if (selected === tab.id || (tableId === selected && index === 0)) { + tab.className = activeTableTab; + tab.setAttribute('aria-selected', true); + tab.setAttribute('tabindex',0); + } else { + tab.className = tableTab; + tab.setAttribute('aria-selected', false); + tab.setAttribute('tabindex',-1); + } + }); +} + +function switchTab(e) { + var selected = document.querySelector('[aria-selected=true]'); + if (selected) { + if ((e.keyCode === 37 || e.keyCode === 38) && selected.previousSibling) { + // left or up arrow key pressed: move focus to previous tab + selected.previousSibling.click(); + selected.previousSibling.focus(); + e.preventDefault(); + } else if ((e.keyCode === 39 || e.keyCode === 40) && selected.nextSibling) { + // right or down arrow key pressed: move focus to next tab + selected.nextSibling.click(); + selected.nextSibling.focus(); + e.preventDefault(); + } + } +} + +var updateSearchResults = function() {}; + +function indexFilesLoaded() { + return moduleSearchIndex + && packageSearchIndex + && typeSearchIndex + && memberSearchIndex + && tagSearchIndex; +} +// Copy the contents of the local snippet to the clipboard +function copySnippet(button) { + copyToClipboard(button.nextElementSibling.innerText); + switchCopyLabel(button, button.firstElementChild); +} +function copyToClipboard(content) { + var textarea = document.createElement("textarea"); + textarea.style.height = 0; + document.body.appendChild(textarea); + textarea.value = content; + textarea.select(); + document.execCommand("copy"); + document.body.removeChild(textarea); +} +function switchCopyLabel(button, span) { + var copied = span.getAttribute("data-copied"); + button.classList.add("visible"); + var initialLabel = span.innerHTML; + span.innerHTML = copied; + setTimeout(function() { + button.classList.remove("visible"); + setTimeout(function() { + if (initialLabel !== copied) { + span.innerHTML = initialLabel; + } + }, 100); + }, 1900); +} +// Workaround for scroll position not being included in browser history (8249133) +document.addEventListener("DOMContentLoaded", function(e) { + var contentDiv = document.querySelector("div.flex-content"); + window.addEventListener("popstate", function(e) { + if (e.state !== null) { + contentDiv.scrollTop = e.state; + } + }); + window.addEventListener("hashchange", function(e) { + history.replaceState(contentDiv.scrollTop, document.title); + }); + var timeoutId; + contentDiv.addEventListener("scroll", function(e) { + if (timeoutId) { + clearTimeout(timeoutId); + } + timeoutId = setTimeout(function() { + history.replaceState(contentDiv.scrollTop, document.title); + }, 100); + }); + if (!location.hash) { + history.replaceState(contentDiv.scrollTop, document.title); + } +}); diff --git a/static/api/admin/4.0.x/search-page.js b/static/api/admin/4.0.x/search-page.js new file mode 100644 index 000000000000..540c90f57c52 --- /dev/null +++ b/static/api/admin/4.0.x/search-page.js @@ -0,0 +1,284 @@ +/* + * Copyright (c) 2022, 2023, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the LICENSE file that accompanied this code. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +"use strict"; +$(function() { + var copy = $("#page-search-copy"); + var expand = $("#page-search-expand"); + var searchLink = $("span#page-search-link"); + var redirect = $("input#search-redirect"); + function setSearchUrlTemplate() { + var href = document.location.href.split(/[#?]/)[0]; + href += "?q=" + "%s"; + if (redirect.is(":checked")) { + href += "&r=1"; + } + searchLink.html(href); + copy[0].onmouseenter(); + } + function copyLink(e) { + copyToClipboard(this.previousSibling.innerText); + switchCopyLabel(this, this.lastElementChild); + } + copy.click(copyLink); + copy[0].onmouseenter = function() {}; + redirect.click(setSearchUrlTemplate); + setSearchUrlTemplate(); + copy.prop("disabled", false); + redirect.prop("disabled", false); + expand.click(function (e) { + var searchInfo = $("div.page-search-info"); + if(this.parentElement.hasAttribute("open")) { + searchInfo.attr("style", "border-width: 0;"); + } else { + searchInfo.attr("style", "border-width: 1px;").height(searchInfo.prop("scrollHeight")); + } + }); +}); +$(window).on("load", function() { + var input = $("#page-search-input"); + var reset = $("#page-search-reset"); + var notify = $("#page-search-notify"); + var resultSection = $("div#result-section"); + var resultContainer = $("div#result-container"); + var searchTerm = ""; + var activeTab = ""; + var fixedTab = false; + var visibleTabs = []; + var feelingLucky = false; + function renderResults(result) { + if (!result.length) { + notify.html(messages.noResult); + } else if (result.length === 1) { + notify.html(messages.oneResult); + } else { + notify.html(messages.manyResults.replace("{0}", result.length)); + } + resultContainer.empty(); + var r = { + "types": [], + "members": [], + "packages": [], + "modules": [], + "searchTags": [] + }; + for (var i in result) { + var item = result[i]; + var arr = r[item.category]; + arr.push(item); + } + if (!activeTab || r[activeTab].length === 0 || !fixedTab) { + Object.keys(r).reduce(function(prev, curr) { + if (r[curr].length > 0 && r[curr][0].score > prev) { + activeTab = curr; + return r[curr][0].score; + } + return prev; + }, 0); + } + if (feelingLucky && activeTab) { + notify.html(messages.redirecting) + var firstItem = r[activeTab][0]; + window.location = getURL(firstItem.indexItem, firstItem.category); + return; + } + if (result.length > 20) { + if (searchTerm[searchTerm.length - 1] === ".") { + if (activeTab === "types" && r["members"].length > r["types"].length) { + activeTab = "members"; + } else if (activeTab === "packages" && r["types"].length > r["packages"].length) { + activeTab = "types"; + } + } + } + var categoryCount = Object.keys(r).reduce(function(prev, curr) { + return prev + (r[curr].length > 0 ? 1 : 0); + }, 0); + visibleTabs = []; + var tabContainer = $("
    ").appendTo(resultContainer); + for (var key in r) { + var id = "#result-tab-" + key.replace("searchTags", "search_tags"); + if (r[key].length) { + var count = r[key].length >= 1000 ? "999+" : r[key].length; + if (result.length > 20 && categoryCount > 1) { + var button = $("").appendTo(tabContainer); + button.click(key, function(e) { + fixedTab = true; + renderResult(e.data, $(this)); + }); + visibleTabs.push(key); + } else { + $("" + categories[key] + + " (" + count + ")").appendTo(tabContainer); + renderTable(key, r[key]).appendTo(resultContainer); + tabContainer = $("
    ").appendTo(resultContainer); + + } + } + } + if (activeTab && result.length > 20 && categoryCount > 1) { + $("button#result-tab-" + activeTab).addClass("active-table-tab"); + renderTable(activeTab, r[activeTab]).appendTo(resultContainer); + } + resultSection.show(); + function renderResult(category, button) { + activeTab = category; + setSearchUrl(); + resultContainer.find("div.summary-table").remove(); + renderTable(activeTab, r[activeTab]).appendTo(resultContainer); + button.siblings().removeClass("active-table-tab"); + button.addClass("active-table-tab"); + } + } + function selectTab(category) { + $("button#result-tab-" + category).click(); + } + function renderTable(category, items) { + var table = $("
    ") + .addClass(category === "modules" + ? "one-column-search-results" + : "two-column-search-results"); + var col1, col2; + if (category === "modules") { + col1 = "Module"; + } else if (category === "packages") { + col1 = "Module"; + col2 = "Package"; + } else if (category === "types") { + col1 = "Package"; + col2 = "Class" + } else if (category === "members") { + col1 = "Class"; + col2 = "Member"; + } else if (category === "searchTags") { + col1 = "Location"; + col2 = "Name"; + } + $("
    " + col1 + "
    ").appendTo(table); + if (category !== "modules") { + $("
    " + col2 + "
    ").appendTo(table); + } + $.each(items, function(index, item) { + var rowColor = index % 2 ? "odd-row-color" : "even-row-color"; + renderItem(item, table, rowColor); + }); + return table; + } + function renderItem(item, table, rowColor) { + var label = getHighlightedText(item.input, item.boundaries, item.prefix.length, item.input.length); + var link = $("") + .attr("href", getURL(item.indexItem, item.category)) + .attr("tabindex", "0") + .addClass("search-result-link") + .html(label); + var container = getHighlightedText(item.input, item.boundaries, 0, item.prefix.length - 1); + if (item.category === "searchTags") { + container = item.indexItem.h || ""; + } + if (item.category !== "modules") { + $("
    ").html(container).addClass("col-plain").addClass(rowColor).appendTo(table); + } + $("
    ").html(link).addClass("col-last").addClass(rowColor).appendTo(table); + } + var timeout; + function schedulePageSearch() { + if (timeout) { + clearTimeout(timeout); + } + timeout = setTimeout(function () { + doPageSearch() + }, 100); + } + function doPageSearch() { + setSearchUrl(); + var term = searchTerm = input.val().trim(); + if (term === "") { + notify.html(messages.enterTerm); + activeTab = ""; + fixedTab = false; + resultContainer.empty(); + resultSection.hide(); + } else { + notify.html(messages.searching); + doSearch({ term: term, maxResults: 1200 }, renderResults); + } + } + function setSearchUrl() { + var query = input.val().trim(); + var url = document.location.pathname; + if (query) { + url += "?q=" + encodeURI(query); + if (activeTab && fixedTab) { + url += "&c=" + activeTab; + } + } + history.replaceState({query: query}, "", url); + } + input.on("input", function(e) { + feelingLucky = false; + schedulePageSearch(); + }); + $(document).keydown(function(e) { + if ((e.ctrlKey || e.metaKey) && (e.key === "ArrowLeft" || e.key === "ArrowRight")) { + if (activeTab && visibleTabs.length > 1) { + var idx = visibleTabs.indexOf(activeTab); + idx += e.key === "ArrowLeft" ? visibleTabs.length - 1 : 1; + selectTab(visibleTabs[idx % visibleTabs.length]); + return false; + } + } + }); + reset.click(function() { + notify.html(messages.enterTerm); + resultSection.hide(); + activeTab = ""; + fixedTab = false; + resultContainer.empty(); + input.val('').focus(); + setSearchUrl(); + }); + input.prop("disabled", false); + reset.prop("disabled", false); + + var urlParams = new URLSearchParams(window.location.search); + if (urlParams.has("q")) { + input.val(urlParams.get("q")) + } + if (urlParams.has("c")) { + activeTab = urlParams.get("c"); + fixedTab = true; + } + if (urlParams.get("r")) { + feelingLucky = true; + } + if (input.val()) { + doPageSearch(); + } else { + notify.html(messages.enterTerm); + } + input.select().focus(); +}); diff --git a/static/api/admin/4.0.x/search.html b/static/api/admin/4.0.x/search.html new file mode 100644 index 000000000000..6fda0e085b22 --- /dev/null +++ b/static/api/admin/4.0.x/search.html @@ -0,0 +1,77 @@ + + + + +Search (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +

    Search

    +
    + + +
    +Additional resources +
    +
    +
    +

    The help page provides an introduction to the scope and syntax of JavaDoc search.

    +

    You can use the <ctrl> or <cmd> keys in combination with the left and right arrow keys to switch between result tabs in this page.

    +

    The URL template below may be used to configure this page as a search engine in browsers that support this feature. It has been tested to work in Google Chrome and Mozilla Firefox. Note that other browsers may not support this feature or require a different URL format.

    +link +

    + +

    +
    +

    Loading search index...

    + +
    + +
    +
    + + diff --git a/static/api/admin/4.0.x/search.js b/static/api/admin/4.0.x/search.js new file mode 100644 index 000000000000..d3986705ef22 --- /dev/null +++ b/static/api/admin/4.0.x/search.js @@ -0,0 +1,458 @@ +/* + * Copyright (c) 2015, 2023, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the LICENSE file that accompanied this code. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ +"use strict"; +const messages = { + enterTerm: "Enter a search term", + noResult: "No results found", + oneResult: "Found one result", + manyResults: "Found {0} results", + loading: "Loading search index...", + searching: "Searching...", + redirecting: "Redirecting to first result...", + linkIcon: "Link icon", + linkToSection: "Link to this section" +} +const categories = { + modules: "Modules", + packages: "Packages", + types: "Classes and Interfaces", + members: "Members", + searchTags: "Search Tags" +}; +const highlight = "$&"; +const NO_MATCH = {}; +const MAX_RESULTS = 300; +function checkUnnamed(name, separator) { + return name === "" || !name ? "" : name + separator; +} +function escapeHtml(str) { + return str.replace(//g, ">"); +} +function getHighlightedText(str, boundaries, from, to) { + var start = from; + var text = ""; + for (var i = 0; i < boundaries.length; i += 2) { + var b0 = boundaries[i]; + var b1 = boundaries[i + 1]; + if (b0 >= to || b1 <= from) { + continue; + } + text += escapeHtml(str.slice(start, Math.max(start, b0))); + text += ""; + text += escapeHtml(str.slice(Math.max(start, b0), Math.min(to, b1))); + text += ""; + start = Math.min(to, b1); + } + text += escapeHtml(str.slice(start, to)); + return text; +} +function getURLPrefix(item, category) { + var urlPrefix = ""; + var slash = "/"; + if (category === "modules") { + return item.l + slash; + } else if (category === "packages" && item.m) { + return item.m + slash; + } else if (category === "types" || category === "members") { + if (item.m) { + urlPrefix = item.m + slash; + } else { + $.each(packageSearchIndex, function(index, it) { + if (it.m && item.p === it.l) { + urlPrefix = it.m + slash; + } + }); + } + } + return urlPrefix; +} +function getURL(item, category) { + if (item.url) { + return item.url; + } + var url = getURLPrefix(item, category); + if (category === "modules") { + url += "module-summary.html"; + } else if (category === "packages") { + if (item.u) { + url = item.u; + } else { + url += item.l.replace(/\./g, '/') + "/package-summary.html"; + } + } else if (category === "types") { + if (item.u) { + url = item.u; + } else { + url += checkUnnamed(item.p, "/").replace(/\./g, '/') + item.l + ".html"; + } + } else if (category === "members") { + url += checkUnnamed(item.p, "/").replace(/\./g, '/') + item.c + ".html" + "#"; + if (item.u) { + url += item.u; + } else { + url += item.l; + } + } else if (category === "searchTags") { + url += item.u; + } + item.url = url; + return url; +} +function createMatcher(term, camelCase) { + if (camelCase && !isUpperCase(term)) { + return null; // no need for camel-case matcher for lower case query + } + var pattern = ""; + var upperCase = []; + term.trim().split(/\s+/).forEach(function(w, index, array) { + var tokens = w.split(/(?=[A-Z,.()<>?[\/])/); + for (var i = 0; i < tokens.length; i++) { + var s = tokens[i]; + // ',' and '?' are the only delimiters commonly followed by space in java signatures + pattern += "(" + $.ui.autocomplete.escapeRegex(s).replace(/[,?]/g, "$&\\s*?") + ")"; + upperCase.push(false); + var isWordToken = /\w$/.test(s); + if (isWordToken) { + if (i === tokens.length - 1 && index < array.length - 1) { + // space in query string matches all delimiters + pattern += "(.*?)"; + upperCase.push(isUpperCase(s[0])); + } else { + if (!camelCase && isUpperCase(s) && s.length === 1) { + pattern += "()"; + } else { + pattern += "([a-z0-9$<>?[\\]]*?)"; + } + upperCase.push(isUpperCase(s[0])); + } + } else { + pattern += "()"; + upperCase.push(false); + } + } + }); + var re = new RegExp(pattern, "gi"); + re.upperCase = upperCase; + return re; +} +function findMatch(matcher, input, startOfName, endOfName) { + var from = startOfName; + matcher.lastIndex = from; + var match = matcher.exec(input); + // Expand search area until we get a valid result or reach the beginning of the string + while (!match || match.index + match[0].length < startOfName || endOfName < match.index) { + if (from === 0) { + return NO_MATCH; + } + from = input.lastIndexOf(".", from - 2) + 1; + matcher.lastIndex = from; + match = matcher.exec(input); + } + var boundaries = []; + var matchEnd = match.index + match[0].length; + var score = 5; + var start = match.index; + var prevEnd = -1; + for (var i = 1; i < match.length; i += 2) { + var isUpper = isUpperCase(input[start]); + var isMatcherUpper = matcher.upperCase[i]; + // capturing groups come in pairs, match and non-match + boundaries.push(start, start + match[i].length); + // make sure groups are anchored on a left word boundary + var prevChar = input[start - 1] || ""; + var nextChar = input[start + 1] || ""; + if (start !== 0 && !/[\W_]/.test(prevChar) && !/[\W_]/.test(input[start])) { + if (isUpper && (isLowerCase(prevChar) || isLowerCase(nextChar))) { + score -= 0.1; + } else if (isMatcherUpper && start === prevEnd) { + score -= isUpper ? 0.1 : 1.0; + } else { + return NO_MATCH; + } + } + prevEnd = start + match[i].length; + start += match[i].length + match[i + 1].length; + + // lower score for parts of the name that are missing + if (match[i + 1] && prevEnd < endOfName) { + score -= rateNoise(match[i + 1]); + } + } + // lower score if a type name contains unmatched camel-case parts + if (input[matchEnd - 1] !== "." && endOfName > matchEnd) + score -= rateNoise(input.slice(matchEnd, endOfName)); + score -= rateNoise(input.slice(0, Math.max(startOfName, match.index))); + + if (score <= 0) { + return NO_MATCH; + } + return { + input: input, + score: score, + boundaries: boundaries + }; +} +function isUpperCase(s) { + return s !== s.toLowerCase(); +} +function isLowerCase(s) { + return s !== s.toUpperCase(); +} +function rateNoise(str) { + return (str.match(/([.(])/g) || []).length / 5 + + (str.match(/([A-Z]+)/g) || []).length / 10 + + str.length / 20; +} +function doSearch(request, response) { + var term = request.term.trim(); + var maxResults = request.maxResults || MAX_RESULTS; + if (term.length === 0) { + return this.close(); + } + var matcher = { + plainMatcher: createMatcher(term, false), + camelCaseMatcher: createMatcher(term, true) + } + var indexLoaded = indexFilesLoaded(); + + function getPrefix(item, category) { + switch (category) { + case "packages": + return checkUnnamed(item.m, "/"); + case "types": + return checkUnnamed(item.p, "."); + case "members": + return checkUnnamed(item.p, ".") + item.c + "."; + default: + return ""; + } + } + function useQualifiedName(category) { + switch (category) { + case "packages": + return /[\s/]/.test(term); + case "types": + case "members": + return /[\s.]/.test(term); + default: + return false; + } + } + function searchIndex(indexArray, category) { + var matches = []; + if (!indexArray) { + if (!indexLoaded) { + matches.push({ l: messages.loading, category: category }); + } + return matches; + } + $.each(indexArray, function (i, item) { + var prefix = getPrefix(item, category); + var simpleName = item.l; + var qualifiedName = prefix + simpleName; + var useQualified = useQualifiedName(category); + var input = useQualified ? qualifiedName : simpleName; + var startOfName = useQualified ? prefix.length : 0; + var endOfName = category === "members" && input.indexOf("(", startOfName) > -1 + ? input.indexOf("(", startOfName) : input.length; + var m = findMatch(matcher.plainMatcher, input, startOfName, endOfName); + if (m === NO_MATCH && matcher.camelCaseMatcher) { + m = findMatch(matcher.camelCaseMatcher, input, startOfName, endOfName); + } + if (m !== NO_MATCH) { + m.indexItem = item; + m.prefix = prefix; + m.category = category; + if (!useQualified) { + m.input = qualifiedName; + m.boundaries = m.boundaries.map(function(b) { + return b + prefix.length; + }); + } + matches.push(m); + } + return true; + }); + return matches.sort(function(e1, e2) { + return e2.score - e1.score; + }).slice(0, maxResults); + } + + var result = searchIndex(moduleSearchIndex, "modules") + .concat(searchIndex(packageSearchIndex, "packages")) + .concat(searchIndex(typeSearchIndex, "types")) + .concat(searchIndex(memberSearchIndex, "members")) + .concat(searchIndex(tagSearchIndex, "searchTags")); + + if (!indexLoaded) { + updateSearchResults = function() { + doSearch(request, response); + } + } else { + updateSearchResults = function() {}; + } + response(result); +} +// JQuery search menu implementation +$.widget("custom.catcomplete", $.ui.autocomplete, { + _create: function() { + this._super(); + this.widget().menu("option", "items", "> .result-item"); + // workaround for search result scrolling + this.menu._scrollIntoView = function _scrollIntoView( item ) { + var borderTop, paddingTop, offset, scroll, elementHeight, itemHeight; + if ( this._hasScroll() ) { + borderTop = parseFloat( $.css( this.activeMenu[ 0 ], "borderTopWidth" ) ) || 0; + paddingTop = parseFloat( $.css( this.activeMenu[ 0 ], "paddingTop" ) ) || 0; + offset = item.offset().top - this.activeMenu.offset().top - borderTop - paddingTop; + scroll = this.activeMenu.scrollTop(); + elementHeight = this.activeMenu.height() - 26; + itemHeight = item.outerHeight(); + + if ( offset < 0 ) { + this.activeMenu.scrollTop( scroll + offset ); + } else if ( offset + itemHeight > elementHeight ) { + this.activeMenu.scrollTop( scroll + offset - elementHeight + itemHeight ); + } + } + }; + }, + _renderMenu: function(ul, items) { + var currentCategory = ""; + var widget = this; + widget.menu.bindings = $(); + $.each(items, function(index, item) { + if (item.category && item.category !== currentCategory) { + ul.append("
  • " + categories[item.category] + "
    • "); + currentCategory = item.category; + } + var li = widget._renderItemData(ul, item); + if (item.category) { + li.attr("aria-label", categories[item.category] + " : " + item.l); + } else { + li.attr("aria-label", item.l); + } + li.attr("class", "result-item"); + }); + ul.append("
  • Go to search page
    • "); + }, + _renderItem: function(ul, item) { + var li = $("
  • ").appendTo(ul); + var div = $("
    ").appendTo(li); + var label = item.l + ? item.l + : getHighlightedText(item.input, item.boundaries, 0, item.input.length); + var idx = item.indexItem; + if (item.category === "searchTags" && idx && idx.h) { + if (idx.d) { + div.html(label + " (" + idx.h + ")
    " + + idx.d + "
    "); + } else { + div.html(label + " (" + idx.h + ")"); + } + } else { + div.html(label); + } + return li; + } +}); +$(function() { + var expanded = false; + var windowWidth; + function collapse() { + if (expanded) { + $("div#navbar-top").removeAttr("style"); + $("button#navbar-toggle-button") + .removeClass("expanded") + .attr("aria-expanded", "false"); + expanded = false; + } + } + $("button#navbar-toggle-button").click(function (e) { + if (expanded) { + collapse(); + } else { + var navbar = $("div#navbar-top"); + navbar.height(navbar.prop("scrollHeight")); + $("button#navbar-toggle-button") + .addClass("expanded") + .attr("aria-expanded", "true"); + expanded = true; + windowWidth = window.innerWidth; + } + }); + $("ul.sub-nav-list-small li a").click(collapse); + $("input#search-input").focus(collapse); + $("main").click(collapse); + $("section[id] > :header, :header[id], :header:has(a[id])").each(function(idx, el) { + // Create anchor links for headers with an associated id attribute + var hdr = $(el); + var id = hdr.attr("id") || hdr.parent("section").attr("id") || hdr.children("a").attr("id"); + if (id) { + hdr.append(" " + messages.linkIcon +""); + } + }); + $(window).on("orientationchange", collapse).on("resize", function(e) { + if (expanded && windowWidth !== window.innerWidth) collapse(); + }); + var search = $("#search-input"); + var reset = $("#reset-button"); + search.catcomplete({ + minLength: 1, + delay: 200, + source: doSearch, + response: function(event, ui) { + if (!ui.content.length) { + ui.content.push({ l: messages.noResult }); + } else { + $("#search-input").empty(); + } + }, + autoFocus: true, + focus: function(event, ui) { + return false; + }, + position: { + collision: "flip" + }, + select: function(event, ui) { + if (ui.item.indexItem) { + var url = getURL(ui.item.indexItem, ui.item.category); + window.location.href = pathtoroot + url; + $("#search-input").focus(); + } + } + }); + search.val(''); + search.prop("disabled", false); + reset.prop("disabled", false); + reset.click(function() { + search.val('').focus(); + }); + search.focus(); +}); diff --git a/static/api/admin/4.0.x/serialized-form.html b/static/api/admin/4.0.x/serialized-form.html new file mode 100644 index 000000000000..36db7cfbfaa2 --- /dev/null +++ b/static/api/admin/4.0.x/serialized-form.html @@ -0,0 +1,292 @@ + + + + +Serialized Form (Pulsar Client Admin :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Serialized Form

    +
    + +
    + +
    +
    + + diff --git a/static/api/admin/4.0.x/stylesheet.css b/static/api/admin/4.0.x/stylesheet.css new file mode 100644 index 000000000000..f71489f86ccd --- /dev/null +++ b/static/api/admin/4.0.x/stylesheet.css @@ -0,0 +1,1272 @@ +/* + * Javadoc style sheet + */ + +@import url('resources/fonts/dejavu.css'); + +/* + * These CSS custom properties (variables) define the core color and font + * properties used in this stylesheet. + */ +:root { + /* body, block and code fonts */ + --body-font-family: 'DejaVu Sans', Arial, Helvetica, sans-serif; + --block-font-family: 'DejaVu Serif', Georgia, "Times New Roman", Times, serif; + --code-font-family: 'DejaVu Sans Mono', monospace; + /* Base font sizes for body and code elements */ + --body-font-size: 14px; + --code-font-size: 14px; + /* Text colors for body and block elements */ + --body-text-color: #353833; + --block-text-color: #474747; + /* Background colors for various structural elements */ + --body-background-color: #ffffff; + --section-background-color: #f8f8f8; + --detail-background-color: #ffffff; + /* Colors for navigation bar and table captions */ + --navbar-background-color: #4D7A97; + --navbar-text-color: #ffffff; + /* Background color for subnavigation and various headers */ + --subnav-background-color: #dee3e9; + /* Background and text colors for selected tabs and navigation items */ + --selected-background-color: #f8981d; + --selected-text-color: #253441; + --selected-link-color: #1f389c; + /* Background colors for generated tables */ + --even-row-color: #ffffff; + --odd-row-color: #eeeeef; + /* Text color for page title */ + --title-color: #2c4557; + /* Text colors for links */ + --link-color: #4A6782; + --link-color-active: #bb7a2a; + /* Snippet colors */ + --snippet-background-color: #ebecee; + --snippet-text-color: var(--block-text-color); + --snippet-highlight-color: #f7c590; + /* Border colors for structural elements and user defined tables */ + --border-color: #ededed; + --table-border-color: #000000; + /* Search input colors */ + --search-input-background-color: #ffffff; + --search-input-text-color: #000000; + --search-input-placeholder-color: #909090; + /* Highlight color for active search tag target */ + --search-tag-highlight-color: #ffff00; + /* Adjustments for icon and active background colors of copy-to-clipboard buttons */ + --copy-icon-brightness: 100%; + --copy-button-background-color-active: rgba(168, 168, 176, 0.3); + /* Colors for invalid tag notifications */ + --invalid-tag-background-color: #ffe6e6; + --invalid-tag-text-color: #000000; +} +/* + * Styles for individual HTML elements. + * + * These are styles that are specific to individual HTML elements. Changing them affects the style of a particular + * HTML element throughout the page. + */ +body { + background-color:var(--body-background-color); + color:var(--body-text-color); + font-family:var(--body-font-family); + font-size:var(--body-font-size); + margin:0; + padding:0; + height:100%; + width:100%; +} +iframe { + margin:0; + padding:0; + height:100%; + width:100%; + overflow-y:scroll; + border:none; +} +a:link, a:visited { + text-decoration:none; + color:var(--link-color); +} +a[href]:hover, a[href]:focus { + text-decoration:none; + color:var(--link-color-active); +} +pre { + font-family:var(--code-font-family); + font-size:1em; +} +h1 { + font-size:1.428em; +} +h2 { + font-size:1.285em; +} +h3 { + font-size:1.14em; +} +h4 { + font-size:1.072em; +} +h5 { + font-size:1.001em; +} +h6 { + font-size:0.93em; +} +/* Disable font boosting for selected elements */ +h1, h2, h3, h4, h5, h6, div.member-signature { + max-height: 1000em; +} +ul { + list-style-type:disc; +} +code, tt { + font-family:var(--code-font-family); +} +:not(h1, h2, h3, h4, h5, h6) > code, +:not(h1, h2, h3, h4, h5, h6) > tt { + font-size:var(--code-font-size); + padding-top:4px; + margin-top:8px; + line-height:1.4em; +} +dt code { + font-family:var(--code-font-family); + font-size:1em; + padding-top:4px; +} +.summary-table dt code { + font-family:var(--code-font-family); + font-size:1em; + vertical-align:top; + padding-top:4px; +} +sup { + font-size:8px; +} +button { + font-family: var(--body-font-family); + font-size: 1em; +} +/* + * Styles for HTML generated by javadoc. + * + * These are style classes that are used by the standard doclet to generate HTML documentation. + */ + +/* + * Styles for document title and copyright. + */ +.about-language { + float:right; + padding:0 21px 8px 8px; + font-size:0.915em; + margin-top:-9px; + height:2.9em; +} +.legal-copy { + margin-left:.5em; +} +/* + * Styles for navigation bar. + */ +@media screen { + div.flex-box { + position:fixed; + display:flex; + flex-direction:column; + height: 100%; + width: 100%; + } + header.flex-header { + flex: 0 0 auto; + } + div.flex-content { + flex: 1 1 auto; + overflow-y: auto; + } +} +.top-nav { + background-color:var(--navbar-background-color); + color:var(--navbar-text-color); + float:left; + width:100%; + clear:right; + min-height:2.8em; + padding:10px 0 0 0; + overflow:hidden; + font-size:0.857em; +} +button#navbar-toggle-button { + display:none; +} +ul.sub-nav-list-small { + display: none; +} +.sub-nav { + background-color:var(--subnav-background-color); + float:left; + width:100%; + overflow:hidden; + font-size:0.857em; +} +.sub-nav div { + clear:left; + float:left; + padding:6px; + text-transform:uppercase; +} +.sub-nav .sub-nav-list { + padding-top:4px; +} +ul.nav-list { + display:block; + margin:0 25px 0 0; + padding:0; +} +ul.sub-nav-list { + float:left; + margin:0 25px 0 0; + padding:0; +} +ul.nav-list li { + list-style:none; + float:left; + padding: 5px 6px; + text-transform:uppercase; +} +.sub-nav .nav-list-search { + float:right; + margin:0; + padding:6px; + clear:none; + text-align:right; + position:relative; +} +ul.sub-nav-list li { + list-style:none; + float:left; +} +.top-nav a:link, .top-nav a:active, .top-nav a:visited { + color:var(--navbar-text-color); + text-decoration:none; + text-transform:uppercase; +} +.top-nav a:hover { + color:var(--link-color-active); +} +.nav-bar-cell1-rev { + background-color:var(--selected-background-color); + color:var(--selected-text-color); + margin: auto 5px; +} +.skip-nav { + position:absolute; + top:auto; + left:-9999px; + overflow:hidden; +} +/* + * Hide navigation links and search box in print layout + */ +@media print { + ul.nav-list, div.sub-nav { + display:none; + } +} +/* + * Styles for page header. + */ +.title { + color:var(--title-color); + margin:10px 0; +} +.sub-title { + margin:5px 0 0 0; +} +ul.contents-list { + margin: 0 0 15px 0; + padding: 0; + list-style: none; +} +ul.contents-list li { + font-size:0.93em; +} +/* + * Styles for headings. + */ +body.class-declaration-page .summary h2, +body.class-declaration-page .details h2, +body.class-use-page h2, +body.module-declaration-page .block-list h2 { + font-style: italic; + padding:0; + margin:15px 0; +} +body.class-declaration-page .summary h3, +body.class-declaration-page .details h3, +body.class-declaration-page .summary .inherited-list h2 { + background-color:var(--subnav-background-color); + border:1px solid var(--border-color); + margin:0 0 6px -8px; + padding:7px 5px; +} +/* + * Styles for page layout containers. + */ +main { + clear:both; + padding:10px 20px; + position:relative; +} +dl.notes > dt { + font-family: var(--body-font-family); + font-size:0.856em; + font-weight:bold; + margin:10px 0 0 0; + color:var(--body-text-color); +} +dl.notes > dd { + margin:5px 10px 10px 0; + font-size:1em; + font-family:var(--block-font-family) +} +dl.name-value > dt { + margin-left:1px; + font-size:1.1em; + display:inline; + font-weight:bold; +} +dl.name-value > dd { + margin:0 0 0 1px; + font-size:1.1em; + display:inline; +} +/* + * Styles for lists. + */ +li.circle { + list-style:circle; +} +ul.horizontal li { + display:inline; + font-size:0.9em; +} +div.inheritance { + margin:0; + padding:0; +} +div.inheritance div.inheritance { + margin-left:2em; +} +ul.block-list, +ul.details-list, +ul.member-list, +ul.summary-list { + margin:10px 0 10px 0; + padding:0; +} +ul.block-list > li, +ul.details-list > li, +ul.member-list > li, +ul.summary-list > li { + list-style:none; + margin-bottom:15px; + line-height:1.4; +} +ul.ref-list { + padding:0; + margin:0; +} +ul.ref-list > li { + list-style:none; +} +.summary-table dl, .summary-table dl dt, .summary-table dl dd { + margin-top:0; + margin-bottom:1px; +} +ul.tag-list, ul.tag-list-long { + padding-left: 0; + list-style: none; +} +ul.tag-list li { + display: inline; +} +ul.tag-list li:not(:last-child):after, +ul.tag-list-long li:not(:last-child):after +{ + content: ", "; + white-space: pre-wrap; +} +ul.preview-feature-list { + list-style: none; + margin:0; + padding:0.1em; + line-height: 1.6em; +} +/* + * Styles for tables. + */ +.summary-table, .details-table { + width:100%; + border-spacing:0; + border:1px solid var(--border-color); + border-top:0; + padding:0; +} +.caption { + position:relative; + text-align:left; + background-repeat:no-repeat; + color:var(--selected-text-color); + clear:none; + overflow:hidden; + padding: 10px 0 0 1px; + margin:0; +} +.caption a:link, .caption a:visited { + color:var(--selected-link-color); +} +.caption a:hover, +.caption a:active { + color:var(--navbar-text-color); +} +.caption span { + font-weight:bold; + white-space:nowrap; + padding:5px 12px 7px 12px; + display:inline-block; + float:left; + background-color:var(--selected-background-color); + border: none; + height:16px; +} +div.table-tabs { + padding:10px 0 0 1px; + margin:10px 0 0 0; +} +div.table-tabs > button { + border: none; + cursor: pointer; + padding: 5px 12px 7px 12px; + font-weight: bold; + margin-right: 8px; +} +div.table-tabs > .active-table-tab { + background: var(--selected-background-color); + color: var(--selected-text-color); +} +div.table-tabs > button.table-tab { + background: var(--navbar-background-color); + color: var(--navbar-text-color); +} +.two-column-search-results { + display: grid; + grid-template-columns: minmax(400px, max-content) minmax(400px, auto); +} +div.checkboxes { + line-height: 2em; +} +div.checkboxes > span { + margin-left: 10px; +} +div.checkboxes > label { + margin-left: 8px; + white-space: nowrap; +} +div.checkboxes > label > input { + margin: 0 2px; +} +.two-column-summary { + display: grid; + grid-template-columns: minmax(25%, max-content) minmax(25%, auto); +} +.three-column-summary { + display: grid; + grid-template-columns: minmax(15%, max-content) minmax(20%, max-content) minmax(20%, auto); +} +.three-column-release-summary { + display: grid; + grid-template-columns: minmax(40%, max-content) minmax(10%, max-content) minmax(40%, auto); +} +.four-column-summary { + display: grid; + grid-template-columns: minmax(10%, max-content) minmax(15%, max-content) minmax(15%, max-content) minmax(15%, auto); +} +@media screen and (max-width: 1000px) { + .four-column-summary { + display: grid; + grid-template-columns: minmax(15%, max-content) minmax(15%, auto); + } +} +@media screen and (max-width: 800px) { + .two-column-search-results { + display: grid; + grid-template-columns: minmax(40%, max-content) minmax(40%, auto); + } + .three-column-summary { + display: grid; + grid-template-columns: minmax(10%, max-content) minmax(25%, auto); + } + .three-column-release-summary { + display: grid; + grid-template-columns: minmax(70%, max-content) minmax(30%, max-content) + } + .three-column-summary .col-last, + .three-column-release-summary .col-last{ + grid-column-end: span 2; + } +} +@media screen and (max-width: 600px) { + .two-column-summary { + display: grid; + grid-template-columns: 1fr; + } +} +.summary-table > div, .details-table > div { + text-align:left; + padding: 8px 3px 3px 7px; + overflow-x: auto; + scrollbar-width: thin; +} +.col-first, .col-second, .col-last, .col-constructor-name, .col-summary-item-name { + vertical-align:top; + padding-right:0; + padding-top:8px; + padding-bottom:3px; +} +.table-header { + background:var(--subnav-background-color); + font-weight: bold; +} +/* Sortable table columns */ +.table-header[onclick] { + cursor: pointer; +} +.table-header[onclick]::after { + content:""; + display:inline-block; + background-image:url('data:image/svg+xml; utf8, \ + \ + '); + background-size:100% 100%; + width:9px; + height:14px; + margin-left:4px; + margin-bottom:-3px; +} +.table-header[onclick].sort-asc::after { + background-image:url('data:image/svg+xml; utf8, \ + \ + \ + '); + +} +.table-header[onclick].sort-desc::after { + background-image:url('data:image/svg+xml; utf8, \ + \ + \ + '); +} +.col-first, .col-first { + font-size:0.93em; +} +.col-second, .col-second, .col-last, .col-constructor-name, .col-summary-item-name, .col-last { + font-size:0.93em; +} +.col-first, .col-second, .col-constructor-name { + vertical-align:top; + overflow: auto; +} +.col-last { + white-space:normal; +} +.col-first a:link, .col-first a:visited, +.col-second a:link, .col-second a:visited, +.col-first a:link, .col-first a:visited, +.col-second a:link, .col-second a:visited, +.col-constructor-name a:link, .col-constructor-name a:visited, +.col-summary-item-name a:link, .col-summary-item-name a:visited { + font-weight:bold; +} +.even-row-color, .even-row-color .table-header { + background-color:var(--even-row-color); +} +.odd-row-color, .odd-row-color .table-header { + background-color:var(--odd-row-color); +} +/* + * Styles for contents. + */ +div.block { + font-size:var(--body-font-size); + font-family:var(--block-font-family); +} +.col-last div { + padding-top:0; +} +.col-last a { + padding-bottom:3px; +} +.module-signature, +.package-signature, +.type-signature, +.member-signature { + font-family:var(--code-font-family); + font-size:1em; + margin:14px 0; + white-space: pre-wrap; +} +.module-signature, +.package-signature, +.type-signature { + margin-top: 0; +} +.member-signature .type-parameters-long, +.member-signature .parameters, +.member-signature .exceptions { + display: inline-block; + vertical-align: top; + white-space: pre; +} +.member-signature .type-parameters { + white-space: normal; +} +/* + * Styles for formatting effect. + */ +.source-line-no { + /* Color of line numbers in source pages can be set via custom property below */ + color:var(--source-linenumber-color, green); + padding:0 30px 0 0; +} +.block { + display:block; + margin:0 10px 5px 0; + color:var(--block-text-color); +} +.deprecated-label, .description-from-type-label, .implementation-label, .member-name-link, +.module-label-in-package, .module-label-in-type, .package-label-in-type, +.package-hierarchy-label, .type-name-label, .type-name-link, .search-tag-link, .preview-label { + font-weight:bold; +} +.deprecation-comment, .help-footnote, .preview-comment { + font-style:italic; +} +.deprecation-block { + font-size:1em; + font-family:var(--block-font-family); + border-style:solid; + border-width:thin; + border-radius:10px; + padding:10px; + margin-bottom:10px; + margin-right:10px; + display:inline-block; +} +.preview-block { + font-size:1em; + font-family:var(--block-font-family); + border-style:solid; + border-width:thin; + border-radius:10px; + padding:10px; + margin-bottom:10px; + margin-right:10px; + display:inline-block; +} +div.block div.deprecation-comment { + font-style:normal; +} +details.invalid-tag, span.invalid-tag { + font-size:1em; + font-family:var(--block-font-family); + color: var(--invalid-tag-text-color); + background: var(--invalid-tag-background-color); + border: thin solid var(--table-border-color); + border-radius:2px; + padding: 2px 4px; + display:inline-block; +} +details summary { + cursor: pointer; +} +/* + * Styles specific to HTML5 elements. + */ +main, nav, header, footer, section { + display:block; +} +/* + * Styles for javadoc search. + */ +.ui-state-active { + /* Overrides the color of selection used in jQuery UI */ + background: var(--selected-background-color); + border: 1px solid var(--selected-background-color); + color: var(--selected-text-color); +} +.ui-autocomplete-category { + font-weight:bold; + font-size:15px; + padding:7px 0 7px 3px; + background-color:var(--navbar-background-color); + color:var(--navbar-text-color); +} +.ui-autocomplete { + max-height:85%; + max-width:65%; + overflow-y:auto; + overflow-x:auto; + scrollbar-width: thin; + white-space:nowrap; + box-shadow: 0 3px 6px rgba(0,0,0,0.16), 0 3px 6px rgba(0,0,0,0.23); +} +ul.ui-autocomplete { + position:fixed; + z-index:1; + background-color: var(--body-background-color); +} +ul.ui-autocomplete li { + float:left; + clear:both; + min-width:100%; +} +ul.ui-autocomplete li.ui-static-link { + position:sticky; + bottom:0; + left:0; + background: var(--subnav-background-color); + padding: 5px 0; + font-family: var(--body-font-family); + font-size: 0.93em; + font-weight: bolder; + z-index: 2; +} +li.ui-static-link a, li.ui-static-link a:visited { + text-decoration:none; + color:var(--link-color); + float:right; + margin-right:20px; +} +.ui-autocomplete .result-item { + font-size: inherit; +} +.ui-autocomplete .result-highlight { + font-weight:bold; +} +#search-input, #page-search-input { + background-image:url('resources/glass.png'); + background-size:13px; + background-repeat:no-repeat; + background-position:2px 3px; + background-color: var(--search-input-background-color); + color: var(--search-input-text-color); + border-color: var(--border-color); + padding-left:20px; + width: 250px; + margin: 0; +} +#search-input { + margin-left: 4px; +} +#reset-button { + background-color: transparent; + background-image:url('resources/x.png'); + background-repeat:no-repeat; + background-size:contain; + border:0; + border-radius:0; + width:12px; + height:12px; + position:absolute; + right:12px; + top:10px; + font-size:0; +} +::placeholder { + color:var(--search-input-placeholder-color); + opacity: 1; +} +.search-tag-desc-result { + font-style:italic; + font-size:11px; +} +.search-tag-holder-result { + font-style:italic; + font-size:12px; +} +.search-tag-result:target { + background-color:var(--search-tag-highlight-color); +} +details.page-search-details { + display: inline-block; +} +div#result-container { + font-size: 1em; +} +div#result-container a.search-result-link { + padding: 0; + margin: 4px 0; + width: 100%; +} +#result-container .result-highlight { + font-weight:bolder; +} +.page-search-info { + background-color: var(--subnav-background-color); + border-radius: 3px; + border: 0 solid var(--border-color); + padding: 0 8px; + overflow: hidden; + height: 0; + transition: all 0.2s ease; +} +div.table-tabs > button.table-tab { + background: var(--navbar-background-color); + color: var(--navbar-text-color); +} +.page-search-header { + padding: 5px 12px 7px 12px; + font-weight: bold; + margin-right: 3px; + background-color:var(--navbar-background-color); + color:var(--navbar-text-color); + display: inline-block; +} +button.page-search-header { + border: none; + cursor: pointer; +} +span#page-search-link { + text-decoration: underline; +} +.module-graph span, .sealed-graph span { + display:none; + position:absolute; +} +.module-graph:hover span, .sealed-graph:hover span { + display:block; + margin: -100px 0 0 100px; + z-index: 1; +} +.inherited-list { + margin: 10px 0 10px 0; +} +section.class-description { + line-height: 1.4; +} +.summary section[class$="-summary"], .details section[class$="-details"], +.class-uses .detail, .serialized-class-details { + padding: 0 20px 5px 10px; + border: 1px solid var(--border-color); + background-color: var(--section-background-color); +} +.inherited-list, section[class$="-details"] .detail { + padding:0 0 5px 8px; + background-color:var(--detail-background-color); + border:none; +} +.vertical-separator { + padding: 0 5px; +} +ul.help-section-list { + margin: 0; +} +ul.help-subtoc > li { + display: inline-block; + padding-right: 5px; + font-size: smaller; +} +ul.help-subtoc > li::before { + content: "\2022" ; + padding-right:2px; +} +.help-note { + font-style: italic; +} +/* + * Indicator icon for external links. + */ +main a[href*="://"]::after { + content:""; + display:inline-block; + background-image:url('data:image/svg+xml; utf8, \ + \ + \ + '); + background-size:100% 100%; + width:7px; + height:7px; + margin-left:2px; + margin-bottom:4px; +} +main a[href*="://"]:hover::after, +main a[href*="://"]:focus::after { + background-image:url('data:image/svg+xml; utf8, \ + \ + \ + '); +} +/* + * Styles for header/section anchor links + */ +a.anchor-link { + opacity: 0; + transition: opacity 0.1s; +} +:hover > a.anchor-link { + opacity: 80%; +} +a.anchor-link:hover, +a.anchor-link:focus-visible, +a.anchor-link.visible { + opacity: 100%; +} +a.anchor-link > img { + width: 0.9em; + height: 0.9em; +} +/* + * Styles for copy-to-clipboard buttons + */ +button.copy { + opacity: 70%; + border: none; + border-radius: 3px; + position: relative; + background:none; + transition: opacity 0.3s; + cursor: pointer; +} +:hover > button.copy { + opacity: 80%; +} +button.copy:hover, +button.copy:active, +button.copy:focus-visible, +button.copy.visible { + opacity: 100%; +} +button.copy img { + position: relative; + background: none; + filter: brightness(var(--copy-icon-brightness)); +} +button.copy:active { + background-color: var(--copy-button-background-color-active); +} +button.copy span { + color: var(--body-text-color); + position: relative; + top: -0.1em; + transition: all 0.1s; + font-size: 0.76rem; + line-height: 1.2em; + opacity: 0; +} +button.copy:hover span, +button.copy:focus-visible span, +button.copy.visible span { + opacity: 100%; +} +/* search page copy button */ +button#page-search-copy { + margin-left: 0.4em; + padding:0.3em; + top:0.13em; +} +button#page-search-copy img { + width: 1.2em; + height: 1.2em; + padding: 0.01em 0; + top: 0.15em; +} +button#page-search-copy span { + color: var(--body-text-color); + line-height: 1.2em; + padding: 0.2em; + top: -0.18em; +} +div.page-search-info:hover button#page-search-copy span { + opacity: 100%; +} +/* snippet copy button */ +button.snippet-copy { + position: absolute; + top: 6px; + right: 6px; + height: 1.7em; + padding: 2px; +} +button.snippet-copy img { + width: 18px; + height: 18px; + padding: 0.05em 0; +} +button.snippet-copy span { + line-height: 1.2em; + padding: 0.2em; + position: relative; + top: -0.5em; +} +div.snippet-container:hover button.snippet-copy span { + opacity: 100%; +} +/* + * Styles for user-provided tables. + * + * borderless: + * No borders, vertical margins, styled caption. + * This style is provided for use with existing doc comments. + * In general, borderless tables should not be used for layout purposes. + * + * plain: + * Plain borders around table and cells, vertical margins, styled caption. + * Best for small tables or for complex tables for tables with cells that span + * rows and columns, when the "striped" style does not work well. + * + * striped: + * Borders around the table and vertical borders between cells, striped rows, + * vertical margins, styled caption. + * Best for tables that have a header row, and a body containing a series of simple rows. + */ + +table.borderless, +table.plain, +table.striped { + margin-top: 10px; + margin-bottom: 10px; +} +table.borderless > caption, +table.plain > caption, +table.striped > caption { + font-weight: bold; + font-size: smaller; +} +table.borderless th, table.borderless td, +table.plain th, table.plain td, +table.striped th, table.striped td { + padding: 2px 5px; +} +table.borderless, +table.borderless > thead > tr > th, table.borderless > tbody > tr > th, table.borderless > tr > th, +table.borderless > thead > tr > td, table.borderless > tbody > tr > td, table.borderless > tr > td { + border: none; +} +table.borderless > thead > tr, table.borderless > tbody > tr, table.borderless > tr { + background-color: transparent; +} +table.plain { + border-collapse: collapse; + border: 1px solid var(--table-border-color); +} +table.plain > thead > tr, table.plain > tbody tr, table.plain > tr { + background-color: transparent; +} +table.plain > thead > tr > th, table.plain > tbody > tr > th, table.plain > tr > th, +table.plain > thead > tr > td, table.plain > tbody > tr > td, table.plain > tr > td { + border: 1px solid var(--table-border-color); +} +table.striped { + border-collapse: collapse; + border: 1px solid var(--table-border-color); +} +table.striped > thead { + background-color: var(--subnav-background-color); +} +table.striped > thead > tr > th, table.striped > thead > tr > td { + border: 1px solid var(--table-border-color); +} +table.striped > tbody > tr:nth-child(even) { + background-color: var(--odd-row-color) +} +table.striped > tbody > tr:nth-child(odd) { + background-color: var(--even-row-color) +} +table.striped > tbody > tr > th, table.striped > tbody > tr > td { + border-left: 1px solid var(--table-border-color); + border-right: 1px solid var(--table-border-color); +} +table.striped > tbody > tr > th { + font-weight: normal; +} +/** + * Tweak style for small screens. + */ +@media screen and (max-width: 920px) { + header.flex-header { + max-height: 100vh; + overflow-y: auto; + } + div#navbar-top { + height: 2.8em; + transition: height 0.35s ease; + } + ul.nav-list { + display: block; + width: 40%; + float:left; + clear: left; + margin: 10px 0 0 0; + padding: 0; + } + ul.nav-list li { + float: none; + padding: 6px; + margin-left: 10px; + margin-top: 2px; + } + ul.sub-nav-list-small { + display:block; + height: 100%; + width: 50%; + float: right; + clear: right; + background-color: var(--subnav-background-color); + color: var(--body-text-color); + margin: 6px 0 0 0; + padding: 0; + } + ul.sub-nav-list-small ul { + padding-left: 20px; + } + ul.sub-nav-list-small a:link, ul.sub-nav-list-small a:visited { + color:var(--link-color); + } + ul.sub-nav-list-small a:hover { + color:var(--link-color-active); + } + ul.sub-nav-list-small li { + list-style:none; + float:none; + padding: 6px; + margin-top: 1px; + text-transform:uppercase; + } + ul.sub-nav-list-small > li { + margin-left: 10px; + } + ul.sub-nav-list-small li p { + margin: 5px 0; + } + div#navbar-sub-list { + display: none; + } + .top-nav a:link, .top-nav a:active, .top-nav a:visited { + display: block; + } + button#navbar-toggle-button { + width: 3.4em; + height: 2.8em; + background-color: transparent; + display: block; + float: left; + border: 0; + margin: 0 10px; + cursor: pointer; + font-size: 10px; + } + button#navbar-toggle-button .nav-bar-toggle-icon { + display: block; + width: 24px; + height: 3px; + margin: 1px 0 4px 0; + border-radius: 2px; + transition: all 0.1s; + background-color: var(--navbar-text-color); + } + button#navbar-toggle-button.expanded span.nav-bar-toggle-icon:nth-child(1) { + transform: rotate(45deg); + transform-origin: 10% 10%; + width: 26px; + } + button#navbar-toggle-button.expanded span.nav-bar-toggle-icon:nth-child(2) { + opacity: 0; + } + button#navbar-toggle-button.expanded span.nav-bar-toggle-icon:nth-child(3) { + transform: rotate(-45deg); + transform-origin: 10% 90%; + width: 26px; + } +} +@media screen and (max-width: 800px) { + .about-language { + padding-right: 16px; + } + ul.nav-list li { + margin-left: 5px; + } + ul.sub-nav-list-small > li { + margin-left: 5px; + } + main { + padding: 10px; + } + .summary section[class$="-summary"], .details section[class$="-details"], + .class-uses .detail, .serialized-class-details { + padding: 0 8px 5px 8px; + } + body { + -webkit-text-size-adjust: none; + } +} +@media screen and (max-width: 400px) { + .about-language { + font-size: 10px; + padding-right: 12px; + } +} +@media screen and (max-width: 400px) { + .nav-list-search { + width: 94%; + } + #search-input, #page-search-input { + width: 70%; + } +} +@media screen and (max-width: 320px) { + .nav-list-search > label { + display: none; + } + .nav-list-search { + width: 90%; + } + #search-input, #page-search-input { + width: 80%; + } +} + +pre.snippet { + background-color: var(--snippet-background-color); + color: var(--snippet-text-color); + padding: 10px; + margin: 12px 0; + overflow: auto; + white-space: pre; +} +div.snippet-container { + position: relative; +} +@media screen and (max-width: 800px) { + pre.snippet { + padding-top: 26px; + } + button.snippet-copy { + top: 4px; + right: 4px; + } +} +pre.snippet .italic { + font-style: italic; +} +pre.snippet .bold { + font-weight: bold; +} +pre.snippet .highlighted { + background-color: var(--snippet-highlight-color); + border-radius: 10%; +} diff --git a/static/api/admin/4.0.x/tag-search-index.js b/static/api/admin/4.0.x/tag-search-index.js new file mode 100644 index 000000000000..bf10aaf6d137 --- /dev/null +++ b/static/api/admin/4.0.x/tag-search-index.js @@ -0,0 +1 @@ +tagSearchIndex = [{"l":"Constant Field Values","h":"","u":"constant-values.html"},{"l":"Serialized Form","h":"","u":"serialized-form.html"}];updateSearchResults(); \ No newline at end of file diff --git a/static/api/admin/4.0.x/type-search-index.js b/static/api/admin/4.0.x/type-search-index.js new file mode 100644 index 000000000000..c6a0575d8b26 --- /dev/null +++ b/static/api/admin/4.0.x/type-search-index.js @@ -0,0 +1 @@ +typeSearchIndex = [{"l":"All Classes and Interfaces","u":"allclasses-index.html"},{"p":"org.apache.pulsar.common.stats","l":"AllocatorStats"},{"p":"org.apache.pulsar.common.stats","l":"AnalyzeSubscriptionBacklogResult"},{"p":"org.apache.pulsar.common.policies.data","l":"AuthAction"},{"p":"org.apache.pulsar.common.functions","l":"AuthenticationConfig"},{"p":"org.apache.pulsar.common.policies.data","l":"AuthPolicies"},{"p":"org.apache.pulsar.common.policies","l":"AutoFailoverPolicy"},{"p":"org.apache.pulsar.common.policies.data","l":"AutoFailoverPolicyData"},{"p":"org.apache.pulsar.common.policies.impl","l":"AutoFailoverPolicyFactory"},{"p":"org.apache.pulsar.common.policies.data","l":"AutoFailoverPolicyType"},{"p":"org.apache.pulsar.common.policies.data","l":"AutoSubscriptionCreationOverride"},{"p":"org.apache.pulsar.common.policies.data.impl","l":"AutoSubscriptionCreationOverrideImpl"},{"p":"org.apache.pulsar.common.policies.data.impl","l":"AutoSubscriptionCreationOverrideImpl.AutoSubscriptionCreationOverrideImplBuilder"},{"p":"org.apache.pulsar.common.policies.data","l":"AutoTopicCreationOverride"},{"p":"org.apache.pulsar.common.policies.data.impl","l":"AutoTopicCreationOverrideImpl"},{"p":"org.apache.pulsar.common.policies.data.impl","l":"AutoTopicCreationOverrideImpl.AutoTopicCreationOverrideImplBuilder"},{"p":"org.apache.pulsar.common.policies.data","l":"BacklogQuota"},{"p":"org.apache.pulsar.common.policies.data.impl","l":"BacklogQuotaImpl"},{"p":"org.apache.pulsar.common.policies.data.impl","l":"BacklogQuotaImpl.BacklogQuotaImplBuilder"},{"p":"org.apache.pulsar.common.policies.data","l":"BacklogQuota.BacklogQuotaType"},{"p":"org.apache.pulsar.common.io","l":"BatchSourceConfig"},{"p":"org.apache.pulsar.common.policies.data","l":"BookieAffinityGroupData"},{"p":"org.apache.pulsar.common.policies.data.impl","l":"BookieAffinityGroupDataImpl"},{"p":"org.apache.pulsar.common.policies.data.impl","l":"BookieAffinityGroupDataImpl.BookieAffinityGroupDataImplBuilder"},{"p":"org.apache.pulsar.common.policies.data","l":"BookieInfo"},{"p":"org.apache.pulsar.common.policies.data.impl","l":"BookieInfoImpl"},{"p":"org.apache.pulsar.common.policies.data.impl","l":"BookieInfoImpl.BookieInfoImplBuilder"},{"p":"org.apache.pulsar.client.admin","l":"Bookies"},{"p":"org.apache.pulsar.common.policies.data","l":"BookiesClusterInfo"},{"p":"org.apache.pulsar.common.policies.data.impl","l":"BookiesClusterInfoImpl"},{"p":"org.apache.pulsar.common.policies.data.impl","l":"BookiesClusterInfoImpl.BookiesClusterInfoImplBuilder"},{"p":"org.apache.pulsar.common.policies.data","l":"BookiesRackConfiguration"},{"p":"org.apache.pulsar.common.policies.data","l":"BrokerAssignment"},{"p":"org.apache.pulsar.common.policies.data","l":"BrokerInfo"},{"p":"org.apache.pulsar.common.policies.data.impl","l":"BrokerInfoImpl"},{"p":"org.apache.pulsar.common.policies.data.impl","l":"BrokerInfoImpl.BrokerInfoImplBuilder"},{"p":"org.apache.pulsar.common.policies.data","l":"BrokerNamespaceIsolationData"},{"p":"org.apache.pulsar.client.admin","l":"Brokers"},{"p":"org.apache.pulsar.client.admin","l":"BrokerStats"},{"p":"org.apache.pulsar.common.policies.data","l":"BrokerStatus"},{"p":"org.apache.pulsar.common.policies.data.impl","l":"BrokerStatusImpl"},{"p":"org.apache.pulsar.common.policies.data.impl","l":"BrokerStatusImpl.BrokerStatusImplBuilder"},{"p":"org.apache.pulsar.common.policies.data","l":"AuthPolicies.Builder"},{"p":"org.apache.pulsar.common.policies.data","l":"AutoFailoverPolicyData.Builder"},{"p":"org.apache.pulsar.common.policies.data","l":"AutoSubscriptionCreationOverride.Builder"},{"p":"org.apache.pulsar.common.policies.data","l":"AutoTopicCreationOverride.Builder"},{"p":"org.apache.pulsar.common.policies.data","l":"BacklogQuota.Builder"},{"p":"org.apache.pulsar.common.policies.data","l":"BookieAffinityGroupData.Builder"},{"p":"org.apache.pulsar.common.policies.data","l":"BookieInfo.Builder"},{"p":"org.apache.pulsar.common.policies.data","l":"BookiesClusterInfo.Builder"},{"p":"org.apache.pulsar.common.policies.data","l":"BrokerInfo.Builder"},{"p":"org.apache.pulsar.common.policies.data","l":"BrokerNamespaceIsolationData.Builder"},{"p":"org.apache.pulsar.common.policies.data","l":"BrokerStatus.Builder"},{"p":"org.apache.pulsar.common.policies.data","l":"BundlesData.Builder"},{"p":"org.apache.pulsar.common.policies.data","l":"ClusterData.Builder"},{"p":"org.apache.pulsar.common.policies.data","l":"ClusterPolicies.Builder"},{"p":"org.apache.pulsar.common.policies.data","l":"DelayedDeliveryPolicies.Builder"},{"p":"org.apache.pulsar.common.policies.data","l":"DispatchRate.Builder"},{"p":"org.apache.pulsar.common.policies.data","l":"FailureDomain.Builder"},{"p":"org.apache.pulsar.common.policies.data","l":"NamespaceIsolationData.Builder"},{"p":"org.apache.pulsar.common.policies.data","l":"OffloadPolicies.Builder"},{"p":"org.apache.pulsar.common.policies.data","l":"TenantInfo.Builder"},{"p":"org.apache.pulsar.common.policies.data","l":"BundlesData"},{"p":"org.apache.pulsar.common.policies.data.impl","l":"BundlesDataImpl"},{"p":"org.apache.pulsar.common.policies.data.impl","l":"BundlesDataImpl.BundlesDataImplBuilder"},{"p":"org.apache.pulsar.common.policies.data","l":"Policies.BundleType"},{"p":"org.apache.pulsar.common.policies.data","l":"ClusterData"},{"p":"org.apache.pulsar.common.policies.data","l":"ClusterPolicies"},{"p":"org.apache.pulsar.client.admin","l":"Clusters"},{"p":"org.apache.pulsar.common.policies.data","l":"ClusterPolicies.ClusterUrl"},{"p":"org.apache.pulsar.common.policies.data","l":"CompactionStats"},{"p":"org.apache.pulsar.client.admin","l":"PulsarAdminException.ConflictException"},{"p":"org.apache.pulsar.client.admin","l":"PulsarAdminException.ConnectException"},{"p":"org.apache.pulsar.common.io","l":"ConnectorDefinition"},{"p":"org.apache.pulsar.common.functions","l":"ConsumerConfig"},{"p":"org.apache.pulsar.common.policies.data","l":"ConsumerStats"},{"p":"org.apache.pulsar.common.functions","l":"CryptoConfig"},{"p":"org.apache.pulsar.common.policies.data","l":"ManagedLedgerInternalStats.CursorStats"},{"p":"org.apache.pulsar.client.admin.utils","l":"DefaultImplementation"},{"p":"org.apache.pulsar.common.policies.data","l":"DelayedDeliveryPolicies"},{"p":"org.apache.pulsar.common.policies.data.impl","l":"DelayedDeliveryPoliciesImpl"},{"p":"org.apache.pulsar.common.policies.data.impl","l":"DelayedDeliveryPoliciesImpl.DelayedDeliveryPoliciesImplBuilder"},{"p":"org.apache.pulsar.common.policies.data","l":"DispatchRate"},{"p":"org.apache.pulsar.common.policies.data.impl","l":"DispatchRateImpl"},{"p":"org.apache.pulsar.common.policies.data.impl","l":"DispatchRateImpl.DispatchRateImplBuilder"},{"p":"org.apache.pulsar.common.policies.data","l":"DrainingHash"},{"p":"org.apache.pulsar.common.policies.data","l":"SchemaMetadata.Entry"},{"p":"org.apache.pulsar.common.policies.data","l":"EntryFilters"},{"p":"org.apache.pulsar.common.policies.data","l":"ErrorData"},{"p":"org.apache.pulsar.common.policies.data","l":"ExceptionInformation"},{"p":"org.apache.pulsar.common.policies.data","l":"FailureDomain"},{"p":"org.apache.pulsar.common.functions","l":"FunctionConfig"},{"p":"org.apache.pulsar.common.functions","l":"FunctionDefinition"},{"p":"org.apache.pulsar.common.policies.data","l":"FunctionInstanceStats"},{"p":"org.apache.pulsar.common.policies.data","l":"FunctionInstanceStatsData"},{"p":"org.apache.pulsar.common.policies.data","l":"FunctionInstanceStatsDataBase"},{"p":"org.apache.pulsar.common.policies.data","l":"FunctionStatus.FunctionInstanceStatus"},{"p":"org.apache.pulsar.common.policies.data","l":"FunctionStatus.FunctionInstanceStatus.FunctionInstanceStatusData"},{"p":"org.apache.pulsar.client.admin","l":"Functions"},{"p":"org.apache.pulsar.common.functions","l":"FunctionState"},{"p":"org.apache.pulsar.common.policies.data","l":"FunctionStats"},{"p":"org.apache.pulsar.common.policies.data","l":"FunctionStatus"},{"p":"org.apache.pulsar.client.admin","l":"GetStatsOptions"},{"p":"org.apache.pulsar.client.admin","l":"PulsarAdminException.GettingAuthenticationDataException"},{"p":"org.apache.pulsar.client.admin","l":"GrantTopicPermissionOptions"},{"p":"org.apache.pulsar.client.admin","l":"PulsarAdminException.HttpErrorException"},{"p":"org.apache.pulsar.common.policies.data","l":"InactiveTopicDeleteMode"},{"p":"org.apache.pulsar.common.policies.data","l":"InactiveTopicPolicies"},{"p":"org.apache.pulsar.common.conf","l":"InternalConfigurationData"},{"p":"org.apache.pulsar.common.protocol.schema","l":"IsCompatibilityResponse"},{"p":"org.apache.pulsar.common.policies.data","l":"ManagedLedgerInternalStats.LedgerInfo"},{"p":"org.apache.pulsar.client.admin","l":"ListNamespaceTopicsOptions"},{"p":"org.apache.pulsar.client.admin","l":"ListTopicsOptions"},{"p":"org.apache.pulsar.policies.data.loadbalancer","l":"LoadManagerReport"},{"p":"org.apache.pulsar.client.admin","l":"LongRunningProcessStatus"},{"p":"org.apache.pulsar.client.admin","l":"Lookup"},{"p":"org.apache.pulsar.common.policies.data","l":"ManagedLedgerInternalStats"},{"p":"org.apache.pulsar.packages.management.core.exceptions","l":"PackagesManagementException.MetadataFormatException"},{"p":"org.apache.pulsar.common.stats","l":"Metrics"},{"p":"org.apache.pulsar.common.policies.impl","l":"MinAvailablePolicy"},{"p":"org.apache.pulsar.client.admin","l":"Mode"},{"p":"org.apache.pulsar.policies.data.loadbalancer","l":"NamespaceBundleStats"},{"p":"org.apache.pulsar.common.policies.data","l":"NamespaceIsolationData"},{"p":"org.apache.pulsar.common.policies.data","l":"NamespaceIsolationPolicyUnloadScope"},{"p":"org.apache.pulsar.common.policies.data","l":"NamespaceOwnershipStatus"},{"p":"org.apache.pulsar.client.admin","l":"Namespaces"},{"p":"org.apache.pulsar.common.policies.data","l":"NonPersistentPartitionedTopicStats"},{"p":"org.apache.pulsar.common.policies.data","l":"NonPersistentPublisherStats"},{"p":"org.apache.pulsar.common.policies.data","l":"NonPersistentReplicatorStats"},{"p":"org.apache.pulsar.common.policies.data","l":"NonPersistentSubscriptionStats"},{"p":"org.apache.pulsar.client.admin","l":"NonPersistentTopics"},{"p":"org.apache.pulsar.common.policies.data","l":"NonPersistentTopicStats"},{"p":"org.apache.pulsar.client.admin","l":"PulsarAdminException.NotAllowedException"},{"p":"org.apache.pulsar.client.admin","l":"PulsarAdminException.NotAuthorizedException"},{"p":"org.apache.pulsar.packages.management.core.exceptions","l":"PackagesManagementException.NotFoundException"},{"p":"org.apache.pulsar.client.admin","l":"PulsarAdminException.NotFoundException"},{"p":"org.apache.pulsar.common.policies.data","l":"OffloadedReadPriority"},{"p":"org.apache.pulsar.common.policies.data","l":"OffloadPolicies"},{"p":"org.apache.pulsar.client.admin","l":"OffloadProcessStatus"},{"p":"org.apache.pulsar.packages.management.core.common","l":"PackageMetadata"},{"p":"org.apache.pulsar.client.admin","l":"Packages"},{"p":"org.apache.pulsar.packages.management.core.exceptions","l":"PackagesManagementException"},{"p":"org.apache.pulsar.packages.management.core.common","l":"PackageType"},{"p":"org.apache.pulsar.common.policies.data","l":"PartitionedTopicInternalStats"},{"p":"org.apache.pulsar.common.partition","l":"PartitionedTopicMetadata"},{"p":"org.apache.pulsar.common.policies.data","l":"PartitionedTopicStats"},{"p":"org.apache.pulsar.common.policies.data","l":"PersistencePolicies"},{"p":"org.apache.pulsar.common.policies.data","l":"PersistentTopicInternalStats"},{"p":"org.apache.pulsar.common.policies.data","l":"Policies"},{"p":"org.apache.pulsar.common.stats","l":"AllocatorStats.PoolArenaStats"},{"p":"org.apache.pulsar.common.stats","l":"AllocatorStats.PoolChunkListStats"},{"p":"org.apache.pulsar.common.stats","l":"AllocatorStats.PoolChunkStats"},{"p":"org.apache.pulsar.common.stats","l":"AllocatorStats.PoolSubpageStats"},{"p":"org.apache.pulsar.common.stats","l":"PositionInPendingAckStats"},{"p":"org.apache.pulsar.common.protocol.schema","l":"PostSchemaPayload"},{"p":"org.apache.pulsar.client.admin","l":"PulsarAdminException.PreconditionFailedException"},{"p":"org.apache.pulsar.common.functions","l":"FunctionConfig.ProcessingGuarantees"},{"p":"org.apache.pulsar.common.functions","l":"WindowConfig.ProcessingGuarantees"},{"p":"org.apache.pulsar.common.functions","l":"ProducerConfig"},{"p":"org.apache.pulsar.client.admin","l":"Properties"},{"p":"org.apache.pulsar.client.admin","l":"ProxyStats"},{"p":"org.apache.pulsar.common.policies.data","l":"PublisherStats"},{"p":"org.apache.pulsar.common.policies.data","l":"PublishRate"},{"p":"org.apache.pulsar.client.admin","l":"PulsarAdmin"},{"p":"org.apache.pulsar.client.admin","l":"PulsarAdminBuilder"},{"p":"org.apache.pulsar.client.admin","l":"PulsarAdminException"},{"p":"org.apache.pulsar.client.admin","l":"Topics.QueryParam"},{"p":"org.apache.pulsar.common.policies.data","l":"RawBookieInfo"},{"p":"org.apache.pulsar.client.admin.utils","l":"ReflectionUtils"},{"p":"org.apache.pulsar.common.policies.data","l":"ReplicatorStats"},{"p":"org.apache.pulsar.common.policies.data","l":"ResourceGroup"},{"p":"org.apache.pulsar.client.admin","l":"ResourceGroups"},{"p":"org.apache.pulsar.common.policies.data","l":"ResourceQuota"},{"p":"org.apache.pulsar.client.admin","l":"ResourceQuotas"},{"p":"org.apache.pulsar.common.functions","l":"Resources"},{"p":"org.apache.pulsar.policies.data.loadbalancer","l":"ResourceUsage"},{"p":"org.apache.pulsar.common.policies.data","l":"RetentionPolicies"},{"p":"org.apache.pulsar.common.policies.data","l":"BacklogQuota.RetentionPolicy"},{"p":"org.apache.pulsar.client.admin","l":"RevokeTopicPermissionOptions"},{"p":"org.apache.pulsar.common.functions","l":"FunctionConfig.Runtime"},{"p":"org.apache.pulsar.common.policies.data","l":"SchemaAutoUpdateCompatibilityStrategy"},{"p":"org.apache.pulsar.common.policies.data","l":"SchemaCompatibilityStrategy"},{"p":"org.apache.pulsar.common.policies.data","l":"SchemaMetadata"},{"p":"org.apache.pulsar.client.admin","l":"Schemas"},{"p":"org.apache.pulsar.common.policies.data","l":"SegmentsStats"},{"p":"org.apache.pulsar.common.policies.data","l":"SegmentStats"},{"p":"org.apache.pulsar.client.admin","l":"PulsarAdminException.ServerSideErrorException"},{"p":"org.apache.pulsar.policies.data.loadbalancer","l":"ServiceLookupData"},{"p":"org.apache.pulsar.client.admin","l":"Sink"},{"p":"org.apache.pulsar.common.io","l":"SinkConfig"},{"p":"org.apache.pulsar.common.policies.data","l":"SinkStatus.SinkInstanceStatus"},{"p":"org.apache.pulsar.common.policies.data","l":"SinkStatus.SinkInstanceStatus.SinkInstanceStatusData"},{"p":"org.apache.pulsar.client.admin","l":"Sinks"},{"p":"org.apache.pulsar.common.policies.data","l":"SinkStatus"},{"p":"org.apache.pulsar.common.policies.data","l":"SnapshotSystemTopicInternalStats"},{"p":"org.apache.pulsar.client.admin","l":"Source"},{"p":"org.apache.pulsar.common.io","l":"SourceConfig"},{"p":"org.apache.pulsar.common.policies.data","l":"SourceStatus.SourceInstanceStatus"},{"p":"org.apache.pulsar.common.policies.data","l":"SourceStatus.SourceInstanceStatus.SourceInstanceStatusData"},{"p":"org.apache.pulsar.client.admin","l":"Sources"},{"p":"org.apache.pulsar.common.policies.data","l":"SourceStatus"},{"p":"org.apache.pulsar.common.stats","l":"PositionInPendingAckStats.State"},{"p":"org.apache.pulsar.client.admin","l":"LongRunningProcessStatus.Status"},{"p":"org.apache.pulsar.common.policies.data","l":"SubscribeRate"},{"p":"org.apache.pulsar.common.policies.data","l":"SubscriptionAuthMode"},{"p":"org.apache.pulsar.common.policies.data","l":"SubscriptionStats"},{"p":"org.apache.pulsar.common.policies.data","l":"TenantInfo"},{"p":"org.apache.pulsar.client.admin","l":"Tenants"},{"p":"org.apache.pulsar.client.admin","l":"PulsarAdminException.TimeoutException"},{"p":"org.apache.pulsar.common.naming","l":"TopicDomain"},{"p":"org.apache.pulsar.common.policies.data","l":"TopicHashPositions"},{"p":"org.apache.pulsar.client.admin","l":"TopicPolicies"},{"p":"org.apache.pulsar.client.admin","l":"Topics"},{"p":"org.apache.pulsar.common.policies.data","l":"TopicStats"},{"p":"org.apache.pulsar.common.policies.data","l":"TopicType"},{"p":"org.apache.pulsar.common.naming","l":"TopicVersion"},{"p":"org.apache.pulsar.common.policies.data","l":"TransactionBufferInternalStats"},{"p":"org.apache.pulsar.common.policies.data","l":"TransactionBufferStats"},{"p":"org.apache.pulsar.common.policies.data","l":"TransactionCoordinatorInfo"},{"p":"org.apache.pulsar.common.policies.data","l":"TransactionCoordinatorInternalStats"},{"p":"org.apache.pulsar.common.policies.data","l":"TransactionCoordinatorStats"},{"p":"org.apache.pulsar.common.policies.data","l":"TransactionCoordinatorStatus"},{"p":"org.apache.pulsar.common.policies.data","l":"TransactionInBufferStats"},{"p":"org.apache.pulsar.common.policies.data","l":"TransactionInPendingAckStats"},{"p":"org.apache.pulsar.common.policies.data","l":"TransactionLogStats"},{"p":"org.apache.pulsar.common.policies.data","l":"TransactionMetadata"},{"p":"org.apache.pulsar.common.policies.data","l":"TransactionPendingAckInternalStats"},{"p":"org.apache.pulsar.common.policies.data","l":"TransactionPendingAckStats"},{"p":"org.apache.pulsar.client.admin","l":"Transactions"},{"p":"org.apache.pulsar.common.functions","l":"UpdateOptions"},{"p":"org.apache.pulsar.common.policies.data","l":"ValidateResult"},{"p":"org.apache.pulsar.common.functions","l":"WindowConfig"},{"p":"org.apache.pulsar.client.admin","l":"Worker"},{"p":"org.apache.pulsar.common.policies.data","l":"WorkerFunctionInstanceStats"},{"p":"org.apache.pulsar.common.functions","l":"WorkerInfo"}];updateSearchResults(); \ No newline at end of file diff --git a/static/api/client/4.0.x/allclasses-index.html b/static/api/client/4.0.x/allclasses-index.html new file mode 100644 index 000000000000..e3659e937bbc --- /dev/null +++ b/static/api/client/4.0.x/allclasses-index.html @@ -0,0 +1,747 @@ + + + + +All Classes and Interfaces (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    All Classes and Interfaces

    +
    +
    +
    +
    +
    +
    Class
    +
    Description
    +
    AuthData
    +
    +
    Authentication data.
    +
    +
    Authentication
    +
    +
    Interface of authentication providers.
    +
    +
    AuthenticationDataProvider
    +
    +
    Interface for accessing data which are used in variety of authentication schemes on client side.
    +
    +
    AuthenticationFactory
    +
    +
    Factory class that allows to create Authentication instances + for all the supported authentication methods.
    +
    +
    AutoClusterFailoverBuilder
    +
    +
    AutoClusterFailoverBuilder is used to configure and create instance of ServiceUrlProvider.
    +
    +
    AutoClusterFailoverBuilder.FailoverPolicy
    +
     
    +
    BatcherBuilder
    +
    +
    Batcher builder.
    +
    +
    BatchMessageContainer
    +
    +
    Batch message container for individual messages being published until they are batched and sent to broker.
    +
    +
    BatchReceivePolicy
    +
    +
    Configuration for message batch receive Consumer.batchReceive() Consumer.batchReceiveAsync().
    +
    +
    BatchReceivePolicy.Builder
    +
    +
    Builder of BatchReceivePolicy.
    +
    +
    ClientBuilder
    +
    +
    Builder interface that is used to configure and construct a PulsarClient instance.
    +
    +
    CompressionType
    +
    +
    The compression type that can be specified on a Producer.
    +
    +
    Consumer<T>
    +
    +
    An interface that abstracts behavior of Pulsar's consumer.
    +
    +
    ConsumerBuilder<T>
    +
    +
    ConsumerBuilder is used to configure and create instances of Consumer.
    +
    +
    ConsumerCryptoFailureAction
    +
    +
    The action a consumer should take when a consumer receives a + message that it cannot decrypt.
    +
    +
    ConsumerEventListener
    +
    +
    Listener on the consumer state changes.
    +
    +
    ConsumerInterceptor<T>
    +
    +
    A plugin interface that allows you to intercept (and possibly mutate) + messages received by the consumer.
    +
    +
    ConsumerStats
    +
    Deprecated. +
    use ClientBuilder.openTelemetry(OpenTelemetry) to enable stats
    +
    +
    ControlledClusterFailoverBuilder
    +
    +
    ControlledClusterFailoverBuilder is used to configure and create instance of ServiceUrlProvider.
    +
    +
    CryptoKeyReader
    +
    +
    Interface that abstracts the access to a key store.
    +
    +
    DeadLetterPolicy
    +
    +
    Configuration for the "dead letter queue" feature in consumer.
    +
    +
    DefaultImplementation
    +
    +
    This class loads the implementation for PulsarClientImplementationBinding + and allows you to decouple the API from the actual implementation.
    +
    +
    DummyCryptoKeyReaderImpl
    +
    +
    An empty implement.
    +
    +
    EncodedAuthenticationParameterSupport
    +
    +
    Support for encoded authentication configuration parameters.
    +
    +
    EncryptionContext
    +
    +
    Class representing an encryption context.
    +
    +
    EncryptionContext.EncryptionKey
    +
    +
    Encryption key with metadata.
    +
    +
    EncryptionKeyInfo
    +
    +
    EncryptionKeyInfo contains the encryption key and corresponding metadata which contains additional information about + the key such as version, timestamp.
    +
    +
    Field
    +
    +
    A field in a record, consisting of a field name, index, and + Schema for the field value.
    +
    +
    FieldSchemaBuilder<T>
    +
    +
    Build a field for a record.
    +
    +
    GenericObject
    +
    +
    This is an abstraction over the logical value that is store into a Message.
    +
    +
    GenericRecord
    +
    +
    An interface represents a message with schema.
    +
    +
    GenericRecordBuilder
    +
    +
    Generic Record Builder to build a GenericRecord.
    +
    +
    GenericSchema<T>
    +
    +
    A schema that serializes and deserializes between GenericRecord and bytes.
    +
    +
    HashingScheme
    +
    +
    Standard hashing functions available when choosing the partition to use for a particular message.
    +
    +
    InterfaceAudience
    +
    +
    Annotation to inform users of a package, class or method's intended audience.
    +
    +
    InterfaceAudience.LimitedPrivate
    +
    +
    Intended for use only within the project(s) specified in the annotation.
    +
    +
    InterfaceAudience.Private
    +
    +
    Intended for use only within the project itself.
    +
    +
    InterfaceAudience.Public
    +
    +
    Intended for use by any project or application.
    +
    +
    InterfaceStability
    +
    +
    Annotation to inform users of how much to rely on a particular package, + class or method not changing over time.
    +
    +
    InterfaceStability.Evolving
    +
    +
    Evolving, but can break compatibility at minor release (i.e.
    +
    +
    InterfaceStability.Stable
    +
    +
    Can evolve while retaining compatibility for minor release boundaries.; + can break compatibility only at major release (ie.
    +
    +
    InterfaceStability.Unstable
    +
    +
    No guarantee is provided as to reliability or stability across any + level of release granularity.
    +
    +
    KeySharedMode
    +
    +
    KeyShared mode of KeyShared subscription.
    +
    +
    KeySharedPolicy
    +
    +
    KeyShared policy for KeyShared subscription.
    +
    +
    KeySharedPolicy.KeySharedPolicyAutoSplit
    +
    +
    Auto split hash range key shared policy.
    +
    +
    KeySharedPolicy.KeySharedPolicySticky
    +
    +
    Sticky attach topic with fixed hash range.
    +
    +
    KeyStoreParams
    +
    +
    KeyStore parameters used for tls authentication.
    +
    +
    KeyValue<K,V>
    +
    +
    A simple KeyValue class.
    +
    +
    KeyValue.KeyValueDecoder<K,V>
    +
    +
    Decoder to decode key/value bytes.
    +
    +
    KeyValueEncodingType
    +
    +
    Encoding types of supported KeyValueSchema for Pulsar messages.
    +
    +
    KeyValueSchema<K,V>
    +
    +
    This interface models a Schema that is composed of two parts.
    +
    +
    Message<T>
    +
    +
    The message abstraction used in Pulsar.
    +
    +
    MessageAcknowledger
    +
    +
    The interface to acknowledge one or more messages individually or cumulatively.
    +
    +
    MessageCrypto<MetadataT,BuilderT>
    +
    +
    Interface that abstracts the method to encrypt/decrypt message for End to End Encryption.
    +
    +
    MessageId
    +
    +
    Opaque unique identifier of a single message
    +
    +
    MessageListener<T>
    +
    +
    A listener that will be called in order for every message received.
    +
    +
    MessageListenerExecutor
    +
    +
    Interface for providing service to execute message listeners.
    +
    +
    MessagePayload
    +
    +
    The abstraction of a message's payload.
    +
    +
    MessagePayloadContext
    +
    +
    The context of the message payload, which usually represents a batched message (batch) or a single message.
    +
    +
    MessagePayloadFactory
    +
    +
    The factory class of MessagePayload.
    +
    +
    MessagePayloadProcessor
    +
    +
    The processor to process a message payload.
    +
    +
    MessageRouter
    +
    +
    Interface for custom message router that can be passed + to a producer to select the partition that a particular + messsage should be published on.
    +
    +
    MessageRoutingMode
    +
    +
    Default routing mode for messages to partition.
    +
    +
    Messages<T>
    +
    +
    A container that holds the list Message for a topic.
    +
    +
    MultiTopicConsumerStats
    +
    +
    Multi-topic Consumer statistics recorded by client.
    +
    +
    PartitionedTopicProducerStats
    +
    +
    Partitioned topic Producer statistics recorded by client.
    +
    +
    Producer<T>
    +
    +
    Producer is used to publish messages on a topic.
    +
    +
    ProducerAccessMode
    +
    +
    The type of access to the topic that the producer requires.
    +
    +
    ProducerBuilder<T>
    +
    +
    ProducerBuilder is used to configure and create instances of Producer.
    +
    +
    ProducerCryptoFailureAction
    +
    +
    The action the producer will take in case of encryption failures.
    +
    +
    ProducerInterceptor
    +
    +
    A plugin interface that allows you to intercept (and possibly mutate) the + messages received by the producer before they are published to the Pulsar + brokers.
    +
    +
    ProducerInterceptor<T>
    +
    Deprecated.
    +
    ProducerInterceptorWrapper
    +
    +
    A wrapper for old style producer interceptor.
    +
    +
    ProducerStats
    +
    Deprecated. +
    use ClientBuilder.openTelemetry(OpenTelemetry) to enable stats
    +
    +
    PropertiesUtils
    +
    +
    Internal utility methods for filtering and mapping Properties objects.
    +
    +
    ProxyProtocol
    +
    +
    Protcol type to determine type of proxy routing when client connects to proxy using + +
    +invalid @link +
    {@link ClientBuilder::proxyServiceUrl
    +
    +}.
    +
    +
    PulsarClient
    +
    +
    Class that provides a client interface to Pulsar.
    +
    +
    PulsarClientException
    +
    +
    Base type of exception thrown by Pulsar client.
    +
    +
    PulsarClientException.AlreadyClosedException
    +
    +
    Already closed exception thrown by Pulsar client.
    +
    +
    PulsarClientException.AuthenticationException
    +
    +
    Authentication exception thrown by Pulsar client.
    +
    +
    PulsarClientException.AuthorizationException
    +
    +
    Authorization exception thrown by Pulsar client.
    +
    +
    PulsarClientException.BrokerMetadataException
    +
    +
    Broker metadata exception thrown by Pulsar client.
    +
    +
    PulsarClientException.BrokerPersistenceException
    +
    +
    Broker persistence exception thrown by Pulsar client.
    +
    +
    PulsarClientException.ChecksumException
    +
    +
    Checksum exception thrown by Pulsar client.
    +
    +
    PulsarClientException.ConnectException
    +
    +
    Connect exception thrown by Pulsar client.
    +
    +
    PulsarClientException.ConsumerAssignException
    +
    +
    Consumer assign exception thrown by Pulsar client.
    +
    +
    PulsarClientException.ConsumerBusyException
    +
    +
    Consumer busy exception thrown by Pulsar client.
    +
    +
    PulsarClientException.CryptoException
    +
    +
    Crypto exception thrown by Pulsar client.
    +
    +
    PulsarClientException.FailedFeatureCheck
    +
    +
    "supports_auth_refresh" was introduced at "2.6" and is no longer supported, so skip this enum.
    +
    +
    PulsarClientException.FeatureNotSupportedException
    +
    +
    Not supported exception thrown by Pulsar client.
    +
    +
    PulsarClientException.GettingAuthenticationDataException
    +
    +
    Getting authentication data exception thrown by Pulsar client.
    +
    +
    PulsarClientException.IncompatibleSchemaException
    +
    +
    Incompatible schema exception thrown by Pulsar client.
    +
    +
    PulsarClientException.InvalidConfigurationException
    +
    +
    Invalid Configuration exception thrown by Pulsar client.
    +
    +
    PulsarClientException.InvalidMessageException
    +
    +
    Invalid message exception thrown by Pulsar client.
    +
    +
    PulsarClientException.InvalidServiceURL
    +
    +
    Invalid Service URL exception thrown by Pulsar client.
    +
    +
    PulsarClientException.InvalidTopicNameException
    +
    +
    Invalid topic name exception thrown by Pulsar client.
    +
    +
    PulsarClientException.LookupException
    +
    +
    Lookup exception thrown by Pulsar client.
    +
    +
    PulsarClientException.MemoryBufferIsFullError
    +
    +
    Memory buffer full error thrown by Pulsar client.
    +
    +
    PulsarClientException.MessageAcknowledgeException
    +
    +
    Consumer assign exception thrown by Pulsar client.
    +
    +
    PulsarClientException.NotAllowedException
    +
    +
    Not allowed exception thrown by Pulsar client.
    +
    +
    PulsarClientException.NotConnectedException
    +
    +
    Not connected exception thrown by Pulsar client.
    +
    +
    PulsarClientException.NotFoundException
    +
    +
    Not Found exception thrown by Pulsar client.
    +
    +
    PulsarClientException.NotSupportedException
    +
    +
    Not supported exception thrown by Pulsar client.
    +
    +
    PulsarClientException.ProducerBlockedQuotaExceededError
    +
    +
    Producer blocked quota exceeded error thrown by Pulsar client.
    +
    +
    PulsarClientException.ProducerBlockedQuotaExceededException
    +
    +
    Producer blocked quota exceeded exception thrown by Pulsar client.
    +
    +
    PulsarClientException.ProducerBusyException
    +
    +
    Producer busy exception thrown by Pulsar client.
    +
    +
    PulsarClientException.ProducerFencedException
    +
    +
    Producer fenced exception thrown by Pulsar client.
    +
    +
    PulsarClientException.ProducerQueueIsFullError
    +
    +
    Full producer queue error thrown by Pulsar client.
    +
    +
    PulsarClientException.SubscriptionNotFoundException
    +
    +
    Not found subscription that cannot be created.
    +
    +
    PulsarClientException.TimeoutException
    +
    +
    Timeout exception thrown by Pulsar client.
    +
    +
    PulsarClientException.TooManyRequestsException
    +
    +
    Too many requests exception thrown by Pulsar client.
    +
    +
    PulsarClientException.TopicDoesNotExistException
    +
    +
    Topic does not exist and cannot be created.
    +
    +
    PulsarClientException.TopicMigrationException
    +
    +
    TopicMigration exception thrown by Pulsar client.
    +
    +
    PulsarClientException.TopicTerminatedException
    +
    +
    Topic terminated exception thrown by Pulsar client.
    +
    +
    PulsarClientException.TransactionConflictException
    +
    +
    Consumer assign exception thrown by Pulsar client.
    +
    +
    PulsarClientException.TransactionHasOperationFailedException
    +
     
    +
    PulsarClientException.UnsupportedAuthenticationException
    +
    +
    Unsupported authentication exception thrown by Pulsar client.
    +
    +
    PulsarClientImplementationBinding
    +
    +
    Helper class for class instantiations and it also contains methods to work with schemas.
    +
    +
    Range
    +
    +
    Int range.
    +
    +
    Reader<T>
    +
    +
    A Reader can be used to scan through all the messages currently available in a topic.
    +
    +
    ReaderBuilder<T>
    +
    +
    ReaderBuilder is used to configure and create instances of Reader.
    +
    +
    ReaderInterceptor<T>
    +
    +
    Reader interceptor.
    +
    +
    ReaderListener<T>
    +
    +
    A listener that will be called in order for every message received.
    +
    +
    RecordSchemaBuilder
    +
    +
    Building the schema for a GenericRecord.
    +
    +
    RedeliveryBackoff
    +
    +
    Interface for custom message is negativeAcked policy, users can specify a RedeliveryBackoff for + a consumer.
    +
    +
    RegexSubscriptionMode
    +
    +
    When subscribing to topics using a regular expression, one can specify + to only pick a certain type of topics.
    +
    +
    Schema<T>
    +
    +
    Message schema definition.
    +
    +
    SchemaBuilder
    +
    +
    Builder to build schema.
    +
    +
    SchemaDefinition<T>
    +
    +
    Interface for schema definition.
    +
    +
    SchemaDefinitionBuilder<T>
    +
    +
    Builder to build schema definition SchemaDefinition.
    +
    +
    SchemaInfo
    +
    +
    Information about the schema.
    +
    +
    SchemaInfo.SchemaInfoBuilder
    +
     
    +
    SchemaInfoProvider
    +
    +
    Schema Provider.
    +
    +
    SchemaInfoWithVersion
    +
    +
    Data structure representing a schema information including its version.
    +
    +
    SchemaReader<T>
    +
    +
    Deserialize messages from bytes.
    +
    +
    SchemaSerializationException
    +
    +
    Schema serialization exception.
    +
    +
    SchemaType
    +
    +
    Types of supported schema for Pulsar messages.
    +
    +
    SchemaWriter<T>
    +
    +
    Serialize messages into bytes.
    +
    +
    ServiceUrlProvider
    +
    +
    The provider to provide the service url.
    +
    +
    SizeUnit
    +
    +
    Size unit converter.
    +
    +
    SubscriptionInitialPosition
    +
    +
    When creating a consumer, if the subscription does not exist, a new subscription will be created.
    +
    +
    SubscriptionMode
    +
    +
    Types of subscription mode supported by Pulsar.
    +
    +
    SubscriptionType
    +
    +
    Types of subscription supported by Pulsar.
    +
    +
    TableView<T>
    +
     
    +
    TableViewBuilder<T>
    +
    +
    TableViewBuilder is used to configure and create instances of TableView.
    +
    +
    TopicConsumerBuilder<T>
    +
    +
    TopicConsumerBuilder is used to configure topic specific options to override those set at the + ConsumerBuilder level.
    +
    +
    TopicMessageId
    +
    +
    The MessageId used for a consumer that subscribes multiple topics or partitioned topics.
    +
    +
    TopicMetadata
    +
    +
    Metadata of a topic that can be used for message routing.
    +
    +
    Transaction
    +
    +
    The class represents a transaction within Pulsar.
    +
    +
    Transaction.State
    +
     
    +
    TransactionBufferClient
    +
    +
    The transaction buffer client to commit and abort transactions on topics or subscription.
    +
    +
    TransactionBufferClientException
    +
    +
    Exceptions for transaction buffer client.
    +
    +
    TransactionBufferClientException.ReachMaxPendingOpsException
    +
    +
    Thrown when transaction buffer op over max pending numbers.
    +
    +
    TransactionBufferClientException.RequestTimeoutException
    +
    +
    Thrown when operation timeout.
    +
    +
    TransactionBuilder
    +
    +
    The builder to build a transaction for Pulsar.
    +
    +
    TransactionCoordinatorClient
    +
    +
    Transaction coordinator client.
    +
    +
    TransactionCoordinatorClient.State
    +
    +
    State of the transaction coordinator client.
    +
    +
    TransactionCoordinatorClientException
    +
    +
    Exceptions for transaction coordinator client.
    +
    +
    TransactionCoordinatorClientException.CoordinatorClientStateException
    +
    +
    Thrown when transaction coordinator with unexpected state.
    +
    +
    TransactionCoordinatorClientException.CoordinatorNotFoundException
    +
    +
    Thrown when transaction coordinator not found in broker side.
    +
    +
    TransactionCoordinatorClientException.InvalidTxnStatusException
    +
    +
    Thrown when transaction switch to a invalid status.
    +
    +
    TransactionCoordinatorClientException.MetaStoreHandlerNotExistsException
    +
    +
    Thrown when transaction meta store handler not exists.
    +
    +
    TransactionCoordinatorClientException.MetaStoreHandlerNotReadyException
    +
    +
    Thrown when send request to transaction meta store but the transaction meta store handler not ready.
    +
    +
    TransactionCoordinatorClientException.TransactionNotFoundException
    +
    +
    Thrown when transaction not found in transaction coordinator.
    +
    +
    TransactionIsolationLevel
    +
     
    +
    TxnID
    +
    +
    An identifier for representing a transaction.
    +
    +
    TypedMessageBuilder<T>
    +
    +
    Message builder that constructs a message to be published through a producer.
    +
    +
    +
    +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/allpackages-index.html b/static/api/client/4.0.x/allpackages-index.html new file mode 100644 index 000000000000..b9d7a5c4c747 --- /dev/null +++ b/static/api/client/4.0.x/allpackages-index.html @@ -0,0 +1,99 @@ + + + + +All Packages (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    All Packages

    +
    +
    Package Summary
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    org.apache.pulsar.client.api.interceptor
    +
    +
    Pulsar interceptors.
    +
    +
    org.apache.pulsar.client.api.schema
    +
    +
    Schema definitions for Pulsar Client API.
    +
    +
    org.apache.pulsar.client.api.transaction
    +
    +
    Pulsar transaction related API.
    +
    +
    org.apache.pulsar.client.internal
    +
    +
    Helpers which provide useful functionality for the implementation of Pulsar Client API.
    +
    +
    org.apache.pulsar.common.api
    +
    +
    Common data classes used in the Pulsar Client API.
    +
    +
    org.apache.pulsar.common.classification
    +
    +
    Annotations used across the whole project.
    +
    +
    org.apache.pulsar.common.schema
    +
    +
    This package contains data structures for schema definitions used in the Pulsar Client API.
    +
    +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/constant-values.html b/static/api/client/4.0.x/constant-values.html new file mode 100644 index 000000000000..aac2305822a4 --- /dev/null +++ b/static/api/client/4.0.x/constant-values.html @@ -0,0 +1,151 @@ + + + + +Constant Field Values (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Constant Field Values

    +
    +
    +

    Contents

    + +
    +
    +

    org.apache.*

    + + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/copy.svg b/static/api/client/4.0.x/copy.svg new file mode 100644 index 000000000000..7c46ab15feaf --- /dev/null +++ b/static/api/client/4.0.x/copy.svg @@ -0,0 +1,33 @@ + + + + + + + + diff --git a/static/api/client/4.0.x/deprecated-list.html b/static/api/client/4.0.x/deprecated-list.html new file mode 100644 index 000000000000..f80bd37314dd --- /dev/null +++ b/static/api/client/4.0.x/deprecated-list.html @@ -0,0 +1,170 @@ + + + + +Deprecated List (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Deprecated API

    +
    +

    Contents

    + + + + + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/element-list b/static/api/client/4.0.x/element-list new file mode 100644 index 000000000000..66c3badd5cb4 --- /dev/null +++ b/static/api/client/4.0.x/element-list @@ -0,0 +1,8 @@ +org.apache.pulsar.client.api +org.apache.pulsar.client.api.interceptor +org.apache.pulsar.client.api.schema +org.apache.pulsar.client.api.transaction +org.apache.pulsar.client.internal +org.apache.pulsar.common.api +org.apache.pulsar.common.classification +org.apache.pulsar.common.schema diff --git a/static/api/client/4.0.x/help-doc.html b/static/api/client/4.0.x/help-doc.html new file mode 100644 index 000000000000..eb80a6aa255b --- /dev/null +++ b/static/api/client/4.0.x/help-doc.html @@ -0,0 +1,208 @@ + + + + +API Help (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +

    JavaDoc Help

    + +
    +
    +

    Navigation

    +Starting from the Overview page, you can browse the documentation using the links in each page, and in the navigation bar at the top of each page. The Index and Search box allow you to navigate to specific declarations and summary pages, including: All Packages, All Classes and Interfaces + +
    +
    +
    +

    Kinds of Pages

    +The following sections describe the different kinds of pages in this collection. +
    +

    Overview

    +

    The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.

    +
    +
    +

    Package

    +

    Each package has a page that contains a list of its classes and interfaces, with a summary for each. These pages may contain the following categories:

    +
      +
    • Interfaces
      • +
    • Classes
      • +
    • Enum Classes
      • +
    • Exception Classes
      • +
    • Annotation Interfaces
      • +
    +
    +
    +

    Class or Interface

    +

    Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a declaration and description, member summary tables, and detailed member descriptions. Entries in each of these sections are omitted if they are empty or not applicable.

    +
      +
    • Class Inheritance Diagram
      • +
    • Direct Subclasses
      • +
    • All Known Subinterfaces
      • +
    • All Known Implementing Classes
      • +
    • Class or Interface Declaration
      • +
    • Class or Interface Description
      • +
    +
    +
      +
    • Nested Class Summary
      • +
    • Enum Constant Summary
      • +
    • Field Summary
      • +
    • Property Summary
      • +
    • Constructor Summary
      • +
    • Method Summary
      • +
    • Required Element Summary
      • +
    • Optional Element Summary
      • +
    +
    +
      +
    • Enum Constant Details
      • +
    • Field Details
      • +
    • Property Details
      • +
    • Constructor Details
      • +
    • Method Details
      • +
    • Element Details
      • +
    +

    Note: Annotation interfaces have required and optional elements, but not methods. Only enum classes have enum constants. The components of a record class are displayed as part of the declaration of the record class. Properties are a feature of JavaFX.

    +

    The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.

    +
    +
    +

    Other Files

    +

    Packages and modules may contain pages with additional information related to the declarations nearby.

    +
    +
    +

    Use

    +

    Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the USE link in the navigation bar.

    +
    +
    +

    Tree (Class Hierarchy)

    +

    There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. Classes are organized by inheritance structure starting with java.lang.Object. Interfaces do not inherit from java.lang.Object.

    +
      +
    • When viewing the Overview page, clicking on TREE displays the hierarchy for all packages.
      • +
    • When viewing a particular package, class or interface page, clicking on TREE displays the hierarchy for only that package.
      • +
    +
    +
    +

    Deprecated API

    +

    The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to shortcomings, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.

    +
    +
    +

    Constant Field Values

    +

    The Constant Field Values page lists the static final fields and their values.

    +
    +
    +

    Serialized Form

    +

    Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to those who implement rather than use the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See Also" section of the class description.

    +
    +
    +

    All Packages

    +

    The All Packages page contains an alphabetic index of all packages contained in the documentation.

    +
    +
    +

    All Classes and Interfaces

    +

    The All Classes and Interfaces page contains an alphabetic index of all classes and interfaces contained in the documentation, including annotation interfaces, enum classes, and record classes.

    +
    +
    +

    Index

    +

    The Index contains an alphabetic index of all classes, interfaces, constructors, methods, and fields in the documentation, as well as summary pages such as All Packages, All Classes and Interfaces.

    +
    +
    +
    +This help file applies to API documentation generated by the standard doclet.
    + +
    +
    + + diff --git a/static/api/client/4.0.x/index-all.html b/static/api/client/4.0.x/index-all.html new file mode 100644 index 000000000000..186d5650a339 --- /dev/null +++ b/static/api/client/4.0.x/index-all.html @@ -0,0 +1,4694 @@ + + + + +Index (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Index

    +
    +A B C D E F G H I J K L M N O P R S T U V W Z 
    All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form +

    A

    +
    +
    abort() - Method in interface org.apache.pulsar.client.api.transaction.Transaction
    +
    +
    Abort the transaction.
    +
    +
    abort(TxnID) - Method in interface org.apache.pulsar.client.api.transaction.TransactionCoordinatorClient
    +
    +
    Abort txn.
    +
    +
    abortAsync(TxnID) - Method in interface org.apache.pulsar.client.api.transaction.TransactionCoordinatorClient
    +
    +
    Abort txn asynchronously.
    +
    +
    ABORTED - Enum constant in enum class org.apache.pulsar.client.api.transaction.Transaction.State
    +
    +
    When a client receives a response to an abort, the transaction state is changed from `ABORTING` to `ABORTED`.
    +
    +
    ABORTING - Enum constant in enum class org.apache.pulsar.client.api.transaction.Transaction.State
    +
    +
    When a client invokes an abort, the transaction state is changed from `OPEN` to `ABORTING`.
    +
    +
    abortTxnOnSubscription(String, String, long, long, long) - Method in interface org.apache.pulsar.client.api.transaction.TransactionBufferClient
    +
    +
    Abort the transaction associated with the topic subscription.
    +
    +
    abortTxnOnTopic(String, long, long, long) - Method in interface org.apache.pulsar.client.api.transaction.TransactionBufferClient
    +
    +
    Abort the transaction associated with the topic.
    +
    +
    accessMode(ProducerAccessMode) - Method in interface org.apache.pulsar.client.api.ProducerBuilder
    +
    +
    Configure the type of access mode that the producer requires on the topic.
    +
    +
    acknowledge(List<MessageId>) - Method in interface org.apache.pulsar.client.api.MessageAcknowledger
    +
    +
    Acknowledge the consumption of a list of message.
    +
    +
    acknowledge(Message<?>) - Method in interface org.apache.pulsar.client.api.MessageAcknowledger
    +
     
    +
    acknowledge(MessageId) - Method in interface org.apache.pulsar.client.api.MessageAcknowledger
    +
    +
    Acknowledge the consumption of a single message.
    +
    +
    acknowledge(Messages<?>) - Method in interface org.apache.pulsar.client.api.MessageAcknowledger
    +
     
    +
    acknowledgeAsync(List<MessageId>) - Method in interface org.apache.pulsar.client.api.MessageAcknowledger
    +
    +
    The asynchronous version of MessageAcknowledger.acknowledge(List).
    +
    +
    acknowledgeAsync(List<MessageId>, Transaction) - Method in interface org.apache.pulsar.client.api.MessageAcknowledger
    +
    +
    The asynchronous version of MessageAcknowledger.acknowledge(List) with transaction support.
    +
    +
    acknowledgeAsync(Message<?>) - Method in interface org.apache.pulsar.client.api.MessageAcknowledger
    +
    +
    The asynchronous version of MessageAcknowledger.acknowledge(Message).
    +
    +
    acknowledgeAsync(MessageId) - Method in interface org.apache.pulsar.client.api.MessageAcknowledger
    +
    +
    The asynchronous version of MessageAcknowledger.acknowledge(MessageId).
    +
    +
    acknowledgeAsync(MessageId, Transaction) - Method in interface org.apache.pulsar.client.api.MessageAcknowledger
    +
    +
    The asynchronous version of MessageAcknowledger.acknowledge(MessageId) with transaction support.
    +
    +
    acknowledgeAsync(Messages<?>) - Method in interface org.apache.pulsar.client.api.MessageAcknowledger
    +
    +
    The asynchronous version of MessageAcknowledger.acknowledge(Messages).
    +
    +
    acknowledgeAsync(Messages<?>, Transaction) - Method in interface org.apache.pulsar.client.api.MessageAcknowledger
    +
    +
    The asynchronous version of MessageAcknowledger.acknowledge(Messages) with transaction support.
    +
    +
    acknowledgeCumulative(Message<?>) - Method in interface org.apache.pulsar.client.api.MessageAcknowledger
    +
     
    +
    acknowledgeCumulative(MessageId) - Method in interface org.apache.pulsar.client.api.MessageAcknowledger
    +
    +
    Acknowledge the reception of all the messages in the stream up to (and including) the provided message.
    +
    +
    acknowledgeCumulativeAsync(Message<?>) - Method in interface org.apache.pulsar.client.api.MessageAcknowledger
    +
    +
    The asynchronous version of MessageAcknowledger.acknowledgeCumulative(Message).
    +
    +
    acknowledgeCumulativeAsync(MessageId) - Method in interface org.apache.pulsar.client.api.MessageAcknowledger
    +
    +
    The asynchronous version of MessageAcknowledger.acknowledgeCumulative(MessageId).
    +
    +
    acknowledgeCumulativeAsync(MessageId, Transaction) - Method in interface org.apache.pulsar.client.api.MessageAcknowledger
    +
    +
    The asynchronous version of MessageAcknowledger.acknowledgeCumulative(MessageId) with transaction support.
    +
    +
    acknowledgmentGroupTime(long, TimeUnit) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
    +
    +
    Sets amount of time for group consumer acknowledgments.
    +
    +
    ackTimeout(long, TimeUnit) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
    +
    +
    Sets the timeout for unacknowledged messages, truncated to the nearest millisecond.
    +
    +
    ackTimeoutRedeliveryBackoff(RedeliveryBackoff) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
    +
    +
    Sets the redelivery backoff policy for messages that are redelivered due to acknowledgement timeout.
    +
    +
    ackTimeoutTickTime(long, TimeUnit) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
    +
    +
    Define the granularity of the ack-timeout redelivery.
    +
    +
    addEncryptionKey(String) - Method in interface org.apache.pulsar.client.api.ProducerBuilder
    +
    +
    Add public encryption key, used by producer to encrypt the data key.
    +
    +
    addProperty(String, String) - Method in interface org.apache.pulsar.client.api.schema.SchemaDefinitionBuilder
    +
    +
    Set schema info properties.
    +
    +
    addPublicKeyCipher(Set<String>, CryptoKeyReader) - Method in interface org.apache.pulsar.client.api.MessageCrypto
    +
     
    +
    addPublishPartitionToTxn(TxnID, List<String>) - Method in interface org.apache.pulsar.client.api.transaction.TransactionCoordinatorClient
    +
    +
    Add publish partition to txn.
    +
    +
    addPublishPartitionToTxnAsync(TxnID, List<String>) - Method in interface org.apache.pulsar.client.api.transaction.TransactionCoordinatorClient
    +
    +
    Add publish partition to txn asynchronously.
    +
    +
    addSubscriptionToTxn(TxnID, String, String) - Method in interface org.apache.pulsar.client.api.transaction.TransactionCoordinatorClient
    +
    +
    Add ack subscription to txn.
    +
    +
    addSubscriptionToTxnAsync(TxnID, String, String) - Method in interface org.apache.pulsar.client.api.transaction.TransactionCoordinatorClient
    +
    +
    Add ack subscription to txn asynchronously.
    +
    +
    aliases(String...) - Method in interface org.apache.pulsar.client.api.schema.FieldSchemaBuilder
    +
    +
    The optional name aliases of this field.
    +
    +
    allowOutOfOrderDelivery - Variable in class org.apache.pulsar.client.api.KeySharedPolicy
    +
     
    +
    allowTlsInsecureConnection(boolean) - Method in interface org.apache.pulsar.client.api.ClientBuilder
    +
    +
    Configure whether the Pulsar client accept untrusted TLS certificate from broker (default: false).
    +
    +
    AllTopics - Enum constant in enum class org.apache.pulsar.client.api.RegexSubscriptionMode
    +
    +
    Subscribe to both persistent and non-persistent topics.
    +
    +
    AlreadyClosedException(String) - Constructor for exception class org.apache.pulsar.client.api.PulsarClientException.AlreadyClosedException
    +
    +
    Constructs an AlreadyClosedException with the specified detail message.
    +
    +
    AlreadyClosedException(String, long) - Constructor for exception class org.apache.pulsar.client.api.PulsarClientException.AlreadyClosedException
    +
    +
    Constructs an AlreadyClosedException with the specified detail message.
    +
    +
    asSingleMessage(MessagePayload, Schema<T>) - Method in interface org.apache.pulsar.client.api.MessagePayloadContext
    +
    +
    Convert the given payload to a single message if the entry is not a batch.
    +
    +
    AuthData - Class in org.apache.pulsar.common.api
    +
    +
    Authentication data.
    +
    +
    AuthData() - Constructor for class org.apache.pulsar.common.api.AuthData
    +
     
    +
    authenticate(AuthData) - Method in interface org.apache.pulsar.client.api.AuthenticationDataProvider
    +
    +
    For mutual authentication, This method use passed in `data` to evaluate and challenge, + then returns null if authentication has completed; + returns authenticated data back to server side, if authentication has not completed.
    +
    +
    authentication(String, String) - Method in interface org.apache.pulsar.client.api.ClientBuilder
    +
    +
    Configure the authentication provider to use in the Pulsar client instance.
    +
    +
    authentication(String, Map<String, String>) - Method in interface org.apache.pulsar.client.api.ClientBuilder
    +
    +
    Configure the authentication provider to use in the Pulsar client instance + using a config map.
    +
    +
    authentication(Authentication) - Method in interface org.apache.pulsar.client.api.ClientBuilder
    +
    +
    Set the authentication provider to use in the Pulsar client instance.
    +
    +
    Authentication - Interface in org.apache.pulsar.client.api
    +
    +
    Interface of authentication providers.
    +
    +
    AuthenticationDataProvider - Interface in org.apache.pulsar.client.api
    +
    +
    Interface for accessing data which are used in variety of authentication schemes on client side.
    +
    +
    AuthenticationException(String) - Constructor for exception class org.apache.pulsar.client.api.PulsarClientException.AuthenticationException
    +
    +
    Constructs an AuthenticationException with the specified detail message.
    +
    +
    AuthenticationFactory - Class in org.apache.pulsar.client.api
    +
    +
    Factory class that allows to create Authentication instances + for all the supported authentication methods.
    +
    +
    AuthenticationFactory() - Constructor for class org.apache.pulsar.client.api.AuthenticationFactory
    +
     
    +
    authenticationStage(String, AuthenticationDataProvider, Map<String, String>, CompletableFuture<Map<String, String>>) - Method in interface org.apache.pulsar.client.api.Authentication
    +
    +
    An authentication Stage.
    +
    +
    AuthorizationException(String) - Constructor for exception class org.apache.pulsar.client.api.PulsarClientException.AuthorizationException
    +
    +
    Constructs an AuthorizationException with the specified detail message.
    +
    +
    AUTO - Enum constant in enum class org.apache.pulsar.common.schema.SchemaType
    +
    +
    Deprecated.
    +
    +
    AUTO() - Static method in interface org.apache.pulsar.client.api.Schema
    +
    +
    Deprecated.
    +
    +
    AUTO_CONSUME - Enum constant in enum class org.apache.pulsar.common.schema.SchemaType
    +
    +
    Auto Consume Type.
    +
    +
    AUTO_CONSUME() - Static method in interface org.apache.pulsar.client.api.Schema
    +
    +
    Create a schema instance that automatically deserialize messages + based on the current topic schema.
    +
    +
    AUTO_PRODUCE_BYTES() - Static method in interface org.apache.pulsar.client.api.Schema
    +
    +
    Create a schema instance that accepts a serialized payload + and validates it against the topic schema.
    +
    +
    AUTO_PRODUCE_BYTES(Schema<?>) - Static method in interface org.apache.pulsar.client.api.Schema
    +
    +
    Create a schema instance that accepts a serialized payload + and validates it against the schema specified.
    +
    +
    AUTO_PUBLISH - Enum constant in enum class org.apache.pulsar.common.schema.SchemaType
    +
    +
    Auto Publish Type.
    +
    +
    AUTO_SPLIT - Enum constant in enum class org.apache.pulsar.client.api.KeySharedMode
    +
    +
    Auto split while new consumer connected.
    +
    +
    autoAckOldestChunkedMessageOnQueueFull(boolean) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
    +
    +
    Buffering large number of outstanding uncompleted chunked messages can create memory pressure and it can be + guarded by providing this @maxPendingChunkedMessage threshold.
    +
    +
    autoAckOldestChunkedMessageOnQueueFull(boolean) - Method in interface org.apache.pulsar.client.api.ReaderBuilder
    +
    +
    Buffering large number of outstanding uncompleted chunked messages can create memory pressure and it can be + guarded by providing this @maxPendingChunkedMessage threshold.
    +
    +
    autoCertRefreshSeconds(int) - Method in interface org.apache.pulsar.client.api.ClientBuilder
    +
    +
    Set Cert Refresh interval in seconds.
    +
    +
    AutoClusterFailoverBuilder - Interface in org.apache.pulsar.client.api
    +
    +
    AutoClusterFailoverBuilder is used to configure and create instance of ServiceUrlProvider.
    +
    +
    AutoClusterFailoverBuilder.FailoverPolicy - Enum Class in org.apache.pulsar.client.api
    +
     
    +
    autoScaledReceiverQueueSizeEnabled(boolean) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
    +
    +
    If this is enabled, the consumer receiver queue size is initialized as a very small value, 1 by default, + and will double itself until it reaches the value set by ConsumerBuilder.receiverQueueSize(int), if and only if:
    +
    +
    autoSplitHashRange() - Static method in class org.apache.pulsar.client.api.KeySharedPolicy
    +
     
    +
    autoUpdatePartitions(boolean) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
    +
    +
    If enabled, the consumer auto-subscribes for partition increases.
    +
    +
    autoUpdatePartitions(boolean) - Method in interface org.apache.pulsar.client.api.ProducerBuilder
    +
    +
    If enabled, partitioned producer will automatically discover new partitions at runtime.
    +
    +
    autoUpdatePartitions(boolean) - Method in interface org.apache.pulsar.client.api.ReaderBuilder
    +
    +
    If enabled, the reader will auto subscribe for partitions increasement.
    +
    +
    autoUpdatePartitionsInterval(int, TimeUnit) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
    +
    +
    Sets the interval of updating partitions (default: 1 minute).
    +
    +
    autoUpdatePartitionsInterval(int, TimeUnit) - Method in interface org.apache.pulsar.client.api.ProducerBuilder
    +
    +
    Set the interval of updating partitions.
    +
    +
    autoUpdatePartitionsInterval(int, TimeUnit) - Method in interface org.apache.pulsar.client.api.ReaderBuilder
    +
    +
    Set the interval of updating partitions (default: 1 minute).
    +
    +
    autoUpdatePartitionsInterval(int, TimeUnit) - Method in interface org.apache.pulsar.client.api.TableViewBuilder
    +
    +
    Set the interval of updating partitions (default: 1 minute).
    +
    +
    AVRO - Enum constant in enum class org.apache.pulsar.common.schema.SchemaType
    +
    +
    Serialize and deserialize via avro.
    +
    +
    AVRO(Class<T>) - Static method in interface org.apache.pulsar.client.api.Schema
    +
    +
    Create a Avro schema type by default configuration of the class.
    +
    +
    AVRO(SchemaDefinition<T>) - Static method in interface org.apache.pulsar.client.api.Schema
    +
    +
    Create a Avro schema type with schema definition.
    +
    +
    +

    B

    +
    +
    batcherBuilder(BatcherBuilder) - Method in interface org.apache.pulsar.client.api.ProducerBuilder
    +
    +
    Set the batcher builder BatcherBuilder of the producer.
    +
    +
    BatcherBuilder - Interface in org.apache.pulsar.client.api
    +
    +
    Batcher builder.
    +
    +
    batchingMaxBytes(int) - Method in interface org.apache.pulsar.client.api.ProducerBuilder
    +
    +
    Set the maximum number of bytes permitted in a batch.
    +
    +
    batchingMaxMessages(int) - Method in interface org.apache.pulsar.client.api.ProducerBuilder
    +
    +
    Set the maximum number of messages permitted in a batch.
    +
    +
    batchingMaxPublishDelay(long, TimeUnit) - Method in interface org.apache.pulsar.client.api.ProducerBuilder
    +
    +
    Set the time period within which messages sent will be batched if batch messages are + enabled.
    +
    +
    BatchMessageContainer - Interface in org.apache.pulsar.client.api
    +
    +
    Batch message container for individual messages being published until they are batched and sent to broker.
    +
    +
    batchReceive() - Method in interface org.apache.pulsar.client.api.Consumer
    +
    +
    Batch receiving messages.
    +
    +
    batchReceiveAsync() - Method in interface org.apache.pulsar.client.api.Consumer
    +
    +
    Batch receiving messages.
    +
    +
    batchReceivePolicy(BatchReceivePolicy) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
    +
    +
    Sets BatchReceivePolicy for the consumer.
    +
    +
    BatchReceivePolicy - Class in org.apache.pulsar.client.api
    +
    +
    Configuration for message batch receive Consumer.batchReceive() Consumer.batchReceiveAsync().
    +
    +
    BatchReceivePolicy.Builder - Class in org.apache.pulsar.client.api
    +
    +
    Builder of BatchReceivePolicy.
    +
    +
    becameActive(Consumer<?>, int) - Method in interface org.apache.pulsar.client.api.ConsumerEventListener
    +
    +
    Notified when the consumer group is changed, and the consumer becomes the active consumer.
    +
    +
    becameInactive(Consumer<?>, int) - Method in interface org.apache.pulsar.client.api.ConsumerEventListener
    +
    +
    Notified when the consumer group is changed, and the consumer is still inactive or becomes inactive.
    +
    +
    beforeConsume(Consumer<T>, Message<T>) - Method in interface org.apache.pulsar.client.api.ConsumerInterceptor
    +
    +
    This is called just before the message is returned by + Consumer.receive(), MessageListener.received(Consumer, Message) or the CompletableFuture returned by + Consumer.receiveAsync() completes.
    +
    +
    beforeRead(Reader<T>, Message<T>) - Method in interface org.apache.pulsar.client.api.ReaderInterceptor
    +
    +
    This is called just before the message is returned by + Reader.readNext(), ReaderListener.received(Reader, Message) + or the CompletableFuture returned by + Reader.readNextAsync() completes.
    +
    +
    beforeSend(Producer<T>, Message<T>) - Method in interface org.apache.pulsar.client.api.ProducerInterceptor
    +
    +
    Deprecated.
    +
    This is called from Producer.send(Object) and Producer.sendAsync(Object) methods, before + send the message to the brokers.
    +
    +
    beforeSend(Producer, Message) - Method in interface org.apache.pulsar.client.api.interceptor.ProducerInterceptor
    +
    +
    This is called from Producer.send(Object) and Producer.sendAsync(Object) methods, before + send the message to the brokers.
    +
    +
    beforeSend(Producer, Message) - Method in class org.apache.pulsar.client.api.interceptor.ProducerInterceptorWrapper
    +
     
    +
    blockIfQueueFull(boolean) - Method in interface org.apache.pulsar.client.api.ProducerBuilder
    +
    +
    Set whether the Producer.send(T) and Producer.sendAsync(T) operations should block when the outgoing + message queue is full.
    +
    +
    BOOL - Static variable in interface org.apache.pulsar.client.api.Schema
    +
    +
    Boolean Schema.
    +
    +
    BOOLEAN - Enum constant in enum class org.apache.pulsar.common.schema.SchemaType
    +
    +
    boolean schema defined.
    +
    +
    BrokerMetadataException(String) - Constructor for exception class org.apache.pulsar.client.api.PulsarClientException.BrokerMetadataException
    +
    +
    Constructs an BrokerMetadataException with the specified detail message.
    +
    +
    BrokerPersistenceException(String) - Constructor for exception class org.apache.pulsar.client.api.PulsarClientException.BrokerPersistenceException
    +
    +
    Constructs an BrokerPersistenceException with the specified detail message.
    +
    +
    build() - Method in interface org.apache.pulsar.client.api.AutoClusterFailoverBuilder
    +
    +
    Build the ServiceUrlProvider instance.
    +
    +
    build() - Method in interface org.apache.pulsar.client.api.BatcherBuilder
    +
    +
    Build a new batch message container.
    +
    +
    build() - Method in class org.apache.pulsar.client.api.BatchReceivePolicy.Builder
    +
     
    +
    build() - Method in interface org.apache.pulsar.client.api.ClientBuilder
    +
    +
    Construct the final PulsarClient instance.
    +
    +
    build() - Method in interface org.apache.pulsar.client.api.ControlledClusterFailoverBuilder
    +
    +
    Build the ServiceUrlProvider instance.
    +
    +
    build() - Method in interface org.apache.pulsar.client.api.schema.GenericRecordBuilder
    +
    +
    Build a generic record.
    +
    +
    build() - Method in interface org.apache.pulsar.client.api.schema.SchemaDefinitionBuilder
    +
    +
    Build the schema definition.
    +
    +
    build() - Method in interface org.apache.pulsar.client.api.TopicConsumerBuilder
    +
    +
    Complete the configuration of the topic specific options and return control back to the + ConsumerBuilder instance.
    +
    +
    build() - Method in interface org.apache.pulsar.client.api.transaction.TransactionBuilder
    +
    +
    Build the transaction with the configured settings.
    +
    +
    build() - Method in class org.apache.pulsar.common.schema.SchemaInfo.SchemaInfoBuilder
    +
     
    +
    build(SchemaType) - Method in interface org.apache.pulsar.client.api.schema.RecordSchemaBuilder
    +
    +
    Build the schema info.
    +
    +
    builder() - Static method in class org.apache.pulsar.client.api.BatchReceivePolicy
    +
     
    +
    builder() - Static method in interface org.apache.pulsar.client.api.PulsarClient
    +
    +
    Get a new builder instance that can used to configure and build a PulsarClient instance.
    +
    +
    builder() - Static method in interface org.apache.pulsar.client.api.schema.SchemaDefinition
    +
    +
    Get a new builder instance that can used to configure and build a SchemaDefinition instance.
    +
    +
    builder() - Static method in interface org.apache.pulsar.common.schema.SchemaInfo
    +
     
    +
    Builder() - Constructor for class org.apache.pulsar.client.api.BatchReceivePolicy.Builder
    +
     
    +
    BYTEBUFFER - Static variable in interface org.apache.pulsar.client.api.Schema
    +
    +
    ByteBuffer Schema.
    +
    +
    BYTES - Enum constant in enum class org.apache.pulsar.client.api.SizeUnit
    +
     
    +
    BYTES - Enum constant in enum class org.apache.pulsar.common.schema.SchemaType
    +
    +
    A bytes array.
    +
    +
    BYTES - Static variable in interface org.apache.pulsar.client.api.Schema
    +
    +
    Schema that doesn't perform any encoding on the message payloads.
    +
    +
    +

    C

    +
    +
    checkInterval(long, TimeUnit) - Method in interface org.apache.pulsar.client.api.AutoClusterFailoverBuilder
    +
    +
    Set the checkInterval for probe.
    +
    +
    checkInterval(long, TimeUnit) - Method in interface org.apache.pulsar.client.api.ControlledClusterFailoverBuilder
    +
    +
    Set the probe check interval.
    +
    +
    ChecksumException(String) - Constructor for exception class org.apache.pulsar.client.api.PulsarClientException.ChecksumException
    +
    +
    Constructs an ChecksumException with the specified detail message.
    +
    +
    choosePartition(Message<?>) - Method in interface org.apache.pulsar.client.api.MessageRouter
    +
    +
    Deprecated. +
    since 1.22.0. Please use MessageRouter.choosePartition(Message, TopicMetadata) instead.
    +
    +
    +
    choosePartition(Message<?>, TopicMetadata) - Method in interface org.apache.pulsar.client.api.MessageRouter
    +
    +
    Choose a partition based on msg and the topic metadata.
    +
    +
    chunkMaxMessageSize(int) - Method in interface org.apache.pulsar.client.api.ProducerBuilder
    +
    +
    Max chunk-message size in bytes.
    +
    +
    clear() - Method in interface org.apache.pulsar.client.api.BatchMessageContainer
    +
    +
    Clear the message batch container.
    +
    +
    clear(String) - Method in interface org.apache.pulsar.client.api.schema.GenericRecordBuilder
    +
    +
    Clears the value of the given field.
    +
    +
    clear(Field) - Method in interface org.apache.pulsar.client.api.schema.GenericRecordBuilder
    +
    +
    Clears the value of the given field.
    +
    +
    ClientBuilder - Interface in org.apache.pulsar.client.api
    +
    +
    Builder interface that is used to configure and construct a PulsarClient instance.
    +
    +
    clock(Clock) - Method in interface org.apache.pulsar.client.api.ClientBuilder
    +
    +
    The clock used by the pulsar client.
    +
    +
    clone() - Method in interface org.apache.pulsar.client.api.ClientBuilder
    +
    +
    Create a copy of the current client builder.
    +
    +
    clone() - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
    +
    +
    Create a copy of the current consumer builder.
    +
    +
    clone() - Method in interface org.apache.pulsar.client.api.ProducerBuilder
    +
    +
    Create a copy of the current ProducerBuilder.
    +
    +
    clone() - Method in interface org.apache.pulsar.client.api.ReaderBuilder
    +
    +
    Create a copy of the current ReaderBuilder.
    +
    +
    clone() - Method in interface org.apache.pulsar.client.api.Schema
    +
    +
    Duplicates the schema.
    +
    +
    close() - Method in interface org.apache.pulsar.client.api.Consumer
    +
    +
    Close the consumer and stop the broker to push more messages.
    +
    +
    close() - Method in interface org.apache.pulsar.client.api.ConsumerInterceptor
    +
    +
    Close the interceptor.
    +
    +
    close() - Method in interface org.apache.pulsar.client.api.interceptor.ProducerInterceptor
    +
    +
    Close the interceptor.
    +
    +
    close() - Method in class org.apache.pulsar.client.api.interceptor.ProducerInterceptorWrapper
    +
     
    +
    close() - Method in interface org.apache.pulsar.client.api.Producer
    +
    +
    Close the producer and releases resources allocated.
    +
    +
    close() - Method in interface org.apache.pulsar.client.api.ProducerInterceptor
    +
    +
    Deprecated.
    +
    Close the interceptor.
    +
    +
    close() - Method in interface org.apache.pulsar.client.api.PulsarClient
    +
    +
    Close the PulsarClient and release all the resources.
    +
    +
    close() - Method in interface org.apache.pulsar.client.api.ReaderInterceptor
    +
    +
    Close the interceptor.
    +
    +
    close() - Method in interface org.apache.pulsar.client.api.ServiceUrlProvider
    +
    +
    Close the resource that the provider allocated.
    +
    +
    close() - Method in interface org.apache.pulsar.client.api.transaction.TransactionBufferClient
    +
     
    +
    closeAsync() - Method in interface org.apache.pulsar.client.api.Consumer
    +
    +
    Asynchronously close the consumer and stop the broker to push more messages.
    +
    +
    closeAsync() - Method in interface org.apache.pulsar.client.api.Producer
    +
    +
    Close the producer and releases resources allocated.
    +
    +
    closeAsync() - Method in interface org.apache.pulsar.client.api.PulsarClient
    +
    +
    Asynchronously close the PulsarClient and release all the resources.
    +
    +
    closeAsync() - Method in interface org.apache.pulsar.client.api.Reader
    +
    +
    Asynchronously close the reader and stop the broker to push more messages.
    +
    +
    closeAsync() - Method in interface org.apache.pulsar.client.api.TableView
    +
    +
    Close the table view and releases resources allocated.
    +
    +
    closeAsync() - Method in interface org.apache.pulsar.client.api.transaction.TransactionCoordinatorClient
    +
    +
    Close the transaction meta store client asynchronous.
    +
    +
    CLOSED - Enum constant in enum class org.apache.pulsar.client.api.transaction.TransactionCoordinatorClient.State
    +
     
    +
    CLOSING - Enum constant in enum class org.apache.pulsar.client.api.transaction.TransactionCoordinatorClient.State
    +
     
    +
    commit() - Method in interface org.apache.pulsar.client.api.transaction.Transaction
    +
    +
    Commit the transaction.
    +
    +
    commit(TxnID) - Method in interface org.apache.pulsar.client.api.transaction.TransactionCoordinatorClient
    +
    +
    Commit txn.
    +
    +
    commitAsync(TxnID) - Method in interface org.apache.pulsar.client.api.transaction.TransactionCoordinatorClient
    +
    +
    Commit txn asynchronously.
    +
    +
    COMMITTED - Enum constant in enum class org.apache.pulsar.client.api.transaction.Transaction.State
    +
    +
    When a client receives a response to a commit, the transaction state is changed from + `COMMITTING` to `COMMITTED`.
    +
    +
    COMMITTING - Enum constant in enum class org.apache.pulsar.client.api.transaction.Transaction.State
    +
    +
    When a client invokes a commit, the transaction state is changed from `OPEN` to `COMMITTING`.
    +
    +
    commitTxnOnSubscription(String, String, long, long, long) - Method in interface org.apache.pulsar.client.api.transaction.TransactionBufferClient
    +
    +
    Commit the transaction associated with the topic subscription.
    +
    +
    commitTxnOnTopic(String, long, long, long) - Method in interface org.apache.pulsar.client.api.transaction.TransactionBufferClient
    +
    +
    Commit the transaction associated with the topic.
    +
    +
    compareTo(Range) - Method in class org.apache.pulsar.client.api.Range
    +
     
    +
    compressionType(CompressionType) - Method in interface org.apache.pulsar.client.api.ProducerBuilder
    +
    +
    Set the compression type for the producer.
    +
    +
    CompressionType - Enum Class in org.apache.pulsar.client.api
    +
    +
    The compression type that can be specified on a Producer.
    +
    +
    CONF_DELIVERY_AFTER_SECONDS - Static variable in interface org.apache.pulsar.client.api.TypedMessageBuilder
    +
     
    +
    CONF_DELIVERY_AT - Static variable in interface org.apache.pulsar.client.api.TypedMessageBuilder
    +
     
    +
    CONF_DISABLE_REPLICATION - Static variable in interface org.apache.pulsar.client.api.TypedMessageBuilder
    +
     
    +
    CONF_EVENT_TIME - Static variable in interface org.apache.pulsar.client.api.TypedMessageBuilder
    +
     
    +
    CONF_KEY - Static variable in interface org.apache.pulsar.client.api.TypedMessageBuilder
    +
     
    +
    CONF_PROPERTIES - Static variable in interface org.apache.pulsar.client.api.TypedMessageBuilder
    +
     
    +
    CONF_REPLICATION_CLUSTERS - Static variable in interface org.apache.pulsar.client.api.TypedMessageBuilder
    +
     
    +
    CONF_SEQUENCE_ID - Static variable in interface org.apache.pulsar.client.api.TypedMessageBuilder
    +
     
    +
    configure(String) - Method in interface org.apache.pulsar.client.api.EncodedAuthenticationParameterSupport
    +
    +
    Plugins which use ":" and/or "," in a configuration parameter value need to implement this interface.
    +
    +
    configure(Map<String, String>) - Method in interface org.apache.pulsar.client.api.Authentication
    +
    +
    Deprecated. +
    This method will be deleted on version 2.0, instead please use configure(String + encodedAuthParamString) which is in EncodedAuthenticationParameterSupport for now and will be + integrated into this interface.
    +
    +
    +
    configureSchemaInfo(String, String, SchemaInfo) - Method in interface org.apache.pulsar.client.api.Schema
    +
    +
    Configure the schema to use the provided schema info.
    +
    +
    ConnectException(String) - Constructor for exception class org.apache.pulsar.client.api.PulsarClientException.ConnectException
    +
    +
    Constructs an ConnectException with the specified detail message.
    +
    +
    ConnectException(Throwable) - Constructor for exception class org.apache.pulsar.client.api.PulsarClientException.ConnectException
    +
    +
    Constructs an ConnectException with the specified cause.
    +
    +
    connectionMaxIdleSeconds(int) - Method in interface org.apache.pulsar.client.api.ClientBuilder
    +
    +
    Release the connection if it is not used for more than seconds.
    +
    +
    connectionsPerBroker(int) - Method in interface org.apache.pulsar.client.api.ClientBuilder
    +
    +
    Sets the max number of connection that the client library will open to a single broker.
    +
    +
    connectionTimeout(int, TimeUnit) - Method in interface org.apache.pulsar.client.api.ClientBuilder
    +
    +
    Set the duration of time to wait for a connection to a broker to be established.
    +
    +
    CONSUME - Enum constant in enum class org.apache.pulsar.client.api.ConsumerCryptoFailureAction
    +
    +
    Deliver the encrypted message to the application.
    +
    +
    Consumer<T> - Interface in org.apache.pulsar.client.api
    +
    +
    An interface that abstracts behavior of Pulsar's consumer.
    +
    +
    ConsumerAssignException(String) - Constructor for exception class org.apache.pulsar.client.api.PulsarClientException.ConsumerAssignException
    +
    +
    Constructs an ConsumerAssignException with the specified detail message.
    +
    +
    ConsumerBuilder<T> - Interface in org.apache.pulsar.client.api
    +
    +
    ConsumerBuilder is used to configure and create instances of Consumer.
    +
    +
    ConsumerBusyException(String) - Constructor for exception class org.apache.pulsar.client.api.PulsarClientException.ConsumerBusyException
    +
    +
    Constructs an ConsumerBusyException with the specified detail message.
    +
    +
    ConsumerCryptoFailureAction - Enum Class in org.apache.pulsar.client.api
    +
    +
    The action a consumer should take when a consumer receives a + message that it cannot decrypt.
    +
    +
    consumerEventListener(ConsumerEventListener) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
    +
    +
    Sets a ConsumerEventListener for the consumer.
    +
    +
    ConsumerEventListener - Interface in org.apache.pulsar.client.api
    +
    +
    Listener on the consumer state changes.
    +
    +
    ConsumerInterceptor<T> - Interface in org.apache.pulsar.client.api
    +
    +
    A plugin interface that allows you to intercept (and possibly mutate) + messages received by the consumer.
    +
    +
    consumerName(String) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
    +
    +
    Sets the consumer name.
    +
    +
    ConsumerStats - Interface in org.apache.pulsar.client.api
    +
    +
    Deprecated. +
    use ClientBuilder.openTelemetry(OpenTelemetry) to enable stats
    +
    +
    +
    contains(int) - Method in class org.apache.pulsar.client.api.Range
    +
    +
    Check if the value is in the range.
    +
    +
    contains(Range) - Method in class org.apache.pulsar.client.api.Range
    +
    +
    Check if the range is fully contained in the other range.
    +
    +
    containsKey(String) - Method in interface org.apache.pulsar.client.api.TableView
    +
    +
    Returns true if this TableView contains a mapping for the specified + key.
    +
    +
    ControlledClusterFailoverBuilder - Interface in org.apache.pulsar.client.api
    +
    +
    ControlledClusterFailoverBuilder is used to configure and create instance of ServiceUrlProvider.
    +
    +
    convertKeyValueDataStringToSchemaInfoSchema(byte[]) - Method in interface org.apache.pulsar.client.internal.PulsarClientImplementationBinding
    +
    +
    Convert the key/value schema info data json bytes to key/value schema info data bytes.
    +
    +
    convertKeyValueSchemaInfoDataToString(KeyValue<SchemaInfo, SchemaInfo>) - Method in interface org.apache.pulsar.client.internal.PulsarClientImplementationBinding
    +
    +
    Convert the key/value schema data.
    +
    +
    CoordinatorClientStateException() - Constructor for exception class org.apache.pulsar.client.api.transaction.TransactionCoordinatorClientException.CoordinatorClientStateException
    +
     
    +
    CoordinatorClientStateException(String) - Constructor for exception class org.apache.pulsar.client.api.transaction.TransactionCoordinatorClientException.CoordinatorClientStateException
    +
     
    +
    CoordinatorNotFoundException(String) - Constructor for exception class org.apache.pulsar.client.api.transaction.TransactionCoordinatorClientException.CoordinatorNotFoundException
    +
     
    +
    copiedBuffer() - Method in interface org.apache.pulsar.client.api.MessagePayload
    +
    +
    Copy the bytes of the payload into the byte array.
    +
    +
    create() - Method in interface org.apache.pulsar.client.api.ProducerBuilder
    +
    +
    Finalize the creation of the Producer instance.
    +
    +
    create() - Method in interface org.apache.pulsar.client.api.ReaderBuilder
    +
    +
    Finalize the creation of the Reader instance.
    +
    +
    create() - Method in interface org.apache.pulsar.client.api.TableViewBuilder
    +
    +
    Finalize the creation of the TableView instance.
    +
    +
    create(String, String) - Static method in class org.apache.pulsar.client.api.AuthenticationFactory
    +
    +
    Create an instance of the Authentication object by using + the plugin class name.
    +
    +
    create(String, Map<String, String>) - Static method in class org.apache.pulsar.client.api.AuthenticationFactory
    +
    +
    Create an instance of the Authentication-Plugin.
    +
    +
    create(String, MessageId) - Static method in interface org.apache.pulsar.client.api.TopicMessageId
    +
     
    +
    createAsync() - Method in interface org.apache.pulsar.client.api.ProducerBuilder
    +
    +
    Finalize the creation of the Producer instance in asynchronous mode.
    +
    +
    createAsync() - Method in interface org.apache.pulsar.client.api.ReaderBuilder
    +
    +
    Finalize the creation of the Reader instance in asynchronous mode.
    +
    +
    createAsync() - Method in interface org.apache.pulsar.client.api.TableViewBuilder
    +
    +
    Finalize the creation of the TableView instance in asynchronous mode.
    +
    +
    createAuthentication(String, String) - Method in interface org.apache.pulsar.client.internal.PulsarClientImplementationBinding
    +
     
    +
    createAuthentication(String, Map<String, String>) - Method in interface org.apache.pulsar.client.internal.PulsarClientImplementationBinding
    +
     
    +
    CryptoException(String) - Constructor for exception class org.apache.pulsar.client.api.PulsarClientException.CryptoException
    +
    +
    Constructs an CryptoException with the specified detail message.
    +
    +
    cryptoFailureAction(ConsumerCryptoFailureAction) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
    +
    +
    Sets the ConsumerCryptoFailureAction to the value specified.
    +
    +
    cryptoFailureAction(ConsumerCryptoFailureAction) - Method in interface org.apache.pulsar.client.api.ReaderBuilder
    +
    +
    Sets the ConsumerCryptoFailureAction to specify.
    +
    +
    cryptoFailureAction(ConsumerCryptoFailureAction) - Method in interface org.apache.pulsar.client.api.TableViewBuilder
    +
    +
    Set the ConsumerCryptoFailureAction to specify.
    +
    +
    cryptoFailureAction(ProducerCryptoFailureAction) - Method in interface org.apache.pulsar.client.api.ProducerBuilder
    +
    +
    Set the ProducerCryptoFailureAction to the value specified.
    +
    +
    cryptoKeyReader(CryptoKeyReader) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
    +
    +
    Sets a CryptoKeyReader.
    +
    +
    cryptoKeyReader(CryptoKeyReader) - Method in interface org.apache.pulsar.client.api.ProducerBuilder
    +
    +
    Sets a CryptoKeyReader.
    +
    +
    cryptoKeyReader(CryptoKeyReader) - Method in interface org.apache.pulsar.client.api.ReaderBuilder
    +
    +
    Sets a CryptoKeyReader to decrypt the message payloads.
    +
    +
    cryptoKeyReader(CryptoKeyReader) - Method in interface org.apache.pulsar.client.api.TableViewBuilder
    +
    +
    Set the CryptoKeyReader to decrypt the message payloads.
    +
    +
    CryptoKeyReader - Interface in org.apache.pulsar.client.api
    +
    +
    Interface that abstracts the access to a key store.
    +
    +
    CustomPartition - Enum constant in enum class org.apache.pulsar.client.api.MessageRoutingMode
    +
    +
    Use custom message router implementation that will be called to determine the partition + for a particular message.
    +
    +
    +

    D

    +
    +
    DATE - Enum constant in enum class org.apache.pulsar.common.schema.SchemaType
    +
    +
    Date.
    +
    +
    DATE - Static variable in interface org.apache.pulsar.client.api.Schema
    +
    +
    Date Schema.
    +
    +
    deadLetterPolicy(DeadLetterPolicy) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
    +
    +
    Sets dead letter policy for a consumer.
    +
    +
    DeadLetterPolicy - Class in org.apache.pulsar.client.api
    +
    +
    Configuration for the "dead letter queue" feature in consumer.
    +
    +
    DeadLetterPolicy() - Constructor for class org.apache.pulsar.client.api.DeadLetterPolicy
    +
     
    +
    decode(byte[]) - Method in interface org.apache.pulsar.client.api.Schema
    +
    +
    Decode a byte array into an object using the schema definition and deserializer implementation.
    +
    +
    decode(byte[], byte[]) - Method in interface org.apache.pulsar.client.api.Schema
    +
    +
    Decode a byte array into an object using a given version.
    +
    +
    decode(byte[], byte[]) - Method in interface org.apache.pulsar.common.schema.KeyValue.KeyValueDecoder
    +
    +
    Decode key and value bytes into a KeyValue pair.
    +
    +
    decode(byte[], KeyValue.KeyValueDecoder<K, V>) - Static method in class org.apache.pulsar.common.schema.KeyValue
    +
    +
    Decode the value into a key/value pair.
    +
    +
    decode(ByteBuffer) - Method in interface org.apache.pulsar.client.api.Schema
    +
    +
    Decode a ByteBuffer into an object using a given version.
    +
    +
    decode(ByteBuffer, byte[]) - Method in interface org.apache.pulsar.client.api.Schema
    +
    +
    Decode a ByteBuffer into an object using a given version.
    +
    +
    decodeKeyValueEncodingType(SchemaInfo) - Method in interface org.apache.pulsar.client.internal.PulsarClientImplementationBinding
    +
    +
    Decode the kv encoding type from the schema info.
    +
    +
    decodeKeyValueSchemaInfo(SchemaInfo) - Method in interface org.apache.pulsar.client.internal.PulsarClientImplementationBinding
    +
    +
    Decode the key/value schema info to get key schema info and value schema info.
    +
    +
    decrypt(Supplier<MetadataT>, ByteBuffer, ByteBuffer, CryptoKeyReader) - Method in interface org.apache.pulsar.client.api.MessageCrypto
    +
     
    +
    DEFAULT - Static variable in interface org.apache.pulsar.client.api.BatcherBuilder
    +
    +
    Default batch message container.
    +
    +
    DEFAULT - Static variable in interface org.apache.pulsar.client.api.MessagePayloadFactory
    +
     
    +
    DEFAULT - Static variable in interface org.apache.pulsar.client.api.MessagePayloadProcessor
    +
     
    +
    DEFAULT_HASH_RANGE_SIZE - Static variable in class org.apache.pulsar.client.api.KeySharedPolicy
    +
     
    +
    DEFAULT_MULTI_TOPICS_DISABLE_POLICY - Static variable in class org.apache.pulsar.client.api.BatchReceivePolicy
    +
     
    +
    DEFAULT_POLICY - Static variable in class org.apache.pulsar.client.api.BatchReceivePolicy
    +
    +
    Default batch receive policy.
    +
    +
    DEFAULT_TXN_TTL_MS - Static variable in interface org.apache.pulsar.client.api.transaction.TransactionCoordinatorClient
    +
    +
    Default transaction ttl in mills.
    +
    +
    defaultCryptoKeyReader(String) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
    +
    +
    Sets the default implementation of CryptoKeyReader.
    +
    +
    defaultCryptoKeyReader(String) - Method in interface org.apache.pulsar.client.api.ProducerBuilder
    +
    +
    Sets the default implementation of CryptoKeyReader.
    +
    +
    defaultCryptoKeyReader(String) - Method in interface org.apache.pulsar.client.api.ReaderBuilder
    +
    +
    Sets the default implementation of CryptoKeyReader.
    +
    +
    defaultCryptoKeyReader(String) - Method in interface org.apache.pulsar.client.api.TableViewBuilder
    +
    +
    Set the default implementation of CryptoKeyReader.
    +
    +
    defaultCryptoKeyReader(Map<String, String>) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
    +
    +
    Sets the default implementation of CryptoKeyReader.
    +
    +
    defaultCryptoKeyReader(Map<String, String>) - Method in interface org.apache.pulsar.client.api.ProducerBuilder
    +
    +
    Sets the default implementation of CryptoKeyReader.
    +
    +
    defaultCryptoKeyReader(Map<String, String>) - Method in interface org.apache.pulsar.client.api.ReaderBuilder
    +
    +
    Sets the default implementation of CryptoKeyReader.
    +
    +
    defaultCryptoKeyReader(Map<String, String>) - Method in interface org.apache.pulsar.client.api.TableViewBuilder
    +
    +
    Set the default implementation of CryptoKeyReader.
    +
    +
    DefaultImplementation - Class in org.apache.pulsar.client.internal
    +
    +
    This class loads the implementation for PulsarClientImplementationBinding + and allows you to decouple the API from the actual implementation.
    +
    +
    DefaultImplementation() - Constructor for class org.apache.pulsar.client.internal.DefaultImplementation
    +
     
    +
    defaultServiceUrl(String) - Method in interface org.apache.pulsar.client.api.ControlledClusterFailoverBuilder
    +
    +
    Set default service url.
    +
    +
    defaultValue(Object) - Method in interface org.apache.pulsar.client.api.schema.FieldSchemaBuilder
    +
    +
    Set the default value of this field.
    +
    +
    deliverAfter(long, TimeUnit) - Method in interface org.apache.pulsar.client.api.TypedMessageBuilder
    +
    +
    Request to deliver the message only after the specified relative delay.
    +
    +
    deliverAt(long) - Method in interface org.apache.pulsar.client.api.TypedMessageBuilder
    +
    +
    Deliver the message only at or after the specified absolute timestamp.
    +
    +
    disableReplication() - Method in interface org.apache.pulsar.client.api.TypedMessageBuilder
    +
    +
    Disable geo-replication for this message.
    +
    +
    discard(Exception) - Method in interface org.apache.pulsar.client.api.BatchMessageContainer
    +
    +
    Release the payload and clear the container.
    +
    +
    DISCARD - Enum constant in enum class org.apache.pulsar.client.api.ConsumerCryptoFailureAction
    +
    +
    Message is silently acknowledged and not delivered to the application.
    +
    +
    dnsLookupBind(String, int) - Method in interface org.apache.pulsar.client.api.ClientBuilder
    +
    +
    Set dns lookup bind address and port.
    +
    +
    dnsServerAddresses(List<InetSocketAddress>) - Method in interface org.apache.pulsar.client.api.ClientBuilder
    +
    +
    Set dns lookup server addresses.
    +
    +
    doc(String) - Method in interface org.apache.pulsar.client.api.schema.FieldSchemaBuilder
    +
    +
    The documentation of this field.
    +
    +
    doc(String) - Method in interface org.apache.pulsar.client.api.schema.RecordSchemaBuilder
    +
    +
    Add doc to the record schema.
    +
    +
    DOUBLE - Enum constant in enum class org.apache.pulsar.common.schema.SchemaType
    +
    +
    A double number.
    +
    +
    DOUBLE - Static variable in interface org.apache.pulsar.client.api.Schema
    +
    +
    Double Schema.
    +
    +
    DummyCryptoKeyReaderImpl - Class in org.apache.pulsar.client.api
    +
    +
    An empty implement.
    +
    +
    Durable - Enum constant in enum class org.apache.pulsar.client.api.SubscriptionMode
    +
     
    +
    +

    E

    +
    +
    earliest - Static variable in interface org.apache.pulsar.client.api.MessageId
    +
    +
    MessageId that represents the oldest message available in the topic.
    +
    +
    Earliest - Enum constant in enum class org.apache.pulsar.client.api.SubscriptionInitialPosition
    +
    +
    The earliest position which means the start consuming position will be the first message.
    +
    +
    eligible(Message) - Method in interface org.apache.pulsar.client.api.interceptor.ProducerInterceptor
    +
    +
    Check whether the interceptor is eligible for this message.
    +
    +
    eligible(Message) - Method in class org.apache.pulsar.client.api.interceptor.ProducerInterceptorWrapper
    +
     
    +
    enableBatchIndexAcknowledgment(boolean) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
    +
    +
    Enable or disable batch index acknowledgment.
    +
    +
    enableBatching(boolean) - Method in interface org.apache.pulsar.client.api.ProducerBuilder
    +
    +
    Set automatic batching of messages for the producer.
    +
    +
    enableBusyWait(boolean) - Method in interface org.apache.pulsar.client.api.ClientBuilder
    +
    +
    Option to enable busy-wait settings.
    +
    +
    enableChunking(boolean) - Method in interface org.apache.pulsar.client.api.ProducerBuilder
    +
    +
    If a message's size is higher than the broker's allowed max publish-payload size, enableChunking allows + the producer to split the message into multiple chunks and publish it to the broker separately and in order.
    +
    +
    enableLazyStartPartitionedProducers(boolean) - Method in interface org.apache.pulsar.client.api.ProducerBuilder
    +
    +
    This config affects Shared mode producers of partitioned topics only.
    +
    +
    enableMultiSchema(boolean) - Method in interface org.apache.pulsar.client.api.ProducerBuilder
    +
    +
    Set the multiple schema mode for producer.
    +
    +
    enableRetry(boolean) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
    +
    +
    If enabled, the consumer auto-retries messages.
    +
    +
    enableTcpNoDelay(boolean) - Method in interface org.apache.pulsar.client.api.ClientBuilder
    +
    +
    Configure whether to use TCP no-delay flag on the connection, to disable Nagle algorithm.
    +
    +
    enableTls(boolean) - Method in interface org.apache.pulsar.client.api.ClientBuilder
    +
    +
    Deprecated. +
    use "pulsar+ssl://" in serviceUrl to enable
    +
    +
    +
    enableTlsHostnameVerification(boolean) - Method in interface org.apache.pulsar.client.api.ClientBuilder
    +
    +
    It allows to validate hostname verification when client connects to broker over tls.
    +
    +
    enableTransaction(boolean) - Method in interface org.apache.pulsar.client.api.ClientBuilder
    +
    +
    If enable transaction, start the transactionCoordinatorClient with pulsar client.
    +
    +
    encode(K, Schema<K>, V, Schema<V>) - Static method in class org.apache.pulsar.common.schema.KeyValue
    +
    +
    Encode a key and value pair into a bytes array.
    +
    +
    encode(T) - Method in interface org.apache.pulsar.client.api.Schema
    +
    +
    Encode an object representing the message content into a byte array.
    +
    +
    EncodedAuthenticationParameterSupport - Interface in org.apache.pulsar.client.api
    +
    +
    Support for encoded authentication configuration parameters.
    +
    +
    encodeKeyValueSchemaInfo(String, Schema<K>, Schema<V>, KeyValueEncodingType) - Method in interface org.apache.pulsar.client.internal.PulsarClientImplementationBinding
    +
    +
    Encode key invalid input: '&' value into schema into a KeyValue schema.
    +
    +
    encodeKeyValueSchemaInfo(Schema<K>, Schema<V>, KeyValueEncodingType) - Method in interface org.apache.pulsar.client.internal.PulsarClientImplementationBinding
    +
    +
    Encode key invalid input: '&' value into schema into a KeyValue schema.
    +
    +
    encrypt(Set<String>, CryptoKeyReader, Supplier<BuilderT>, ByteBuffer, ByteBuffer) - Method in interface org.apache.pulsar.client.api.MessageCrypto
    +
     
    +
    EncryptionContext - Class in org.apache.pulsar.common.api
    +
    +
    Class representing an encryption context.
    +
    +
    EncryptionContext() - Constructor for class org.apache.pulsar.common.api.EncryptionContext
    +
     
    +
    EncryptionContext.EncryptionKey - Class in org.apache.pulsar.common.api
    +
    +
    Encryption key with metadata.
    +
    +
    EncryptionKey() - Constructor for class org.apache.pulsar.common.api.EncryptionContext.EncryptionKey
    +
     
    +
    EncryptionKeyInfo - Class in org.apache.pulsar.client.api
    +
    +
    EncryptionKeyInfo contains the encryption key and corresponding metadata which contains additional information about + the key such as version, timestamp.
    +
    +
    EncryptionKeyInfo() - Constructor for class org.apache.pulsar.client.api.EncryptionKeyInfo
    +
     
    +
    EncryptionKeyInfo(byte[], Map<String, String>) - Constructor for class org.apache.pulsar.client.api.EncryptionKeyInfo
    +
     
    +
    entrySet() - Method in interface org.apache.pulsar.client.api.TableView
    +
    +
    Returns a Set view of the mappings contained in this map.
    +
    +
    equals(Object) - Method in class org.apache.pulsar.client.api.Range
    +
     
    +
    equals(Object) - Method in class org.apache.pulsar.client.api.transaction.TxnID
    +
     
    +
    equals(Object) - Method in class org.apache.pulsar.common.schema.KeyValue
    +
     
    +
    ERROR - Enum constant in enum class org.apache.pulsar.client.api.transaction.Transaction.State
    +
    +
    When a client invokes a commit or an abort, but a transaction does not exist in a coordinator, + then the state is changed to `ERROR`.
    +
    +
    eventTime(long) - Method in interface org.apache.pulsar.client.api.TypedMessageBuilder
    +
    +
    Set the event time for a given message.
    +
    +
    Exclusive - Enum constant in enum class org.apache.pulsar.client.api.ProducerAccessMode
    +
    +
    Require exclusive access for producer.
    +
    +
    Exclusive - Enum constant in enum class org.apache.pulsar.client.api.SubscriptionType
    +
    +
    There can be only 1 consumer on the same topic with the same subscription name.
    +
    +
    ExclusiveWithFencing - Enum constant in enum class org.apache.pulsar.client.api.ProducerAccessMode
    +
    +
    Acquire exclusive access for the producer.
    +
    +
    execute(Message<?>, Runnable) - Method in interface org.apache.pulsar.client.api.MessageListenerExecutor
    +
    +
    select a thread by message to execute the runnable!
    +
    +
    expireTimeOfIncompleteChunkedMessage(long, TimeUnit) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
    +
    +
    If the producer fails to publish all the chunks of a message, then the consumer can expire incomplete chunks if + the consumer doesn't receive all chunks during the expiration period (default 1 minute).
    +
    +
    expireTimeOfIncompleteChunkedMessage(long, TimeUnit) - Method in interface org.apache.pulsar.client.api.ReaderBuilder
    +
    +
    If producer fails to publish all the chunks of a message then consumer can expire incomplete chunks if consumer + won't be able to receive all chunks in expire times (default 1 minute).
    +
    +
    +

    F

    +
    +
    FAIL - Enum constant in enum class org.apache.pulsar.client.api.ConsumerCryptoFailureAction
    +
    +
    This is the default option to fail consume messages until crypto succeeds.
    +
    +
    FAIL - Enum constant in enum class org.apache.pulsar.client.api.ProducerCryptoFailureAction
    +
    +
    This is the default option to fail send if crypto operation fails.
    +
    +
    Failover - Enum constant in enum class org.apache.pulsar.client.api.SubscriptionType
    +
    +
    Multiple consumer will be able to use the same subscription name but only 1 consumer will receive the messages.
    +
    +
    failoverDelay(long, TimeUnit) - Method in interface org.apache.pulsar.client.api.AutoClusterFailoverBuilder
    +
    +
    Set the switch failoverDelay.
    +
    +
    failoverPolicy(AutoClusterFailoverBuilder.FailoverPolicy) - Method in interface org.apache.pulsar.client.api.AutoClusterFailoverBuilder
    +
    +
    Set secondary choose policy.
    +
    +
    FeatureNotSupportedException(String, PulsarClientException.FailedFeatureCheck) - Constructor for exception class org.apache.pulsar.client.api.PulsarClientException.FeatureNotSupportedException
    +
     
    +
    field(String) - Method in interface org.apache.pulsar.client.api.schema.RecordSchemaBuilder
    +
    +
    Add a field with the given name to the record.
    +
    +
    field(String, GenericSchema) - Method in interface org.apache.pulsar.client.api.schema.RecordSchemaBuilder
    +
    +
    Add a field with the given name and genericSchema to the record.
    +
    +
    Field - Class in org.apache.pulsar.client.api.schema
    +
    +
    A field in a record, consisting of a field name, index, and + Schema for the field value.
    +
    +
    Field() - Constructor for class org.apache.pulsar.client.api.schema.Field
    +
     
    +
    FieldSchemaBuilder<T> - Interface in org.apache.pulsar.client.api.schema
    +
    +
    Build a field for a record.
    +
    +
    filterAndMapProperties(Properties, String) - Static method in class org.apache.pulsar.client.internal.PropertiesUtils
    +
    +
    Filters the Properties object so that only properties with the configured prefix are retained, + and then removes that prefix and puts the key value pairs into the result map.
    +
    +
    filterAndMapProperties(Properties, String, String) - Static method in class org.apache.pulsar.client.internal.PropertiesUtils
    +
    +
    Filters the Properties object so that only properties with the configured prefix are retained, + and then replaces the srcPrefix with the targetPrefix when putting the key value pairs in the resulting map.
    +
    +
    FLOAT - Enum constant in enum class org.apache.pulsar.common.schema.SchemaType
    +
    +
    A float number.
    +
    +
    FLOAT - Static variable in interface org.apache.pulsar.client.api.Schema
    +
    +
    Float Schema.
    +
    +
    flush() - Method in interface org.apache.pulsar.client.api.Producer
    +
    +
    Flush all the messages buffered in the client and wait until all messages have been successfully persisted.
    +
    +
    flushAsync() - Method in interface org.apache.pulsar.client.api.Producer
    +
    +
    Flush all the messages buffered in the client and wait until all messages have been successfully persisted.
    +
    +
    forEach(BiConsumer<String, T>) - Method in interface org.apache.pulsar.client.api.TableView
    +
    +
    Performs the given action for each entry in this map until all entries + have been processed or the action throws an exception.
    +
    +
    forEachAndListen(BiConsumer<String, T>) - Method in interface org.apache.pulsar.client.api.TableView
    +
    +
    Performs the given action for each entry in this map until all entries + have been processed or the action throws an exception.
    +
    +
    fromByteArray(byte[]) - Static method in interface org.apache.pulsar.client.api.MessageId
    +
    +
    De-serialize a message id from a byte array.
    +
    +
    fromByteArrayWithTopic(byte[], String) - Static method in interface org.apache.pulsar.client.api.MessageId
    +
    +
    De-serialize a message id from a byte array with its topic + information attached.
    +
    +
    +

    G

    +
    +
    generic(SchemaInfo) - Static method in interface org.apache.pulsar.client.api.Schema
    +
    +
    Returns a generic schema of existing schema info.
    +
    +
    GenericObject - Interface in org.apache.pulsar.client.api.schema
    +
    +
    This is an abstraction over the logical value that is store into a Message.
    +
    +
    GenericRecord - Interface in org.apache.pulsar.client.api.schema
    +
    +
    An interface represents a message with schema.
    +
    +
    GenericRecordBuilder - Interface in org.apache.pulsar.client.api.schema
    +
    +
    Generic Record Builder to build a GenericRecord.
    +
    +
    GenericSchema<T> - Interface in org.apache.pulsar.client.api.schema
    +
    +
    A schema that serializes and deserializes between GenericRecord and bytes.
    +
    +
    get(String) - Method in interface org.apache.pulsar.client.api.TableView
    +
    +
    Returns the value to which the specified key is mapped, or null if this map contains + no mapping for the key.
    +
    +
    getAlwaysAllowNull() - Method in interface org.apache.pulsar.client.api.schema.SchemaDefinition
    +
    +
    Get schema whether always allow null or not.
    +
    +
    getAuthData() - Method in interface org.apache.pulsar.client.api.Authentication
    +
     
    +
    getAuthData(String) - Method in interface org.apache.pulsar.client.api.Authentication
    +
    +
    Get/Create an authentication data provider which provides the data that this client will be sent to the broker.
    +
    +
    getAuthMethodName() - Method in interface org.apache.pulsar.client.api.Authentication
    +
     
    +
    getAvailableRequestCredits() - Method in interface org.apache.pulsar.client.api.transaction.TransactionBufferClient
    +
     
    +
    getBatchAllocatedSizeBytes() - Method in interface org.apache.pulsar.client.api.BatchMessageContainer
    +
    +
    Get current allocated buffer size of the message batch container in bytes.
    +
    +
    getBrokerPublishTime() - Method in interface org.apache.pulsar.client.api.Message
    +
    +
    Get broker publish time from broker entry metadata.
    +
    +
    getBytes(ByteBuffer) - Static method in interface org.apache.pulsar.client.internal.PulsarClientImplementationBinding
    +
    +
    Retrieves ByteBuffer data into byte[].
    +
    +
    getClassLoader() - Method in interface org.apache.pulsar.client.api.schema.SchemaDefinition
    +
    +
    Get pojo classLoader.
    +
    +
    getCommandData() - Method in interface org.apache.pulsar.client.api.AuthenticationDataProvider
    +
     
    +
    getConsumerName() - Method in interface org.apache.pulsar.client.api.Consumer
    +
    +
    Get the name of consumer.
    +
    +
    getCurrentBatchSize() - Method in interface org.apache.pulsar.client.api.BatchMessageContainer
    +
    +
    Get current message batch size of the message batch container in bytes.
    +
    +
    getData() - Method in interface org.apache.pulsar.client.api.Message
    +
    +
    Get the raw payload of the message.
    +
    +
    getDeadLetterProducerStats() - Method in interface org.apache.pulsar.client.api.ConsumerStats
    +
    +
    Deprecated.
    + 
    +
    getDefaultImplementation() - Static method in class org.apache.pulsar.client.internal.DefaultImplementation
    +
    +
    Access the actual implementation of the Pulsar Client API.
    +
    +
    getEncryptionCtx() - Method in interface org.apache.pulsar.client.api.Message
    +
    +
    EncryptionContext contains encryption and compression information in it using which application can + decrypt consumed message with encrypted-payload.
    +
    +
    getEnd() - Method in class org.apache.pulsar.client.api.Range
    +
     
    +
    getEventTime() - Method in interface org.apache.pulsar.client.api.Message
    +
    +
    Get the event time associated with this message.
    +
    +
    getField(String) - Method in interface org.apache.pulsar.client.api.schema.GenericRecord
    +
    +
    Retrieve the value of the provided fieldName.
    +
    +
    getField(Field) - Method in interface org.apache.pulsar.client.api.schema.GenericRecord
    +
    +
    Retrieve the value of the provided field.
    +
    +
    getFields() - Method in interface org.apache.pulsar.client.api.schema.GenericRecord
    +
    +
    Returns the list of fields associated with the record.
    +
    +
    getFields() - Method in interface org.apache.pulsar.client.api.schema.GenericSchema
    +
    +
    Returns the list of fields.
    +
    +
    getGenericSchema(SchemaInfo) - Method in interface org.apache.pulsar.client.internal.PulsarClientImplementationBinding
    +
     
    +
    getHashRangeTotal() - Method in class org.apache.pulsar.client.api.KeySharedPolicy
    +
     
    +
    getHttpAuthType() - Method in interface org.apache.pulsar.client.api.AuthenticationDataProvider
    +
     
    +
    getHttpHeaders() - Method in interface org.apache.pulsar.client.api.AuthenticationDataProvider
    +
     
    +
    getIndex() - Method in interface org.apache.pulsar.client.api.Message
    +
    +
    Get index from broker entry metadata.
    +
    +
    getJsonDef() - Method in interface org.apache.pulsar.client.api.schema.SchemaDefinition
    +
    +
    Get json schema definition.
    +
    +
    getKey() - Method in class org.apache.pulsar.client.api.EncryptionKeyInfo
    +
     
    +
    getKey() - Method in interface org.apache.pulsar.client.api.Message
    +
    +
    Get the key of the message.
    +
    +
    getKey() - Method in class org.apache.pulsar.common.schema.KeyValue
    +
     
    +
    getKeyBytes() - Method in interface org.apache.pulsar.client.api.Message
    +
    +
    Get bytes in key.
    +
    +
    getKeySchema() - Method in interface org.apache.pulsar.client.api.schema.KeyValueSchema
    +
    +
    Get the Schema of the Key.
    +
    +
    getKeySharedMode() - Method in class org.apache.pulsar.client.api.KeySharedPolicy
    +
     
    +
    getKeyValueEncodingType() - Method in interface org.apache.pulsar.client.api.schema.KeyValueSchema
    +
    +
    Get the KeyValueEncodingType.
    +
    +
    getLastDisconnectedTimestamp() - Method in interface org.apache.pulsar.client.api.Consumer
    +
     
    +
    getLastDisconnectedTimestamp() - Method in interface org.apache.pulsar.client.api.Producer
    +
     
    +
    getLastMessageId() - Method in interface org.apache.pulsar.client.api.Consumer
    +
    +
    Deprecated. +
    Use Consumer.getLastMessageIds() instead.
    +
    +
    +
    getLastMessageIdAsync() - Method in interface org.apache.pulsar.client.api.Consumer
    +
    +
    Deprecated. +
    Use Consumer.getLastMessageIdsAsync()} instead.
    +
    +
    +
    getLastMessageIds() - Method in interface org.apache.pulsar.client.api.Consumer
    +
    +
    Get all the last message id of the topics the consumer subscribed.
    +
    +
    getLastMessageIds() - Method in interface org.apache.pulsar.client.api.Reader
    +
    +
    Get all the last message id of the topics the reader subscribed.
    +
    +
    getLastMessageIdsAsync() - Method in interface org.apache.pulsar.client.api.Consumer
    +
    +
    The asynchronous version of Consumer.getLastMessageIds().
    +
    +
    getLastMessageIdsAsync() - Method in interface org.apache.pulsar.client.api.Reader
    +
    +
    The asynchronous version of Reader.getLastMessageIds().
    +
    +
    getLastSequenceId() - Method in interface org.apache.pulsar.client.api.Producer
    +
    +
    Get the last sequence id that was published by this producer.
    +
    +
    getLatestSchema() - Method in interface org.apache.pulsar.client.api.schema.SchemaInfoProvider
    +
    +
    Retrieve the latest schema info.
    +
    +
    getMaxNumBytes() - Method in class org.apache.pulsar.client.api.BatchReceivePolicy
    +
     
    +
    getMaxNumMessages() - Method in class org.apache.pulsar.client.api.BatchReceivePolicy
    +
     
    +
    getMaxOutputSize(int) - Method in interface org.apache.pulsar.client.api.MessageCrypto
    +
    +
    Return the maximum for a given buffer to be encrypted or decrypted.
    +
    +
    getMessageAt(int, int, MessagePayload, boolean, Schema<T>) - Method in interface org.apache.pulsar.client.api.MessagePayloadContext
    +
    +
    Get the internal single message with a specific index from a payload if the payload is a batch.
    +
    +
    getMessageId() - Method in interface org.apache.pulsar.client.api.Message
    +
    +
    Get the unique message ID associated with this message.
    +
    +
    getMetadata() - Method in class org.apache.pulsar.client.api.EncryptionKeyInfo
    +
     
    +
    getMsgNumInReceiverQueue() - Method in interface org.apache.pulsar.client.api.ConsumerStats
    +
    +
    Deprecated.
    +
    Get the size of receiver queue.
    +
    +
    getMsgNumInSubReceiverQueue() - Method in interface org.apache.pulsar.client.api.ConsumerStats
    +
    +
    Deprecated.
    +
    Get the receiver queue size of sub-consumers.
    +
    +
    getName() - Method in interface org.apache.pulsar.common.schema.SchemaInfo
    +
     
    +
    getNativeObject() - Method in interface org.apache.pulsar.client.api.schema.GenericObject
    +
    +
    Return the internal native representation of the Object, + like a AVRO GenericRecord, a String or a byte[].
    +
    +
    getNativeObject() - Method in interface org.apache.pulsar.client.api.schema.GenericRecord
    +
    +
    Return the internal native representation of the Record, + like a AVRO GenericRecord.
    +
    +
    getNativeSchema() - Method in interface org.apache.pulsar.client.api.Schema
    +
    +
    Return the native schema that is wrapped by Pulsar API.
    +
    +
    getNativeSchema() - Method in interface org.apache.pulsar.client.api.schema.SchemaReader
    +
    +
    Returns the underling Schema if possible.
    +
    +
    getNumAcksFailed() - Method in interface org.apache.pulsar.client.api.ConsumerStats
    +
    +
    Deprecated.
    + 
    +
    getNumAcksReceived() - Method in interface org.apache.pulsar.client.api.ProducerStats
    +
    +
    Deprecated.
    + 
    +
    getNumAcksSent() - Method in interface org.apache.pulsar.client.api.ConsumerStats
    +
    +
    Deprecated.
    + 
    +
    getNumBatchReceiveFailed() - Method in interface org.apache.pulsar.client.api.ConsumerStats
    +
    +
    Deprecated.
    + 
    +
    getNumBytesReceived() - Method in interface org.apache.pulsar.client.api.ConsumerStats
    +
    +
    Deprecated.
    + 
    +
    getNumBytesSent() - Method in interface org.apache.pulsar.client.api.ProducerStats
    +
    +
    Deprecated.
    + 
    +
    getNumMessages() - Method in interface org.apache.pulsar.client.api.MessagePayloadContext
    +
    +
    Get the number of messages when the payload is produced by Pulsar producer.
    +
    +
    getNumMessagesInBatch() - Method in interface org.apache.pulsar.client.api.BatchMessageContainer
    +
    +
    Get count of messages in the message batch container.
    +
    +
    getNumMsgsReceived() - Method in interface org.apache.pulsar.client.api.ConsumerStats
    +
    +
    Deprecated.
    + 
    +
    getNumMsgsSent() - Method in interface org.apache.pulsar.client.api.ProducerStats
    +
    +
    Deprecated.
    + 
    +
    getNumOfPartitions() - Method in interface org.apache.pulsar.client.api.Producer
    +
     
    +
    getNumReceiveFailed() - Method in interface org.apache.pulsar.client.api.ConsumerStats
    +
    +
    Deprecated.
    + 
    +
    getNumSendFailed() - Method in interface org.apache.pulsar.client.api.ProducerStats
    +
    +
    Deprecated.
    + 
    +
    getOrderingKey() - Method in interface org.apache.pulsar.client.api.Message
    +
    +
    Get the ordering key of the message.
    +
    +
    getOwnerTopic() - Method in interface org.apache.pulsar.client.api.TopicMessageId
    +
    +
    Return the owner topic name of a message.
    +
    +
    getPartitionsForTopic(String) - Method in interface org.apache.pulsar.client.api.PulsarClient
    +
    +
    Deprecated.
    +
    +
    getPartitionsForTopic(String, boolean) - Method in interface org.apache.pulsar.client.api.PulsarClient
    +
    +
    1.
    +
    +
    getPartitionStats() - Method in interface org.apache.pulsar.client.api.ConsumerStats
    +
    +
    Deprecated.
    + 
    +
    getPartitionStats() - Method in interface org.apache.pulsar.client.api.MultiTopicConsumerStats
    +
     
    +
    getPartitionStats() - Method in interface org.apache.pulsar.client.api.PartitionedTopicProducerStats
    +
     
    +
    getPartitionStats() - Method in interface org.apache.pulsar.client.api.ProducerStats
    +
    +
    Deprecated.
    + 
    +
    getPendingQueueSize() - Method in interface org.apache.pulsar.client.api.ProducerStats
    +
    +
    Deprecated.
    + 
    +
    getPendingRequestsCount() - Method in interface org.apache.pulsar.client.api.transaction.TransactionBufferClient
    +
     
    +
    getPojo() - Method in interface org.apache.pulsar.client.api.schema.SchemaDefinition
    +
    +
    Get pojo schema definition.
    +
    +
    getPrivateKey(String, Map<String, String>) - Method in interface org.apache.pulsar.client.api.CryptoKeyReader
    +
     
    +
    getPrivateKey(String, Map<String, String>) - Method in class org.apache.pulsar.client.api.DummyCryptoKeyReaderImpl
    +
     
    +
    getProducerName() - Method in interface org.apache.pulsar.client.api.Message
    +
    +
    Get the producer name who produced this message.
    +
    +
    getProducerName() - Method in interface org.apache.pulsar.client.api.Producer
    +
     
    +
    getProperties() - Method in interface org.apache.pulsar.client.api.Message
    +
    +
    Return the properties attached to the message.
    +
    +
    getProperties() - Method in interface org.apache.pulsar.client.api.schema.SchemaDefinition
    +
    +
    Get schema class.
    +
    +
    getProperties() - Method in interface org.apache.pulsar.common.schema.SchemaInfo
    +
    +
    Additional properties of the schema definition (implementation defined).
    +
    +
    getProperty(String) - Method in interface org.apache.pulsar.client.api.Message
    +
    +
    Get the value of a specific property.
    +
    +
    getProperty(String) - Method in interface org.apache.pulsar.client.api.MessagePayloadContext
    +
    +
    Get a value associated with the given key.
    +
    +
    getPublicKey(String, Map<String, String>) - Method in interface org.apache.pulsar.client.api.CryptoKeyReader
    +
    +
    Return the encryption key corresponding to the key name in the argument.
    +
    +
    getPublicKey(String, Map<String, String>) - Method in class org.apache.pulsar.client.api.DummyCryptoKeyReaderImpl
    +
     
    +
    getPublishTime() - Method in interface org.apache.pulsar.client.api.Message
    +
    +
    Get the publish time of this message.
    +
    +
    getRanges() - Method in class org.apache.pulsar.client.api.KeySharedPolicy.KeySharedPolicySticky
    +
     
    +
    getRateBytesReceived() - Method in interface org.apache.pulsar.client.api.ConsumerStats
    +
    +
    Deprecated.
    + 
    +
    getRateMsgsReceived() - Method in interface org.apache.pulsar.client.api.ConsumerStats
    +
    +
    Deprecated.
    + 
    +
    getReaderSchema() - Method in interface org.apache.pulsar.client.api.Message
    +
    +
    Get the schema associated to the message.
    +
    +
    getRedeliveryCount() - Method in interface org.apache.pulsar.client.api.Message
    +
    +
    Get message redelivery count, redelivery count maintain in pulsar broker.
    +
    +
    getReplicatedFrom() - Method in interface org.apache.pulsar.client.api.Message
    +
    +
    Get name of cluster, from which the message is replicated.
    +
    +
    getRetryLetterProducerStats() - Method in interface org.apache.pulsar.client.api.ConsumerStats
    +
    +
    Deprecated.
    + 
    +
    getSchema() - Method in interface org.apache.pulsar.common.schema.SchemaInfo
    +
    +
    The schema data in AVRO JSON format.
    +
    +
    getSchema(SchemaInfo) - Static method in interface org.apache.pulsar.client.api.Schema
    +
     
    +
    getSchema(SchemaInfo) - Method in interface org.apache.pulsar.client.internal.PulsarClientImplementationBinding
    +
     
    +
    getSchemaByVersion(byte[]) - Method in interface org.apache.pulsar.client.api.schema.SchemaInfoProvider
    +
    +
    Retrieve the schema info of a given schemaVersion.
    +
    +
    getSchemaDefinition() - Method in interface org.apache.pulsar.common.schema.SchemaInfo
    +
     
    +
    getSchemaInfo() - Method in interface org.apache.pulsar.client.api.Schema
    +
     
    +
    getSchemaReaderOpt() - Method in interface org.apache.pulsar.client.api.schema.SchemaDefinition
    +
    +
    Get a configured schema reader.
    +
    +
    getSchemaType() - Method in interface org.apache.pulsar.client.api.schema.GenericObject
    +
    +
    Return the schema tyoe.
    +
    +
    getSchemaType() - Method in interface org.apache.pulsar.client.api.schema.GenericRecord
    +
    +
    Return the schema tyoe.
    +
    +
    getSchemaVersion() - Method in interface org.apache.pulsar.client.api.Message
    +
    +
    Get schema version of the message.
    +
    +
    getSchemaVersion() - Method in interface org.apache.pulsar.client.api.schema.GenericRecord
    +
    +
    Return schema version.
    +
    +
    getSchemaWriterOpt() - Method in interface org.apache.pulsar.client.api.schema.SchemaDefinition
    +
    +
    Get a configured schema writer.
    +
    +
    getSendBytesRate() - Method in interface org.apache.pulsar.client.api.ProducerStats
    +
    +
    Deprecated.
    + 
    +
    getSendLatencyMillis50pct() - Method in interface org.apache.pulsar.client.api.ProducerStats
    +
    +
    Deprecated.
    + 
    +
    getSendLatencyMillis75pct() - Method in interface org.apache.pulsar.client.api.ProducerStats
    +
    +
    Deprecated.
    + 
    +
    getSendLatencyMillis95pct() - Method in interface org.apache.pulsar.client.api.ProducerStats
    +
    +
    Deprecated.
    + 
    +
    getSendLatencyMillis999pct() - Method in interface org.apache.pulsar.client.api.ProducerStats
    +
    +
    Deprecated.
    + 
    +
    getSendLatencyMillis99pct() - Method in interface org.apache.pulsar.client.api.ProducerStats
    +
    +
    Deprecated.
    + 
    +
    getSendLatencyMillisMax() - Method in interface org.apache.pulsar.client.api.ProducerStats
    +
    +
    Deprecated.
    + 
    +
    getSendMsgsRate() - Method in interface org.apache.pulsar.client.api.ProducerStats
    +
    +
    Deprecated.
    + 
    +
    getSequenceId() - Method in interface org.apache.pulsar.client.api.Message
    +
    +
    Get the sequence id associated with this message.
    +
    +
    getSequenceId() - Method in exception class org.apache.pulsar.client.api.PulsarClientException
    +
     
    +
    getServiceUrl() - Method in interface org.apache.pulsar.client.api.ServiceUrlProvider
    +
    +
    Get the current service URL the Pulsar client should connect to.
    +
    +
    getStart() - Method in class org.apache.pulsar.client.api.Range
    +
     
    +
    getState() - Method in interface org.apache.pulsar.client.api.transaction.Transaction
    +
    +
    Get transaction state.
    +
    +
    getState() - Method in interface org.apache.pulsar.client.api.transaction.TransactionCoordinatorClient
    +
    +
    Get current state of the transaction meta store.
    +
    +
    getStats() - Method in interface org.apache.pulsar.client.api.Consumer
    +
    +
    Get statistics for the consumer.
    +
    +
    getStats() - Method in interface org.apache.pulsar.client.api.Producer
    +
    +
    Get statistics for the producer.
    +
    +
    getSubscription() - Method in interface org.apache.pulsar.client.api.Consumer
    +
    +
    Get a subscription for the consumer.
    +
    +
    getSupportSchemaVersioning() - Method in interface org.apache.pulsar.client.api.schema.SchemaDefinition
    +
    +
    Get supportSchemaVersioning schema definition.
    +
    +
    getTimeoutMs() - Method in class org.apache.pulsar.client.api.BatchReceivePolicy
    +
     
    +
    getTimestamp() - Method in interface org.apache.pulsar.common.schema.SchemaInfo
    +
    +
    The created time of schema.
    +
    +
    GettingAuthenticationDataException(String) - Constructor for exception class org.apache.pulsar.client.api.PulsarClientException.GettingAuthenticationDataException
    +
    +
    Constructs an GettingAuthenticationDataException with the specified detail message.
    +
    +
    GettingAuthenticationDataException(Throwable) - Constructor for exception class org.apache.pulsar.client.api.PulsarClientException.GettingAuthenticationDataException
    +
    +
    Constructs an GettingAuthenticationDataException with the specified cause.
    +
    +
    getTlsCertificateFilePath() - Method in interface org.apache.pulsar.client.api.AuthenticationDataProvider
    +
     
    +
    getTlsCertificates() - Method in interface org.apache.pulsar.client.api.AuthenticationDataProvider
    +
     
    +
    getTlsKeyStoreParams() - Method in interface org.apache.pulsar.client.api.AuthenticationDataProvider
    +
    +
    Used for TLS authentication with keystore type.
    +
    +
    getTlsPrivateKey() - Method in interface org.apache.pulsar.client.api.AuthenticationDataProvider
    +
     
    +
    getTlsPrivateKeyFilePath() - Method in interface org.apache.pulsar.client.api.AuthenticationDataProvider
    +
     
    +
    getTlsTrustStoreStream() - Method in interface org.apache.pulsar.client.api.AuthenticationDataProvider
    +
     
    +
    getTopic() - Method in interface org.apache.pulsar.client.api.Consumer
    +
    +
    Get a topic for the consumer.
    +
    +
    getTopic() - Method in interface org.apache.pulsar.client.api.Producer
    +
     
    +
    getTopic() - Method in interface org.apache.pulsar.client.api.Reader
    +
     
    +
    getTopicName() - Method in interface org.apache.pulsar.client.api.Message
    +
    +
    Get the topic the message was published to.
    +
    +
    getTopicName() - Method in interface org.apache.pulsar.client.api.schema.SchemaInfoProvider
    +
    +
    Retrieve the topic name.
    +
    +
    getTotaBatchReceivedFailed() - Method in interface org.apache.pulsar.client.api.ConsumerStats
    +
    +
    Deprecated.
    + 
    +
    getTotalAcksFailed() - Method in interface org.apache.pulsar.client.api.ConsumerStats
    +
    +
    Deprecated.
    + 
    +
    getTotalAcksReceived() - Method in interface org.apache.pulsar.client.api.ProducerStats
    +
    +
    Deprecated.
    + 
    +
    getTotalAcksSent() - Method in interface org.apache.pulsar.client.api.ConsumerStats
    +
    +
    Deprecated.
    + 
    +
    getTotalBytesReceived() - Method in interface org.apache.pulsar.client.api.ConsumerStats
    +
    +
    Deprecated.
    + 
    +
    getTotalBytesSent() - Method in interface org.apache.pulsar.client.api.ProducerStats
    +
    +
    Deprecated.
    + 
    +
    getTotalMsgsReceived() - Method in interface org.apache.pulsar.client.api.ConsumerStats
    +
    +
    Deprecated.
    + 
    +
    getTotalMsgsSent() - Method in interface org.apache.pulsar.client.api.ProducerStats
    +
    +
    Deprecated.
    + 
    +
    getTotalReceivedFailed() - Method in interface org.apache.pulsar.client.api.ConsumerStats
    +
    +
    Deprecated.
    + 
    +
    getTotalSendFailed() - Method in interface org.apache.pulsar.client.api.ProducerStats
    +
    +
    Deprecated.
    + 
    +
    getTxnID() - Method in interface org.apache.pulsar.client.api.transaction.Transaction
    +
    +
    Get TxnID of the transaction.
    +
    +
    getType() - Method in interface org.apache.pulsar.common.schema.SchemaInfo
    +
    +
    The type of schema (AVRO, JSON, PROTOBUF, etc..).
    +
    +
    getValue() - Method in interface org.apache.pulsar.client.api.Message
    +
    +
    Get the de-serialized value of the message, according the configured Schema.
    +
    +
    getValue() - Method in enum class org.apache.pulsar.client.api.SubscriptionInitialPosition
    +
     
    +
    getValue() - Method in class org.apache.pulsar.common.schema.KeyValue
    +
     
    +
    getValue() - Method in enum class org.apache.pulsar.common.schema.SchemaType
    +
     
    +
    getValueSchema() - Method in interface org.apache.pulsar.client.api.schema.KeyValueSchema
    +
    +
    Get the Schema of the Value.
    +
    +
    GIGA_BYTES - Enum constant in enum class org.apache.pulsar.client.api.SizeUnit
    +
     
    +
    +

    H

    +
    +
    hasBase64EncodedKey() - Method in interface org.apache.pulsar.client.api.Message
    +
    +
    Check whether the key has been base64 encoded.
    +
    +
    hasBrokerPublishTime() - Method in interface org.apache.pulsar.client.api.Message
    +
    +
    Check whether the message has a broker publish time.
    +
    +
    hasDataForHttp() - Method in interface org.apache.pulsar.client.api.AuthenticationDataProvider
    +
    +
    Check if data for HTTP are available.
    +
    +
    hasDataForTls() - Method in interface org.apache.pulsar.client.api.AuthenticationDataProvider
    +
    +
    Check if data for TLS are available.
    +
    +
    hasDataFromCommand() - Method in interface org.apache.pulsar.client.api.AuthenticationDataProvider
    +
    +
    Check if data from Pulsar protocol are available.
    +
    +
    hashCode() - Method in class org.apache.pulsar.client.api.Range
    +
     
    +
    hashCode() - Method in class org.apache.pulsar.client.api.transaction.TxnID
    +
     
    +
    hashCode() - Method in class org.apache.pulsar.common.schema.KeyValue
    +
     
    +
    hashingScheme(HashingScheme) - Method in interface org.apache.pulsar.client.api.ProducerBuilder
    +
    +
    Change the HashingScheme used to choose the partition on which to publish a particular message.
    +
    +
    HashingScheme - Enum Class in org.apache.pulsar.client.api
    +
    +
    Standard hashing functions available when choosing the partition to use for a particular message.
    +
    +
    hasIndex() - Method in interface org.apache.pulsar.client.api.Message
    +
    +
    Check whether the message has an index.
    +
    +
    hasKey() - Method in interface org.apache.pulsar.client.api.Message
    +
    +
    Check whether the message has a key.
    +
    +
    hasMessageAvailable() - Method in interface org.apache.pulsar.client.api.Reader
    +
    +
    Check if there is any message available to read from the current position.
    +
    +
    hasMessageAvailableAsync() - Method in interface org.apache.pulsar.client.api.Reader
    +
    +
    Asynchronously check if there is any message available to read from the current position.
    +
    +
    hasOrderingKey() - Method in interface org.apache.pulsar.client.api.Message
    +
    +
    Check whether the message has a ordering key.
    +
    +
    hasProperty(String) - Method in interface org.apache.pulsar.client.api.Message
    +
    +
    Check whether the message has a specific property attached.
    +
    +
    hasReachedEndOfTopic() - Method in interface org.apache.pulsar.client.api.Consumer
    +
    +
    Return true if the topic was terminated and this consumer has already consumed all the messages in the topic.
    +
    +
    hasReachedEndOfTopic() - Method in interface org.apache.pulsar.client.api.Reader
    +
    +
    Return true if the topic was terminated and this reader has reached the end of the topic.
    +
    +
    +

    I

    +
    +
    IncompatibleSchemaException(String) - Constructor for exception class org.apache.pulsar.client.api.PulsarClientException.IncompatibleSchemaException
    +
    +
    Constructs an IncompatibleSchemaException with the specified detail message.
    +
    +
    IncompatibleSchemaException(Throwable) - Constructor for exception class org.apache.pulsar.client.api.PulsarClientException.IncompatibleSchemaException
    +
    +
    Constructs an IncompatibleSchemaException with the specified cause.
    +
    +
    INIT_AUTH_DATA - Static variable in class org.apache.pulsar.common.api.AuthData
    +
     
    +
    INIT_AUTH_DATA_BYTES - Static variable in class org.apache.pulsar.common.api.AuthData
    +
     
    +
    initialize(PulsarClient) - Method in interface org.apache.pulsar.client.api.ServiceUrlProvider
    +
    +
    Initialize the service url provider with Pulsar client instance.
    +
    +
    initialSequenceId(long) - Method in interface org.apache.pulsar.client.api.ProducerBuilder
    +
    +
    Set the baseline for sequence ids for messages published by the producer.
    +
    +
    INLINE - Enum constant in enum class org.apache.pulsar.common.schema.KeyValueEncodingType
    +
    +
    Key and value are stored as message payload.
    +
    +
    INSTANCE - Static variable in class org.apache.pulsar.client.api.DummyCryptoKeyReaderImpl
    +
     
    +
    INSTANT - Enum constant in enum class org.apache.pulsar.common.schema.SchemaType
    +
    +
    Instant.
    +
    +
    INSTANT - Static variable in interface org.apache.pulsar.client.api.Schema
    +
    +
    Instant Schema.
    +
    +
    INT16 - Enum constant in enum class org.apache.pulsar.common.schema.SchemaType
    +
    +
    A 16-byte integer.
    +
    +
    INT16 - Static variable in interface org.apache.pulsar.client.api.Schema
    +
    +
    INT16 Schema.
    +
    +
    INT32 - Enum constant in enum class org.apache.pulsar.common.schema.SchemaType
    +
    +
    A 32-byte integer.
    +
    +
    INT32 - Static variable in interface org.apache.pulsar.client.api.Schema
    +
    +
    INT32 Schema.
    +
    +
    INT64 - Enum constant in enum class org.apache.pulsar.common.schema.SchemaType
    +
    +
    A 64-byte integer.
    +
    +
    INT64 - Static variable in interface org.apache.pulsar.client.api.Schema
    +
    +
    INT64 Schema.
    +
    +
    INT8 - Enum constant in enum class org.apache.pulsar.common.schema.SchemaType
    +
    +
    A 8-byte integer.
    +
    +
    INT8 - Static variable in interface org.apache.pulsar.client.api.Schema
    +
    +
    INT8 Schema.
    +
    +
    intercept(ConsumerInterceptor<T>...) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
    +
    +
    Intercept Consumer.
    +
    +
    intercept(ProducerInterceptor...) - Method in interface org.apache.pulsar.client.api.ProducerBuilder
    +
    +
    Add a set of ProducerInterceptor to the producer.
    +
    +
    intercept(ProducerInterceptor<T>...) - Method in interface org.apache.pulsar.client.api.ProducerBuilder
    +
    +
    Deprecated.
    +
    +
    intercept(ReaderInterceptor<T>...) - Method in interface org.apache.pulsar.client.api.ReaderBuilder
    +
    +
    Intercept Reader.
    +
    +
    InterfaceAudience - Class in org.apache.pulsar.common.classification
    +
    +
    Annotation to inform users of a package, class or method's intended audience.
    +
    +
    InterfaceAudience.LimitedPrivate - Annotation Interface in org.apache.pulsar.common.classification
    +
    +
    Intended for use only within the project(s) specified in the annotation.
    +
    +
    InterfaceAudience.Private - Annotation Interface in org.apache.pulsar.common.classification
    +
    +
    Intended for use only within the project itself.
    +
    +
    InterfaceAudience.Public - Annotation Interface in org.apache.pulsar.common.classification
    +
    +
    Intended for use by any project or application.
    +
    +
    InterfaceStability - Class in org.apache.pulsar.common.classification
    +
    +
    Annotation to inform users of how much to rely on a particular package, + class or method not changing over time.
    +
    +
    InterfaceStability.Evolving - Annotation Interface in org.apache.pulsar.common.classification
    +
    +
    Evolving, but can break compatibility at minor release (i.e.
    +
    +
    InterfaceStability.Stable - Annotation Interface in org.apache.pulsar.common.classification
    +
    +
    Can evolve while retaining compatibility for minor release boundaries.; + can break compatibility only at major release (ie.
    +
    +
    InterfaceStability.Unstable - Annotation Interface in org.apache.pulsar.common.classification
    +
    +
    No guarantee is provided as to reliability or stability across any + level of release granularity.
    +
    +
    intersect(Range) - Method in class org.apache.pulsar.client.api.Range
    +
     
    +
    InvalidConfigurationException(String) - Constructor for exception class org.apache.pulsar.client.api.PulsarClientException.InvalidConfigurationException
    +
    +
    Constructs an InvalidConfigurationException with the specified detail message.
    +
    +
    InvalidConfigurationException(String, Throwable) - Constructor for exception class org.apache.pulsar.client.api.PulsarClientException.InvalidConfigurationException
    +
    +
    Constructs an InvalidConfigurationException with the specified cause.
    +
    +
    InvalidConfigurationException(Throwable) - Constructor for exception class org.apache.pulsar.client.api.PulsarClientException.InvalidConfigurationException
    +
    +
    Constructs an InvalidConfigurationException with the specified cause.
    +
    +
    InvalidMessageException(String) - Constructor for exception class org.apache.pulsar.client.api.PulsarClientException.InvalidMessageException
    +
    +
    Constructs an InvalidMessageException with the specified detail message.
    +
    +
    InvalidMessageException(String, long) - Constructor for exception class org.apache.pulsar.client.api.PulsarClientException.InvalidMessageException
    +
    +
    Constructs an InvalidMessageException with the specified detail message.
    +
    +
    InvalidServiceURL(String, Throwable) - Constructor for exception class org.apache.pulsar.client.api.PulsarClientException.InvalidServiceURL
    +
    +
    Constructs an InvalidServiceURL with the specified cause.
    +
    +
    InvalidServiceURL(Throwable) - Constructor for exception class org.apache.pulsar.client.api.PulsarClientException.InvalidServiceURL
    +
    +
    Constructs an InvalidServiceURL with the specified cause.
    +
    +
    InvalidTopicNameException(String) - Constructor for exception class org.apache.pulsar.client.api.PulsarClientException.InvalidTopicNameException
    +
    +
    Constructs an InvalidTopicNameException with the specified detail message.
    +
    +
    InvalidTxnStatusException(String) - Constructor for exception class org.apache.pulsar.client.api.transaction.TransactionCoordinatorClientException.InvalidTxnStatusException
    +
     
    +
    InvalidTxnStatusException(String, String, String) - Constructor for exception class org.apache.pulsar.client.api.transaction.TransactionCoordinatorClientException.InvalidTxnStatusException
    +
     
    +
    ioThreads(int) - Method in interface org.apache.pulsar.client.api.ClientBuilder
    +
    +
    Set the number of threads to be used for handling connections to brokers + (default: Runtime.getRuntime().availableProcessors()).
    +
    +
    isAckReceiptEnabled(boolean) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
    +
    +
    Enables or disables the acknowledgment receipt feature.
    +
    +
    isAllowOutOfOrderDelivery() - Method in class org.apache.pulsar.client.api.KeySharedPolicy
    +
     
    +
    isBatch() - Method in interface org.apache.pulsar.client.api.MessagePayloadContext
    +
    +
    Check whether the payload is a batch when the payload is produced by Pulsar producer.
    +
    +
    isClosed() - Method in interface org.apache.pulsar.client.api.PulsarClient
    +
    +
    Return internal state of the client.
    +
    +
    isComplete() - Method in class org.apache.pulsar.common.api.AuthData
    +
     
    +
    isConnected() - Method in interface org.apache.pulsar.client.api.Consumer
    +
     
    +
    isConnected() - Method in interface org.apache.pulsar.client.api.Producer
    +
     
    +
    isConnected() - Method in interface org.apache.pulsar.client.api.Reader
    +
     
    +
    isEmpty() - Method in interface org.apache.pulsar.client.api.BatchMessageContainer
    +
    +
    Check the message batch container is empty.
    +
    +
    isEmpty() - Method in interface org.apache.pulsar.client.api.TableView
    +
    +
    Returns true if this TableView contains no key-value mappings.
    +
    +
    isJsr310ConversionEnabled() - Method in interface org.apache.pulsar.client.api.schema.SchemaDefinition
    +
    +
    Get JSR310 conversion enabled.
    +
    +
    isMessagesFromMultiTopicsEnabled() - Method in class org.apache.pulsar.client.api.BatchReceivePolicy
    +
     
    +
    isMultiBatches() - Method in interface org.apache.pulsar.client.api.BatchMessageContainer
    +
    +
    Return the batch container batch message in multiple batches.
    +
    +
    isPrimitive() - Method in enum class org.apache.pulsar.common.schema.SchemaType
    +
     
    +
    isPrimitiveType(SchemaType) - Static method in enum class org.apache.pulsar.common.schema.SchemaType
    +
     
    +
    isReplicated() - Method in interface org.apache.pulsar.client.api.Message
    +
    +
    Check whether the message is replicated from other cluster.
    +
    +
    isRetriableError(Throwable) - Static method in exception class org.apache.pulsar.client.api.PulsarClientException
    +
     
    +
    isStruct() - Method in enum class org.apache.pulsar.common.schema.SchemaType
    +
     
    +
    isStructType(SchemaType) - Static method in enum class org.apache.pulsar.common.schema.SchemaType
    +
     
    +
    IV_LEN - Static variable in interface org.apache.pulsar.client.api.MessageCrypto
    +
     
    +
    +

    J

    +
    +
    JavaStringHash - Enum constant in enum class org.apache.pulsar.client.api.HashingScheme
    +
    +
    Use regular String.hashCode().
    +
    +
    JSON - Enum constant in enum class org.apache.pulsar.common.schema.SchemaType
    +
    +
    JSON object encoding and validation.
    +
    +
    JSON(Class<T>) - Static method in interface org.apache.pulsar.client.api.Schema
    +
    +
    Create a JSON schema type by extracting the fields of the specified class.
    +
    +
    JSON(SchemaDefinition) - Static method in interface org.apache.pulsar.client.api.Schema
    +
    +
    Create a JSON schema type with schema definition.
    +
    +
    jsonifyKeyValueSchemaInfo(KeyValue<SchemaInfo, SchemaInfo>) - Method in interface org.apache.pulsar.client.internal.PulsarClientImplementationBinding
    +
    +
    Jsonify the key/value schema info.
    +
    +
    jsonifySchemaInfo(SchemaInfo) - Method in interface org.apache.pulsar.client.internal.PulsarClientImplementationBinding
    +
    +
    Jsonify the schema info.
    +
    +
    jsonifySchemaInfoWithVersion(SchemaInfoWithVersion) - Method in interface org.apache.pulsar.client.internal.PulsarClientImplementationBinding
    +
    +
    Jsonify the schema info with version.
    +
    +
    +

    K

    +
    +
    keepAliveInterval(int, TimeUnit) - Method in interface org.apache.pulsar.client.api.ClientBuilder
    +
    +
    Set keep alive interval for each client-broker-connection.
    +
    +
    key(String) - Method in interface org.apache.pulsar.client.api.TypedMessageBuilder
    +
    +
    Sets the key of the message for routing policy.
    +
    +
    KEY_BASED - Static variable in interface org.apache.pulsar.client.api.BatcherBuilder
    +
    +
    Key based batch message container.
    +
    +
    Key_Shared - Enum constant in enum class org.apache.pulsar.client.api.SubscriptionType
    +
    +
    Multiple consumer will be able to use the same subscription and all messages with the same key + will be dispatched to only one consumer.
    +
    +
    KEY_VALUE - Enum constant in enum class org.apache.pulsar.common.schema.SchemaType
    +
    +
    A Schema that contains Key Schema and Value Schema.
    +
    +
    keyBytes(byte[]) - Method in interface org.apache.pulsar.client.api.TypedMessageBuilder
    +
    +
    Sets the bytes of the key of the message for routing policy.
    +
    +
    keyHashRange(Range...) - Method in interface org.apache.pulsar.client.api.ReaderBuilder
    +
    +
    Set key hash range of the reader, broker will only dispatch messages which hash of the message key contains by + the specified key hash range.
    +
    +
    keySet() - Method in interface org.apache.pulsar.client.api.TableView
    +
    +
    Returns a Set view of the keys contained in this TableView.
    +
    +
    keySharedMode - Variable in class org.apache.pulsar.client.api.KeySharedPolicy
    +
     
    +
    KeySharedMode - Enum Class in org.apache.pulsar.client.api
    +
    +
    KeyShared mode of KeyShared subscription.
    +
    +
    keySharedPolicy(KeySharedPolicy) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
    +
    +
    Sets KeyShared subscription policy for consumer.
    +
    +
    KeySharedPolicy - Class in org.apache.pulsar.client.api
    +
    +
    KeyShared policy for KeyShared subscription.
    +
    +
    KeySharedPolicy() - Constructor for class org.apache.pulsar.client.api.KeySharedPolicy
    +
     
    +
    KeySharedPolicy.KeySharedPolicyAutoSplit - Class in org.apache.pulsar.client.api
    +
    +
    Auto split hash range key shared policy.
    +
    +
    KeySharedPolicy.KeySharedPolicySticky - Class in org.apache.pulsar.client.api
    +
    +
    Sticky attach topic with fixed hash range.
    +
    +
    KeyStoreParams - Class in org.apache.pulsar.client.api
    +
    +
    KeyStore parameters used for tls authentication.
    +
    +
    KeyStoreParams() - Constructor for class org.apache.pulsar.client.api.KeyStoreParams
    +
     
    +
    KeyValue<K,V> - Class in org.apache.pulsar.common.schema
    +
    +
    A simple KeyValue class.
    +
    +
    KeyValue(K, V) - Constructor for class org.apache.pulsar.common.schema.KeyValue
    +
     
    +
    KeyValue(Class<K>, Class<V>) - Static method in interface org.apache.pulsar.client.api.Schema
    +
    +
    Key Value Schema whose underneath key and value schemas are JSONSchema.
    +
    +
    KeyValue(Class<K>, Class<V>, SchemaType) - Static method in interface org.apache.pulsar.client.api.Schema
    +
    +
    Key Value Schema using passed in schema type, support JSON and AVRO currently.
    +
    +
    KeyValue(Schema<K>, Schema<V>) - Static method in interface org.apache.pulsar.client.api.Schema
    +
    +
    Key Value Schema using passed in key and value schemas with KeyValueEncodingType.INLINE encoding type.
    +
    +
    KeyValue(Schema<K>, Schema<V>, KeyValueEncodingType) - Static method in interface org.apache.pulsar.client.api.Schema
    +
    +
    Key Value Schema using passed in key, value and encoding type schemas.
    +
    +
    KeyValue.KeyValueDecoder<K,V> - Interface in org.apache.pulsar.common.schema
    +
    +
    Decoder to decode key/value bytes.
    +
    +
    KeyValueEncodingType - Enum Class in org.apache.pulsar.common.schema
    +
    +
    Encoding types of supported KeyValueSchema for Pulsar messages.
    +
    +
    KeyValueSchema<K,V> - Interface in org.apache.pulsar.client.api.schema
    +
    +
    This interface models a Schema that is composed of two parts.
    +
    +
    KILO_BYTES - Enum constant in enum class org.apache.pulsar.client.api.SizeUnit
    +
     
    +
    KV_BYTES() - Static method in interface org.apache.pulsar.client.api.Schema
    +
    +
    Schema that can be used to encode/decode KeyValue.
    +
    +
    +

    L

    +
    +
    latest - Static variable in interface org.apache.pulsar.client.api.MessageId
    +
    +
    MessageId that represents the next message published in the topic.
    +
    +
    Latest - Enum constant in enum class org.apache.pulsar.client.api.SubscriptionInitialPosition
    +
    +
    The latest position which means the start consuming position will be the last message.
    +
    +
    listen(BiConsumer<String, T>) - Method in interface org.apache.pulsar.client.api.TableView
    +
    +
    Performs the given action for each future entry in this map until all entries + have been processed or the action throws an exception.
    +
    +
    listenerName(String) - Method in interface org.apache.pulsar.client.api.ClientBuilder
    +
    +
    Configure the listenerName that the broker will return the corresponding `advertisedListener`.
    +
    +
    listenerThreads(int) - Method in interface org.apache.pulsar.client.api.ClientBuilder
    +
    +
    Set the number of threads to be used for message listeners + (default: Runtime.getRuntime().availableProcessors()).
    +
    +
    loadConf(Map<String, Object>) - Method in interface org.apache.pulsar.client.api.ClientBuilder
    +
    +
    Load the configuration from provided config map.
    +
    +
    loadConf(Map<String, Object>) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
    +
    +
    Load the configuration from provided config map.
    +
    +
    loadConf(Map<String, Object>) - Method in interface org.apache.pulsar.client.api.ProducerBuilder
    +
    +
    Load the configuration from provided config map.
    +
    +
    loadConf(Map<String, Object>) - Method in interface org.apache.pulsar.client.api.ReaderBuilder
    +
    +
    Load the configuration from provided config map.
    +
    +
    loadConf(Map<String, Object>) - Method in interface org.apache.pulsar.client.api.TableViewBuilder
    +
    +
    Load the configuration from provided config map.
    +
    +
    loadConf(Map<String, Object>) - Method in interface org.apache.pulsar.client.api.TypedMessageBuilder
    +
    +
    Configure the TypedMessageBuilder from a config map, as an alternative compared + to call the individual builder methods.
    +
    +
    LOCAL_DATE - Enum constant in enum class org.apache.pulsar.common.schema.SchemaType
    +
    +
    LocalDate.
    +
    +
    LOCAL_DATE - Static variable in interface org.apache.pulsar.client.api.Schema
    +
    +
    LocalDate Schema.
    +
    +
    LOCAL_DATE_TIME - Enum constant in enum class org.apache.pulsar.common.schema.SchemaType
    +
    +
    LocalDateTime.
    +
    +
    LOCAL_DATE_TIME - Static variable in interface org.apache.pulsar.client.api.Schema
    +
    +
    LocalDateTime Schema.
    +
    +
    LOCAL_TIME - Enum constant in enum class org.apache.pulsar.common.schema.SchemaType
    +
    +
    LocalTime.
    +
    +
    LOCAL_TIME - Static variable in interface org.apache.pulsar.client.api.Schema
    +
    +
    LocalTime Schema.
    +
    +
    LookupException(String) - Constructor for exception class org.apache.pulsar.client.api.PulsarClientException.LookupException
    +
    +
    Constructs an LookupException with the specified detail message.
    +
    +
    lookupProperties(Map<String, String>) - Method in interface org.apache.pulsar.client.api.ClientBuilder
    +
    +
    Set the properties used for topic lookup.
    +
    +
    lookupTimeout(int, TimeUnit) - Method in interface org.apache.pulsar.client.api.ClientBuilder
    +
    +
    Set lookup timeout (default: matches operation timeout)
    +
    +
    LZ4 - Enum constant in enum class org.apache.pulsar.client.api.CompressionType
    +
    +
    Compress with LZ4 algorithm.
    +
    +
    +

    M

    +
    +
    maxAcknowledgmentGroupSize(int) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
    +
    +
    Set the number of messages for group consumer acknowledgments.
    +
    +
    maxBackoffInterval(long, TimeUnit) - Method in interface org.apache.pulsar.client.api.ClientBuilder
    +
    +
    Set the maximum duration of time for a backoff interval.
    +
    +
    maxConcurrentLookupRequests(int) - Method in interface org.apache.pulsar.client.api.ClientBuilder
    +
    +
    Number of concurrent lookup-requests allowed to send on each broker-connection to prevent overload on broker.
    +
    +
    maxLookupRedirects(int) - Method in interface org.apache.pulsar.client.api.ClientBuilder
    +
    +
    Set the maximum number of times a lookup-request to a broker will be redirected.
    +
    +
    maxLookupRequests(int) - Method in interface org.apache.pulsar.client.api.ClientBuilder
    +
    +
    Number of max lookup-requests allowed on each broker-connection to prevent overload on broker.
    +
    +
    maxNumberOfRejectedRequestPerConnection(int) - Method in interface org.apache.pulsar.client.api.ClientBuilder
    +
    +
    Set max number of broker-rejected requests in a certain time-frame (60 seconds) after which current connection + will be closed and client creates a new connection that give chance to connect a different broker (default: + 50).
    +
    +
    maxNumBytes(int) - Method in class org.apache.pulsar.client.api.BatchReceivePolicy.Builder
    +
     
    +
    maxNumMessages(int) - Method in class org.apache.pulsar.client.api.BatchReceivePolicy.Builder
    +
     
    +
    maxPendingChuckedMessage(int) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
    +
    +
    Deprecated. +
    use ConsumerBuilder.maxPendingChunkedMessage(int)
    +
    +
    +
    maxPendingChunkedMessage(int) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
    +
    +
    Consumer buffers chunk messages into memory until it receives all the chunks of the original message.
    +
    +
    maxPendingChunkedMessage(int) - Method in interface org.apache.pulsar.client.api.ReaderBuilder
    +
    +
    Consumer buffers chunk messages into memory until it receives all the chunks of the original message.
    +
    +
    maxPendingMessages(int) - Method in interface org.apache.pulsar.client.api.ProducerBuilder
    +
    +
    Set the max size of the queue holding the messages pending to receive an acknowledgment from the broker.
    +
    +
    maxPendingMessagesAcrossPartitions(int) - Method in interface org.apache.pulsar.client.api.ProducerBuilder
    +
    +
    Deprecated.
    +
    +
    maxTotalReceiverQueueSizeAcrossPartitions(int) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
    +
    +
    Sets the max total receiver queue size across partitions.
    +
    +
    MEGA_BYTES - Enum constant in enum class org.apache.pulsar.client.api.SizeUnit
    +
     
    +
    MemoryBufferIsFullError(String) - Constructor for exception class org.apache.pulsar.client.api.PulsarClientException.MemoryBufferIsFullError
    +
    +
    Constructs an MemoryBufferIsFullError with the specified detail message.
    +
    +
    MemoryBufferIsFullError(String, long) - Constructor for exception class org.apache.pulsar.client.api.PulsarClientException.MemoryBufferIsFullError
    +
    +
    Constructs an MemoryBufferIsFullError with the specified detail message.
    +
    +
    memoryLimit(long, SizeUnit) - Method in interface org.apache.pulsar.client.api.ClientBuilder
    +
    +
    Configure a limit on the amount of direct memory that will be allocated by this client instance.
    +
    +
    Message<T> - Interface in org.apache.pulsar.client.api
    +
    +
    The message abstraction used in Pulsar.
    +
    +
    MessageAcknowledgeException(String) - Constructor for exception class org.apache.pulsar.client.api.PulsarClientException.MessageAcknowledgeException
    +
    +
    Constructs an MessageAcknowledgeException with the specified detail message.
    +
    +
    MessageAcknowledgeException(Throwable) - Constructor for exception class org.apache.pulsar.client.api.PulsarClientException.MessageAcknowledgeException
    +
    +
    Constructs an MessageAcknowledgeException with the specified cause.
    +
    +
    MessageAcknowledger - Interface in org.apache.pulsar.client.api
    +
    +
    The interface to acknowledge one or more messages individually or cumulatively.
    +
    +
    messageCrypto(MessageCrypto) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
    +
    +
    Sets a MessageCrypto.
    +
    +
    messageCrypto(MessageCrypto) - Method in interface org.apache.pulsar.client.api.ProducerBuilder
    +
    +
    Sets a MessageCrypto.
    +
    +
    messageCrypto(MessageCrypto) - Method in interface org.apache.pulsar.client.api.ReaderBuilder
    +
    +
    Sets a MessageCrypto.
    +
    +
    MessageCrypto<MetadataT,BuilderT> - Interface in org.apache.pulsar.client.api
    +
    +
    Interface that abstracts the method to encrypt/decrypt message for End to End Encryption.
    +
    +
    MessageId - Interface in org.apache.pulsar.client.api
    +
    +
    Opaque unique identifier of a single message
    +
    +
    messageListener(MessageListener<T>) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
    +
    +
    Sets a MessageListener for the consumer.
    +
    +
    MessageListener<T> - Interface in org.apache.pulsar.client.api
    +
    +
    A listener that will be called in order for every message received.
    +
    +
    messageListenerExecutor(MessageListenerExecutor) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
    +
    +
    Set the MessageListenerExecutor to be used for message listeners of current consumer.
    +
    +
    MessageListenerExecutor - Interface in org.apache.pulsar.client.api
    +
    +
    Interface for providing service to execute message listeners.
    +
    +
    MessagePayload - Interface in org.apache.pulsar.client.api
    +
    +
    The abstraction of a message's payload.
    +
    +
    MessagePayloadContext - Interface in org.apache.pulsar.client.api
    +
    +
    The context of the message payload, which usually represents a batched message (batch) or a single message.
    +
    +
    MessagePayloadFactory - Interface in org.apache.pulsar.client.api
    +
    +
    The factory class of MessagePayload.
    +
    +
    messagePayloadProcessor(MessagePayloadProcessor) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
    +
    +
    If configured with a non-null value, the consumer uses the processor to process the payload, including + decoding it to messages and triggering the listener.
    +
    +
    MessagePayloadProcessor - Interface in org.apache.pulsar.client.api
    +
    +
    The processor to process a message payload.
    +
    +
    messageRouter(MessageRouter) - Method in interface org.apache.pulsar.client.api.ProducerBuilder
    +
    +
    Set a custom message routing policy by passing an implementation of MessageRouter.
    +
    +
    MessageRouter - Interface in org.apache.pulsar.client.api
    +
    +
    Interface for custom message router that can be passed + to a producer to select the partition that a particular + messsage should be published on.
    +
    +
    messageRoutingMode(MessageRoutingMode) - Method in interface org.apache.pulsar.client.api.ProducerBuilder
    +
    +
    Set the MessageRoutingMode for a partitioned producer.
    +
    +
    MessageRoutingMode - Enum Class in org.apache.pulsar.client.api
    +
    +
    Default routing mode for messages to partition.
    +
    +
    Messages<T> - Interface in org.apache.pulsar.client.api
    +
    +
    A container that holds the list Message for a topic.
    +
    +
    messagesFromMultiTopicsEnabled(boolean) - Method in class org.apache.pulsar.client.api.BatchReceivePolicy.Builder
    +
     
    +
    MetaStoreHandlerNotExistsException(long) - Constructor for exception class org.apache.pulsar.client.api.transaction.TransactionCoordinatorClientException.MetaStoreHandlerNotExistsException
    +
     
    +
    MetaStoreHandlerNotExistsException(String) - Constructor for exception class org.apache.pulsar.client.api.transaction.TransactionCoordinatorClientException.MetaStoreHandlerNotExistsException
    +
     
    +
    MetaStoreHandlerNotReadyException(long) - Constructor for exception class org.apache.pulsar.client.api.transaction.TransactionCoordinatorClientException.MetaStoreHandlerNotReadyException
    +
     
    +
    MetaStoreHandlerNotReadyException(String) - Constructor for exception class org.apache.pulsar.client.api.transaction.TransactionCoordinatorClientException.MetaStoreHandlerNotReadyException
    +
     
    +
    MultiTopicConsumerStats - Interface in org.apache.pulsar.client.api
    +
    +
    Multi-topic Consumer statistics recorded by client.
    +
    +
    Murmur3_32Hash - Enum constant in enum class org.apache.pulsar.client.api.HashingScheme
    +
    +
    Use Murmur3 hashing function.
    +
    +
    +

    N

    +
    +
    name(String) - Method in class org.apache.pulsar.common.schema.SchemaInfo.SchemaInfoBuilder
    +
     
    +
    NATIVE_AVRO(Object) - Static method in interface org.apache.pulsar.client.api.Schema
    +
    +
    Create a schema instance that accepts a serialized Avro payload + without validating it against the schema specified.
    +
    +
    negativeAcknowledge(Message<?>) - Method in interface org.apache.pulsar.client.api.Consumer
    +
    +
    Acknowledge the failure to process a single message.
    +
    +
    negativeAcknowledge(MessageId) - Method in interface org.apache.pulsar.client.api.Consumer
    +
    +
    Acknowledge the failure to process a single message.
    +
    +
    negativeAcknowledge(Messages<?>) - Method in interface org.apache.pulsar.client.api.Consumer
    +
    +
    Acknowledge the failure to process Messages.
    +
    +
    negativeAckRedeliveryBackoff(RedeliveryBackoff) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
    +
    +
    negativeAckRedeliveryBackoff sets the redelivery backoff policy for messages that are negatively acknowledged + using + `consumer.negativeAcknowledge(Messageinvalid input: '<'?> message)` but not with `consumer.negativeAcknowledge(MessageId + messageId)`.
    +
    +
    negativeAckRedeliveryDelay(long, TimeUnit) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
    +
    +
    Sets the delay to wait before re-delivering messages that have failed to be processed.
    +
    +
    newAuthenticationTLS(String, String) - Method in interface org.apache.pulsar.client.internal.PulsarClientImplementationBinding
    +
     
    +
    newAuthenticationToken(String) - Method in interface org.apache.pulsar.client.internal.PulsarClientImplementationBinding
    +
     
    +
    newAuthenticationToken(Supplier<String>) - Method in interface org.apache.pulsar.client.internal.PulsarClientImplementationBinding
    +
     
    +
    newAutoConsumeSchema() - Method in interface org.apache.pulsar.client.internal.PulsarClientImplementationBinding
    +
     
    +
    newAutoProduceSchema() - Method in interface org.apache.pulsar.client.internal.PulsarClientImplementationBinding
    +
     
    +
    newAutoProduceSchema(Schema<?>) - Method in interface org.apache.pulsar.client.internal.PulsarClientImplementationBinding
    +
     
    +
    newAutoProduceValidatedAvroSchema(Object) - Method in interface org.apache.pulsar.client.internal.PulsarClientImplementationBinding
    +
     
    +
    newAvroSchema(SchemaDefinition) - Method in interface org.apache.pulsar.client.internal.PulsarClientImplementationBinding
    +
     
    +
    newBooleanSchema() - Method in interface org.apache.pulsar.client.internal.PulsarClientImplementationBinding
    +
     
    +
    newByteBufferSchema() - Method in interface org.apache.pulsar.client.internal.PulsarClientImplementationBinding
    +
     
    +
    newByteSchema() - Method in interface org.apache.pulsar.client.internal.PulsarClientImplementationBinding
    +
     
    +
    newBytesSchema() - Method in interface org.apache.pulsar.client.internal.PulsarClientImplementationBinding
    +
     
    +
    newClientBuilder() - Method in interface org.apache.pulsar.client.internal.PulsarClientImplementationBinding
    +
     
    +
    newConsumer() - Method in interface org.apache.pulsar.client.api.PulsarClient
    +
    +
    Create a consumer builder with no schema (Schema.BYTES) for subscribing to + one or more topics.
    +
    +
    newConsumer(Schema<T>) - Method in interface org.apache.pulsar.client.api.PulsarClient
    +
    +
    Create a consumer builder with a specific schema for subscribing on a specific topic
    +
    +
    newDateSchema() - Method in interface org.apache.pulsar.client.internal.PulsarClientImplementationBinding
    +
     
    +
    newDefaultBatcherBuilder() - Method in interface org.apache.pulsar.client.internal.PulsarClientImplementationBinding
    +
     
    +
    newDefaultMessagePayloadFactory() - Method in interface org.apache.pulsar.client.internal.PulsarClientImplementationBinding
    +
     
    +
    newDoubleSchema() - Method in interface org.apache.pulsar.client.internal.PulsarClientImplementationBinding
    +
     
    +
    newFloatSchema() - Method in interface org.apache.pulsar.client.internal.PulsarClientImplementationBinding
    +
     
    +
    newInstantSchema() - Method in interface org.apache.pulsar.client.internal.PulsarClientImplementationBinding
    +
     
    +
    newIntSchema() - Method in interface org.apache.pulsar.client.internal.PulsarClientImplementationBinding
    +
     
    +
    newJSONSchema(SchemaDefinition) - Method in interface org.apache.pulsar.client.internal.PulsarClientImplementationBinding
    +
     
    +
    newKeyBasedBatcherBuilder() - Method in interface org.apache.pulsar.client.internal.PulsarClientImplementationBinding
    +
     
    +
    newKeyValueBytesSchema() - Method in interface org.apache.pulsar.client.internal.PulsarClientImplementationBinding
    +
     
    +
    newKeyValueSchema(Class<K>, Class<V>, SchemaType) - Method in interface org.apache.pulsar.client.internal.PulsarClientImplementationBinding
    +
     
    +
    newKeyValueSchema(Schema<K>, Schema<V>, KeyValueEncodingType) - Method in interface org.apache.pulsar.client.internal.PulsarClientImplementationBinding
    +
     
    +
    newLocalDateSchema() - Method in interface org.apache.pulsar.client.internal.PulsarClientImplementationBinding
    +
     
    +
    newLocalDateTimeSchema() - Method in interface org.apache.pulsar.client.internal.PulsarClientImplementationBinding
    +
     
    +
    newLocalTimeSchema() - Method in interface org.apache.pulsar.client.internal.PulsarClientImplementationBinding
    +
     
    +
    newLongSchema() - Method in interface org.apache.pulsar.client.internal.PulsarClientImplementationBinding
    +
     
    +
    newMessage() - Method in interface org.apache.pulsar.client.api.Producer
    +
    +
    Create a new message builder.
    +
    +
    newMessage(Schema<V>) - Method in interface org.apache.pulsar.client.api.Producer
    +
    +
    Create a new message builder with schema, not required same parameterized type with the producer.
    +
    +
    newMessage(Transaction) - Method in interface org.apache.pulsar.client.api.Producer
    +
    +
    Create a new message builder with transaction.
    +
    +
    newMessageId(long, long, int) - Method in interface org.apache.pulsar.client.internal.PulsarClientImplementationBinding
    +
     
    +
    newMessageIdFromByteArray(byte[]) - Method in interface org.apache.pulsar.client.internal.PulsarClientImplementationBinding
    +
     
    +
    newMessageIdFromByteArrayWithTopic(byte[], String) - Method in interface org.apache.pulsar.client.internal.PulsarClientImplementationBinding
    +
     
    +
    newProducer() - Method in interface org.apache.pulsar.client.api.PulsarClient
    +
    +
    Create a producer builder that can be used to configure + and construct a producer with default Schema.BYTES.
    +
    +
    newProducer(Schema<T>) - Method in interface org.apache.pulsar.client.api.PulsarClient
    +
    +
    Create a producer builder that can be used to configure + and construct a producer with the specified schema.
    +
    +
    newProtobufNativeSchema(SchemaDefinition) - Method in interface org.apache.pulsar.client.internal.PulsarClientImplementationBinding
    +
     
    +
    newProtobufSchema(SchemaDefinition) - Method in interface org.apache.pulsar.client.internal.PulsarClientImplementationBinding
    +
     
    +
    newReader() - Method in interface org.apache.pulsar.client.api.PulsarClient
    +
    +
    Create a topic reader builder with no schema (Schema.BYTES) to read from the specified topic.
    +
    +
    newReader(Schema<T>) - Method in interface org.apache.pulsar.client.api.PulsarClient
    +
    +
    Create a topic reader builder with a specific Schema) to read from the specified topic.
    +
    +
    newRecordBuilder() - Method in interface org.apache.pulsar.client.api.schema.GenericSchema
    +
    +
    Create a builder to build GenericRecord.
    +
    +
    newRecordSchemaBuilder(String) - Method in interface org.apache.pulsar.client.internal.PulsarClientImplementationBinding
    +
     
    +
    newRequestHeader(String, AuthenticationDataProvider, Map<String, String>) - Method in interface org.apache.pulsar.client.api.Authentication
    +
    +
    Add an authenticationStage that will complete along with authFuture.
    +
    +
    newSchemaDefinitionBuilder() - Method in interface org.apache.pulsar.client.internal.PulsarClientImplementationBinding
    +
     
    +
    newSchemaInfoImpl(String, byte[], SchemaType, long, Map<String, String>) - Method in interface org.apache.pulsar.client.internal.PulsarClientImplementationBinding
    +
     
    +
    newShortSchema() - Method in interface org.apache.pulsar.client.internal.PulsarClientImplementationBinding
    +
     
    +
    newStringSchema() - Method in interface org.apache.pulsar.client.internal.PulsarClientImplementationBinding
    +
     
    +
    newStringSchema(Charset) - Method in interface org.apache.pulsar.client.internal.PulsarClientImplementationBinding
    +
     
    +
    newTableView() - Method in interface org.apache.pulsar.client.api.PulsarClient
    +
    +
    Create a table view builder for subscribing on a specific topic.
    +
    +
    newTableView(Schema<T>) - Method in interface org.apache.pulsar.client.api.PulsarClient
    +
    +
    Create a table view builder with a specific schema for subscribing on a specific topic.
    +
    +
    newTableViewBuilder(Schema<T>) - Method in interface org.apache.pulsar.client.api.PulsarClient
    +
    +
    Deprecated. +
    Use PulsarClient.newTableView(Schema) to build and configure a TableViewBuilder + instance
    +
    +
    +
    newTimeSchema() - Method in interface org.apache.pulsar.client.internal.PulsarClientImplementationBinding
    +
     
    +
    newTimestampSchema() - Method in interface org.apache.pulsar.client.internal.PulsarClientImplementationBinding
    +
     
    +
    newTopicMessageId(String, MessageId) - Method in interface org.apache.pulsar.client.internal.PulsarClientImplementationBinding
    +
     
    +
    newTransaction() - Method in interface org.apache.pulsar.client.api.PulsarClient
    +
    +
    Create a transaction builder that can be used to configure + and construct a transaction.
    +
    +
    newTransaction() - Method in interface org.apache.pulsar.client.api.transaction.TransactionCoordinatorClient
    +
    +
    Create a new transaction.
    +
    +
    newTransaction(long, TimeUnit) - Method in interface org.apache.pulsar.client.api.transaction.TransactionCoordinatorClient
    +
    +
    Create a new transaction.
    +
    +
    newTransactionAsync() - Method in interface org.apache.pulsar.client.api.transaction.TransactionCoordinatorClient
    +
    +
    Create a new transaction asynchronously.
    +
    +
    newTransactionAsync(long, TimeUnit) - Method in interface org.apache.pulsar.client.api.transaction.TransactionCoordinatorClient
    +
    +
    Create a new transaction asynchronously.
    +
    +
    next(int) - Method in interface org.apache.pulsar.client.api.RedeliveryBackoff
    +
     
    +
    NonDurable - Enum constant in enum class org.apache.pulsar.client.api.SubscriptionMode
    +
     
    +
    NONE - Enum constant in enum class org.apache.pulsar.client.api.CompressionType
    +
    +
    No compression.
    +
    +
    NONE - Enum constant in enum class org.apache.pulsar.client.api.transaction.TransactionCoordinatorClient.State
    +
     
    +
    NONE - Enum constant in enum class org.apache.pulsar.common.schema.SchemaType
    +
    +
    No schema defined.
    +
    +
    NonPersistentOnly - Enum constant in enum class org.apache.pulsar.client.api.RegexSubscriptionMode
    +
    +
    Only subscribe to non-persistent topics.
    +
    +
    NotAllowedException(String) - Constructor for exception class org.apache.pulsar.client.api.PulsarClientException.NotAllowedException
    +
    +
    Constructs an NotAllowedException with the specified detail message.
    +
    +
    NotConnectedException() - Constructor for exception class org.apache.pulsar.client.api.PulsarClientException.NotConnectedException
    +
     
    +
    NotConnectedException(long) - Constructor for exception class org.apache.pulsar.client.api.PulsarClientException.NotConnectedException
    +
     
    +
    NotConnectedException(String) - Constructor for exception class org.apache.pulsar.client.api.PulsarClientException.NotConnectedException
    +
     
    +
    NotFoundException(String) - Constructor for exception class org.apache.pulsar.client.api.PulsarClientException.NotFoundException
    +
    +
    Constructs an NotFoundException with the specified detail message.
    +
    +
    NotFoundException(Throwable) - Constructor for exception class org.apache.pulsar.client.api.PulsarClientException.NotFoundException
    +
    +
    Constructs an NotFoundException with the specified cause.
    +
    +
    NotSupportedException(String) - Constructor for exception class org.apache.pulsar.client.api.PulsarClientException.NotSupportedException
    +
    +
    Constructs an NotSupportedException with the specified detail message.
    +
    +
    numPartitions() - Method in interface org.apache.pulsar.client.api.TopicMetadata
    +
    +
    Return the number of partitions per topic.
    +
    +
    +

    O

    +
    +
    of(int, int) - Static method in class org.apache.pulsar.client.api.Range
    +
     
    +
    of(SchemaInfo) - Static method in interface org.apache.pulsar.client.api.schema.GenericSchema
    +
     
    +
    of(SchemaInfo, boolean) - Static method in interface org.apache.pulsar.client.api.schema.GenericSchema
    +
     
    +
    onAcknowledge(Consumer<T>, MessageId, Throwable) - Method in interface org.apache.pulsar.client.api.ConsumerInterceptor
    +
    +
    This is called consumer sends the acknowledgment to the broker.
    +
    +
    onAcknowledgeCumulative(Consumer<T>, MessageId, Throwable) - Method in interface org.apache.pulsar.client.api.ConsumerInterceptor
    +
    +
    This is called consumer send the cumulative acknowledgment to the broker.
    +
    +
    onAckTimeoutSend(Consumer<T>, Set<MessageId>) - Method in interface org.apache.pulsar.client.api.ConsumerInterceptor
    +
    +
    This method will be called when a redelivery from an acknowledge timeout occurs.
    +
    +
    onArrival(Consumer<T>, Message<T>) - Method in interface org.apache.pulsar.client.api.ConsumerInterceptor
    +
    +
    This method is called when a message arrives in the consumer.
    +
    +
    onNegativeAcksSend(Consumer<T>, Set<MessageId>) - Method in interface org.apache.pulsar.client.api.ConsumerInterceptor
    +
    +
    This method will be called when a redelivery from a negative acknowledge occurs.
    +
    +
    onPartitionsChange(String, int) - Method in interface org.apache.pulsar.client.api.ConsumerInterceptor
    +
    +
    This method is called when partitions of the topic (partitioned-topic) changes.
    +
    +
    onPartitionsChange(String, int) - Method in interface org.apache.pulsar.client.api.interceptor.ProducerInterceptor
    +
    +
    This method is called when partitions of the topic (partitioned-topic) changes.
    +
    +
    onPartitionsChange(String, int) - Method in class org.apache.pulsar.client.api.interceptor.ProducerInterceptorWrapper
    +
     
    +
    onPartitionsChange(String, int) - Method in interface org.apache.pulsar.client.api.ProducerInterceptor
    +
    +
    Deprecated.
    +
    This method is called when partitions of the topic (partitioned-topic) changes.
    +
    +
    onPartitionsChange(String, int) - Method in interface org.apache.pulsar.client.api.ReaderInterceptor
    +
    +
    This method is called when partitions of the topic (partitioned-topic) changes.
    +
    +
    onSendAcknowledgement(Producer<T>, Message<T>, MessageId, Throwable) - Method in interface org.apache.pulsar.client.api.ProducerInterceptor
    +
    +
    Deprecated.
    +
    This method is called when the message sent to the broker has been + acknowledged, or when sending the message fails.
    +
    +
    onSendAcknowledgement(Producer, Message, MessageId, Throwable) - Method in interface org.apache.pulsar.client.api.interceptor.ProducerInterceptor
    +
    +
    This method is called when the message sent to the broker has been + acknowledged, or when sending the message fails.
    +
    +
    onSendAcknowledgement(Producer, Message, MessageId, Throwable) - Method in class org.apache.pulsar.client.api.interceptor.ProducerInterceptorWrapper
    +
     
    +
    OPEN - Enum constant in enum class org.apache.pulsar.client.api.transaction.Transaction.State
    +
    +
    When a transaction is in the `OPEN` state, messages can be produced and acked with this transaction.
    +
    +
    openTelemetry(OpenTelemetry) - Method in interface org.apache.pulsar.client.api.ClientBuilder
    +
    +
    Configure OpenTelemetry for Pulsar Client
    +
    +
    operationTimeout(int, TimeUnit) - Method in interface org.apache.pulsar.client.api.ClientBuilder
    +
    +
    Set the operation timeout (default: 30 seconds).
    +
    +
    optional() - Method in interface org.apache.pulsar.client.api.schema.FieldSchemaBuilder
    +
    +
    Make this field optional.
    +
    +
    ORDER - Enum constant in enum class org.apache.pulsar.client.api.AutoClusterFailoverBuilder.FailoverPolicy
    +
     
    +
    orderingKey(byte[]) - Method in interface org.apache.pulsar.client.api.TypedMessageBuilder
    +
    +
    Sets the ordering key of the message for message dispatch in SubscriptionType.Key_Shared mode.
    +
    +
    org.apache.pulsar.client.api - package org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    org.apache.pulsar.client.api.interceptor - package org.apache.pulsar.client.api.interceptor
    +
    +
    Pulsar interceptors.
    +
    +
    org.apache.pulsar.client.api.schema - package org.apache.pulsar.client.api.schema
    +
    +
    Schema definitions for Pulsar Client API.
    +
    +
    org.apache.pulsar.client.api.transaction - package org.apache.pulsar.client.api.transaction
    +
    +
    Pulsar transaction related API.
    +
    +
    org.apache.pulsar.client.internal - package org.apache.pulsar.client.internal
    +
    +
    Helpers which provide useful functionality for the implementation of Pulsar Client API.
    +
    +
    org.apache.pulsar.common.api - package org.apache.pulsar.common.api
    +
    +
    Common data classes used in the Pulsar Client API.
    +
    +
    org.apache.pulsar.common.classification - package org.apache.pulsar.common.classification
    +
    +
    Annotations used across the whole project.
    +
    +
    org.apache.pulsar.common.schema - package org.apache.pulsar.common.schema
    +
    +
    This package contains data structures for schema definitions used in the Pulsar Client API.
    +
    +
    +

    P

    +
    +
    PartitionedTopicProducerStats - Interface in org.apache.pulsar.client.api
    +
    +
    Partitioned topic Producer statistics recorded by client.
    +
    +
    patternAutoDiscoveryPeriod(int) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
    +
    +
    Sets topic's auto-discovery period when using a pattern for topic's consumer.
    +
    +
    patternAutoDiscoveryPeriod(int, TimeUnit) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
    +
    +
    Sets topic's auto-discovery period when using a pattern for topic's consumer.
    +
    +
    pause() - Method in interface org.apache.pulsar.client.api.Consumer
    +
    +
    Stop requesting new messages from the broker until Consumer.resume() is called.
    +
    +
    PersistentOnly - Enum constant in enum class org.apache.pulsar.client.api.RegexSubscriptionMode
    +
    +
    Only subscribe to persistent topics.
    +
    +
    poolMessages(boolean) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
    +
    +
    Enable pooling of messages and the underlying data buffers.
    +
    +
    poolMessages(boolean) - Method in interface org.apache.pulsar.client.api.ReaderBuilder
    +
    +
    Enable pooling of messages and the underlying data buffers.
    +
    +
    primary(String) - Method in interface org.apache.pulsar.client.api.AutoClusterFailoverBuilder
    +
    +
    Set the primary service url.
    +
    +
    priorityLevel(int) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
    +
    +
    Shared subscription
    +
    +
    priorityLevel(int) - Method in interface org.apache.pulsar.client.api.TopicConsumerBuilder
    +
    +
    Configure the priority level of this topic.
    +
    +
    process(MessagePayload, MessagePayloadContext, Schema<T>, Consumer<Message<T>>) - Method in interface org.apache.pulsar.client.api.MessagePayloadProcessor
    +
    +
    Process the message payload.
    +
    +
    Producer<T> - Interface in org.apache.pulsar.client.api
    +
    +
    Producer is used to publish messages on a topic.
    +
    +
    ProducerAccessMode - Enum Class in org.apache.pulsar.client.api
    +
    +
    The type of access to the topic that the producer requires.
    +
    +
    ProducerBlockedQuotaExceededError(String) - Constructor for exception class org.apache.pulsar.client.api.PulsarClientException.ProducerBlockedQuotaExceededError
    +
    +
    Constructs an ProducerBlockedQuotaExceededError with the specified detail message.
    +
    +
    ProducerBlockedQuotaExceededException(String) - Constructor for exception class org.apache.pulsar.client.api.PulsarClientException.ProducerBlockedQuotaExceededException
    +
    +
    Constructs an ProducerBlockedQuotaExceededException with the specified detail message.
    +
    +
    ProducerBuilder<T> - Interface in org.apache.pulsar.client.api
    +
    +
    ProducerBuilder is used to configure and create instances of Producer.
    +
    +
    ProducerBusyException(String) - Constructor for exception class org.apache.pulsar.client.api.PulsarClientException.ProducerBusyException
    +
    +
    Constructs an ProducerBusyException with the specified detail message.
    +
    +
    ProducerCryptoFailureAction - Enum Class in org.apache.pulsar.client.api
    +
    +
    The action the producer will take in case of encryption failures.
    +
    +
    ProducerFencedException(String) - Constructor for exception class org.apache.pulsar.client.api.PulsarClientException.ProducerFencedException
    +
    +
    Constructs a ProducerFencedException with the specified detail message.
    +
    +
    ProducerInterceptor - Interface in org.apache.pulsar.client.api.interceptor
    +
    +
    A plugin interface that allows you to intercept (and possibly mutate) the + messages received by the producer before they are published to the Pulsar + brokers.
    +
    +
    ProducerInterceptor<T> - Interface in org.apache.pulsar.client.api
    +
    +
    Deprecated.
    +
    +
    ProducerInterceptorWrapper - Class in org.apache.pulsar.client.api.interceptor
    +
    +
    A wrapper for old style producer interceptor.
    +
    +
    ProducerInterceptorWrapper(ProducerInterceptor<?>) - Constructor for class org.apache.pulsar.client.api.interceptor.ProducerInterceptorWrapper
    +
     
    +
    producerName(String) - Method in interface org.apache.pulsar.client.api.ProducerBuilder
    +
    +
    Specify a name for the producer.
    +
    +
    ProducerQueueIsFullError(String) - Constructor for exception class org.apache.pulsar.client.api.PulsarClientException.ProducerQueueIsFullError
    +
    +
    Constructs an ProducerQueueIsFullError with the specified detail message.
    +
    +
    ProducerQueueIsFullError(String, long) - Constructor for exception class org.apache.pulsar.client.api.PulsarClientException.ProducerQueueIsFullError
    +
    +
    Constructs an ProducerQueueIsFullError with the specified detail message.
    +
    +
    ProducerStats - Interface in org.apache.pulsar.client.api
    +
    +
    Deprecated. +
    use ClientBuilder.openTelemetry(OpenTelemetry) to enable stats
    +
    +
    +
    properties(Map<String, String>) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
    +
    +
    Add all the properties in the provided map to the consumer.
    +
    +
    properties(Map<String, String>) - Method in interface org.apache.pulsar.client.api.ProducerBuilder
    +
    +
    Add all the properties in the provided map to the producer.
    +
    +
    properties(Map<String, String>) - Method in interface org.apache.pulsar.client.api.TypedMessageBuilder
    +
    +
    Add all the properties in the provided map.
    +
    +
    properties(Map<String, String>) - Method in class org.apache.pulsar.common.schema.SchemaInfo.SchemaInfoBuilder
    +
     
    +
    PropertiesUtils - Class in org.apache.pulsar.client.internal
    +
    +
    Internal utility methods for filtering and mapping Properties objects.
    +
    +
    PropertiesUtils() - Constructor for class org.apache.pulsar.client.internal.PropertiesUtils
    +
     
    +
    property(String, String) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
    +
    +
    Sets a name/value property with this consumer.
    +
    +
    property(String, String) - Method in interface org.apache.pulsar.client.api.ProducerBuilder
    +
    +
    Set a name/value property for this producer.
    +
    +
    property(String, String) - Method in interface org.apache.pulsar.client.api.schema.FieldSchemaBuilder
    +
    +
    Set name-value pair properties for this field.
    +
    +
    property(String, String) - Method in interface org.apache.pulsar.client.api.schema.RecordSchemaBuilder
    +
    +
    Attach val-name property pair to the record schema.
    +
    +
    property(String, String) - Method in interface org.apache.pulsar.client.api.TypedMessageBuilder
    +
    +
    Sets a new property on a message.
    +
    +
    PROTOBUF - Enum constant in enum class org.apache.pulsar.common.schema.SchemaType
    +
    +
    Protobuf message encoding and decoding.
    +
    +
    PROTOBUF(Class<T>) - Static method in interface org.apache.pulsar.client.api.Schema
    +
    +
    Create a Protobuf schema type by extracting the fields of the specified class.
    +
    +
    PROTOBUF(SchemaDefinition<T>) - Static method in interface org.apache.pulsar.client.api.Schema
    +
    +
    Create a Protobuf schema type with schema definition.
    +
    +
    PROTOBUF_NATIVE - Enum constant in enum class org.apache.pulsar.common.schema.SchemaType
    +
    +
    Protobuf native schema base on Descriptor.
    +
    +
    PROTOBUF_NATIVE(Class<T>) - Static method in interface org.apache.pulsar.client.api.Schema
    +
    +
    Create a Protobuf-Native schema type by extracting the fields of the specified class.
    +
    +
    PROTOBUF_NATIVE(SchemaDefinition<T>) - Static method in interface org.apache.pulsar.client.api.Schema
    +
    +
    Create a Protobuf-Native schema type with schema definition.
    +
    +
    ProxyProtocol - Enum Class in org.apache.pulsar.client.api
    +
    +
    Protcol type to determine type of proxy routing when client connects to proxy using + +
    +invalid @link +
    {@link ClientBuilder::proxyServiceUrl
    +
    +}.
    +
    +
    proxyServiceUrl(String, ProxyProtocol) - Method in interface org.apache.pulsar.client.api.ClientBuilder
    +
    +
    Proxy-service url when client would like to connect to broker via proxy.
    +
    +
    PULSAR_AUTH_METHOD_NAME - Static variable in interface org.apache.pulsar.client.api.AuthenticationDataProvider
    +
     
    +
    PulsarClient - Interface in org.apache.pulsar.client.api
    +
    +
    Class that provides a client interface to Pulsar.
    +
    +
    PulsarClientException - Exception Class in org.apache.pulsar.client.api
    +
    +
    Base type of exception thrown by Pulsar client.
    +
    +
    PulsarClientException(String) - Constructor for exception class org.apache.pulsar.client.api.PulsarClientException
    +
    +
    Constructs an PulsarClientException with the specified detail message.
    +
    +
    PulsarClientException(String, long) - Constructor for exception class org.apache.pulsar.client.api.PulsarClientException
    +
    +
    Constructs an PulsarClientException with the specified detail message.
    +
    +
    PulsarClientException(String, Throwable) - Constructor for exception class org.apache.pulsar.client.api.PulsarClientException
    +
    +
    Constructs an PulsarClientException with the specified cause.
    +
    +
    PulsarClientException(Throwable) - Constructor for exception class org.apache.pulsar.client.api.PulsarClientException
    +
    +
    Constructs an PulsarClientException with the specified cause.
    +
    +
    PulsarClientException(Throwable, long) - Constructor for exception class org.apache.pulsar.client.api.PulsarClientException
    +
    +
    Constructs an PulsarClientException with the specified cause.
    +
    +
    PulsarClientException.AlreadyClosedException - Exception Class in org.apache.pulsar.client.api
    +
    +
    Already closed exception thrown by Pulsar client.
    +
    +
    PulsarClientException.AuthenticationException - Exception Class in org.apache.pulsar.client.api
    +
    +
    Authentication exception thrown by Pulsar client.
    +
    +
    PulsarClientException.AuthorizationException - Exception Class in org.apache.pulsar.client.api
    +
    +
    Authorization exception thrown by Pulsar client.
    +
    +
    PulsarClientException.BrokerMetadataException - Exception Class in org.apache.pulsar.client.api
    +
    +
    Broker metadata exception thrown by Pulsar client.
    +
    +
    PulsarClientException.BrokerPersistenceException - Exception Class in org.apache.pulsar.client.api
    +
    +
    Broker persistence exception thrown by Pulsar client.
    +
    +
    PulsarClientException.ChecksumException - Exception Class in org.apache.pulsar.client.api
    +
    +
    Checksum exception thrown by Pulsar client.
    +
    +
    PulsarClientException.ConnectException - Exception Class in org.apache.pulsar.client.api
    +
    +
    Connect exception thrown by Pulsar client.
    +
    +
    PulsarClientException.ConsumerAssignException - Exception Class in org.apache.pulsar.client.api
    +
    +
    Consumer assign exception thrown by Pulsar client.
    +
    +
    PulsarClientException.ConsumerBusyException - Exception Class in org.apache.pulsar.client.api
    +
    +
    Consumer busy exception thrown by Pulsar client.
    +
    +
    PulsarClientException.CryptoException - Exception Class in org.apache.pulsar.client.api
    +
    +
    Crypto exception thrown by Pulsar client.
    +
    +
    PulsarClientException.FailedFeatureCheck - Enum Class in org.apache.pulsar.client.api
    +
    +
    "supports_auth_refresh" was introduced at "2.6" and is no longer supported, so skip this enum.
    +
    +
    PulsarClientException.FeatureNotSupportedException - Exception Class in org.apache.pulsar.client.api
    +
    +
    Not supported exception thrown by Pulsar client.
    +
    +
    PulsarClientException.GettingAuthenticationDataException - Exception Class in org.apache.pulsar.client.api
    +
    +
    Getting authentication data exception thrown by Pulsar client.
    +
    +
    PulsarClientException.IncompatibleSchemaException - Exception Class in org.apache.pulsar.client.api
    +
    +
    Incompatible schema exception thrown by Pulsar client.
    +
    +
    PulsarClientException.InvalidConfigurationException - Exception Class in org.apache.pulsar.client.api
    +
    +
    Invalid Configuration exception thrown by Pulsar client.
    +
    +
    PulsarClientException.InvalidMessageException - Exception Class in org.apache.pulsar.client.api
    +
    +
    Invalid message exception thrown by Pulsar client.
    +
    +
    PulsarClientException.InvalidServiceURL - Exception Class in org.apache.pulsar.client.api
    +
    +
    Invalid Service URL exception thrown by Pulsar client.
    +
    +
    PulsarClientException.InvalidTopicNameException - Exception Class in org.apache.pulsar.client.api
    +
    +
    Invalid topic name exception thrown by Pulsar client.
    +
    +
    PulsarClientException.LookupException - Exception Class in org.apache.pulsar.client.api
    +
    +
    Lookup exception thrown by Pulsar client.
    +
    +
    PulsarClientException.MemoryBufferIsFullError - Exception Class in org.apache.pulsar.client.api
    +
    +
    Memory buffer full error thrown by Pulsar client.
    +
    +
    PulsarClientException.MessageAcknowledgeException - Exception Class in org.apache.pulsar.client.api
    +
    +
    Consumer assign exception thrown by Pulsar client.
    +
    +
    PulsarClientException.NotAllowedException - Exception Class in org.apache.pulsar.client.api
    +
    +
    Not allowed exception thrown by Pulsar client.
    +
    +
    PulsarClientException.NotConnectedException - Exception Class in org.apache.pulsar.client.api
    +
    +
    Not connected exception thrown by Pulsar client.
    +
    +
    PulsarClientException.NotFoundException - Exception Class in org.apache.pulsar.client.api
    +
    +
    Not Found exception thrown by Pulsar client.
    +
    +
    PulsarClientException.NotSupportedException - Exception Class in org.apache.pulsar.client.api
    +
    +
    Not supported exception thrown by Pulsar client.
    +
    +
    PulsarClientException.ProducerBlockedQuotaExceededError - Exception Class in org.apache.pulsar.client.api
    +
    +
    Producer blocked quota exceeded error thrown by Pulsar client.
    +
    +
    PulsarClientException.ProducerBlockedQuotaExceededException - Exception Class in org.apache.pulsar.client.api
    +
    +
    Producer blocked quota exceeded exception thrown by Pulsar client.
    +
    +
    PulsarClientException.ProducerBusyException - Exception Class in org.apache.pulsar.client.api
    +
    +
    Producer busy exception thrown by Pulsar client.
    +
    +
    PulsarClientException.ProducerFencedException - Exception Class in org.apache.pulsar.client.api
    +
    +
    Producer fenced exception thrown by Pulsar client.
    +
    +
    PulsarClientException.ProducerQueueIsFullError - Exception Class in org.apache.pulsar.client.api
    +
    +
    Full producer queue error thrown by Pulsar client.
    +
    +
    PulsarClientException.SubscriptionNotFoundException - Exception Class in org.apache.pulsar.client.api
    +
    +
    Not found subscription that cannot be created.
    +
    +
    PulsarClientException.TimeoutException - Exception Class in org.apache.pulsar.client.api
    +
    +
    Timeout exception thrown by Pulsar client.
    +
    +
    PulsarClientException.TooManyRequestsException - Exception Class in org.apache.pulsar.client.api
    +
    +
    Too many requests exception thrown by Pulsar client.
    +
    +
    PulsarClientException.TopicDoesNotExistException - Exception Class in org.apache.pulsar.client.api
    +
    +
    Topic does not exist and cannot be created.
    +
    +
    PulsarClientException.TopicMigrationException - Exception Class in org.apache.pulsar.client.api
    +
    +
    TopicMigration exception thrown by Pulsar client.
    +
    +
    PulsarClientException.TopicTerminatedException - Exception Class in org.apache.pulsar.client.api
    +
    +
    Topic terminated exception thrown by Pulsar client.
    +
    +
    PulsarClientException.TransactionConflictException - Exception Class in org.apache.pulsar.client.api
    +
    +
    Consumer assign exception thrown by Pulsar client.
    +
    +
    PulsarClientException.TransactionHasOperationFailedException - Exception Class in org.apache.pulsar.client.api
    +
     
    +
    PulsarClientException.UnsupportedAuthenticationException - Exception Class in org.apache.pulsar.client.api
    +
    +
    Unsupported authentication exception thrown by Pulsar client.
    +
    +
    PulsarClientImplementationBinding - Interface in org.apache.pulsar.client.internal
    +
    +
    Helper class for class instantiations and it also contains methods to work with schemas.
    +
    +
    +

    R

    +
    +
    Range - Class in org.apache.pulsar.client.api
    +
    +
    Int range.
    +
    +
    Range(int, int) - Constructor for class org.apache.pulsar.client.api.Range
    +
     
    +
    ranges - Variable in class org.apache.pulsar.client.api.KeySharedPolicy.KeySharedPolicySticky
    +
     
    +
    ranges(List<Range>) - Method in class org.apache.pulsar.client.api.KeySharedPolicy.KeySharedPolicySticky
    +
     
    +
    ranges(Range...) - Method in class org.apache.pulsar.client.api.KeySharedPolicy.KeySharedPolicySticky
    +
     
    +
    reachedEndOfTopic(Consumer<T>) - Method in interface org.apache.pulsar.client.api.MessageListener
    +
    +
    Get the notification when a topic is terminated.
    +
    +
    reachedEndOfTopic(Reader<T>) - Method in interface org.apache.pulsar.client.api.ReaderListener
    +
    +
    Get the notification when a topic is terminated.
    +
    +
    ReachMaxPendingOpsException() - Constructor for exception class org.apache.pulsar.client.api.transaction.TransactionBufferClientException.ReachMaxPendingOpsException
    +
     
    +
    ReachMaxPendingOpsException(String) - Constructor for exception class org.apache.pulsar.client.api.transaction.TransactionBufferClientException.ReachMaxPendingOpsException
    +
     
    +
    read(byte[]) - Method in interface org.apache.pulsar.client.api.schema.SchemaReader
    +
    +
    Serialize bytes convert pojo.
    +
    +
    read(byte[], byte[]) - Method in interface org.apache.pulsar.client.api.schema.SchemaReader
    +
    +
    Serialize bytes convert pojo.
    +
    +
    read(byte[], int, int) - Method in interface org.apache.pulsar.client.api.schema.SchemaReader
    +
    +
    serialize bytes convert pojo.
    +
    +
    read(InputStream) - Method in interface org.apache.pulsar.client.api.schema.SchemaReader
    +
    +
    serialize bytes convert pojo.
    +
    +
    read(InputStream, byte[]) - Method in interface org.apache.pulsar.client.api.schema.SchemaReader
    +
    +
    serialize bytes convert pojo.
    +
    +
    READ_COMMITTED - Enum constant in enum class org.apache.pulsar.client.api.TransactionIsolationLevel
    +
     
    +
    READ_UNCOMMITTED - Enum constant in enum class org.apache.pulsar.client.api.TransactionIsolationLevel
    +
     
    +
    readCompacted(boolean) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
    +
    +
    If enabled, the consumer reads messages from the compacted topic rather than the full message topic backlog.
    +
    +
    readCompacted(boolean) - Method in interface org.apache.pulsar.client.api.ReaderBuilder
    +
    +
    If enabled, the reader will read messages from the compacted topic rather than reading the full message backlog + of the topic.
    +
    +
    Reader<T> - Interface in org.apache.pulsar.client.api
    +
    +
    A Reader can be used to scan through all the messages currently available in a topic.
    +
    +
    ReaderBuilder<T> - Interface in org.apache.pulsar.client.api
    +
    +
    ReaderBuilder is used to configure and create instances of Reader.
    +
    +
    ReaderInterceptor<T> - Interface in org.apache.pulsar.client.api
    +
    +
    Reader interceptor.
    +
    +
    readerListener(ReaderListener<T>) - Method in interface org.apache.pulsar.client.api.ReaderBuilder
    +
    +
    Sets a ReaderListener for the reader.
    +
    +
    ReaderListener<T> - Interface in org.apache.pulsar.client.api
    +
    +
    A listener that will be called in order for every message received.
    +
    +
    readerName(String) - Method in interface org.apache.pulsar.client.api.ReaderBuilder
    +
    +
    Specify a reader name.
    +
    +
    readNext() - Method in interface org.apache.pulsar.client.api.Reader
    +
    +
    Read the next message in the topic.
    +
    +
    readNext(int, TimeUnit) - Method in interface org.apache.pulsar.client.api.Reader
    +
    +
    Read the next message in the topic waiting for a maximum time.
    +
    +
    readNextAsync() - Method in interface org.apache.pulsar.client.api.Reader
    +
    +
    Read asynchronously the next message in the topic.
    +
    +
    READY - Enum constant in enum class org.apache.pulsar.client.api.transaction.TransactionCoordinatorClient.State
    +
     
    +
    receive() - Method in interface org.apache.pulsar.client.api.Consumer
    +
    +
    Receives a single message.
    +
    +
    receive(int, TimeUnit) - Method in interface org.apache.pulsar.client.api.Consumer
    +
    +
    Receive a single message.
    +
    +
    receiveAsync() - Method in interface org.apache.pulsar.client.api.Consumer
    +
    +
    Receive a single message
    +
    +
    received(Consumer<T>, Message<T>) - Method in interface org.apache.pulsar.client.api.MessageListener
    +
    +
    This method is called whenever a new message is received.
    +
    +
    received(Reader<T>, Message<T>) - Method in interface org.apache.pulsar.client.api.ReaderListener
    +
    +
    This method is called whenever a new message is received.
    +
    +
    receiverQueueSize(int) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
    +
    +
    Sets the size of the consumer receive queue.
    +
    +
    receiverQueueSize(int) - Method in interface org.apache.pulsar.client.api.ReaderBuilder
    +
    +
    Sets the size of the consumer receive queue.
    +
    +
    reconsumeLater(Message<?>, long, TimeUnit) - Method in interface org.apache.pulsar.client.api.Consumer
    +
    +
    reconsumeLater the consumption of Messages.
    +
    +
    reconsumeLater(Message<?>, Map<String, String>, long, TimeUnit) - Method in interface org.apache.pulsar.client.api.Consumer
    +
    +
    reconsumeLater the consumption of Messages.
    +
    +
    reconsumeLater(Messages<?>, long, TimeUnit) - Method in interface org.apache.pulsar.client.api.Consumer
    +
    +
    reconsumeLater the consumption of Messages.
    +
    +
    reconsumeLaterAsync(Message<?>, long, TimeUnit) - Method in interface org.apache.pulsar.client.api.Consumer
    +
    +
    Asynchronously reconsumeLater the consumption of a single message.
    +
    +
    reconsumeLaterAsync(Message<?>, Map<String, String>, long, TimeUnit) - Method in interface org.apache.pulsar.client.api.Consumer
    +
    +
    Asynchronously reconsumeLater the consumption of a single message.
    +
    +
    reconsumeLaterAsync(Messages<?>, long, TimeUnit) - Method in interface org.apache.pulsar.client.api.Consumer
    +
    +
    Asynchronously reconsumeLater the consumption of Messages.
    +
    +
    reconsumeLaterCumulative(Message<?>, long, TimeUnit) - Method in interface org.apache.pulsar.client.api.Consumer
    +
    +
    reconsumeLater the reception of all the messages in the stream up to (and including) the provided message.
    +
    +
    reconsumeLaterCumulativeAsync(Message<?>, long, TimeUnit) - Method in interface org.apache.pulsar.client.api.Consumer
    +
    +
    Asynchronously ReconsumeLater the reception of all the messages in the stream up to (and including) the provided + message.
    +
    +
    reconsumeLaterCumulativeAsync(Message<?>, Map<String, String>, long, TimeUnit) - Method in interface org.apache.pulsar.client.api.Consumer
    +
    +
    Asynchronously ReconsumeLater the reception of all the messages in the stream up to (and including) the provided + message.
    +
    +
    record(String) - Static method in interface org.apache.pulsar.client.api.schema.SchemaBuilder
    +
    +
    Build the schema for a record.
    +
    +
    RecordSchemaBuilder - Interface in org.apache.pulsar.client.api.schema
    +
    +
    Building the schema for a GenericRecord.
    +
    +
    redeliverUnacknowledgedMessages() - Method in interface org.apache.pulsar.client.api.Consumer
    +
    +
    Redelivers all the unacknowledged messages.
    +
    +
    RedeliveryBackoff - Interface in org.apache.pulsar.client.api
    +
    +
    Interface for custom message is negativeAcked policy, users can specify a RedeliveryBackoff for + a consumer.
    +
    +
    refresh() - Method in interface org.apache.pulsar.client.api.TableView
    +
    +
    Refresh the table view with the latest data in the topic, ensuring that all subsequent reads are based on + the refreshed data.
    +
    +
    REFRESH_AUTH_DATA - Static variable in class org.apache.pulsar.common.api.AuthData
    +
     
    +
    REFRESH_AUTH_DATA_BYTES - Static variable in class org.apache.pulsar.common.api.AuthData
    +
     
    +
    refreshAsync() - Method in interface org.apache.pulsar.client.api.TableView
    +
    +
    Refresh the table view with the latest data in the topic, ensuring that all subsequent reads are based on + the refreshed data.
    +
    +
    RegexSubscriptionMode - Enum Class in org.apache.pulsar.client.api
    +
    +
    When subscribing to topics using a regular expression, one can specify + to only pick a certain type of topics.
    +
    +
    release() - Method in interface org.apache.pulsar.client.api.Message
    +
    +
    Release a message back to the pool.
    +
    +
    release() - Method in interface org.apache.pulsar.client.api.MessagePayload
    +
    +
    Release the resources if necessary.
    +
    +
    removeKeyCipher(String) - Method in interface org.apache.pulsar.client.api.MessageCrypto
    +
     
    +
    replicateSubscriptionState(boolean) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
    +
     
    +
    replicationClusters(List<String>) - Method in interface org.apache.pulsar.client.api.TypedMessageBuilder
    +
    +
    Override the geo-replication clusters for this message.
    +
    +
    RequestTimeoutException() - Constructor for exception class org.apache.pulsar.client.api.transaction.TransactionBufferClientException.RequestTimeoutException
    +
     
    +
    RequestTimeoutException(String) - Constructor for exception class org.apache.pulsar.client.api.transaction.TransactionBufferClientException.RequestTimeoutException
    +
     
    +
    required() - Method in interface org.apache.pulsar.client.api.schema.FieldSchemaBuilder
    +
    +
    Make this field required.
    +
    +
    requireFetchingSchemaInfo() - Method in interface org.apache.pulsar.client.api.Schema
    +
    +
    Check if this schema requires fetching schema info to configure the schema.
    +
    +
    resume() - Method in interface org.apache.pulsar.client.api.Consumer
    +
    +
    Resume requesting messages from the broker.
    +
    +
    RoundRobinPartition - Enum constant in enum class org.apache.pulsar.client.api.MessageRoutingMode
    +
    +
    If no key is provided, the producer will publish messages across all partitions in round-robin fashion + to achieve maximum throughput.
    +
    +
    roundRobinRouterBatchingPartitionSwitchFrequency(int) - Method in interface org.apache.pulsar.client.api.ProducerBuilder
    +
    +
    Set the partition switch frequency while batching of messages is enabled and + using round-robin routing mode for non-keyed messages.
    +
    +
    +

    S

    +
    +
    schema(byte[]) - Method in class org.apache.pulsar.common.schema.SchemaInfo.SchemaInfoBuilder
    +
     
    +
    Schema<T> - Interface in org.apache.pulsar.client.api
    +
    +
    Message schema definition.
    +
    +
    SchemaBuilder - Interface in org.apache.pulsar.client.api.schema
    +
    +
    Builder to build schema.
    +
    +
    SchemaDefinition<T> - Interface in org.apache.pulsar.client.api.schema
    +
    +
    Interface for schema definition.
    +
    +
    SchemaDefinitionBuilder<T> - Interface in org.apache.pulsar.client.api.schema
    +
    +
    Builder to build schema definition SchemaDefinition.
    +
    +
    SchemaInfo - Interface in org.apache.pulsar.common.schema
    +
    +
    Information about the schema.
    +
    +
    SchemaInfo.SchemaInfoBuilder - Class in org.apache.pulsar.common.schema
    +
     
    +
    SchemaInfoProvider - Interface in org.apache.pulsar.client.api.schema
    +
    +
    Schema Provider.
    +
    +
    SchemaInfoWithVersion - Class in org.apache.pulsar.common.schema
    +
    +
    Data structure representing a schema information including its version.
    +
    +
    SchemaInfoWithVersion() - Constructor for class org.apache.pulsar.common.schema.SchemaInfoWithVersion
    +
     
    +
    SchemaReader<T> - Interface in org.apache.pulsar.client.api.schema
    +
    +
    Deserialize messages from bytes.
    +
    +
    SchemaSerializationException - Exception Class in org.apache.pulsar.client.api
    +
    +
    Schema serialization exception.
    +
    +
    SchemaSerializationException(String) - Constructor for exception class org.apache.pulsar.client.api.SchemaSerializationException
    +
    +
    Constructs an SchemaSerializationException with the specified detail message.
    +
    +
    SchemaSerializationException(Throwable) - Constructor for exception class org.apache.pulsar.client.api.SchemaSerializationException
    +
    +
    Constructs an SchemaSerializationException with the specified cause.
    +
    +
    SchemaType - Enum Class in org.apache.pulsar.common.schema
    +
    +
    Types of supported schema for Pulsar messages.
    +
    +
    SchemaWriter<T> - Interface in org.apache.pulsar.client.api.schema
    +
    +
    Serialize messages into bytes.
    +
    +
    secondary(List<String>) - Method in interface org.apache.pulsar.client.api.AutoClusterFailoverBuilder
    +
    +
    Set the secondary service url.
    +
    +
    secondaryAuthentication(Map<String, Authentication>) - Method in interface org.apache.pulsar.client.api.AutoClusterFailoverBuilder
    +
    +
    Set secondary authentication.
    +
    +
    secondaryTlsTrustCertsFilePath(Map<String, String>) - Method in interface org.apache.pulsar.client.api.AutoClusterFailoverBuilder
    +
    +
    Set secondary tlsTrustCertsFilePath.
    +
    +
    secondaryTlsTrustStorePassword(Map<String, String>) - Method in interface org.apache.pulsar.client.api.AutoClusterFailoverBuilder
    +
    +
    Set secondary tlsTrustStorePassword.
    +
    +
    secondaryTlsTrustStorePath(Map<String, String>) - Method in interface org.apache.pulsar.client.api.AutoClusterFailoverBuilder
    +
    +
    Set secondary tlsTrustStorePath.
    +
    +
    seek(long) - Method in interface org.apache.pulsar.client.api.Consumer
    +
    +
    Reset the subscription associated with this consumer to a specific message publish time.
    +
    +
    seek(long) - Method in interface org.apache.pulsar.client.api.Reader
    +
    +
    Reset the subscription associated with this reader to a specific message publish time.
    +
    +
    seek(Function<String, Object>) - Method in interface org.apache.pulsar.client.api.Consumer
    +
    +
    Reset the subscription associated with this consumer to a specific message ID or message publish time.
    +
    +
    seek(Function<String, Object>) - Method in interface org.apache.pulsar.client.api.Reader
    +
    +
    Reset the subscription associated with this consumer to a specific message ID or message publish time.
    +
    +
    seek(MessageId) - Method in interface org.apache.pulsar.client.api.Consumer
    +
    +
    Reset the subscription associated with this consumer to a specific message id.
    +
    +
    seek(MessageId) - Method in interface org.apache.pulsar.client.api.Reader
    +
    +
    Reset the subscription associated with this reader to a specific message id.
    +
    +
    seekAsync(long) - Method in interface org.apache.pulsar.client.api.Consumer
    +
    +
    Reset the subscription associated with this consumer to a specific message publish time.
    +
    +
    seekAsync(long) - Method in interface org.apache.pulsar.client.api.Reader
    +
    +
    Reset the subscription associated with this reader to a specific message publish time.
    +
    +
    seekAsync(Function<String, Object>) - Method in interface org.apache.pulsar.client.api.Consumer
    +
    +
    Reset the subscription associated with this consumer to a specific message ID + or message publish time asynchronously.
    +
    +
    seekAsync(Function<String, Object>) - Method in interface org.apache.pulsar.client.api.Reader
    +
    +
    Reset the subscription associated with this consumer to a specific message ID + or message publish time asynchronously.
    +
    +
    seekAsync(MessageId) - Method in interface org.apache.pulsar.client.api.Consumer
    +
    +
    The asynchronous version of Consumer.seek(MessageId).
    +
    +
    seekAsync(MessageId) - Method in interface org.apache.pulsar.client.api.Reader
    +
    +
    Reset the subscription associated with this reader to a specific message id.
    +
    +
    send() - Method in interface org.apache.pulsar.client.api.TypedMessageBuilder
    +
    +
    Send a message synchronously.
    +
    +
    send(T) - Method in interface org.apache.pulsar.client.api.Producer
    +
    +
    Sends a message.
    +
    +
    SEND - Enum constant in enum class org.apache.pulsar.client.api.ProducerCryptoFailureAction
    +
    +
    Ignore crypto failure and proceed with sending unencrypted messages.
    +
    +
    sendAsync() - Method in interface org.apache.pulsar.client.api.TypedMessageBuilder
    +
    +
    Send a message asynchronously
    +
    +
    sendAsync(T) - Method in interface org.apache.pulsar.client.api.Producer
    +
    +
    Send a message asynchronously.
    +
    +
    sendTimeout(int, TimeUnit) - Method in interface org.apache.pulsar.client.api.ProducerBuilder
    +
    +
    Set the send timeout (default: 30 seconds).
    +
    +
    SEPARATED - Enum constant in enum class org.apache.pulsar.common.schema.KeyValueEncodingType
    +
    +
    Key is stored as message key, while value is stored as message payload.
    +
    +
    sequenceId(long) - Method in interface org.apache.pulsar.client.api.TypedMessageBuilder
    +
    +
    Specify a custom sequence id for the message being published.
    +
    +
    serviceUrl(String) - Method in interface org.apache.pulsar.client.api.ClientBuilder
    +
    +
    Configure the service URL for the Pulsar service.
    +
    +
    serviceUrlProvider(ServiceUrlProvider) - Method in interface org.apache.pulsar.client.api.ClientBuilder
    +
    +
    Configure the service URL provider for Pulsar service.
    +
    +
    ServiceUrlProvider - Interface in org.apache.pulsar.client.api
    +
    +
    The provider to provide the service url.
    +
    +
    set(String, Object) - Method in interface org.apache.pulsar.client.api.schema.GenericRecordBuilder
    +
    +
    Sets the value of a field.
    +
    +
    set(Field, Object) - Method in interface org.apache.pulsar.client.api.schema.GenericRecordBuilder
    +
    +
    Sets the value of a field.
    +
    +
    setAllowOutOfOrderDelivery(boolean) - Method in class org.apache.pulsar.client.api.KeySharedPolicy
    +
    +
    If enabled, it will relax the ordering requirement, allowing the broker to send out-of-order messages in case of + failures.
    +
    +
    setKey(byte[]) - Method in class org.apache.pulsar.client.api.EncryptionKeyInfo
    +
     
    +
    setMetadata(Map<String, String>) - Method in class org.apache.pulsar.client.api.EncryptionKeyInfo
    +
     
    +
    setPreviousExceptionCount(Throwable, AtomicInteger) - Static method in exception class org.apache.pulsar.client.api.PulsarClientException
    +
     
    +
    setPreviousExceptionCount(AtomicInteger) - Method in exception class org.apache.pulsar.client.api.PulsarClientException
    +
     
    +
    setSchemaInfoProvider(SchemaInfoProvider) - Method in interface org.apache.pulsar.client.api.schema.SchemaReader
    +
    +
    Set schema info provider, this method support multi version reader.
    +
    +
    setSchemaInfoProvider(SchemaInfoProvider) - Method in interface org.apache.pulsar.client.api.Schema
    +
     
    +
    setSequenceId(long) - Method in exception class org.apache.pulsar.client.api.PulsarClientException
    +
     
    +
    Shared - Enum constant in enum class org.apache.pulsar.client.api.ProducerAccessMode
    +
    +
    By default multiple producers can publish on a topic.
    +
    +
    Shared - Enum constant in enum class org.apache.pulsar.client.api.SubscriptionType
    +
    +
    Multiple consumer will be able to use the same subscription name and the messages will be dispatched + according to a round-robin rotation between the connected consumers.
    +
    +
    shutdown() - Method in interface org.apache.pulsar.client.api.PulsarClient
    +
    +
    Perform immediate shutdown of PulsarClient.
    +
    +
    SinglePartition - Enum constant in enum class org.apache.pulsar.client.api.MessageRoutingMode
    +
    +
    If no key is provided, The partitioned producer will randomly pick one single partition + and publish all the messages into that partition.
    +
    +
    size() - Method in interface org.apache.pulsar.client.api.Message
    +
    +
    Get the uncompressed message payload size in bytes.
    +
    +
    size() - Method in interface org.apache.pulsar.client.api.Messages
    +
    +
    Get number of messages.
    +
    +
    size() - Method in class org.apache.pulsar.client.api.Range
    +
    +
    Get the size of the range.
    +
    +
    size() - Method in interface org.apache.pulsar.client.api.TableView
    +
    +
    Returns the number of key-value mappings in the TableView.
    +
    +
    SizeUnit - Enum Class in org.apache.pulsar.client.api
    +
    +
    Size unit converter.
    +
    +
    SNAPPY - Enum constant in enum class org.apache.pulsar.client.api.CompressionType
    +
    +
    Compress with Snappy codec.
    +
    +
    SNI - Enum constant in enum class org.apache.pulsar.client.api.ProxyProtocol
    +
    +
    Follows SNI-routing + https://docs.trafficserver.apache.org/en/latest/admin-guide/layer-4-routing.en.html#sni-routing.
    +
    +
    socks5ProxyAddress(InetSocketAddress) - Method in interface org.apache.pulsar.client.api.ClientBuilder
    +
    +
    Set socks5 proxy address.
    +
    +
    socks5ProxyPassword(String) - Method in interface org.apache.pulsar.client.api.ClientBuilder
    +
    +
    Set socks5 proxy password.
    +
    +
    socks5ProxyUsername(String) - Method in interface org.apache.pulsar.client.api.ClientBuilder
    +
    +
    Set socks5 proxy username.
    +
    +
    sslFactoryPlugin(String) - Method in interface org.apache.pulsar.client.api.ClientBuilder
    +
    +
    Set the SSL Factory Plugin for custom implementation to create SSL Context and SSLEngine.
    +
    +
    sslFactoryPluginParams(String) - Method in interface org.apache.pulsar.client.api.ClientBuilder
    +
    +
    Set the SSL Factory Plugin params for the ssl factory plugin to use.
    +
    +
    sslProvider(String) - Method in interface org.apache.pulsar.client.api.ClientBuilder
    +
    +
    The name of the security provider used for SSL connections.
    +
    +
    start() - Method in interface org.apache.pulsar.client.api.Authentication
    +
    +
    Initialize the authentication provider.
    +
    +
    start() - Method in interface org.apache.pulsar.client.api.transaction.TransactionCoordinatorClient
    +
    +
    Start transaction meta store client.
    +
    +
    startAsync() - Method in interface org.apache.pulsar.client.api.transaction.TransactionCoordinatorClient
    +
    +
    Start transaction meta store client asynchronous.
    +
    +
    STARTING - Enum constant in enum class org.apache.pulsar.client.api.transaction.TransactionCoordinatorClient.State
    +
     
    +
    startingBackoffInterval(long, TimeUnit) - Method in interface org.apache.pulsar.client.api.ClientBuilder
    +
    +
    Set the duration of time for a backoff interval.
    +
    +
    startMessageFromRollbackDuration(long, TimeUnit) - Method in interface org.apache.pulsar.client.api.ReaderBuilder
    +
    +
    The initial reader positioning can be set at specific timestamp by providing total rollback duration.
    +
    +
    startMessageId(MessageId) - Method in interface org.apache.pulsar.client.api.ReaderBuilder
    +
    +
    The initial reader positioning is done by specifying a message id.
    +
    +
    startMessageIdInclusive() - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
    +
    +
    Sets the consumer to include the given position of any reset operation like Consumer.seek(long) or + Consumer.seek(MessageId)}.
    +
    +
    startMessageIdInclusive() - Method in interface org.apache.pulsar.client.api.ReaderBuilder
    +
    +
    Set the reader to include the given position of ReaderBuilder.startMessageId(MessageId)
    +
    +
    startPaused(boolean) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
    +
    +
    Starts the consumer in a paused state.
    +
    +
    statsInterval(long, TimeUnit) - Method in interface org.apache.pulsar.client.api.ClientBuilder
    +
    +
    Deprecated. +
    @see ClientBuilder.openTelemetry(OpenTelemetry)
    +
    +
    +
    STICKY - Enum constant in enum class org.apache.pulsar.client.api.KeySharedMode
    +
    +
    New consumer with fixed hash range to attach the topic, if new consumer use conflict hash range with + exits consumers, new consumer will be rejected.
    +
    +
    stickyHashRange() - Static method in class org.apache.pulsar.client.api.KeySharedPolicy
    +
     
    +
    STRING - Enum constant in enum class org.apache.pulsar.common.schema.SchemaType
    +
    +
    Simple String encoding with UTF-8.
    +
    +
    STRING - Static variable in interface org.apache.pulsar.client.api.Schema
    +
    +
    Schema that can be used to encode/decode messages whose values are String.
    +
    +
    subscribe() - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
    +
    +
    Finalize the Consumer creation by subscribing to the topic.
    +
    +
    subscribeAsync() - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
    +
    +
    Finalize the Consumer creation by subscribing to the topic in asynchronous mode.
    +
    +
    subscriptionInitialPosition(SubscriptionInitialPosition) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
    +
    +
    Sets the SubscriptionInitialPosition for the consumer.
    +
    +
    SubscriptionInitialPosition - Enum Class in org.apache.pulsar.client.api
    +
    +
    When creating a consumer, if the subscription does not exist, a new subscription will be created.
    +
    +
    subscriptionMode(SubscriptionMode) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
    +
    +
    Selects the subscription mode to be used when subscribing to a topic.
    +
    +
    SubscriptionMode - Enum Class in org.apache.pulsar.client.api
    +
    +
    Types of subscription mode supported by Pulsar.
    +
    +
    subscriptionName(String) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
    +
    +
    Specify the subscription name for this consumer.
    +
    +
    subscriptionName(String) - Method in interface org.apache.pulsar.client.api.ReaderBuilder
    +
    +
    Set the subscription name.
    +
    +
    subscriptionName(String) - Method in interface org.apache.pulsar.client.api.TableViewBuilder
    +
    +
    Set the subscription name of the TableView.
    +
    +
    SubscriptionNotFoundException(String) - Constructor for exception class org.apache.pulsar.client.api.PulsarClientException.SubscriptionNotFoundException
    +
    +
    Constructs an SubscriptionNotFoundException with the specified detail message.
    +
    +
    subscriptionProperties(Map<String, String>) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
    +
    +
    Specify the subscription properties for this subscription.
    +
    +
    subscriptionRolePrefix(String) - Method in interface org.apache.pulsar.client.api.ReaderBuilder
    +
    +
    Set the subscription role prefix.
    +
    +
    subscriptionTopicsMode(RegexSubscriptionMode) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
    +
    +
    Determines which topics this consumer should be subscribed to - Persistent, Non-Persistent, or both.
    +
    +
    subscriptionType(SubscriptionType) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
    +
    +
    Select the subscription type to be used when subscribing to a topic.
    +
    +
    SubscriptionType - Enum Class in org.apache.pulsar.client.api
    +
    +
    Types of subscription supported by Pulsar.
    +
    +
    supportSchemaVersioning() - Method in interface org.apache.pulsar.client.api.Schema
    +
    +
    Returns whether this schema supports versioning.
    +
    +
    SupportsGetPartitionedMetadataWithoutAutoCreation - Enum constant in enum class org.apache.pulsar.client.api.PulsarClientException.FailedFeatureCheck
    +
     
    +
    switchBackDelay(long, TimeUnit) - Method in interface org.apache.pulsar.client.api.AutoClusterFailoverBuilder
    +
    +
    Set the switchBackDelay.
    +
    +
    +

    T

    +
    +
    TableView<T> - Interface in org.apache.pulsar.client.api
    +
     
    +
    TableViewBuilder<T> - Interface in org.apache.pulsar.client.api
    +
    +
    TableViewBuilder is used to configure and create instances of TableView.
    +
    +
    TIME - Enum constant in enum class org.apache.pulsar.common.schema.SchemaType
    +
    +
    Time.
    +
    +
    TIME - Static variable in interface org.apache.pulsar.client.api.Schema
    +
    +
    Time Schema.
    +
    +
    TIME_OUT - Enum constant in enum class org.apache.pulsar.client.api.transaction.Transaction.State
    +
    +
    When a transaction is timed out and the transaction state is `OPEN`, + then the transaction state is changed from `OPEN` to `TIME_OUT`.
    +
    +
    timeout(int, TimeUnit) - Method in class org.apache.pulsar.client.api.BatchReceivePolicy.Builder
    +
     
    +
    TimeoutException(String) - Constructor for exception class org.apache.pulsar.client.api.PulsarClientException.TimeoutException
    +
    +
    Constructs an TimeoutException with the specified detail message.
    +
    +
    TimeoutException(String, long) - Constructor for exception class org.apache.pulsar.client.api.PulsarClientException.TimeoutException
    +
    +
    Constructs an TimeoutException with the specified detail message.
    +
    +
    TimeoutException(Throwable) - Constructor for exception class org.apache.pulsar.client.api.PulsarClientException.TimeoutException
    +
    +
    Constructs an TimeoutException with the specified cause.
    +
    +
    TimeoutException(Throwable, long) - Constructor for exception class org.apache.pulsar.client.api.PulsarClientException.TimeoutException
    +
    +
    Constructs an TimeoutException with the specified cause.
    +
    +
    timestamp(long) - Method in class org.apache.pulsar.common.schema.SchemaInfo.SchemaInfoBuilder
    +
     
    +
    TIMESTAMP - Enum constant in enum class org.apache.pulsar.common.schema.SchemaType
    +
    +
    Timestamp.
    +
    +
    TIMESTAMP - Static variable in interface org.apache.pulsar.client.api.Schema
    +
    +
    Timestamp Schema.
    +
    +
    TLS(String, String) - Static method in class org.apache.pulsar.client.api.AuthenticationFactory
    +
    +
    Create an authentication provider for TLS based authentication.
    +
    +
    tlsCertificateFilePath(String) - Method in interface org.apache.pulsar.client.api.ClientBuilder
    +
    +
    Set the path to the TLS certificate file.
    +
    +
    tlsCiphers(Set<String>) - Method in interface org.apache.pulsar.client.api.ClientBuilder
    +
    +
    A list of cipher suites.
    +
    +
    tlsKeyFilePath(String) - Method in interface org.apache.pulsar.client.api.ClientBuilder
    +
    +
    Set the path to the TLS key file.
    +
    +
    tlsKeyStorePassword(String) - Method in interface org.apache.pulsar.client.api.ClientBuilder
    +
    +
    The store password for the key store file.
    +
    +
    tlsKeyStorePath(String) - Method in interface org.apache.pulsar.client.api.ClientBuilder
    +
    +
    The location of the key store file.
    +
    +
    tlsKeyStoreType(String) - Method in interface org.apache.pulsar.client.api.ClientBuilder
    +
    +
    The file format of the key store file.
    +
    +
    tlsProtocols(Set<String>) - Method in interface org.apache.pulsar.client.api.ClientBuilder
    +
    +
    The SSL protocol used to generate the SSLContext.
    +
    +
    tlsTrustCertsFilePath(String) - Method in interface org.apache.pulsar.client.api.ClientBuilder
    +
    +
    Set the path to the trusted TLS certificate file.
    +
    +
    tlsTrustStorePassword(String) - Method in interface org.apache.pulsar.client.api.ClientBuilder
    +
    +
    The store password for the key store file.
    +
    +
    tlsTrustStorePath(String) - Method in interface org.apache.pulsar.client.api.ClientBuilder
    +
    +
    The location of the trust store file.
    +
    +
    tlsTrustStoreType(String) - Method in interface org.apache.pulsar.client.api.ClientBuilder
    +
    +
    The file format of the trust store file.
    +
    +
    toByteArray() - Method in interface org.apache.pulsar.client.api.MessageId
    +
    +
    Serialize the message ID into a byte array.
    +
    +
    toBytes(long) - Method in enum class org.apache.pulsar.client.api.SizeUnit
    +
     
    +
    toGigaBytes(long) - Method in enum class org.apache.pulsar.client.api.SizeUnit
    +
     
    +
    token(String) - Static method in class org.apache.pulsar.client.api.AuthenticationFactory
    +
    +
    Create an authentication provider for token based authentication.
    +
    +
    token(Supplier<String>) - Static method in class org.apache.pulsar.client.api.AuthenticationFactory
    +
    +
    Create an authentication provider for token based authentication.
    +
    +
    toKiloBytes(long) - Method in enum class org.apache.pulsar.client.api.SizeUnit
    +
     
    +
    toMegaBytes(long) - Method in enum class org.apache.pulsar.client.api.SizeUnit
    +
     
    +
    TooManyRequestsException(String) - Constructor for exception class org.apache.pulsar.client.api.PulsarClientException.TooManyRequestsException
    +
    +
    Constructs an TooManyRequestsException with the specified detail message.
    +
    +
    topic(String) - Method in interface org.apache.pulsar.client.api.ProducerBuilder
    +
    +
    Specify the topic this producer will be publishing on.
    +
    +
    topic(String) - Method in interface org.apache.pulsar.client.api.ReaderBuilder
    +
    +
    Specify the topic this reader will read from.
    +
    +
    topic(String) - Method in interface org.apache.pulsar.client.api.TableViewBuilder
    +
    +
    Set the topic name of the TableView.
    +
    +
    topic(String...) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
    +
    +
    Specify the topics this consumer subscribes to.
    +
    +
    topicConfiguration(String) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
    +
    +
    Configure topic specific options to override those set at the ConsumerBuilder level.
    +
    +
    topicConfiguration(String, Consumer<TopicConsumerBuilder<T>>) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
    +
    +
    Configure topic specific options to override those set at the ConsumerBuilder level.
    +
    +
    topicConfiguration(Pattern) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
    +
    +
    Configure topic specific options to override those set at the ConsumerBuilder level.
    +
    +
    topicConfiguration(Pattern, Consumer<TopicConsumerBuilder<T>>) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
    +
    +
    Configure topic specific options to override those set at the ConsumerBuilder level.
    +
    +
    TopicConsumerBuilder<T> - Interface in org.apache.pulsar.client.api
    +
    +
    TopicConsumerBuilder is used to configure topic specific options to override those set at the + ConsumerBuilder level.
    +
    +
    TopicDoesNotExistException(String) - Constructor for exception class org.apache.pulsar.client.api.PulsarClientException.TopicDoesNotExistException
    +
    +
    Constructs an TopicDoesNotExistException with the specified detail message.
    +
    +
    TopicMessageId - Interface in org.apache.pulsar.client.api
    +
    +
    The MessageId used for a consumer that subscribes multiple topics or partitioned topics.
    +
    +
    TopicMetadata - Interface in org.apache.pulsar.client.api
    +
    +
    Metadata of a topic that can be used for message routing.
    +
    +
    TopicMigrationException(String) - Constructor for exception class org.apache.pulsar.client.api.PulsarClientException.TopicMigrationException
    +
    +
    Constructs an TopicMigrationException with the specified detail message.
    +
    +
    topics(List<String>) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
    +
    +
    Specify a list of topics that this consumer subscribes to.
    +
    +
    topics(List<String>) - Method in interface org.apache.pulsar.client.api.ReaderBuilder
    +
    +
    Specify topics this reader will read from.
    +
    +
    topicsPattern(String) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
    +
    +
    Specify a pattern for topics(not contains the partition suffix) that this consumer subscribes to.
    +
    +
    topicsPattern(Pattern) - Method in interface org.apache.pulsar.client.api.ConsumerBuilder
    +
    +
    Specify a pattern for topics(not contains the partition suffix) that this consumer subscribes to.
    +
    +
    TopicTerminatedException(String) - Constructor for exception class org.apache.pulsar.client.api.PulsarClientException.TopicTerminatedException
    +
    +
    Constructs an TopicTerminatedException with the specified detail message.
    +
    +
    TopicTerminatedException(String, long) - Constructor for exception class org.apache.pulsar.client.api.PulsarClientException.TopicTerminatedException
    +
    +
    Constructs an TopicTerminatedException with the specified detail message.
    +
    +
    toString() - Method in class org.apache.pulsar.client.api.BatchReceivePolicy
    +
     
    +
    toString() - Method in exception class org.apache.pulsar.client.api.PulsarClientException
    +
     
    +
    toString() - Method in class org.apache.pulsar.client.api.Range
    +
     
    +
    toString() - Method in class org.apache.pulsar.client.api.transaction.TxnID
    +
     
    +
    toString() - Method in class org.apache.pulsar.common.schema.KeyValue
    +
     
    +
    toString() - Method in class org.apache.pulsar.common.schema.SchemaInfoWithVersion
    +
     
    +
    Transaction - Interface in org.apache.pulsar.client.api.transaction
    +
    +
    The class represents a transaction within Pulsar.
    +
    +
    Transaction.State - Enum Class in org.apache.pulsar.client.api.transaction
    +
     
    +
    TransactionBufferClient - Interface in org.apache.pulsar.client.api.transaction
    +
    +
    The transaction buffer client to commit and abort transactions on topics or subscription.
    +
    +
    TransactionBufferClientException - Exception Class in org.apache.pulsar.client.api.transaction
    +
    +
    Exceptions for transaction buffer client.
    +
    +
    TransactionBufferClientException(String) - Constructor for exception class org.apache.pulsar.client.api.transaction.TransactionBufferClientException
    +
     
    +
    TransactionBufferClientException(Throwable) - Constructor for exception class org.apache.pulsar.client.api.transaction.TransactionBufferClientException
    +
     
    +
    TransactionBufferClientException.ReachMaxPendingOpsException - Exception Class in org.apache.pulsar.client.api.transaction
    +
    +
    Thrown when transaction buffer op over max pending numbers.
    +
    +
    TransactionBufferClientException.RequestTimeoutException - Exception Class in org.apache.pulsar.client.api.transaction
    +
    +
    Thrown when operation timeout.
    +
    +
    TransactionBuilder - Interface in org.apache.pulsar.client.api.transaction
    +
    +
    The builder to build a transaction for Pulsar.
    +
    +
    TransactionConflictException(String) - Constructor for exception class org.apache.pulsar.client.api.PulsarClientException.TransactionConflictException
    +
    +
    Constructs an TransactionConflictException with the specified detail message.
    +
    +
    TransactionConflictException(Throwable) - Constructor for exception class org.apache.pulsar.client.api.PulsarClientException.TransactionConflictException
    +
    +
    Constructs an TransactionConflictException with the specified cause.
    +
    +
    TransactionCoordinatorClient - Interface in org.apache.pulsar.client.api.transaction
    +
    +
    Transaction coordinator client.
    +
    +
    TransactionCoordinatorClient.State - Enum Class in org.apache.pulsar.client.api.transaction
    +
    +
    State of the transaction coordinator client.
    +
    +
    TransactionCoordinatorClientException - Exception Class in org.apache.pulsar.client.api.transaction
    +
    +
    Exceptions for transaction coordinator client.
    +
    +
    TransactionCoordinatorClientException(String) - Constructor for exception class org.apache.pulsar.client.api.transaction.TransactionCoordinatorClientException
    +
     
    +
    TransactionCoordinatorClientException(Throwable) - Constructor for exception class org.apache.pulsar.client.api.transaction.TransactionCoordinatorClientException
    +
     
    +
    TransactionCoordinatorClientException.CoordinatorClientStateException - Exception Class in org.apache.pulsar.client.api.transaction
    +
    +
    Thrown when transaction coordinator with unexpected state.
    +
    +
    TransactionCoordinatorClientException.CoordinatorNotFoundException - Exception Class in org.apache.pulsar.client.api.transaction
    +
    +
    Thrown when transaction coordinator not found in broker side.
    +
    +
    TransactionCoordinatorClientException.InvalidTxnStatusException - Exception Class in org.apache.pulsar.client.api.transaction
    +
    +
    Thrown when transaction switch to a invalid status.
    +
    +
    TransactionCoordinatorClientException.MetaStoreHandlerNotExistsException - Exception Class in org.apache.pulsar.client.api.transaction
    +
    +
    Thrown when transaction meta store handler not exists.
    +
    +
    TransactionCoordinatorClientException.MetaStoreHandlerNotReadyException - Exception Class in org.apache.pulsar.client.api.transaction
    +
    +
    Thrown when send request to transaction meta store but the transaction meta store handler not ready.
    +
    +
    TransactionCoordinatorClientException.TransactionNotFoundException - Exception Class in org.apache.pulsar.client.api.transaction
    +
    +
    Thrown when transaction not found in transaction coordinator.
    +
    +
    TransactionHasOperationFailedException() - Constructor for exception class org.apache.pulsar.client.api.PulsarClientException.TransactionHasOperationFailedException
    +
    +
    Constructs an TransactionHasOperationFailedException.
    +
    +
    TransactionHasOperationFailedException(String) - Constructor for exception class org.apache.pulsar.client.api.PulsarClientException.TransactionHasOperationFailedException
    +
    +
    Constructs an TransactionHasOperationFailedException with the specified detail message.
    +
    +
    TransactionIsolationLevel - Enum Class in org.apache.pulsar.client.api
    +
     
    +
    TransactionNotFoundException(String) - Constructor for exception class org.apache.pulsar.client.api.transaction.TransactionCoordinatorClientException.TransactionNotFoundException
    +
     
    +
    TxnID - Class in org.apache.pulsar.client.api.transaction
    +
    +
    An identifier for representing a transaction.
    +
    +
    TxnID(long, long) - Constructor for class org.apache.pulsar.client.api.transaction.TxnID
    +
     
    +
    type(SchemaType) - Method in interface org.apache.pulsar.client.api.schema.FieldSchemaBuilder
    +
    +
    The type of this field.
    +
    +
    type(SchemaType) - Method in class org.apache.pulsar.common.schema.SchemaInfo.SchemaInfoBuilder
    +
     
    +
    TypedMessageBuilder<T> - Interface in org.apache.pulsar.client.api
    +
    +
    Message builder that constructs a message to be published through a producer.
    +
    +
    +

    U

    +
    +
    unsubscribe() - Method in interface org.apache.pulsar.client.api.Consumer
    +
    +
    Unsubscribe the consumer.
    +
    +
    unsubscribe(boolean) - Method in interface org.apache.pulsar.client.api.Consumer
    +
    +
    Unsubscribe the consumer.
    +
    +
    unsubscribeAsync() - Method in interface org.apache.pulsar.client.api.Consumer
    +
    +
    Asynchronously unsubscribe the consumer.
    +
    +
    unsubscribeAsync(boolean) - Method in interface org.apache.pulsar.client.api.Consumer
    +
    +
    Asynchronously unsubscribe the consumer.
    +
    +
    UnsupportedAuthenticationException(String) - Constructor for exception class org.apache.pulsar.client.api.PulsarClientException.UnsupportedAuthenticationException
    +
    +
    Constructs an UnsupportedAuthenticationException with the specified detail message.
    +
    +
    UnsupportedAuthenticationException(Throwable) - Constructor for exception class org.apache.pulsar.client.api.PulsarClientException.UnsupportedAuthenticationException
    +
    +
    Constructs an UnsupportedAuthenticationException with the specified cause.
    +
    +
    unwrap(Throwable) - Static method in exception class org.apache.pulsar.client.api.PulsarClientException
    +
     
    +
    unwrap(Throwable) - Static method in exception class org.apache.pulsar.client.api.transaction.TransactionBufferClientException
    +
     
    +
    unwrap(Throwable) - Static method in exception class org.apache.pulsar.client.api.transaction.TransactionCoordinatorClientException
    +
     
    +
    updateServiceUrl(String) - Method in interface org.apache.pulsar.client.api.PulsarClient
    +
    +
    Update the service URL this client is using.
    +
    +
    urlProvider(String) - Method in interface org.apache.pulsar.client.api.ControlledClusterFailoverBuilder
    +
    +
    Set the service url provider.
    +
    +
    urlProviderHeader(Map<String, String>) - Method in interface org.apache.pulsar.client.api.ControlledClusterFailoverBuilder
    +
    +
    Set the service url provider header to authenticate provider service.
    +
    +
    useKeyStoreTls(boolean) - Method in interface org.apache.pulsar.client.api.ClientBuilder
    +
    +
    If Tls is enabled, whether use KeyStore type as tls configuration parameter.
    +
    +
    +

    V

    +
    +
    validate() - Method in class org.apache.pulsar.client.api.KeySharedPolicy.KeySharedPolicyAutoSplit
    +
     
    +
    validate() - Method in class org.apache.pulsar.client.api.KeySharedPolicy.KeySharedPolicySticky
    +
     
    +
    validate() - Method in class org.apache.pulsar.client.api.KeySharedPolicy
    +
     
    +
    validate(byte[]) - Method in interface org.apache.pulsar.client.api.Schema
    +
    +
    Check if the message is a valid object for this schema.
    +
    +
    value(T) - Method in interface org.apache.pulsar.client.api.TypedMessageBuilder
    +
    +
    Set a domain object on the message.
    +
    +
    valueOf(int) - Static method in enum class org.apache.pulsar.common.schema.SchemaType
    +
    +
    Returns the enum constant of this class with the specified name.
    +
    +
    valueOf(String) - Static method in enum class org.apache.pulsar.client.api.AutoClusterFailoverBuilder.FailoverPolicy
    +
    +
    Returns the enum constant of this class with the specified name.
    +
    +
    valueOf(String) - Static method in enum class org.apache.pulsar.client.api.CompressionType
    +
    +
    Returns the enum constant of this class with the specified name.
    +
    +
    valueOf(String) - Static method in enum class org.apache.pulsar.client.api.ConsumerCryptoFailureAction
    +
    +
    Returns the enum constant of this class with the specified name.
    +
    +
    valueOf(String) - Static method in enum class org.apache.pulsar.client.api.HashingScheme
    +
    +
    Returns the enum constant of this class with the specified name.
    +
    +
    valueOf(String) - Static method in enum class org.apache.pulsar.client.api.KeySharedMode
    +
    +
    Returns the enum constant of this class with the specified name.
    +
    +
    valueOf(String) - Static method in enum class org.apache.pulsar.client.api.MessageRoutingMode
    +
    +
    Returns the enum constant of this class with the specified name.
    +
    +
    valueOf(String) - Static method in enum class org.apache.pulsar.client.api.ProducerAccessMode
    +
    +
    Returns the enum constant of this class with the specified name.
    +
    +
    valueOf(String) - Static method in enum class org.apache.pulsar.client.api.ProducerCryptoFailureAction
    +
    +
    Returns the enum constant of this class with the specified name.
    +
    +
    valueOf(String) - Static method in enum class org.apache.pulsar.client.api.ProxyProtocol
    +
    +
    Returns the enum constant of this class with the specified name.
    +
    +
    valueOf(String) - Static method in enum class org.apache.pulsar.client.api.PulsarClientException.FailedFeatureCheck
    +
    +
    Returns the enum constant of this class with the specified name.
    +
    +
    valueOf(String) - Static method in enum class org.apache.pulsar.client.api.RegexSubscriptionMode
    +
    +
    Returns the enum constant of this class with the specified name.
    +
    +
    valueOf(String) - Static method in enum class org.apache.pulsar.client.api.SizeUnit
    +
    +
    Returns the enum constant of this class with the specified name.
    +
    +
    valueOf(String) - Static method in enum class org.apache.pulsar.client.api.SubscriptionInitialPosition
    +
    +
    Returns the enum constant of this class with the specified name.
    +
    +
    valueOf(String) - Static method in enum class org.apache.pulsar.client.api.SubscriptionMode
    +
    +
    Returns the enum constant of this class with the specified name.
    +
    +
    valueOf(String) - Static method in enum class org.apache.pulsar.client.api.SubscriptionType
    +
    +
    Returns the enum constant of this class with the specified name.
    +
    +
    valueOf(String) - Static method in enum class org.apache.pulsar.client.api.transaction.Transaction.State
    +
    +
    Returns the enum constant of this class with the specified name.
    +
    +
    valueOf(String) - Static method in enum class org.apache.pulsar.client.api.transaction.TransactionCoordinatorClient.State
    +
    +
    Returns the enum constant of this class with the specified name.
    +
    +
    valueOf(String) - Static method in enum class org.apache.pulsar.client.api.TransactionIsolationLevel
    +
    +
    Returns the enum constant of this class with the specified name.
    +
    +
    valueOf(String) - Static method in enum class org.apache.pulsar.common.schema.KeyValueEncodingType
    +
    +
    Returns the enum constant of this class with the specified name.
    +
    +
    valueOf(String) - Static method in enum class org.apache.pulsar.common.schema.SchemaType
    +
    +
    Returns the enum constant of this class with the specified name.
    +
    +
    values() - Static method in enum class org.apache.pulsar.client.api.AutoClusterFailoverBuilder.FailoverPolicy
    +
    +
    Returns an array containing the constants of this enum class, in +the order they are declared.
    +
    +
    values() - Static method in enum class org.apache.pulsar.client.api.CompressionType
    +
    +
    Returns an array containing the constants of this enum class, in +the order they are declared.
    +
    +
    values() - Static method in enum class org.apache.pulsar.client.api.ConsumerCryptoFailureAction
    +
    +
    Returns an array containing the constants of this enum class, in +the order they are declared.
    +
    +
    values() - Static method in enum class org.apache.pulsar.client.api.HashingScheme
    +
    +
    Returns an array containing the constants of this enum class, in +the order they are declared.
    +
    +
    values() - Static method in enum class org.apache.pulsar.client.api.KeySharedMode
    +
    +
    Returns an array containing the constants of this enum class, in +the order they are declared.
    +
    +
    values() - Static method in enum class org.apache.pulsar.client.api.MessageRoutingMode
    +
    +
    Returns an array containing the constants of this enum class, in +the order they are declared.
    +
    +
    values() - Static method in enum class org.apache.pulsar.client.api.ProducerAccessMode
    +
    +
    Returns an array containing the constants of this enum class, in +the order they are declared.
    +
    +
    values() - Static method in enum class org.apache.pulsar.client.api.ProducerCryptoFailureAction
    +
    +
    Returns an array containing the constants of this enum class, in +the order they are declared.
    +
    +
    values() - Static method in enum class org.apache.pulsar.client.api.ProxyProtocol
    +
    +
    Returns an array containing the constants of this enum class, in +the order they are declared.
    +
    +
    values() - Static method in enum class org.apache.pulsar.client.api.PulsarClientException.FailedFeatureCheck
    +
    +
    Returns an array containing the constants of this enum class, in +the order they are declared.
    +
    +
    values() - Static method in enum class org.apache.pulsar.client.api.RegexSubscriptionMode
    +
    +
    Returns an array containing the constants of this enum class, in +the order they are declared.
    +
    +
    values() - Static method in enum class org.apache.pulsar.client.api.SizeUnit
    +
    +
    Returns an array containing the constants of this enum class, in +the order they are declared.
    +
    +
    values() - Static method in enum class org.apache.pulsar.client.api.SubscriptionInitialPosition
    +
    +
    Returns an array containing the constants of this enum class, in +the order they are declared.
    +
    +
    values() - Static method in enum class org.apache.pulsar.client.api.SubscriptionMode
    +
    +
    Returns an array containing the constants of this enum class, in +the order they are declared.
    +
    +
    values() - Static method in enum class org.apache.pulsar.client.api.SubscriptionType
    +
    +
    Returns an array containing the constants of this enum class, in +the order they are declared.
    +
    +
    values() - Method in interface org.apache.pulsar.client.api.TableView
    +
    +
    Returns a Collection view of the values contained in this TableView.
    +
    +
    values() - Static method in enum class org.apache.pulsar.client.api.transaction.Transaction.State
    +
    +
    Returns an array containing the constants of this enum class, in +the order they are declared.
    +
    +
    values() - Static method in enum class org.apache.pulsar.client.api.transaction.TransactionCoordinatorClient.State
    +
    +
    Returns an array containing the constants of this enum class, in +the order they are declared.
    +
    +
    values() - Static method in enum class org.apache.pulsar.client.api.TransactionIsolationLevel
    +
    +
    Returns an array containing the constants of this enum class, in +the order they are declared.
    +
    +
    values() - Static method in enum class org.apache.pulsar.common.schema.KeyValueEncodingType
    +
    +
    Returns an array containing the constants of this enum class, in +the order they are declared.
    +
    +
    values() - Static method in enum class org.apache.pulsar.common.schema.SchemaType
    +
    +
    Returns an array containing the constants of this enum class, in +the order they are declared.
    +
    +
    verify() - Method in class org.apache.pulsar.client.api.BatchReceivePolicy
    +
     
    +
    +

    W

    +
    +
    WaitForExclusive - Enum constant in enum class org.apache.pulsar.client.api.ProducerAccessMode
    +
    +
    Producer creation is pending until it can acquire exclusive access.
    +
    +
    withAlwaysAllowNull(boolean) - Method in interface org.apache.pulsar.client.api.schema.SchemaDefinitionBuilder
    +
    +
    Set schema whether always allow null or not.
    +
    +
    withClassLoader(ClassLoader) - Method in interface org.apache.pulsar.client.api.schema.SchemaDefinitionBuilder
    +
    +
    Set schema of pojo classLoader.
    +
    +
    withJsonDef(String) - Method in interface org.apache.pulsar.client.api.schema.SchemaDefinitionBuilder
    +
    +
    Set schema of json definition.
    +
    +
    withJSR310ConversionEnabled(boolean) - Method in interface org.apache.pulsar.client.api.schema.SchemaDefinitionBuilder
    +
    +
    Set schema use JRS310 conversion or not.
    +
    +
    withPojo(Class) - Method in interface org.apache.pulsar.client.api.schema.SchemaDefinitionBuilder
    +
    +
    Set schema of pojo definition.
    +
    +
    withProperties(Map<String, String>) - Method in interface org.apache.pulsar.client.api.schema.SchemaDefinitionBuilder
    +
    +
    Set schema info properties.
    +
    +
    withSchemaReader(SchemaReader<T>) - Method in interface org.apache.pulsar.client.api.schema.SchemaDefinitionBuilder
    +
    +
    Set schema reader for deserialization of object data.
    +
    +
    withSchemaWriter(SchemaWriter<T>) - Method in interface org.apache.pulsar.client.api.schema.SchemaDefinitionBuilder
    +
    +
    Set schema writer for serialization of objects.
    +
    +
    withSupportSchemaVersioning(boolean) - Method in interface org.apache.pulsar.client.api.schema.SchemaDefinitionBuilder
    +
    +
    Set schema whether decode by schema version.
    +
    +
    withTransactionTimeout(long, TimeUnit) - Method in interface org.apache.pulsar.client.api.transaction.TransactionBuilder
    +
    +
    Configure the maximum amount of time that the transaction + coordinator will for a transaction to be completed by the + client before proactively aborting the ongoing transaction.
    +
    +
    wrap(byte[]) - Method in interface org.apache.pulsar.client.api.MessagePayloadFactory
    +
    +
    Create a payload whose underlying buffer refers to a byte array.
    +
    +
    wrap(Throwable, String) - Static method in exception class org.apache.pulsar.client.api.PulsarClientException
    +
     
    +
    wrap(ByteBuffer) - Method in interface org.apache.pulsar.client.api.MessagePayloadFactory
    +
    +
    Create a payload whose underlying buffer refers to a NIO buffer.
    +
    +
    write(T) - Method in interface org.apache.pulsar.client.api.schema.SchemaWriter
    +
    +
    Serialize the message into bytes.
    +
    +
    +

    Z

    +
    +
    ZLIB - Enum constant in enum class org.apache.pulsar.client.api.CompressionType
    +
    +
    Compress with ZLib.
    +
    +
    ZSTD - Enum constant in enum class org.apache.pulsar.client.api.CompressionType
    +
    +
    Compress with Zstandard codec.
    +
    +
    +A B C D E F G H I J K L M N O P R S T U V W Z 
    All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
    + +
    +
    + + diff --git a/static/api/client/4.0.x/index.html b/static/api/client/4.0.x/index.html new file mode 100644 index 000000000000..5241b54655c9 --- /dev/null +++ b/static/api/client/4.0.x/index.html @@ -0,0 +1,101 @@ + + + + +Overview (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Pulsar Client :: API 4.0.0 API

    +
    +
    +
    Packages
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    org.apache.pulsar.client.api.interceptor
    +
    +
    Pulsar interceptors.
    +
    +
    org.apache.pulsar.client.api.schema
    +
    +
    Schema definitions for Pulsar Client API.
    +
    +
    org.apache.pulsar.client.api.transaction
    +
    +
    Pulsar transaction related API.
    +
    +
    org.apache.pulsar.client.internal
    +
    +
    Helpers which provide useful functionality for the implementation of Pulsar Client API.
    +
    +
    org.apache.pulsar.common.api
    +
    +
    Common data classes used in the Pulsar Client API.
    +
    +
    org.apache.pulsar.common.classification
    +
    +
    Annotations used across the whole project.
    +
    +
    org.apache.pulsar.common.schema
    +
    +
    This package contains data structures for schema definitions used in the Pulsar Client API.
    +
    +
    +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/legal/ADDITIONAL_LICENSE_INFO b/static/api/client/4.0.x/legal/ADDITIONAL_LICENSE_INFO new file mode 100644 index 000000000000..ff700cd09f6e --- /dev/null +++ b/static/api/client/4.0.x/legal/ADDITIONAL_LICENSE_INFO @@ -0,0 +1,37 @@ + ADDITIONAL INFORMATION ABOUT LICENSING + +Certain files distributed by Oracle America, Inc. and/or its affiliates are +subject to the following clarification and special exception to the GPLv2, +based on the GNU Project exception for its Classpath libraries, known as the +GNU Classpath Exception. + +Note that Oracle includes multiple, independent programs in this software +package. Some of those programs are provided under licenses deemed +incompatible with the GPLv2 by the Free Software Foundation and others. +For example, the package includes programs licensed under the Apache +License, Version 2.0 and may include FreeType. Such programs are licensed +to you under their original licenses. + +Oracle facilitates your further distribution of this package by adding the +Classpath Exception to the necessary parts of its GPLv2 code, which permits +you to use that code in combination with other independent modules not +licensed under the GPLv2. However, note that this would not permit you to +commingle code under an incompatible license with Oracle's GPLv2 licensed +code by, for example, cutting and pasting such code into a file also +containing Oracle's GPLv2 licensed code and then distributing the result. + +Additionally, if you were to remove the Classpath Exception from any of the +files to which it applies and distribute the result, you would likely be +required to license some or all of the other code in that distribution under +the GPLv2 as well, and since the GPLv2 is incompatible with the license terms +of some items included in the distribution by Oracle, removing the Classpath +Exception could therefore effectively compromise your ability to further +distribute the package. + +Failing to distribute notices associated with some files may also create +unexpected legal consequences. + +Proceed with caution and we recommend that you obtain the advice of a lawyer +skilled in open source matters before removing the Classpath Exception or +making modifications to this package which may subsequently be redistributed +and/or involve the use of third party software. diff --git a/static/api/client/4.0.x/legal/ASSEMBLY_EXCEPTION b/static/api/client/4.0.x/legal/ASSEMBLY_EXCEPTION new file mode 100644 index 000000000000..429666664e9f --- /dev/null +++ b/static/api/client/4.0.x/legal/ASSEMBLY_EXCEPTION @@ -0,0 +1,27 @@ + +OPENJDK ASSEMBLY EXCEPTION + +The OpenJDK source code made available by Oracle America, Inc. (Oracle) at +openjdk.org ("OpenJDK Code") is distributed under the terms of the GNU +General Public License version 2 +only ("GPL2"), with the following clarification and special exception. + + Linking this OpenJDK Code statically or dynamically with other code + is making a combined work based on this library. Thus, the terms + and conditions of GPL2 cover the whole combination. + + As a special exception, Oracle gives you permission to link this + OpenJDK Code with certain code licensed by Oracle as indicated at + https://openjdk.org/legal/exception-modules-2007-05-08.html + ("Designated Exception Modules") to produce an executable, + regardless of the license terms of the Designated Exception Modules, + and to copy and distribute the resulting executable under GPL2, + provided that the Designated Exception Modules continue to be + governed by the licenses under which they were offered by Oracle. + +As such, it allows licensees and sublicensees of Oracle's GPL2 OpenJDK Code +to build an executable that includes those portions of necessary code that +Oracle could not provide under GPL2 (or that Oracle has provided under GPL2 +with the Classpath exception). If you modify or add to the OpenJDK code, +that new GPL2 code may still be combined with Designated Exception Modules +if the new code is made subject to this exception by its copyright holder. diff --git a/static/api/client/4.0.x/legal/LICENSE b/static/api/client/4.0.x/legal/LICENSE new file mode 100644 index 000000000000..8b400c7ab81b --- /dev/null +++ b/static/api/client/4.0.x/legal/LICENSE @@ -0,0 +1,347 @@ +The GNU General Public License (GPL) + +Version 2, June 1991 + +Copyright (C) 1989, 1991 Free Software Foundation, Inc. +51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + +Everyone is permitted to copy and distribute verbatim copies of this license +document, but changing it is not allowed. + +Preamble + +The licenses for most software are designed to take away your freedom to share +and change it. By contrast, the GNU General Public License is intended to +guarantee your freedom to share and change free software--to make sure the +software is free for all its users. This General Public License applies to +most of the Free Software Foundation's software and to any other program whose +authors commit to using it. (Some other Free Software Foundation software is +covered by the GNU Library General Public License instead.) You can apply it to +your programs, too. + +When we speak of free software, we are referring to freedom, not price. Our +General Public Licenses are designed to make sure that you have the freedom to +distribute copies of free software (and charge for this service if you wish), +that you receive source code or can get it if you want it, that you can change +the software or use pieces of it in new free programs; and that you know you +can do these things. + +To protect your rights, we need to make restrictions that forbid anyone to deny +you these rights or to ask you to surrender the rights. These restrictions +translate to certain responsibilities for you if you distribute copies of the +software, or if you modify it. + +For example, if you distribute copies of such a program, whether gratis or for +a fee, you must give the recipients all the rights that you have. You must +make sure that they, too, receive or can get the source code. And you must +show them these terms so they know their rights. + +We protect your rights with two steps: (1) copyright the software, and (2) +offer you this license which gives you legal permission to copy, distribute +and/or modify the software. + +Also, for each author's protection and ours, we want to make certain that +everyone understands that there is no warranty for this free software. If the +software is modified by someone else and passed on, we want its recipients to +know that what they have is not the original, so that any problems introduced +by others will not reflect on the original authors' reputations. + +Finally, any free program is threatened constantly by software patents. We +wish to avoid the danger that redistributors of a free program will +individually obtain patent licenses, in effect making the program proprietary. +To prevent this, we have made it clear that any patent must be licensed for +everyone's free use or not licensed at all. + +The precise terms and conditions for copying, distribution and modification +follow. + +TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + +0. This License applies to any program or other work which contains a notice +placed by the copyright holder saying it may be distributed under the terms of +this General Public License. The "Program", below, refers to any such program +or work, and a "work based on the Program" means either the Program or any +derivative work under copyright law: that is to say, a work containing the +Program or a portion of it, either verbatim or with modifications and/or +translated into another language. (Hereinafter, translation is included +without limitation in the term "modification".) Each licensee is addressed as +"you". + +Activities other than copying, distribution and modification are not covered by +this License; they are outside its scope. The act of running the Program is +not restricted, and the output from the Program is covered only if its contents +constitute a work based on the Program (independent of having been made by +running the Program). Whether that is true depends on what the Program does. + +1. You may copy and distribute verbatim copies of the Program's source code as +you receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice and +disclaimer of warranty; keep intact all the notices that refer to this License +and to the absence of any warranty; and give any other recipients of the +Program a copy of this License along with the Program. + +You may charge a fee for the physical act of transferring a copy, and you may +at your option offer warranty protection in exchange for a fee. + +2. You may modify your copy or copies of the Program or any portion of it, thus +forming a work based on the Program, and copy and distribute such modifications +or work under the terms of Section 1 above, provided that you also meet all of +these conditions: + + a) You must cause the modified files to carry prominent notices stating + that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in whole or + in part contains or is derived from the Program or any part thereof, to be + licensed as a whole at no charge to all third parties under the terms of + this License. + + c) If the modified program normally reads commands interactively when run, + you must cause it, when started running for such interactive use in the + most ordinary way, to print or display an announcement including an + appropriate copyright notice and a notice that there is no warranty (or + else, saying that you provide a warranty) and that users may redistribute + the program under these conditions, and telling the user how to view a copy + of this License. (Exception: if the Program itself is interactive but does + not normally print such an announcement, your work based on the Program is + not required to print an announcement.) + +These requirements apply to the modified work as a whole. If identifiable +sections of that work are not derived from the Program, and can be reasonably +considered independent and separate works in themselves, then this License, and +its terms, do not apply to those sections when you distribute them as separate +works. But when you distribute the same sections as part of a whole which is a +work based on the Program, the distribution of the whole must be on the terms +of this License, whose permissions for other licensees extend to the entire +whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest your +rights to work written entirely by you; rather, the intent is to exercise the +right to control the distribution of derivative or collective works based on +the Program. + +In addition, mere aggregation of another work not based on the Program with the +Program (or with a work based on the Program) on a volume of a storage or +distribution medium does not bring the other work under the scope of this +License. + +3. You may copy and distribute the Program (or a work based on it, under +Section 2) in object code or executable form under the terms of Sections 1 and +2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable source + code, which must be distributed under the terms of Sections 1 and 2 above + on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three years, to + give any third party, for a charge no more than your cost of physically + performing source distribution, a complete machine-readable copy of the + corresponding source code, to be distributed under the terms of Sections 1 + and 2 above on a medium customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer to + distribute corresponding source code. (This alternative is allowed only + for noncommercial distribution and only if you received the program in + object code or executable form with such an offer, in accord with + Subsection b above.) + +The source code for a work means the preferred form of the work for making +modifications to it. For an executable work, complete source code means all +the source code for all modules it contains, plus any associated interface +definition files, plus the scripts used to control compilation and installation +of the executable. However, as a special exception, the source code +distributed need not include anything that is normally distributed (in either +source or binary form) with the major components (compiler, kernel, and so on) +of the operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering access to copy +from a designated place, then offering equivalent access to copy the source +code from the same place counts as distribution of the source code, even though +third parties are not compelled to copy the source along with the object code. + +4. You may not copy, modify, sublicense, or distribute the Program except as +expressly provided under this License. Any attempt otherwise to copy, modify, +sublicense or distribute the Program is void, and will automatically terminate +your rights under this License. However, parties who have received copies, or +rights, from you under this License will not have their licenses terminated so +long as such parties remain in full compliance. + +5. You are not required to accept this License, since you have not signed it. +However, nothing else grants you permission to modify or distribute the Program +or its derivative works. These actions are prohibited by law if you do not +accept this License. Therefore, by modifying or distributing the Program (or +any work based on the Program), you indicate your acceptance of this License to +do so, and all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + +6. Each time you redistribute the Program (or any work based on the Program), +the recipient automatically receives a license from the original licensor to +copy, distribute or modify the Program subject to these terms and conditions. +You may not impose any further restrictions on the recipients' exercise of the +rights granted herein. You are not responsible for enforcing compliance by +third parties to this License. + +7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), conditions +are imposed on you (whether by court order, agreement or otherwise) that +contradict the conditions of this License, they do not excuse you from the +conditions of this License. If you cannot distribute so as to satisfy +simultaneously your obligations under this License and any other pertinent +obligations, then as a consequence you may not distribute the Program at all. +For example, if a patent license would not permit royalty-free redistribution +of the Program by all those who receive copies directly or indirectly through +you, then the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under any +particular circumstance, the balance of the section is intended to apply and +the section as a whole is intended to apply in other circumstances. + +It is not the purpose of this section to induce you to infringe any patents or +other property right claims or to contest validity of any such claims; this +section has the sole purpose of protecting the integrity of the free software +distribution system, which is implemented by public license practices. Many +people have made generous contributions to the wide range of software +distributed through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing to +distribute software through any other system and a licensee cannot impose that +choice. + +This section is intended to make thoroughly clear what is believed to be a +consequence of the rest of this License. + +8. If the distribution and/or use of the Program is restricted in certain +countries either by patents or by copyrighted interfaces, the original +copyright holder who places the Program under this License may add an explicit +geographical distribution limitation excluding those countries, so that +distribution is permitted only in or among countries not thus excluded. In +such case, this License incorporates the limitation as if written in the body +of this License. + +9. The Free Software Foundation may publish revised and/or new versions of the +General Public License from time to time. Such new versions will be similar in +spirit to the present version, but may differ in detail to address new problems +or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any later +version", you have the option of following the terms and conditions either of +that version or of any later version published by the Free Software Foundation. +If the Program does not specify a version number of this License, you may +choose any version ever published by the Free Software Foundation. + +10. If you wish to incorporate parts of the Program into other free programs +whose distribution conditions are different, write to the author to ask for +permission. For software which is copyrighted by the Free Software Foundation, +write to the Free Software Foundation; we sometimes make exceptions for this. +Our decision will be guided by the two goals of preserving the free status of +all derivatives of our free software and of promoting the sharing and reuse of +software generally. + +NO WARRANTY + +11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR +THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE +STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE +PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, +INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND +FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND +PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, +YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + +12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL +ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE +PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR +INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA +BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A +FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER +OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. + +END OF TERMS AND CONDITIONS + +How to Apply These Terms to Your New Programs + +If you develop a new program, and you want it to be of the greatest possible +use to the public, the best way to achieve this is to make it free software +which everyone can redistribute and change under these terms. + +To do so, attach the following notices to the program. It is safest to attach +them to the start of each source file to most effectively convey the exclusion +of warranty; and each file should have at least the "copyright" line and a +pointer to where the full notice is found. + + One line to give the program's name and a brief idea of what it does. + + Copyright (C) + + This program is free software; you can redistribute it and/or modify it + under the terms of the GNU General Public License as published by the Free + Software Foundation; either version 2 of the License, or (at your option) + any later version. + + This program is distributed in the hope that it will be useful, but WITHOUT + ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for + more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this when it +starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author Gnomovision comes + with ABSOLUTELY NO WARRANTY; for details type 'show w'. This is free + software, and you are welcome to redistribute it under certain conditions; + type 'show c' for details. + +The hypothetical commands 'show w' and 'show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may be +called something other than 'show w' and 'show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your school, +if any, to sign a "copyright disclaimer" for the program, if necessary. Here +is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + 'Gnomovision' (which makes passes at compilers) written by James Hacker. + + signature of Ty Coon, 1 April 1989 + + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Library General Public +License instead of this License. + + +"CLASSPATH" EXCEPTION TO THE GPL + +Certain source files distributed by Oracle America and/or its affiliates are +subject to the following clarification and special exception to the GPL, but +only where Oracle has expressly included in the particular source file's header +the words "Oracle designates this particular file as subject to the "Classpath" +exception as provided by Oracle in the LICENSE file that accompanied this code." + + Linking this library statically or dynamically with other modules is making + a combined work based on this library. Thus, the terms and conditions of + the GNU General Public License cover the whole combination. + + As a special exception, the copyright holders of this library give you + permission to link this library with independent modules to produce an + executable, regardless of the license terms of these independent modules, + and to copy and distribute the resulting executable under terms of your + choice, provided that you also meet, for each linked independent module, + the terms and conditions of the license of that module. An independent + module is a module which is not derived from or based on this library. If + you modify this library, you may extend this exception to your version of + the library, but you are not obligated to do so. If you do not wish to do + so, delete this exception statement from your version. diff --git a/static/api/client/4.0.x/legal/jquery.md b/static/api/client/4.0.x/legal/jquery.md new file mode 100644 index 000000000000..d468b3183a70 --- /dev/null +++ b/static/api/client/4.0.x/legal/jquery.md @@ -0,0 +1,72 @@ +## jQuery v3.6.1 + +### jQuery License +``` +jQuery v 3.6.1 +Copyright OpenJS Foundation and other contributors, https://openjsf.org/ + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +****************************************** + +The jQuery JavaScript Library v3.6.1 also includes Sizzle.js + +Sizzle.js includes the following license: + +Copyright JS Foundation and other contributors, https://js.foundation/ + +This software consists of voluntary contributions made by many +individuals. For exact contribution history, see the revision history +available at https://github.com/jquery/sizzle + +The following license applies to all parts of this software except as +documented below: + +==== + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +==== + +All files located in the node_modules and external directories are +externally maintained libraries used by this software which have their +own licenses; we recommend you read them, as their terms may differ from +the terms above. + +********************* + +``` diff --git a/static/api/client/4.0.x/legal/jqueryUI.md b/static/api/client/4.0.x/legal/jqueryUI.md new file mode 100644 index 000000000000..8bda9d7a85e8 --- /dev/null +++ b/static/api/client/4.0.x/legal/jqueryUI.md @@ -0,0 +1,49 @@ +## jQuery UI v1.13.2 + +### jQuery UI License +``` +Copyright jQuery Foundation and other contributors, https://jquery.org/ + +This software consists of voluntary contributions made by many +individuals. For exact contribution history, see the revision history +available at https://github.com/jquery/jquery-ui + +The following license applies to all parts of this software except as +documented below: + +==== + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +==== + +Copyright and related rights for sample code are waived via CC0. Sample +code is defined as all source code contained within the demos directory. + +CC0: http://creativecommons.org/publicdomain/zero/1.0/ + +==== + +All files located in the node_modules and external directories are +externally maintained libraries used by this software which have their +own licenses; we recommend you read them, as their terms may differ from +the terms above. + +``` diff --git a/static/api/client/4.0.x/link.svg b/static/api/client/4.0.x/link.svg new file mode 100644 index 000000000000..7ccc5ed08cbf --- /dev/null +++ b/static/api/client/4.0.x/link.svg @@ -0,0 +1,31 @@ + + + + + + + + diff --git a/static/api/client/4.0.x/member-search-index.js b/static/api/client/4.0.x/member-search-index.js new file mode 100644 index 000000000000..4e85e8d4a6f2 --- /dev/null +++ b/static/api/client/4.0.x/member-search-index.js @@ -0,0 +1 @@ +memberSearchIndex = [{"p":"org.apache.pulsar.client.api.transaction","c":"Transaction","l":"abort()"},{"p":"org.apache.pulsar.client.api.transaction","c":"TransactionCoordinatorClient","l":"abort(TxnID)","u":"abort(org.apache.pulsar.client.api.transaction.TxnID)"},{"p":"org.apache.pulsar.client.api.transaction","c":"TransactionCoordinatorClient","l":"abortAsync(TxnID)","u":"abortAsync(org.apache.pulsar.client.api.transaction.TxnID)"},{"p":"org.apache.pulsar.client.api.transaction","c":"Transaction.State","l":"ABORTED"},{"p":"org.apache.pulsar.client.api.transaction","c":"Transaction.State","l":"ABORTING"},{"p":"org.apache.pulsar.client.api.transaction","c":"TransactionBufferClient","l":"abortTxnOnSubscription(String, String, long, long, long)","u":"abortTxnOnSubscription(java.lang.String,java.lang.String,long,long,long)"},{"p":"org.apache.pulsar.client.api.transaction","c":"TransactionBufferClient","l":"abortTxnOnTopic(String, long, long, long)","u":"abortTxnOnTopic(java.lang.String,long,long,long)"},{"p":"org.apache.pulsar.client.api","c":"ProducerBuilder","l":"accessMode(ProducerAccessMode)","u":"accessMode(org.apache.pulsar.client.api.ProducerAccessMode)"},{"p":"org.apache.pulsar.client.api","c":"MessageAcknowledger","l":"acknowledge(List)","u":"acknowledge(java.util.List)"},{"p":"org.apache.pulsar.client.api","c":"MessageAcknowledger","l":"acknowledge(Message)","u":"acknowledge(org.apache.pulsar.client.api.Message)"},{"p":"org.apache.pulsar.client.api","c":"MessageAcknowledger","l":"acknowledge(MessageId)","u":"acknowledge(org.apache.pulsar.client.api.MessageId)"},{"p":"org.apache.pulsar.client.api","c":"MessageAcknowledger","l":"acknowledge(Messages)","u":"acknowledge(org.apache.pulsar.client.api.Messages)"},{"p":"org.apache.pulsar.client.api","c":"MessageAcknowledger","l":"acknowledgeAsync(List)","u":"acknowledgeAsync(java.util.List)"},{"p":"org.apache.pulsar.client.api","c":"MessageAcknowledger","l":"acknowledgeAsync(List, Transaction)","u":"acknowledgeAsync(java.util.List,org.apache.pulsar.client.api.transaction.Transaction)"},{"p":"org.apache.pulsar.client.api","c":"MessageAcknowledger","l":"acknowledgeAsync(Message)","u":"acknowledgeAsync(org.apache.pulsar.client.api.Message)"},{"p":"org.apache.pulsar.client.api","c":"MessageAcknowledger","l":"acknowledgeAsync(MessageId)","u":"acknowledgeAsync(org.apache.pulsar.client.api.MessageId)"},{"p":"org.apache.pulsar.client.api","c":"MessageAcknowledger","l":"acknowledgeAsync(MessageId, Transaction)","u":"acknowledgeAsync(org.apache.pulsar.client.api.MessageId,org.apache.pulsar.client.api.transaction.Transaction)"},{"p":"org.apache.pulsar.client.api","c":"MessageAcknowledger","l":"acknowledgeAsync(Messages)","u":"acknowledgeAsync(org.apache.pulsar.client.api.Messages)"},{"p":"org.apache.pulsar.client.api","c":"MessageAcknowledger","l":"acknowledgeAsync(Messages, Transaction)","u":"acknowledgeAsync(org.apache.pulsar.client.api.Messages,org.apache.pulsar.client.api.transaction.Transaction)"},{"p":"org.apache.pulsar.client.api","c":"MessageAcknowledger","l":"acknowledgeCumulative(Message)","u":"acknowledgeCumulative(org.apache.pulsar.client.api.Message)"},{"p":"org.apache.pulsar.client.api","c":"MessageAcknowledger","l":"acknowledgeCumulative(MessageId)","u":"acknowledgeCumulative(org.apache.pulsar.client.api.MessageId)"},{"p":"org.apache.pulsar.client.api","c":"MessageAcknowledger","l":"acknowledgeCumulativeAsync(Message)","u":"acknowledgeCumulativeAsync(org.apache.pulsar.client.api.Message)"},{"p":"org.apache.pulsar.client.api","c":"MessageAcknowledger","l":"acknowledgeCumulativeAsync(MessageId)","u":"acknowledgeCumulativeAsync(org.apache.pulsar.client.api.MessageId)"},{"p":"org.apache.pulsar.client.api","c":"MessageAcknowledger","l":"acknowledgeCumulativeAsync(MessageId, Transaction)","u":"acknowledgeCumulativeAsync(org.apache.pulsar.client.api.MessageId,org.apache.pulsar.client.api.transaction.Transaction)"},{"p":"org.apache.pulsar.client.api","c":"ConsumerBuilder","l":"acknowledgmentGroupTime(long, TimeUnit)","u":"acknowledgmentGroupTime(long,java.util.concurrent.TimeUnit)"},{"p":"org.apache.pulsar.client.api","c":"ConsumerBuilder","l":"ackTimeout(long, TimeUnit)","u":"ackTimeout(long,java.util.concurrent.TimeUnit)"},{"p":"org.apache.pulsar.client.api","c":"ConsumerBuilder","l":"ackTimeoutRedeliveryBackoff(RedeliveryBackoff)","u":"ackTimeoutRedeliveryBackoff(org.apache.pulsar.client.api.RedeliveryBackoff)"},{"p":"org.apache.pulsar.client.api","c":"ConsumerBuilder","l":"ackTimeoutTickTime(long, TimeUnit)","u":"ackTimeoutTickTime(long,java.util.concurrent.TimeUnit)"},{"p":"org.apache.pulsar.client.api","c":"ProducerBuilder","l":"addEncryptionKey(String)","u":"addEncryptionKey(java.lang.String)"},{"p":"org.apache.pulsar.client.api.schema","c":"SchemaDefinitionBuilder","l":"addProperty(String, String)","u":"addProperty(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"MessageCrypto","l":"addPublicKeyCipher(Set, CryptoKeyReader)","u":"addPublicKeyCipher(java.util.Set,org.apache.pulsar.client.api.CryptoKeyReader)"},{"p":"org.apache.pulsar.client.api.transaction","c":"TransactionCoordinatorClient","l":"addPublishPartitionToTxn(TxnID, List)","u":"addPublishPartitionToTxn(org.apache.pulsar.client.api.transaction.TxnID,java.util.List)"},{"p":"org.apache.pulsar.client.api.transaction","c":"TransactionCoordinatorClient","l":"addPublishPartitionToTxnAsync(TxnID, List)","u":"addPublishPartitionToTxnAsync(org.apache.pulsar.client.api.transaction.TxnID,java.util.List)"},{"p":"org.apache.pulsar.client.api.transaction","c":"TransactionCoordinatorClient","l":"addSubscriptionToTxn(TxnID, String, String)","u":"addSubscriptionToTxn(org.apache.pulsar.client.api.transaction.TxnID,java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.api.transaction","c":"TransactionCoordinatorClient","l":"addSubscriptionToTxnAsync(TxnID, String, String)","u":"addSubscriptionToTxnAsync(org.apache.pulsar.client.api.transaction.TxnID,java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.api.schema","c":"FieldSchemaBuilder","l":"aliases(String...)","u":"aliases(java.lang.String...)"},{"p":"org.apache.pulsar.client.api","c":"KeySharedPolicy","l":"allowOutOfOrderDelivery"},{"p":"org.apache.pulsar.client.api","c":"ClientBuilder","l":"allowTlsInsecureConnection(boolean)"},{"p":"org.apache.pulsar.client.api","c":"RegexSubscriptionMode","l":"AllTopics"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException.AlreadyClosedException","l":"AlreadyClosedException(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException.AlreadyClosedException","l":"AlreadyClosedException(String, long)","u":"%3Cinit%3E(java.lang.String,long)"},{"p":"org.apache.pulsar.client.api","c":"MessagePayloadContext","l":"asSingleMessage(MessagePayload, Schema)","u":"asSingleMessage(org.apache.pulsar.client.api.MessagePayload,org.apache.pulsar.client.api.Schema)"},{"p":"org.apache.pulsar.common.api","c":"AuthData","l":"AuthData()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.client.api","c":"AuthenticationDataProvider","l":"authenticate(AuthData)","u":"authenticate(org.apache.pulsar.common.api.AuthData)"},{"p":"org.apache.pulsar.client.api","c":"ClientBuilder","l":"authentication(Authentication)","u":"authentication(org.apache.pulsar.client.api.Authentication)"},{"p":"org.apache.pulsar.client.api","c":"ClientBuilder","l":"authentication(String, Map)","u":"authentication(java.lang.String,java.util.Map)"},{"p":"org.apache.pulsar.client.api","c":"ClientBuilder","l":"authentication(String, String)","u":"authentication(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException.AuthenticationException","l":"AuthenticationException(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"AuthenticationFactory","l":"AuthenticationFactory()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.client.api","c":"Authentication","l":"authenticationStage(String, AuthenticationDataProvider, Map, CompletableFuture>)","u":"authenticationStage(java.lang.String,org.apache.pulsar.client.api.AuthenticationDataProvider,java.util.Map,java.util.concurrent.CompletableFuture)"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException.AuthorizationException","l":"AuthorizationException(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"org.apache.pulsar.common.schema","c":"SchemaType","l":"AUTO"},{"p":"org.apache.pulsar.common.schema","c":"SchemaType","l":"AUTO_CONSUME"},{"p":"org.apache.pulsar.client.api","c":"Schema","l":"AUTO_CONSUME()"},{"p":"org.apache.pulsar.client.api","c":"Schema","l":"AUTO_PRODUCE_BYTES()"},{"p":"org.apache.pulsar.client.api","c":"Schema","l":"AUTO_PRODUCE_BYTES(Schema)","u":"AUTO_PRODUCE_BYTES(org.apache.pulsar.client.api.Schema)"},{"p":"org.apache.pulsar.common.schema","c":"SchemaType","l":"AUTO_PUBLISH"},{"p":"org.apache.pulsar.client.api","c":"KeySharedMode","l":"AUTO_SPLIT"},{"p":"org.apache.pulsar.client.api","c":"Schema","l":"AUTO()"},{"p":"org.apache.pulsar.client.api","c":"ConsumerBuilder","l":"autoAckOldestChunkedMessageOnQueueFull(boolean)"},{"p":"org.apache.pulsar.client.api","c":"ReaderBuilder","l":"autoAckOldestChunkedMessageOnQueueFull(boolean)"},{"p":"org.apache.pulsar.client.api","c":"ClientBuilder","l":"autoCertRefreshSeconds(int)"},{"p":"org.apache.pulsar.client.api","c":"ConsumerBuilder","l":"autoScaledReceiverQueueSizeEnabled(boolean)"},{"p":"org.apache.pulsar.client.api","c":"KeySharedPolicy","l":"autoSplitHashRange()"},{"p":"org.apache.pulsar.client.api","c":"ConsumerBuilder","l":"autoUpdatePartitions(boolean)"},{"p":"org.apache.pulsar.client.api","c":"ProducerBuilder","l":"autoUpdatePartitions(boolean)"},{"p":"org.apache.pulsar.client.api","c":"ReaderBuilder","l":"autoUpdatePartitions(boolean)"},{"p":"org.apache.pulsar.client.api","c":"ConsumerBuilder","l":"autoUpdatePartitionsInterval(int, TimeUnit)","u":"autoUpdatePartitionsInterval(int,java.util.concurrent.TimeUnit)"},{"p":"org.apache.pulsar.client.api","c":"ProducerBuilder","l":"autoUpdatePartitionsInterval(int, TimeUnit)","u":"autoUpdatePartitionsInterval(int,java.util.concurrent.TimeUnit)"},{"p":"org.apache.pulsar.client.api","c":"ReaderBuilder","l":"autoUpdatePartitionsInterval(int, TimeUnit)","u":"autoUpdatePartitionsInterval(int,java.util.concurrent.TimeUnit)"},{"p":"org.apache.pulsar.client.api","c":"TableViewBuilder","l":"autoUpdatePartitionsInterval(int, TimeUnit)","u":"autoUpdatePartitionsInterval(int,java.util.concurrent.TimeUnit)"},{"p":"org.apache.pulsar.common.schema","c":"SchemaType","l":"AVRO"},{"p":"org.apache.pulsar.client.api","c":"Schema","l":"AVRO(Class)","u":"AVRO(java.lang.Class)"},{"p":"org.apache.pulsar.client.api","c":"Schema","l":"AVRO(SchemaDefinition)","u":"AVRO(org.apache.pulsar.client.api.schema.SchemaDefinition)"},{"p":"org.apache.pulsar.client.api","c":"ProducerBuilder","l":"batcherBuilder(BatcherBuilder)","u":"batcherBuilder(org.apache.pulsar.client.api.BatcherBuilder)"},{"p":"org.apache.pulsar.client.api","c":"ProducerBuilder","l":"batchingMaxBytes(int)"},{"p":"org.apache.pulsar.client.api","c":"ProducerBuilder","l":"batchingMaxMessages(int)"},{"p":"org.apache.pulsar.client.api","c":"ProducerBuilder","l":"batchingMaxPublishDelay(long, TimeUnit)","u":"batchingMaxPublishDelay(long,java.util.concurrent.TimeUnit)"},{"p":"org.apache.pulsar.client.api","c":"Consumer","l":"batchReceive()"},{"p":"org.apache.pulsar.client.api","c":"Consumer","l":"batchReceiveAsync()"},{"p":"org.apache.pulsar.client.api","c":"ConsumerBuilder","l":"batchReceivePolicy(BatchReceivePolicy)","u":"batchReceivePolicy(org.apache.pulsar.client.api.BatchReceivePolicy)"},{"p":"org.apache.pulsar.client.api","c":"ConsumerEventListener","l":"becameActive(Consumer, int)","u":"becameActive(org.apache.pulsar.client.api.Consumer,int)"},{"p":"org.apache.pulsar.client.api","c":"ConsumerEventListener","l":"becameInactive(Consumer, int)","u":"becameInactive(org.apache.pulsar.client.api.Consumer,int)"},{"p":"org.apache.pulsar.client.api","c":"ConsumerInterceptor","l":"beforeConsume(Consumer, Message)","u":"beforeConsume(org.apache.pulsar.client.api.Consumer,org.apache.pulsar.client.api.Message)"},{"p":"org.apache.pulsar.client.api","c":"ReaderInterceptor","l":"beforeRead(Reader, Message)","u":"beforeRead(org.apache.pulsar.client.api.Reader,org.apache.pulsar.client.api.Message)"},{"p":"org.apache.pulsar.client.api.interceptor","c":"ProducerInterceptor","l":"beforeSend(Producer, Message)","u":"beforeSend(org.apache.pulsar.client.api.Producer,org.apache.pulsar.client.api.Message)"},{"p":"org.apache.pulsar.client.api.interceptor","c":"ProducerInterceptorWrapper","l":"beforeSend(Producer, Message)","u":"beforeSend(org.apache.pulsar.client.api.Producer,org.apache.pulsar.client.api.Message)"},{"p":"org.apache.pulsar.client.api","c":"ProducerInterceptor","l":"beforeSend(Producer, Message)","u":"beforeSend(org.apache.pulsar.client.api.Producer,org.apache.pulsar.client.api.Message)"},{"p":"org.apache.pulsar.client.api","c":"ProducerBuilder","l":"blockIfQueueFull(boolean)"},{"p":"org.apache.pulsar.client.api","c":"Schema","l":"BOOL"},{"p":"org.apache.pulsar.common.schema","c":"SchemaType","l":"BOOLEAN"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException.BrokerMetadataException","l":"BrokerMetadataException(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException.BrokerPersistenceException","l":"BrokerPersistenceException(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"AutoClusterFailoverBuilder","l":"build()"},{"p":"org.apache.pulsar.client.api","c":"BatcherBuilder","l":"build()"},{"p":"org.apache.pulsar.client.api","c":"BatchReceivePolicy.Builder","l":"build()"},{"p":"org.apache.pulsar.client.api","c":"ClientBuilder","l":"build()"},{"p":"org.apache.pulsar.client.api","c":"ControlledClusterFailoverBuilder","l":"build()"},{"p":"org.apache.pulsar.client.api.schema","c":"GenericRecordBuilder","l":"build()"},{"p":"org.apache.pulsar.client.api.schema","c":"SchemaDefinitionBuilder","l":"build()"},{"p":"org.apache.pulsar.client.api","c":"TopicConsumerBuilder","l":"build()"},{"p":"org.apache.pulsar.client.api.transaction","c":"TransactionBuilder","l":"build()"},{"p":"org.apache.pulsar.common.schema","c":"SchemaInfo.SchemaInfoBuilder","l":"build()"},{"p":"org.apache.pulsar.client.api.schema","c":"RecordSchemaBuilder","l":"build(SchemaType)","u":"build(org.apache.pulsar.common.schema.SchemaType)"},{"p":"org.apache.pulsar.client.api","c":"BatchReceivePolicy","l":"builder()"},{"p":"org.apache.pulsar.client.api","c":"PulsarClient","l":"builder()"},{"p":"org.apache.pulsar.client.api.schema","c":"SchemaDefinition","l":"builder()"},{"p":"org.apache.pulsar.common.schema","c":"SchemaInfo","l":"builder()"},{"p":"org.apache.pulsar.client.api","c":"BatchReceivePolicy.Builder","l":"Builder()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.client.api","c":"Schema","l":"BYTEBUFFER"},{"p":"org.apache.pulsar.client.api","c":"SizeUnit","l":"BYTES"},{"p":"org.apache.pulsar.common.schema","c":"SchemaType","l":"BYTES"},{"p":"org.apache.pulsar.client.api","c":"Schema","l":"BYTES"},{"p":"org.apache.pulsar.client.api","c":"AutoClusterFailoverBuilder","l":"checkInterval(long, TimeUnit)","u":"checkInterval(long,java.util.concurrent.TimeUnit)"},{"p":"org.apache.pulsar.client.api","c":"ControlledClusterFailoverBuilder","l":"checkInterval(long, TimeUnit)","u":"checkInterval(long,java.util.concurrent.TimeUnit)"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException.ChecksumException","l":"ChecksumException(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"MessageRouter","l":"choosePartition(Message)","u":"choosePartition(org.apache.pulsar.client.api.Message)"},{"p":"org.apache.pulsar.client.api","c":"MessageRouter","l":"choosePartition(Message, TopicMetadata)","u":"choosePartition(org.apache.pulsar.client.api.Message,org.apache.pulsar.client.api.TopicMetadata)"},{"p":"org.apache.pulsar.client.api","c":"ProducerBuilder","l":"chunkMaxMessageSize(int)"},{"p":"org.apache.pulsar.client.api","c":"BatchMessageContainer","l":"clear()"},{"p":"org.apache.pulsar.client.api.schema","c":"GenericRecordBuilder","l":"clear(Field)","u":"clear(org.apache.pulsar.client.api.schema.Field)"},{"p":"org.apache.pulsar.client.api.schema","c":"GenericRecordBuilder","l":"clear(String)","u":"clear(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"ClientBuilder","l":"clock(Clock)","u":"clock(java.time.Clock)"},{"p":"org.apache.pulsar.client.api","c":"ClientBuilder","l":"clone()"},{"p":"org.apache.pulsar.client.api","c":"ConsumerBuilder","l":"clone()"},{"p":"org.apache.pulsar.client.api","c":"ProducerBuilder","l":"clone()"},{"p":"org.apache.pulsar.client.api","c":"ReaderBuilder","l":"clone()"},{"p":"org.apache.pulsar.client.api","c":"Schema","l":"clone()"},{"p":"org.apache.pulsar.client.api","c":"Consumer","l":"close()"},{"p":"org.apache.pulsar.client.api","c":"ConsumerInterceptor","l":"close()"},{"p":"org.apache.pulsar.client.api.interceptor","c":"ProducerInterceptor","l":"close()"},{"p":"org.apache.pulsar.client.api.interceptor","c":"ProducerInterceptorWrapper","l":"close()"},{"p":"org.apache.pulsar.client.api","c":"Producer","l":"close()"},{"p":"org.apache.pulsar.client.api","c":"ProducerInterceptor","l":"close()"},{"p":"org.apache.pulsar.client.api","c":"PulsarClient","l":"close()"},{"p":"org.apache.pulsar.client.api","c":"ReaderInterceptor","l":"close()"},{"p":"org.apache.pulsar.client.api","c":"ServiceUrlProvider","l":"close()"},{"p":"org.apache.pulsar.client.api.transaction","c":"TransactionBufferClient","l":"close()"},{"p":"org.apache.pulsar.client.api","c":"Consumer","l":"closeAsync()"},{"p":"org.apache.pulsar.client.api","c":"Producer","l":"closeAsync()"},{"p":"org.apache.pulsar.client.api","c":"PulsarClient","l":"closeAsync()"},{"p":"org.apache.pulsar.client.api","c":"Reader","l":"closeAsync()"},{"p":"org.apache.pulsar.client.api","c":"TableView","l":"closeAsync()"},{"p":"org.apache.pulsar.client.api.transaction","c":"TransactionCoordinatorClient","l":"closeAsync()"},{"p":"org.apache.pulsar.client.api.transaction","c":"TransactionCoordinatorClient.State","l":"CLOSED"},{"p":"org.apache.pulsar.client.api.transaction","c":"TransactionCoordinatorClient.State","l":"CLOSING"},{"p":"org.apache.pulsar.client.api.transaction","c":"Transaction","l":"commit()"},{"p":"org.apache.pulsar.client.api.transaction","c":"TransactionCoordinatorClient","l":"commit(TxnID)","u":"commit(org.apache.pulsar.client.api.transaction.TxnID)"},{"p":"org.apache.pulsar.client.api.transaction","c":"TransactionCoordinatorClient","l":"commitAsync(TxnID)","u":"commitAsync(org.apache.pulsar.client.api.transaction.TxnID)"},{"p":"org.apache.pulsar.client.api.transaction","c":"Transaction.State","l":"COMMITTED"},{"p":"org.apache.pulsar.client.api.transaction","c":"Transaction.State","l":"COMMITTING"},{"p":"org.apache.pulsar.client.api.transaction","c":"TransactionBufferClient","l":"commitTxnOnSubscription(String, String, long, long, long)","u":"commitTxnOnSubscription(java.lang.String,java.lang.String,long,long,long)"},{"p":"org.apache.pulsar.client.api.transaction","c":"TransactionBufferClient","l":"commitTxnOnTopic(String, long, long, long)","u":"commitTxnOnTopic(java.lang.String,long,long,long)"},{"p":"org.apache.pulsar.client.api","c":"Range","l":"compareTo(Range)","u":"compareTo(org.apache.pulsar.client.api.Range)"},{"p":"org.apache.pulsar.client.api","c":"ProducerBuilder","l":"compressionType(CompressionType)","u":"compressionType(org.apache.pulsar.client.api.CompressionType)"},{"p":"org.apache.pulsar.client.api","c":"TypedMessageBuilder","l":"CONF_DELIVERY_AFTER_SECONDS"},{"p":"org.apache.pulsar.client.api","c":"TypedMessageBuilder","l":"CONF_DELIVERY_AT"},{"p":"org.apache.pulsar.client.api","c":"TypedMessageBuilder","l":"CONF_DISABLE_REPLICATION"},{"p":"org.apache.pulsar.client.api","c":"TypedMessageBuilder","l":"CONF_EVENT_TIME"},{"p":"org.apache.pulsar.client.api","c":"TypedMessageBuilder","l":"CONF_KEY"},{"p":"org.apache.pulsar.client.api","c":"TypedMessageBuilder","l":"CONF_PROPERTIES"},{"p":"org.apache.pulsar.client.api","c":"TypedMessageBuilder","l":"CONF_REPLICATION_CLUSTERS"},{"p":"org.apache.pulsar.client.api","c":"TypedMessageBuilder","l":"CONF_SEQUENCE_ID"},{"p":"org.apache.pulsar.client.api","c":"Authentication","l":"configure(Map)","u":"configure(java.util.Map)"},{"p":"org.apache.pulsar.client.api","c":"EncodedAuthenticationParameterSupport","l":"configure(String)","u":"configure(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"Schema","l":"configureSchemaInfo(String, String, SchemaInfo)","u":"configureSchemaInfo(java.lang.String,java.lang.String,org.apache.pulsar.common.schema.SchemaInfo)"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException.ConnectException","l":"ConnectException(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException.ConnectException","l":"ConnectException(Throwable)","u":"%3Cinit%3E(java.lang.Throwable)"},{"p":"org.apache.pulsar.client.api","c":"ClientBuilder","l":"connectionMaxIdleSeconds(int)"},{"p":"org.apache.pulsar.client.api","c":"ClientBuilder","l":"connectionsPerBroker(int)"},{"p":"org.apache.pulsar.client.api","c":"ClientBuilder","l":"connectionTimeout(int, TimeUnit)","u":"connectionTimeout(int,java.util.concurrent.TimeUnit)"},{"p":"org.apache.pulsar.client.api","c":"ConsumerCryptoFailureAction","l":"CONSUME"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException.ConsumerAssignException","l":"ConsumerAssignException(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException.ConsumerBusyException","l":"ConsumerBusyException(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"ConsumerBuilder","l":"consumerEventListener(ConsumerEventListener)","u":"consumerEventListener(org.apache.pulsar.client.api.ConsumerEventListener)"},{"p":"org.apache.pulsar.client.api","c":"ConsumerBuilder","l":"consumerName(String)","u":"consumerName(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"Range","l":"contains(int)"},{"p":"org.apache.pulsar.client.api","c":"Range","l":"contains(Range)","u":"contains(org.apache.pulsar.client.api.Range)"},{"p":"org.apache.pulsar.client.api","c":"TableView","l":"containsKey(String)","u":"containsKey(java.lang.String)"},{"p":"org.apache.pulsar.client.internal","c":"PulsarClientImplementationBinding","l":"convertKeyValueDataStringToSchemaInfoSchema(byte[])"},{"p":"org.apache.pulsar.client.internal","c":"PulsarClientImplementationBinding","l":"convertKeyValueSchemaInfoDataToString(KeyValue)","u":"convertKeyValueSchemaInfoDataToString(org.apache.pulsar.common.schema.KeyValue)"},{"p":"org.apache.pulsar.client.api.transaction","c":"TransactionCoordinatorClientException.CoordinatorClientStateException","l":"CoordinatorClientStateException()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.client.api.transaction","c":"TransactionCoordinatorClientException.CoordinatorClientStateException","l":"CoordinatorClientStateException(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"org.apache.pulsar.client.api.transaction","c":"TransactionCoordinatorClientException.CoordinatorNotFoundException","l":"CoordinatorNotFoundException(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"MessagePayload","l":"copiedBuffer()"},{"p":"org.apache.pulsar.client.api","c":"ProducerBuilder","l":"create()"},{"p":"org.apache.pulsar.client.api","c":"ReaderBuilder","l":"create()"},{"p":"org.apache.pulsar.client.api","c":"TableViewBuilder","l":"create()"},{"p":"org.apache.pulsar.client.api","c":"AuthenticationFactory","l":"create(String, Map)","u":"create(java.lang.String,java.util.Map)"},{"p":"org.apache.pulsar.client.api","c":"TopicMessageId","l":"create(String, MessageId)","u":"create(java.lang.String,org.apache.pulsar.client.api.MessageId)"},{"p":"org.apache.pulsar.client.api","c":"AuthenticationFactory","l":"create(String, String)","u":"create(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"ProducerBuilder","l":"createAsync()"},{"p":"org.apache.pulsar.client.api","c":"ReaderBuilder","l":"createAsync()"},{"p":"org.apache.pulsar.client.api","c":"TableViewBuilder","l":"createAsync()"},{"p":"org.apache.pulsar.client.internal","c":"PulsarClientImplementationBinding","l":"createAuthentication(String, Map)","u":"createAuthentication(java.lang.String,java.util.Map)"},{"p":"org.apache.pulsar.client.internal","c":"PulsarClientImplementationBinding","l":"createAuthentication(String, String)","u":"createAuthentication(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException.CryptoException","l":"CryptoException(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"ConsumerBuilder","l":"cryptoFailureAction(ConsumerCryptoFailureAction)","u":"cryptoFailureAction(org.apache.pulsar.client.api.ConsumerCryptoFailureAction)"},{"p":"org.apache.pulsar.client.api","c":"ReaderBuilder","l":"cryptoFailureAction(ConsumerCryptoFailureAction)","u":"cryptoFailureAction(org.apache.pulsar.client.api.ConsumerCryptoFailureAction)"},{"p":"org.apache.pulsar.client.api","c":"TableViewBuilder","l":"cryptoFailureAction(ConsumerCryptoFailureAction)","u":"cryptoFailureAction(org.apache.pulsar.client.api.ConsumerCryptoFailureAction)"},{"p":"org.apache.pulsar.client.api","c":"ProducerBuilder","l":"cryptoFailureAction(ProducerCryptoFailureAction)","u":"cryptoFailureAction(org.apache.pulsar.client.api.ProducerCryptoFailureAction)"},{"p":"org.apache.pulsar.client.api","c":"ConsumerBuilder","l":"cryptoKeyReader(CryptoKeyReader)","u":"cryptoKeyReader(org.apache.pulsar.client.api.CryptoKeyReader)"},{"p":"org.apache.pulsar.client.api","c":"ProducerBuilder","l":"cryptoKeyReader(CryptoKeyReader)","u":"cryptoKeyReader(org.apache.pulsar.client.api.CryptoKeyReader)"},{"p":"org.apache.pulsar.client.api","c":"ReaderBuilder","l":"cryptoKeyReader(CryptoKeyReader)","u":"cryptoKeyReader(org.apache.pulsar.client.api.CryptoKeyReader)"},{"p":"org.apache.pulsar.client.api","c":"TableViewBuilder","l":"cryptoKeyReader(CryptoKeyReader)","u":"cryptoKeyReader(org.apache.pulsar.client.api.CryptoKeyReader)"},{"p":"org.apache.pulsar.client.api","c":"MessageRoutingMode","l":"CustomPartition"},{"p":"org.apache.pulsar.common.schema","c":"SchemaType","l":"DATE"},{"p":"org.apache.pulsar.client.api","c":"Schema","l":"DATE"},{"p":"org.apache.pulsar.client.api","c":"DeadLetterPolicy","l":"DeadLetterPolicy()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.client.api","c":"ConsumerBuilder","l":"deadLetterPolicy(DeadLetterPolicy)","u":"deadLetterPolicy(org.apache.pulsar.client.api.DeadLetterPolicy)"},{"p":"org.apache.pulsar.client.api","c":"Schema","l":"decode(byte[])"},{"p":"org.apache.pulsar.client.api","c":"Schema","l":"decode(byte[], byte[])","u":"decode(byte[],byte[])"},{"p":"org.apache.pulsar.common.schema","c":"KeyValue.KeyValueDecoder","l":"decode(byte[], byte[])","u":"decode(byte[],byte[])"},{"p":"org.apache.pulsar.common.schema","c":"KeyValue","l":"decode(byte[], KeyValue.KeyValueDecoder)","u":"decode(byte[],org.apache.pulsar.common.schema.KeyValue.KeyValueDecoder)"},{"p":"org.apache.pulsar.client.api","c":"Schema","l":"decode(ByteBuffer)","u":"decode(java.nio.ByteBuffer)"},{"p":"org.apache.pulsar.client.api","c":"Schema","l":"decode(ByteBuffer, byte[])","u":"decode(java.nio.ByteBuffer,byte[])"},{"p":"org.apache.pulsar.client.internal","c":"PulsarClientImplementationBinding","l":"decodeKeyValueEncodingType(SchemaInfo)","u":"decodeKeyValueEncodingType(org.apache.pulsar.common.schema.SchemaInfo)"},{"p":"org.apache.pulsar.client.internal","c":"PulsarClientImplementationBinding","l":"decodeKeyValueSchemaInfo(SchemaInfo)","u":"decodeKeyValueSchemaInfo(org.apache.pulsar.common.schema.SchemaInfo)"},{"p":"org.apache.pulsar.client.api","c":"MessageCrypto","l":"decrypt(Supplier, ByteBuffer, ByteBuffer, CryptoKeyReader)","u":"decrypt(java.util.function.Supplier,java.nio.ByteBuffer,java.nio.ByteBuffer,org.apache.pulsar.client.api.CryptoKeyReader)"},{"p":"org.apache.pulsar.client.api","c":"BatcherBuilder","l":"DEFAULT"},{"p":"org.apache.pulsar.client.api","c":"MessagePayloadFactory","l":"DEFAULT"},{"p":"org.apache.pulsar.client.api","c":"MessagePayloadProcessor","l":"DEFAULT"},{"p":"org.apache.pulsar.client.api","c":"KeySharedPolicy","l":"DEFAULT_HASH_RANGE_SIZE"},{"p":"org.apache.pulsar.client.api","c":"BatchReceivePolicy","l":"DEFAULT_MULTI_TOPICS_DISABLE_POLICY"},{"p":"org.apache.pulsar.client.api","c":"BatchReceivePolicy","l":"DEFAULT_POLICY"},{"p":"org.apache.pulsar.client.api.transaction","c":"TransactionCoordinatorClient","l":"DEFAULT_TXN_TTL_MS"},{"p":"org.apache.pulsar.client.api","c":"ConsumerBuilder","l":"defaultCryptoKeyReader(Map)","u":"defaultCryptoKeyReader(java.util.Map)"},{"p":"org.apache.pulsar.client.api","c":"ProducerBuilder","l":"defaultCryptoKeyReader(Map)","u":"defaultCryptoKeyReader(java.util.Map)"},{"p":"org.apache.pulsar.client.api","c":"ReaderBuilder","l":"defaultCryptoKeyReader(Map)","u":"defaultCryptoKeyReader(java.util.Map)"},{"p":"org.apache.pulsar.client.api","c":"TableViewBuilder","l":"defaultCryptoKeyReader(Map)","u":"defaultCryptoKeyReader(java.util.Map)"},{"p":"org.apache.pulsar.client.api","c":"ConsumerBuilder","l":"defaultCryptoKeyReader(String)","u":"defaultCryptoKeyReader(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"ProducerBuilder","l":"defaultCryptoKeyReader(String)","u":"defaultCryptoKeyReader(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"ReaderBuilder","l":"defaultCryptoKeyReader(String)","u":"defaultCryptoKeyReader(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"TableViewBuilder","l":"defaultCryptoKeyReader(String)","u":"defaultCryptoKeyReader(java.lang.String)"},{"p":"org.apache.pulsar.client.internal","c":"DefaultImplementation","l":"DefaultImplementation()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.client.api","c":"ControlledClusterFailoverBuilder","l":"defaultServiceUrl(String)","u":"defaultServiceUrl(java.lang.String)"},{"p":"org.apache.pulsar.client.api.schema","c":"FieldSchemaBuilder","l":"defaultValue(Object)","u":"defaultValue(java.lang.Object)"},{"p":"org.apache.pulsar.client.api","c":"TypedMessageBuilder","l":"deliverAfter(long, TimeUnit)","u":"deliverAfter(long,java.util.concurrent.TimeUnit)"},{"p":"org.apache.pulsar.client.api","c":"TypedMessageBuilder","l":"deliverAt(long)"},{"p":"org.apache.pulsar.client.api","c":"TypedMessageBuilder","l":"disableReplication()"},{"p":"org.apache.pulsar.client.api","c":"ConsumerCryptoFailureAction","l":"DISCARD"},{"p":"org.apache.pulsar.client.api","c":"BatchMessageContainer","l":"discard(Exception)","u":"discard(java.lang.Exception)"},{"p":"org.apache.pulsar.client.api","c":"ClientBuilder","l":"dnsLookupBind(String, int)","u":"dnsLookupBind(java.lang.String,int)"},{"p":"org.apache.pulsar.client.api","c":"ClientBuilder","l":"dnsServerAddresses(List)","u":"dnsServerAddresses(java.util.List)"},{"p":"org.apache.pulsar.client.api.schema","c":"FieldSchemaBuilder","l":"doc(String)","u":"doc(java.lang.String)"},{"p":"org.apache.pulsar.client.api.schema","c":"RecordSchemaBuilder","l":"doc(String)","u":"doc(java.lang.String)"},{"p":"org.apache.pulsar.common.schema","c":"SchemaType","l":"DOUBLE"},{"p":"org.apache.pulsar.client.api","c":"Schema","l":"DOUBLE"},{"p":"org.apache.pulsar.client.api","c":"SubscriptionMode","l":"Durable"},{"p":"org.apache.pulsar.client.api","c":"MessageId","l":"earliest"},{"p":"org.apache.pulsar.client.api","c":"SubscriptionInitialPosition","l":"Earliest"},{"p":"org.apache.pulsar.client.api.interceptor","c":"ProducerInterceptor","l":"eligible(Message)","u":"eligible(org.apache.pulsar.client.api.Message)"},{"p":"org.apache.pulsar.client.api.interceptor","c":"ProducerInterceptorWrapper","l":"eligible(Message)","u":"eligible(org.apache.pulsar.client.api.Message)"},{"p":"org.apache.pulsar.client.api","c":"ConsumerBuilder","l":"enableBatchIndexAcknowledgment(boolean)"},{"p":"org.apache.pulsar.client.api","c":"ProducerBuilder","l":"enableBatching(boolean)"},{"p":"org.apache.pulsar.client.api","c":"ClientBuilder","l":"enableBusyWait(boolean)"},{"p":"org.apache.pulsar.client.api","c":"ProducerBuilder","l":"enableChunking(boolean)"},{"p":"org.apache.pulsar.client.api","c":"ProducerBuilder","l":"enableLazyStartPartitionedProducers(boolean)"},{"p":"org.apache.pulsar.client.api","c":"ProducerBuilder","l":"enableMultiSchema(boolean)"},{"p":"org.apache.pulsar.client.api","c":"ConsumerBuilder","l":"enableRetry(boolean)"},{"p":"org.apache.pulsar.client.api","c":"ClientBuilder","l":"enableTcpNoDelay(boolean)"},{"p":"org.apache.pulsar.client.api","c":"ClientBuilder","l":"enableTls(boolean)"},{"p":"org.apache.pulsar.client.api","c":"ClientBuilder","l":"enableTlsHostnameVerification(boolean)"},{"p":"org.apache.pulsar.client.api","c":"ClientBuilder","l":"enableTransaction(boolean)"},{"p":"org.apache.pulsar.common.schema","c":"KeyValue","l":"encode(K, Schema, V, Schema)","u":"encode(K,org.apache.pulsar.client.api.Schema,V,org.apache.pulsar.client.api.Schema)"},{"p":"org.apache.pulsar.client.api","c":"Schema","l":"encode(T)"},{"p":"org.apache.pulsar.client.internal","c":"PulsarClientImplementationBinding","l":"encodeKeyValueSchemaInfo(Schema, Schema, KeyValueEncodingType)","u":"encodeKeyValueSchemaInfo(org.apache.pulsar.client.api.Schema,org.apache.pulsar.client.api.Schema,org.apache.pulsar.common.schema.KeyValueEncodingType)"},{"p":"org.apache.pulsar.client.internal","c":"PulsarClientImplementationBinding","l":"encodeKeyValueSchemaInfo(String, Schema, Schema, KeyValueEncodingType)","u":"encodeKeyValueSchemaInfo(java.lang.String,org.apache.pulsar.client.api.Schema,org.apache.pulsar.client.api.Schema,org.apache.pulsar.common.schema.KeyValueEncodingType)"},{"p":"org.apache.pulsar.client.api","c":"MessageCrypto","l":"encrypt(Set, CryptoKeyReader, Supplier, ByteBuffer, ByteBuffer)","u":"encrypt(java.util.Set,org.apache.pulsar.client.api.CryptoKeyReader,java.util.function.Supplier,java.nio.ByteBuffer,java.nio.ByteBuffer)"},{"p":"org.apache.pulsar.common.api","c":"EncryptionContext","l":"EncryptionContext()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.common.api","c":"EncryptionContext.EncryptionKey","l":"EncryptionKey()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.client.api","c":"EncryptionKeyInfo","l":"EncryptionKeyInfo()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.client.api","c":"EncryptionKeyInfo","l":"EncryptionKeyInfo(byte[], Map)","u":"%3Cinit%3E(byte[],java.util.Map)"},{"p":"org.apache.pulsar.client.api","c":"TableView","l":"entrySet()"},{"p":"org.apache.pulsar.client.api","c":"Range","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"org.apache.pulsar.client.api.transaction","c":"TxnID","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"org.apache.pulsar.common.schema","c":"KeyValue","l":"equals(Object)","u":"equals(java.lang.Object)"},{"p":"org.apache.pulsar.client.api.transaction","c":"Transaction.State","l":"ERROR"},{"p":"org.apache.pulsar.client.api","c":"TypedMessageBuilder","l":"eventTime(long)"},{"p":"org.apache.pulsar.client.api","c":"ProducerAccessMode","l":"Exclusive"},{"p":"org.apache.pulsar.client.api","c":"SubscriptionType","l":"Exclusive"},{"p":"org.apache.pulsar.client.api","c":"ProducerAccessMode","l":"ExclusiveWithFencing"},{"p":"org.apache.pulsar.client.api","c":"MessageListenerExecutor","l":"execute(Message, Runnable)","u":"execute(org.apache.pulsar.client.api.Message,java.lang.Runnable)"},{"p":"org.apache.pulsar.client.api","c":"ConsumerBuilder","l":"expireTimeOfIncompleteChunkedMessage(long, TimeUnit)","u":"expireTimeOfIncompleteChunkedMessage(long,java.util.concurrent.TimeUnit)"},{"p":"org.apache.pulsar.client.api","c":"ReaderBuilder","l":"expireTimeOfIncompleteChunkedMessage(long, TimeUnit)","u":"expireTimeOfIncompleteChunkedMessage(long,java.util.concurrent.TimeUnit)"},{"p":"org.apache.pulsar.client.api","c":"ConsumerCryptoFailureAction","l":"FAIL"},{"p":"org.apache.pulsar.client.api","c":"ProducerCryptoFailureAction","l":"FAIL"},{"p":"org.apache.pulsar.client.api","c":"SubscriptionType","l":"Failover"},{"p":"org.apache.pulsar.client.api","c":"AutoClusterFailoverBuilder","l":"failoverDelay(long, TimeUnit)","u":"failoverDelay(long,java.util.concurrent.TimeUnit)"},{"p":"org.apache.pulsar.client.api","c":"AutoClusterFailoverBuilder","l":"failoverPolicy(AutoClusterFailoverBuilder.FailoverPolicy)","u":"failoverPolicy(org.apache.pulsar.client.api.AutoClusterFailoverBuilder.FailoverPolicy)"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException.FeatureNotSupportedException","l":"FeatureNotSupportedException(String, PulsarClientException.FailedFeatureCheck)","u":"%3Cinit%3E(java.lang.String,org.apache.pulsar.client.api.PulsarClientException.FailedFeatureCheck)"},{"p":"org.apache.pulsar.client.api.schema","c":"Field","l":"Field()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.client.api.schema","c":"RecordSchemaBuilder","l":"field(String)","u":"field(java.lang.String)"},{"p":"org.apache.pulsar.client.api.schema","c":"RecordSchemaBuilder","l":"field(String, GenericSchema)","u":"field(java.lang.String,org.apache.pulsar.client.api.schema.GenericSchema)"},{"p":"org.apache.pulsar.client.internal","c":"PropertiesUtils","l":"filterAndMapProperties(Properties, String)","u":"filterAndMapProperties(java.util.Properties,java.lang.String)"},{"p":"org.apache.pulsar.client.internal","c":"PropertiesUtils","l":"filterAndMapProperties(Properties, String, String)","u":"filterAndMapProperties(java.util.Properties,java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.common.schema","c":"SchemaType","l":"FLOAT"},{"p":"org.apache.pulsar.client.api","c":"Schema","l":"FLOAT"},{"p":"org.apache.pulsar.client.api","c":"Producer","l":"flush()"},{"p":"org.apache.pulsar.client.api","c":"Producer","l":"flushAsync()"},{"p":"org.apache.pulsar.client.api","c":"TableView","l":"forEach(BiConsumer)","u":"forEach(java.util.function.BiConsumer)"},{"p":"org.apache.pulsar.client.api","c":"TableView","l":"forEachAndListen(BiConsumer)","u":"forEachAndListen(java.util.function.BiConsumer)"},{"p":"org.apache.pulsar.client.api","c":"MessageId","l":"fromByteArray(byte[])"},{"p":"org.apache.pulsar.client.api","c":"MessageId","l":"fromByteArrayWithTopic(byte[], String)","u":"fromByteArrayWithTopic(byte[],java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"Schema","l":"generic(SchemaInfo)","u":"generic(org.apache.pulsar.common.schema.SchemaInfo)"},{"p":"org.apache.pulsar.client.api","c":"TableView","l":"get(String)","u":"get(java.lang.String)"},{"p":"org.apache.pulsar.client.api.schema","c":"SchemaDefinition","l":"getAlwaysAllowNull()"},{"p":"org.apache.pulsar.client.api","c":"Authentication","l":"getAuthData()"},{"p":"org.apache.pulsar.client.api","c":"Authentication","l":"getAuthData(String)","u":"getAuthData(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"Authentication","l":"getAuthMethodName()"},{"p":"org.apache.pulsar.client.api.transaction","c":"TransactionBufferClient","l":"getAvailableRequestCredits()"},{"p":"org.apache.pulsar.client.api","c":"BatchMessageContainer","l":"getBatchAllocatedSizeBytes()"},{"p":"org.apache.pulsar.client.api","c":"Message","l":"getBrokerPublishTime()"},{"p":"org.apache.pulsar.client.internal","c":"PulsarClientImplementationBinding","l":"getBytes(ByteBuffer)","u":"getBytes(java.nio.ByteBuffer)"},{"p":"org.apache.pulsar.client.api.schema","c":"SchemaDefinition","l":"getClassLoader()"},{"p":"org.apache.pulsar.client.api","c":"AuthenticationDataProvider","l":"getCommandData()"},{"p":"org.apache.pulsar.client.api","c":"Consumer","l":"getConsumerName()"},{"p":"org.apache.pulsar.client.api","c":"BatchMessageContainer","l":"getCurrentBatchSize()"},{"p":"org.apache.pulsar.client.api","c":"Message","l":"getData()"},{"p":"org.apache.pulsar.client.api","c":"ConsumerStats","l":"getDeadLetterProducerStats()"},{"p":"org.apache.pulsar.client.internal","c":"DefaultImplementation","l":"getDefaultImplementation()"},{"p":"org.apache.pulsar.client.api","c":"Message","l":"getEncryptionCtx()"},{"p":"org.apache.pulsar.client.api","c":"Range","l":"getEnd()"},{"p":"org.apache.pulsar.client.api","c":"Message","l":"getEventTime()"},{"p":"org.apache.pulsar.client.api.schema","c":"GenericRecord","l":"getField(Field)","u":"getField(org.apache.pulsar.client.api.schema.Field)"},{"p":"org.apache.pulsar.client.api.schema","c":"GenericRecord","l":"getField(String)","u":"getField(java.lang.String)"},{"p":"org.apache.pulsar.client.api.schema","c":"GenericRecord","l":"getFields()"},{"p":"org.apache.pulsar.client.api.schema","c":"GenericSchema","l":"getFields()"},{"p":"org.apache.pulsar.client.internal","c":"PulsarClientImplementationBinding","l":"getGenericSchema(SchemaInfo)","u":"getGenericSchema(org.apache.pulsar.common.schema.SchemaInfo)"},{"p":"org.apache.pulsar.client.api","c":"KeySharedPolicy","l":"getHashRangeTotal()"},{"p":"org.apache.pulsar.client.api","c":"AuthenticationDataProvider","l":"getHttpAuthType()"},{"p":"org.apache.pulsar.client.api","c":"AuthenticationDataProvider","l":"getHttpHeaders()"},{"p":"org.apache.pulsar.client.api","c":"Message","l":"getIndex()"},{"p":"org.apache.pulsar.client.api.schema","c":"SchemaDefinition","l":"getJsonDef()"},{"p":"org.apache.pulsar.client.api","c":"EncryptionKeyInfo","l":"getKey()"},{"p":"org.apache.pulsar.client.api","c":"Message","l":"getKey()"},{"p":"org.apache.pulsar.common.schema","c":"KeyValue","l":"getKey()"},{"p":"org.apache.pulsar.client.api","c":"Message","l":"getKeyBytes()"},{"p":"org.apache.pulsar.client.api.schema","c":"KeyValueSchema","l":"getKeySchema()"},{"p":"org.apache.pulsar.client.api","c":"KeySharedPolicy","l":"getKeySharedMode()"},{"p":"org.apache.pulsar.client.api.schema","c":"KeyValueSchema","l":"getKeyValueEncodingType()"},{"p":"org.apache.pulsar.client.api","c":"Consumer","l":"getLastDisconnectedTimestamp()"},{"p":"org.apache.pulsar.client.api","c":"Producer","l":"getLastDisconnectedTimestamp()"},{"p":"org.apache.pulsar.client.api","c":"Consumer","l":"getLastMessageId()"},{"p":"org.apache.pulsar.client.api","c":"Consumer","l":"getLastMessageIdAsync()"},{"p":"org.apache.pulsar.client.api","c":"Consumer","l":"getLastMessageIds()"},{"p":"org.apache.pulsar.client.api","c":"Reader","l":"getLastMessageIds()"},{"p":"org.apache.pulsar.client.api","c":"Consumer","l":"getLastMessageIdsAsync()"},{"p":"org.apache.pulsar.client.api","c":"Reader","l":"getLastMessageIdsAsync()"},{"p":"org.apache.pulsar.client.api","c":"Producer","l":"getLastSequenceId()"},{"p":"org.apache.pulsar.client.api.schema","c":"SchemaInfoProvider","l":"getLatestSchema()"},{"p":"org.apache.pulsar.client.api","c":"BatchReceivePolicy","l":"getMaxNumBytes()"},{"p":"org.apache.pulsar.client.api","c":"BatchReceivePolicy","l":"getMaxNumMessages()"},{"p":"org.apache.pulsar.client.api","c":"MessageCrypto","l":"getMaxOutputSize(int)"},{"p":"org.apache.pulsar.client.api","c":"MessagePayloadContext","l":"getMessageAt(int, int, MessagePayload, boolean, Schema)","u":"getMessageAt(int,int,org.apache.pulsar.client.api.MessagePayload,boolean,org.apache.pulsar.client.api.Schema)"},{"p":"org.apache.pulsar.client.api","c":"Message","l":"getMessageId()"},{"p":"org.apache.pulsar.client.api","c":"EncryptionKeyInfo","l":"getMetadata()"},{"p":"org.apache.pulsar.client.api","c":"ConsumerStats","l":"getMsgNumInReceiverQueue()"},{"p":"org.apache.pulsar.client.api","c":"ConsumerStats","l":"getMsgNumInSubReceiverQueue()"},{"p":"org.apache.pulsar.common.schema","c":"SchemaInfo","l":"getName()"},{"p":"org.apache.pulsar.client.api.schema","c":"GenericObject","l":"getNativeObject()"},{"p":"org.apache.pulsar.client.api.schema","c":"GenericRecord","l":"getNativeObject()"},{"p":"org.apache.pulsar.client.api","c":"Schema","l":"getNativeSchema()"},{"p":"org.apache.pulsar.client.api.schema","c":"SchemaReader","l":"getNativeSchema()"},{"p":"org.apache.pulsar.client.api","c":"ConsumerStats","l":"getNumAcksFailed()"},{"p":"org.apache.pulsar.client.api","c":"ProducerStats","l":"getNumAcksReceived()"},{"p":"org.apache.pulsar.client.api","c":"ConsumerStats","l":"getNumAcksSent()"},{"p":"org.apache.pulsar.client.api","c":"ConsumerStats","l":"getNumBatchReceiveFailed()"},{"p":"org.apache.pulsar.client.api","c":"ConsumerStats","l":"getNumBytesReceived()"},{"p":"org.apache.pulsar.client.api","c":"ProducerStats","l":"getNumBytesSent()"},{"p":"org.apache.pulsar.client.api","c":"MessagePayloadContext","l":"getNumMessages()"},{"p":"org.apache.pulsar.client.api","c":"BatchMessageContainer","l":"getNumMessagesInBatch()"},{"p":"org.apache.pulsar.client.api","c":"ConsumerStats","l":"getNumMsgsReceived()"},{"p":"org.apache.pulsar.client.api","c":"ProducerStats","l":"getNumMsgsSent()"},{"p":"org.apache.pulsar.client.api","c":"Producer","l":"getNumOfPartitions()"},{"p":"org.apache.pulsar.client.api","c":"ConsumerStats","l":"getNumReceiveFailed()"},{"p":"org.apache.pulsar.client.api","c":"ProducerStats","l":"getNumSendFailed()"},{"p":"org.apache.pulsar.client.api","c":"Message","l":"getOrderingKey()"},{"p":"org.apache.pulsar.client.api","c":"TopicMessageId","l":"getOwnerTopic()"},{"p":"org.apache.pulsar.client.api","c":"PulsarClient","l":"getPartitionsForTopic(String)","u":"getPartitionsForTopic(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"PulsarClient","l":"getPartitionsForTopic(String, boolean)","u":"getPartitionsForTopic(java.lang.String,boolean)"},{"p":"org.apache.pulsar.client.api","c":"ConsumerStats","l":"getPartitionStats()"},{"p":"org.apache.pulsar.client.api","c":"MultiTopicConsumerStats","l":"getPartitionStats()"},{"p":"org.apache.pulsar.client.api","c":"PartitionedTopicProducerStats","l":"getPartitionStats()"},{"p":"org.apache.pulsar.client.api","c":"ProducerStats","l":"getPartitionStats()"},{"p":"org.apache.pulsar.client.api","c":"ProducerStats","l":"getPendingQueueSize()"},{"p":"org.apache.pulsar.client.api.transaction","c":"TransactionBufferClient","l":"getPendingRequestsCount()"},{"p":"org.apache.pulsar.client.api.schema","c":"SchemaDefinition","l":"getPojo()"},{"p":"org.apache.pulsar.client.api","c":"CryptoKeyReader","l":"getPrivateKey(String, Map)","u":"getPrivateKey(java.lang.String,java.util.Map)"},{"p":"org.apache.pulsar.client.api","c":"DummyCryptoKeyReaderImpl","l":"getPrivateKey(String, Map)","u":"getPrivateKey(java.lang.String,java.util.Map)"},{"p":"org.apache.pulsar.client.api","c":"Message","l":"getProducerName()"},{"p":"org.apache.pulsar.client.api","c":"Producer","l":"getProducerName()"},{"p":"org.apache.pulsar.client.api","c":"Message","l":"getProperties()"},{"p":"org.apache.pulsar.client.api.schema","c":"SchemaDefinition","l":"getProperties()"},{"p":"org.apache.pulsar.common.schema","c":"SchemaInfo","l":"getProperties()"},{"p":"org.apache.pulsar.client.api","c":"Message","l":"getProperty(String)","u":"getProperty(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"MessagePayloadContext","l":"getProperty(String)","u":"getProperty(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"CryptoKeyReader","l":"getPublicKey(String, Map)","u":"getPublicKey(java.lang.String,java.util.Map)"},{"p":"org.apache.pulsar.client.api","c":"DummyCryptoKeyReaderImpl","l":"getPublicKey(String, Map)","u":"getPublicKey(java.lang.String,java.util.Map)"},{"p":"org.apache.pulsar.client.api","c":"Message","l":"getPublishTime()"},{"p":"org.apache.pulsar.client.api","c":"KeySharedPolicy.KeySharedPolicySticky","l":"getRanges()"},{"p":"org.apache.pulsar.client.api","c":"ConsumerStats","l":"getRateBytesReceived()"},{"p":"org.apache.pulsar.client.api","c":"ConsumerStats","l":"getRateMsgsReceived()"},{"p":"org.apache.pulsar.client.api","c":"Message","l":"getReaderSchema()"},{"p":"org.apache.pulsar.client.api","c":"Message","l":"getRedeliveryCount()"},{"p":"org.apache.pulsar.client.api","c":"Message","l":"getReplicatedFrom()"},{"p":"org.apache.pulsar.client.api","c":"ConsumerStats","l":"getRetryLetterProducerStats()"},{"p":"org.apache.pulsar.common.schema","c":"SchemaInfo","l":"getSchema()"},{"p":"org.apache.pulsar.client.api","c":"Schema","l":"getSchema(SchemaInfo)","u":"getSchema(org.apache.pulsar.common.schema.SchemaInfo)"},{"p":"org.apache.pulsar.client.internal","c":"PulsarClientImplementationBinding","l":"getSchema(SchemaInfo)","u":"getSchema(org.apache.pulsar.common.schema.SchemaInfo)"},{"p":"org.apache.pulsar.client.api.schema","c":"SchemaInfoProvider","l":"getSchemaByVersion(byte[])"},{"p":"org.apache.pulsar.common.schema","c":"SchemaInfo","l":"getSchemaDefinition()"},{"p":"org.apache.pulsar.client.api","c":"Schema","l":"getSchemaInfo()"},{"p":"org.apache.pulsar.client.api.schema","c":"SchemaDefinition","l":"getSchemaReaderOpt()"},{"p":"org.apache.pulsar.client.api.schema","c":"GenericObject","l":"getSchemaType()"},{"p":"org.apache.pulsar.client.api.schema","c":"GenericRecord","l":"getSchemaType()"},{"p":"org.apache.pulsar.client.api","c":"Message","l":"getSchemaVersion()"},{"p":"org.apache.pulsar.client.api.schema","c":"GenericRecord","l":"getSchemaVersion()"},{"p":"org.apache.pulsar.client.api.schema","c":"SchemaDefinition","l":"getSchemaWriterOpt()"},{"p":"org.apache.pulsar.client.api","c":"ProducerStats","l":"getSendBytesRate()"},{"p":"org.apache.pulsar.client.api","c":"ProducerStats","l":"getSendLatencyMillis50pct()"},{"p":"org.apache.pulsar.client.api","c":"ProducerStats","l":"getSendLatencyMillis75pct()"},{"p":"org.apache.pulsar.client.api","c":"ProducerStats","l":"getSendLatencyMillis95pct()"},{"p":"org.apache.pulsar.client.api","c":"ProducerStats","l":"getSendLatencyMillis999pct()"},{"p":"org.apache.pulsar.client.api","c":"ProducerStats","l":"getSendLatencyMillis99pct()"},{"p":"org.apache.pulsar.client.api","c":"ProducerStats","l":"getSendLatencyMillisMax()"},{"p":"org.apache.pulsar.client.api","c":"ProducerStats","l":"getSendMsgsRate()"},{"p":"org.apache.pulsar.client.api","c":"Message","l":"getSequenceId()"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException","l":"getSequenceId()"},{"p":"org.apache.pulsar.client.api","c":"ServiceUrlProvider","l":"getServiceUrl()"},{"p":"org.apache.pulsar.client.api","c":"Range","l":"getStart()"},{"p":"org.apache.pulsar.client.api.transaction","c":"Transaction","l":"getState()"},{"p":"org.apache.pulsar.client.api.transaction","c":"TransactionCoordinatorClient","l":"getState()"},{"p":"org.apache.pulsar.client.api","c":"Consumer","l":"getStats()"},{"p":"org.apache.pulsar.client.api","c":"Producer","l":"getStats()"},{"p":"org.apache.pulsar.client.api","c":"Consumer","l":"getSubscription()"},{"p":"org.apache.pulsar.client.api.schema","c":"SchemaDefinition","l":"getSupportSchemaVersioning()"},{"p":"org.apache.pulsar.client.api","c":"BatchReceivePolicy","l":"getTimeoutMs()"},{"p":"org.apache.pulsar.common.schema","c":"SchemaInfo","l":"getTimestamp()"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException.GettingAuthenticationDataException","l":"GettingAuthenticationDataException(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException.GettingAuthenticationDataException","l":"GettingAuthenticationDataException(Throwable)","u":"%3Cinit%3E(java.lang.Throwable)"},{"p":"org.apache.pulsar.client.api","c":"AuthenticationDataProvider","l":"getTlsCertificateFilePath()"},{"p":"org.apache.pulsar.client.api","c":"AuthenticationDataProvider","l":"getTlsCertificates()"},{"p":"org.apache.pulsar.client.api","c":"AuthenticationDataProvider","l":"getTlsKeyStoreParams()"},{"p":"org.apache.pulsar.client.api","c":"AuthenticationDataProvider","l":"getTlsPrivateKey()"},{"p":"org.apache.pulsar.client.api","c":"AuthenticationDataProvider","l":"getTlsPrivateKeyFilePath()"},{"p":"org.apache.pulsar.client.api","c":"AuthenticationDataProvider","l":"getTlsTrustStoreStream()"},{"p":"org.apache.pulsar.client.api","c":"Consumer","l":"getTopic()"},{"p":"org.apache.pulsar.client.api","c":"Producer","l":"getTopic()"},{"p":"org.apache.pulsar.client.api","c":"Reader","l":"getTopic()"},{"p":"org.apache.pulsar.client.api","c":"Message","l":"getTopicName()"},{"p":"org.apache.pulsar.client.api.schema","c":"SchemaInfoProvider","l":"getTopicName()"},{"p":"org.apache.pulsar.client.api","c":"ConsumerStats","l":"getTotaBatchReceivedFailed()"},{"p":"org.apache.pulsar.client.api","c":"ConsumerStats","l":"getTotalAcksFailed()"},{"p":"org.apache.pulsar.client.api","c":"ProducerStats","l":"getTotalAcksReceived()"},{"p":"org.apache.pulsar.client.api","c":"ConsumerStats","l":"getTotalAcksSent()"},{"p":"org.apache.pulsar.client.api","c":"ConsumerStats","l":"getTotalBytesReceived()"},{"p":"org.apache.pulsar.client.api","c":"ProducerStats","l":"getTotalBytesSent()"},{"p":"org.apache.pulsar.client.api","c":"ConsumerStats","l":"getTotalMsgsReceived()"},{"p":"org.apache.pulsar.client.api","c":"ProducerStats","l":"getTotalMsgsSent()"},{"p":"org.apache.pulsar.client.api","c":"ConsumerStats","l":"getTotalReceivedFailed()"},{"p":"org.apache.pulsar.client.api","c":"ProducerStats","l":"getTotalSendFailed()"},{"p":"org.apache.pulsar.client.api.transaction","c":"Transaction","l":"getTxnID()"},{"p":"org.apache.pulsar.common.schema","c":"SchemaInfo","l":"getType()"},{"p":"org.apache.pulsar.client.api","c":"Message","l":"getValue()"},{"p":"org.apache.pulsar.client.api","c":"SubscriptionInitialPosition","l":"getValue()"},{"p":"org.apache.pulsar.common.schema","c":"KeyValue","l":"getValue()"},{"p":"org.apache.pulsar.common.schema","c":"SchemaType","l":"getValue()"},{"p":"org.apache.pulsar.client.api.schema","c":"KeyValueSchema","l":"getValueSchema()"},{"p":"org.apache.pulsar.client.api","c":"SizeUnit","l":"GIGA_BYTES"},{"p":"org.apache.pulsar.client.api","c":"Message","l":"hasBase64EncodedKey()"},{"p":"org.apache.pulsar.client.api","c":"Message","l":"hasBrokerPublishTime()"},{"p":"org.apache.pulsar.client.api","c":"AuthenticationDataProvider","l":"hasDataForHttp()"},{"p":"org.apache.pulsar.client.api","c":"AuthenticationDataProvider","l":"hasDataForTls()"},{"p":"org.apache.pulsar.client.api","c":"AuthenticationDataProvider","l":"hasDataFromCommand()"},{"p":"org.apache.pulsar.client.api","c":"Range","l":"hashCode()"},{"p":"org.apache.pulsar.client.api.transaction","c":"TxnID","l":"hashCode()"},{"p":"org.apache.pulsar.common.schema","c":"KeyValue","l":"hashCode()"},{"p":"org.apache.pulsar.client.api","c":"ProducerBuilder","l":"hashingScheme(HashingScheme)","u":"hashingScheme(org.apache.pulsar.client.api.HashingScheme)"},{"p":"org.apache.pulsar.client.api","c":"Message","l":"hasIndex()"},{"p":"org.apache.pulsar.client.api","c":"Message","l":"hasKey()"},{"p":"org.apache.pulsar.client.api","c":"Reader","l":"hasMessageAvailable()"},{"p":"org.apache.pulsar.client.api","c":"Reader","l":"hasMessageAvailableAsync()"},{"p":"org.apache.pulsar.client.api","c":"Message","l":"hasOrderingKey()"},{"p":"org.apache.pulsar.client.api","c":"Message","l":"hasProperty(String)","u":"hasProperty(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"Consumer","l":"hasReachedEndOfTopic()"},{"p":"org.apache.pulsar.client.api","c":"Reader","l":"hasReachedEndOfTopic()"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException.IncompatibleSchemaException","l":"IncompatibleSchemaException(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException.IncompatibleSchemaException","l":"IncompatibleSchemaException(Throwable)","u":"%3Cinit%3E(java.lang.Throwable)"},{"p":"org.apache.pulsar.common.api","c":"AuthData","l":"INIT_AUTH_DATA"},{"p":"org.apache.pulsar.common.api","c":"AuthData","l":"INIT_AUTH_DATA_BYTES"},{"p":"org.apache.pulsar.client.api","c":"ServiceUrlProvider","l":"initialize(PulsarClient)","u":"initialize(org.apache.pulsar.client.api.PulsarClient)"},{"p":"org.apache.pulsar.client.api","c":"ProducerBuilder","l":"initialSequenceId(long)"},{"p":"org.apache.pulsar.common.schema","c":"KeyValueEncodingType","l":"INLINE"},{"p":"org.apache.pulsar.client.api","c":"DummyCryptoKeyReaderImpl","l":"INSTANCE"},{"p":"org.apache.pulsar.common.schema","c":"SchemaType","l":"INSTANT"},{"p":"org.apache.pulsar.client.api","c":"Schema","l":"INSTANT"},{"p":"org.apache.pulsar.common.schema","c":"SchemaType","l":"INT16"},{"p":"org.apache.pulsar.client.api","c":"Schema","l":"INT16"},{"p":"org.apache.pulsar.common.schema","c":"SchemaType","l":"INT32"},{"p":"org.apache.pulsar.client.api","c":"Schema","l":"INT32"},{"p":"org.apache.pulsar.common.schema","c":"SchemaType","l":"INT64"},{"p":"org.apache.pulsar.client.api","c":"Schema","l":"INT64"},{"p":"org.apache.pulsar.common.schema","c":"SchemaType","l":"INT8"},{"p":"org.apache.pulsar.client.api","c":"Schema","l":"INT8"},{"p":"org.apache.pulsar.client.api","c":"ConsumerBuilder","l":"intercept(ConsumerInterceptor...)","u":"intercept(org.apache.pulsar.client.api.ConsumerInterceptor...)"},{"p":"org.apache.pulsar.client.api","c":"ProducerBuilder","l":"intercept(ProducerInterceptor...)","u":"intercept(org.apache.pulsar.client.api.interceptor.ProducerInterceptor...)"},{"p":"org.apache.pulsar.client.api","c":"ProducerBuilder","l":"intercept(ProducerInterceptor...)","u":"intercept(org.apache.pulsar.client.api.ProducerInterceptor...)"},{"p":"org.apache.pulsar.client.api","c":"ReaderBuilder","l":"intercept(ReaderInterceptor...)","u":"intercept(org.apache.pulsar.client.api.ReaderInterceptor...)"},{"p":"org.apache.pulsar.client.api","c":"Range","l":"intersect(Range)","u":"intersect(org.apache.pulsar.client.api.Range)"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException.InvalidConfigurationException","l":"InvalidConfigurationException(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException.InvalidConfigurationException","l":"InvalidConfigurationException(String, Throwable)","u":"%3Cinit%3E(java.lang.String,java.lang.Throwable)"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException.InvalidConfigurationException","l":"InvalidConfigurationException(Throwable)","u":"%3Cinit%3E(java.lang.Throwable)"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException.InvalidMessageException","l":"InvalidMessageException(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException.InvalidMessageException","l":"InvalidMessageException(String, long)","u":"%3Cinit%3E(java.lang.String,long)"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException.InvalidServiceURL","l":"InvalidServiceURL(String, Throwable)","u":"%3Cinit%3E(java.lang.String,java.lang.Throwable)"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException.InvalidServiceURL","l":"InvalidServiceURL(Throwable)","u":"%3Cinit%3E(java.lang.Throwable)"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException.InvalidTopicNameException","l":"InvalidTopicNameException(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"org.apache.pulsar.client.api.transaction","c":"TransactionCoordinatorClientException.InvalidTxnStatusException","l":"InvalidTxnStatusException(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"org.apache.pulsar.client.api.transaction","c":"TransactionCoordinatorClientException.InvalidTxnStatusException","l":"InvalidTxnStatusException(String, String, String)","u":"%3Cinit%3E(java.lang.String,java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"ClientBuilder","l":"ioThreads(int)"},{"p":"org.apache.pulsar.client.api","c":"ConsumerBuilder","l":"isAckReceiptEnabled(boolean)"},{"p":"org.apache.pulsar.client.api","c":"KeySharedPolicy","l":"isAllowOutOfOrderDelivery()"},{"p":"org.apache.pulsar.client.api","c":"MessagePayloadContext","l":"isBatch()"},{"p":"org.apache.pulsar.client.api","c":"PulsarClient","l":"isClosed()"},{"p":"org.apache.pulsar.common.api","c":"AuthData","l":"isComplete()"},{"p":"org.apache.pulsar.client.api","c":"Consumer","l":"isConnected()"},{"p":"org.apache.pulsar.client.api","c":"Producer","l":"isConnected()"},{"p":"org.apache.pulsar.client.api","c":"Reader","l":"isConnected()"},{"p":"org.apache.pulsar.client.api","c":"BatchMessageContainer","l":"isEmpty()"},{"p":"org.apache.pulsar.client.api","c":"TableView","l":"isEmpty()"},{"p":"org.apache.pulsar.client.api.schema","c":"SchemaDefinition","l":"isJsr310ConversionEnabled()"},{"p":"org.apache.pulsar.client.api","c":"BatchReceivePolicy","l":"isMessagesFromMultiTopicsEnabled()"},{"p":"org.apache.pulsar.client.api","c":"BatchMessageContainer","l":"isMultiBatches()"},{"p":"org.apache.pulsar.common.schema","c":"SchemaType","l":"isPrimitive()"},{"p":"org.apache.pulsar.common.schema","c":"SchemaType","l":"isPrimitiveType(SchemaType)","u":"isPrimitiveType(org.apache.pulsar.common.schema.SchemaType)"},{"p":"org.apache.pulsar.client.api","c":"Message","l":"isReplicated()"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException","l":"isRetriableError(Throwable)","u":"isRetriableError(java.lang.Throwable)"},{"p":"org.apache.pulsar.common.schema","c":"SchemaType","l":"isStruct()"},{"p":"org.apache.pulsar.common.schema","c":"SchemaType","l":"isStructType(SchemaType)","u":"isStructType(org.apache.pulsar.common.schema.SchemaType)"},{"p":"org.apache.pulsar.client.api","c":"MessageCrypto","l":"IV_LEN"},{"p":"org.apache.pulsar.client.api","c":"HashingScheme","l":"JavaStringHash"},{"p":"org.apache.pulsar.common.schema","c":"SchemaType","l":"JSON"},{"p":"org.apache.pulsar.client.api","c":"Schema","l":"JSON(Class)","u":"JSON(java.lang.Class)"},{"p":"org.apache.pulsar.client.api","c":"Schema","l":"JSON(SchemaDefinition)","u":"JSON(org.apache.pulsar.client.api.schema.SchemaDefinition)"},{"p":"org.apache.pulsar.client.internal","c":"PulsarClientImplementationBinding","l":"jsonifyKeyValueSchemaInfo(KeyValue)","u":"jsonifyKeyValueSchemaInfo(org.apache.pulsar.common.schema.KeyValue)"},{"p":"org.apache.pulsar.client.internal","c":"PulsarClientImplementationBinding","l":"jsonifySchemaInfo(SchemaInfo)","u":"jsonifySchemaInfo(org.apache.pulsar.common.schema.SchemaInfo)"},{"p":"org.apache.pulsar.client.internal","c":"PulsarClientImplementationBinding","l":"jsonifySchemaInfoWithVersion(SchemaInfoWithVersion)","u":"jsonifySchemaInfoWithVersion(org.apache.pulsar.common.schema.SchemaInfoWithVersion)"},{"p":"org.apache.pulsar.client.api","c":"ClientBuilder","l":"keepAliveInterval(int, TimeUnit)","u":"keepAliveInterval(int,java.util.concurrent.TimeUnit)"},{"p":"org.apache.pulsar.client.api","c":"BatcherBuilder","l":"KEY_BASED"},{"p":"org.apache.pulsar.client.api","c":"SubscriptionType","l":"Key_Shared"},{"p":"org.apache.pulsar.common.schema","c":"SchemaType","l":"KEY_VALUE"},{"p":"org.apache.pulsar.client.api","c":"TypedMessageBuilder","l":"key(String)","u":"key(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"TypedMessageBuilder","l":"keyBytes(byte[])"},{"p":"org.apache.pulsar.client.api","c":"ReaderBuilder","l":"keyHashRange(Range...)","u":"keyHashRange(org.apache.pulsar.client.api.Range...)"},{"p":"org.apache.pulsar.client.api","c":"TableView","l":"keySet()"},{"p":"org.apache.pulsar.client.api","c":"KeySharedPolicy","l":"keySharedMode"},{"p":"org.apache.pulsar.client.api","c":"KeySharedPolicy","l":"KeySharedPolicy()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.client.api","c":"ConsumerBuilder","l":"keySharedPolicy(KeySharedPolicy)","u":"keySharedPolicy(org.apache.pulsar.client.api.KeySharedPolicy)"},{"p":"org.apache.pulsar.client.api","c":"KeyStoreParams","l":"KeyStoreParams()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.client.api","c":"Schema","l":"KeyValue(Class, Class)","u":"KeyValue(java.lang.Class,java.lang.Class)"},{"p":"org.apache.pulsar.client.api","c":"Schema","l":"KeyValue(Class, Class, SchemaType)","u":"KeyValue(java.lang.Class,java.lang.Class,org.apache.pulsar.common.schema.SchemaType)"},{"p":"org.apache.pulsar.common.schema","c":"KeyValue","l":"KeyValue(K, V)","u":"%3Cinit%3E(K,V)"},{"p":"org.apache.pulsar.client.api","c":"Schema","l":"KeyValue(Schema, Schema)","u":"KeyValue(org.apache.pulsar.client.api.Schema,org.apache.pulsar.client.api.Schema)"},{"p":"org.apache.pulsar.client.api","c":"Schema","l":"KeyValue(Schema, Schema, KeyValueEncodingType)","u":"KeyValue(org.apache.pulsar.client.api.Schema,org.apache.pulsar.client.api.Schema,org.apache.pulsar.common.schema.KeyValueEncodingType)"},{"p":"org.apache.pulsar.client.api","c":"SizeUnit","l":"KILO_BYTES"},{"p":"org.apache.pulsar.client.api","c":"Schema","l":"KV_BYTES()"},{"p":"org.apache.pulsar.client.api","c":"MessageId","l":"latest"},{"p":"org.apache.pulsar.client.api","c":"SubscriptionInitialPosition","l":"Latest"},{"p":"org.apache.pulsar.client.api","c":"TableView","l":"listen(BiConsumer)","u":"listen(java.util.function.BiConsumer)"},{"p":"org.apache.pulsar.client.api","c":"ClientBuilder","l":"listenerName(String)","u":"listenerName(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"ClientBuilder","l":"listenerThreads(int)"},{"p":"org.apache.pulsar.client.api","c":"ClientBuilder","l":"loadConf(Map)","u":"loadConf(java.util.Map)"},{"p":"org.apache.pulsar.client.api","c":"ConsumerBuilder","l":"loadConf(Map)","u":"loadConf(java.util.Map)"},{"p":"org.apache.pulsar.client.api","c":"ProducerBuilder","l":"loadConf(Map)","u":"loadConf(java.util.Map)"},{"p":"org.apache.pulsar.client.api","c":"ReaderBuilder","l":"loadConf(Map)","u":"loadConf(java.util.Map)"},{"p":"org.apache.pulsar.client.api","c":"TableViewBuilder","l":"loadConf(Map)","u":"loadConf(java.util.Map)"},{"p":"org.apache.pulsar.client.api","c":"TypedMessageBuilder","l":"loadConf(Map)","u":"loadConf(java.util.Map)"},{"p":"org.apache.pulsar.common.schema","c":"SchemaType","l":"LOCAL_DATE"},{"p":"org.apache.pulsar.client.api","c":"Schema","l":"LOCAL_DATE"},{"p":"org.apache.pulsar.common.schema","c":"SchemaType","l":"LOCAL_DATE_TIME"},{"p":"org.apache.pulsar.client.api","c":"Schema","l":"LOCAL_DATE_TIME"},{"p":"org.apache.pulsar.common.schema","c":"SchemaType","l":"LOCAL_TIME"},{"p":"org.apache.pulsar.client.api","c":"Schema","l":"LOCAL_TIME"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException.LookupException","l":"LookupException(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"ClientBuilder","l":"lookupProperties(Map)","u":"lookupProperties(java.util.Map)"},{"p":"org.apache.pulsar.client.api","c":"ClientBuilder","l":"lookupTimeout(int, TimeUnit)","u":"lookupTimeout(int,java.util.concurrent.TimeUnit)"},{"p":"org.apache.pulsar.client.api","c":"CompressionType","l":"LZ4"},{"p":"org.apache.pulsar.client.api","c":"ConsumerBuilder","l":"maxAcknowledgmentGroupSize(int)"},{"p":"org.apache.pulsar.client.api","c":"ClientBuilder","l":"maxBackoffInterval(long, TimeUnit)","u":"maxBackoffInterval(long,java.util.concurrent.TimeUnit)"},{"p":"org.apache.pulsar.client.api","c":"ClientBuilder","l":"maxConcurrentLookupRequests(int)"},{"p":"org.apache.pulsar.client.api","c":"ClientBuilder","l":"maxLookupRedirects(int)"},{"p":"org.apache.pulsar.client.api","c":"ClientBuilder","l":"maxLookupRequests(int)"},{"p":"org.apache.pulsar.client.api","c":"ClientBuilder","l":"maxNumberOfRejectedRequestPerConnection(int)"},{"p":"org.apache.pulsar.client.api","c":"BatchReceivePolicy.Builder","l":"maxNumBytes(int)"},{"p":"org.apache.pulsar.client.api","c":"BatchReceivePolicy.Builder","l":"maxNumMessages(int)"},{"p":"org.apache.pulsar.client.api","c":"ConsumerBuilder","l":"maxPendingChuckedMessage(int)"},{"p":"org.apache.pulsar.client.api","c":"ConsumerBuilder","l":"maxPendingChunkedMessage(int)"},{"p":"org.apache.pulsar.client.api","c":"ReaderBuilder","l":"maxPendingChunkedMessage(int)"},{"p":"org.apache.pulsar.client.api","c":"ProducerBuilder","l":"maxPendingMessages(int)"},{"p":"org.apache.pulsar.client.api","c":"ProducerBuilder","l":"maxPendingMessagesAcrossPartitions(int)"},{"p":"org.apache.pulsar.client.api","c":"ConsumerBuilder","l":"maxTotalReceiverQueueSizeAcrossPartitions(int)"},{"p":"org.apache.pulsar.client.api","c":"SizeUnit","l":"MEGA_BYTES"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException.MemoryBufferIsFullError","l":"MemoryBufferIsFullError(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException.MemoryBufferIsFullError","l":"MemoryBufferIsFullError(String, long)","u":"%3Cinit%3E(java.lang.String,long)"},{"p":"org.apache.pulsar.client.api","c":"ClientBuilder","l":"memoryLimit(long, SizeUnit)","u":"memoryLimit(long,org.apache.pulsar.client.api.SizeUnit)"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException.MessageAcknowledgeException","l":"MessageAcknowledgeException(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException.MessageAcknowledgeException","l":"MessageAcknowledgeException(Throwable)","u":"%3Cinit%3E(java.lang.Throwable)"},{"p":"org.apache.pulsar.client.api","c":"ConsumerBuilder","l":"messageCrypto(MessageCrypto)","u":"messageCrypto(org.apache.pulsar.client.api.MessageCrypto)"},{"p":"org.apache.pulsar.client.api","c":"ProducerBuilder","l":"messageCrypto(MessageCrypto)","u":"messageCrypto(org.apache.pulsar.client.api.MessageCrypto)"},{"p":"org.apache.pulsar.client.api","c":"ReaderBuilder","l":"messageCrypto(MessageCrypto)","u":"messageCrypto(org.apache.pulsar.client.api.MessageCrypto)"},{"p":"org.apache.pulsar.client.api","c":"ConsumerBuilder","l":"messageListener(MessageListener)","u":"messageListener(org.apache.pulsar.client.api.MessageListener)"},{"p":"org.apache.pulsar.client.api","c":"ConsumerBuilder","l":"messageListenerExecutor(MessageListenerExecutor)","u":"messageListenerExecutor(org.apache.pulsar.client.api.MessageListenerExecutor)"},{"p":"org.apache.pulsar.client.api","c":"ConsumerBuilder","l":"messagePayloadProcessor(MessagePayloadProcessor)","u":"messagePayloadProcessor(org.apache.pulsar.client.api.MessagePayloadProcessor)"},{"p":"org.apache.pulsar.client.api","c":"ProducerBuilder","l":"messageRouter(MessageRouter)","u":"messageRouter(org.apache.pulsar.client.api.MessageRouter)"},{"p":"org.apache.pulsar.client.api","c":"ProducerBuilder","l":"messageRoutingMode(MessageRoutingMode)","u":"messageRoutingMode(org.apache.pulsar.client.api.MessageRoutingMode)"},{"p":"org.apache.pulsar.client.api","c":"BatchReceivePolicy.Builder","l":"messagesFromMultiTopicsEnabled(boolean)"},{"p":"org.apache.pulsar.client.api.transaction","c":"TransactionCoordinatorClientException.MetaStoreHandlerNotExistsException","l":"MetaStoreHandlerNotExistsException(long)","u":"%3Cinit%3E(long)"},{"p":"org.apache.pulsar.client.api.transaction","c":"TransactionCoordinatorClientException.MetaStoreHandlerNotExistsException","l":"MetaStoreHandlerNotExistsException(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"org.apache.pulsar.client.api.transaction","c":"TransactionCoordinatorClientException.MetaStoreHandlerNotReadyException","l":"MetaStoreHandlerNotReadyException(long)","u":"%3Cinit%3E(long)"},{"p":"org.apache.pulsar.client.api.transaction","c":"TransactionCoordinatorClientException.MetaStoreHandlerNotReadyException","l":"MetaStoreHandlerNotReadyException(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"HashingScheme","l":"Murmur3_32Hash"},{"p":"org.apache.pulsar.common.schema","c":"SchemaInfo.SchemaInfoBuilder","l":"name(String)","u":"name(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"Schema","l":"NATIVE_AVRO(Object)","u":"NATIVE_AVRO(java.lang.Object)"},{"p":"org.apache.pulsar.client.api","c":"Consumer","l":"negativeAcknowledge(Message)","u":"negativeAcknowledge(org.apache.pulsar.client.api.Message)"},{"p":"org.apache.pulsar.client.api","c":"Consumer","l":"negativeAcknowledge(MessageId)","u":"negativeAcknowledge(org.apache.pulsar.client.api.MessageId)"},{"p":"org.apache.pulsar.client.api","c":"Consumer","l":"negativeAcknowledge(Messages)","u":"negativeAcknowledge(org.apache.pulsar.client.api.Messages)"},{"p":"org.apache.pulsar.client.api","c":"ConsumerBuilder","l":"negativeAckRedeliveryBackoff(RedeliveryBackoff)","u":"negativeAckRedeliveryBackoff(org.apache.pulsar.client.api.RedeliveryBackoff)"},{"p":"org.apache.pulsar.client.api","c":"ConsumerBuilder","l":"negativeAckRedeliveryDelay(long, TimeUnit)","u":"negativeAckRedeliveryDelay(long,java.util.concurrent.TimeUnit)"},{"p":"org.apache.pulsar.client.internal","c":"PulsarClientImplementationBinding","l":"newAuthenticationTLS(String, String)","u":"newAuthenticationTLS(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.internal","c":"PulsarClientImplementationBinding","l":"newAuthenticationToken(String)","u":"newAuthenticationToken(java.lang.String)"},{"p":"org.apache.pulsar.client.internal","c":"PulsarClientImplementationBinding","l":"newAuthenticationToken(Supplier)","u":"newAuthenticationToken(java.util.function.Supplier)"},{"p":"org.apache.pulsar.client.internal","c":"PulsarClientImplementationBinding","l":"newAutoConsumeSchema()"},{"p":"org.apache.pulsar.client.internal","c":"PulsarClientImplementationBinding","l":"newAutoProduceSchema()"},{"p":"org.apache.pulsar.client.internal","c":"PulsarClientImplementationBinding","l":"newAutoProduceSchema(Schema)","u":"newAutoProduceSchema(org.apache.pulsar.client.api.Schema)"},{"p":"org.apache.pulsar.client.internal","c":"PulsarClientImplementationBinding","l":"newAutoProduceValidatedAvroSchema(Object)","u":"newAutoProduceValidatedAvroSchema(java.lang.Object)"},{"p":"org.apache.pulsar.client.internal","c":"PulsarClientImplementationBinding","l":"newAvroSchema(SchemaDefinition)","u":"newAvroSchema(org.apache.pulsar.client.api.schema.SchemaDefinition)"},{"p":"org.apache.pulsar.client.internal","c":"PulsarClientImplementationBinding","l":"newBooleanSchema()"},{"p":"org.apache.pulsar.client.internal","c":"PulsarClientImplementationBinding","l":"newByteBufferSchema()"},{"p":"org.apache.pulsar.client.internal","c":"PulsarClientImplementationBinding","l":"newByteSchema()"},{"p":"org.apache.pulsar.client.internal","c":"PulsarClientImplementationBinding","l":"newBytesSchema()"},{"p":"org.apache.pulsar.client.internal","c":"PulsarClientImplementationBinding","l":"newClientBuilder()"},{"p":"org.apache.pulsar.client.api","c":"PulsarClient","l":"newConsumer()"},{"p":"org.apache.pulsar.client.api","c":"PulsarClient","l":"newConsumer(Schema)","u":"newConsumer(org.apache.pulsar.client.api.Schema)"},{"p":"org.apache.pulsar.client.internal","c":"PulsarClientImplementationBinding","l":"newDateSchema()"},{"p":"org.apache.pulsar.client.internal","c":"PulsarClientImplementationBinding","l":"newDefaultBatcherBuilder()"},{"p":"org.apache.pulsar.client.internal","c":"PulsarClientImplementationBinding","l":"newDefaultMessagePayloadFactory()"},{"p":"org.apache.pulsar.client.internal","c":"PulsarClientImplementationBinding","l":"newDoubleSchema()"},{"p":"org.apache.pulsar.client.internal","c":"PulsarClientImplementationBinding","l":"newFloatSchema()"},{"p":"org.apache.pulsar.client.internal","c":"PulsarClientImplementationBinding","l":"newInstantSchema()"},{"p":"org.apache.pulsar.client.internal","c":"PulsarClientImplementationBinding","l":"newIntSchema()"},{"p":"org.apache.pulsar.client.internal","c":"PulsarClientImplementationBinding","l":"newJSONSchema(SchemaDefinition)","u":"newJSONSchema(org.apache.pulsar.client.api.schema.SchemaDefinition)"},{"p":"org.apache.pulsar.client.internal","c":"PulsarClientImplementationBinding","l":"newKeyBasedBatcherBuilder()"},{"p":"org.apache.pulsar.client.internal","c":"PulsarClientImplementationBinding","l":"newKeyValueBytesSchema()"},{"p":"org.apache.pulsar.client.internal","c":"PulsarClientImplementationBinding","l":"newKeyValueSchema(Class, Class, SchemaType)","u":"newKeyValueSchema(java.lang.Class,java.lang.Class,org.apache.pulsar.common.schema.SchemaType)"},{"p":"org.apache.pulsar.client.internal","c":"PulsarClientImplementationBinding","l":"newKeyValueSchema(Schema, Schema, KeyValueEncodingType)","u":"newKeyValueSchema(org.apache.pulsar.client.api.Schema,org.apache.pulsar.client.api.Schema,org.apache.pulsar.common.schema.KeyValueEncodingType)"},{"p":"org.apache.pulsar.client.internal","c":"PulsarClientImplementationBinding","l":"newLocalDateSchema()"},{"p":"org.apache.pulsar.client.internal","c":"PulsarClientImplementationBinding","l":"newLocalDateTimeSchema()"},{"p":"org.apache.pulsar.client.internal","c":"PulsarClientImplementationBinding","l":"newLocalTimeSchema()"},{"p":"org.apache.pulsar.client.internal","c":"PulsarClientImplementationBinding","l":"newLongSchema()"},{"p":"org.apache.pulsar.client.api","c":"Producer","l":"newMessage()"},{"p":"org.apache.pulsar.client.api","c":"Producer","l":"newMessage(Schema)","u":"newMessage(org.apache.pulsar.client.api.Schema)"},{"p":"org.apache.pulsar.client.api","c":"Producer","l":"newMessage(Transaction)","u":"newMessage(org.apache.pulsar.client.api.transaction.Transaction)"},{"p":"org.apache.pulsar.client.internal","c":"PulsarClientImplementationBinding","l":"newMessageId(long, long, int)","u":"newMessageId(long,long,int)"},{"p":"org.apache.pulsar.client.internal","c":"PulsarClientImplementationBinding","l":"newMessageIdFromByteArray(byte[])"},{"p":"org.apache.pulsar.client.internal","c":"PulsarClientImplementationBinding","l":"newMessageIdFromByteArrayWithTopic(byte[], String)","u":"newMessageIdFromByteArrayWithTopic(byte[],java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"PulsarClient","l":"newProducer()"},{"p":"org.apache.pulsar.client.api","c":"PulsarClient","l":"newProducer(Schema)","u":"newProducer(org.apache.pulsar.client.api.Schema)"},{"p":"org.apache.pulsar.client.internal","c":"PulsarClientImplementationBinding","l":"newProtobufNativeSchema(SchemaDefinition)","u":"newProtobufNativeSchema(org.apache.pulsar.client.api.schema.SchemaDefinition)"},{"p":"org.apache.pulsar.client.internal","c":"PulsarClientImplementationBinding","l":"newProtobufSchema(SchemaDefinition)","u":"newProtobufSchema(org.apache.pulsar.client.api.schema.SchemaDefinition)"},{"p":"org.apache.pulsar.client.api","c":"PulsarClient","l":"newReader()"},{"p":"org.apache.pulsar.client.api","c":"PulsarClient","l":"newReader(Schema)","u":"newReader(org.apache.pulsar.client.api.Schema)"},{"p":"org.apache.pulsar.client.api.schema","c":"GenericSchema","l":"newRecordBuilder()"},{"p":"org.apache.pulsar.client.internal","c":"PulsarClientImplementationBinding","l":"newRecordSchemaBuilder(String)","u":"newRecordSchemaBuilder(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"Authentication","l":"newRequestHeader(String, AuthenticationDataProvider, Map)","u":"newRequestHeader(java.lang.String,org.apache.pulsar.client.api.AuthenticationDataProvider,java.util.Map)"},{"p":"org.apache.pulsar.client.internal","c":"PulsarClientImplementationBinding","l":"newSchemaDefinitionBuilder()"},{"p":"org.apache.pulsar.client.internal","c":"PulsarClientImplementationBinding","l":"newSchemaInfoImpl(String, byte[], SchemaType, long, Map)","u":"newSchemaInfoImpl(java.lang.String,byte[],org.apache.pulsar.common.schema.SchemaType,long,java.util.Map)"},{"p":"org.apache.pulsar.client.internal","c":"PulsarClientImplementationBinding","l":"newShortSchema()"},{"p":"org.apache.pulsar.client.internal","c":"PulsarClientImplementationBinding","l":"newStringSchema()"},{"p":"org.apache.pulsar.client.internal","c":"PulsarClientImplementationBinding","l":"newStringSchema(Charset)","u":"newStringSchema(java.nio.charset.Charset)"},{"p":"org.apache.pulsar.client.api","c":"PulsarClient","l":"newTableView()"},{"p":"org.apache.pulsar.client.api","c":"PulsarClient","l":"newTableView(Schema)","u":"newTableView(org.apache.pulsar.client.api.Schema)"},{"p":"org.apache.pulsar.client.api","c":"PulsarClient","l":"newTableViewBuilder(Schema)","u":"newTableViewBuilder(org.apache.pulsar.client.api.Schema)"},{"p":"org.apache.pulsar.client.internal","c":"PulsarClientImplementationBinding","l":"newTimeSchema()"},{"p":"org.apache.pulsar.client.internal","c":"PulsarClientImplementationBinding","l":"newTimestampSchema()"},{"p":"org.apache.pulsar.client.internal","c":"PulsarClientImplementationBinding","l":"newTopicMessageId(String, MessageId)","u":"newTopicMessageId(java.lang.String,org.apache.pulsar.client.api.MessageId)"},{"p":"org.apache.pulsar.client.api","c":"PulsarClient","l":"newTransaction()"},{"p":"org.apache.pulsar.client.api.transaction","c":"TransactionCoordinatorClient","l":"newTransaction()"},{"p":"org.apache.pulsar.client.api.transaction","c":"TransactionCoordinatorClient","l":"newTransaction(long, TimeUnit)","u":"newTransaction(long,java.util.concurrent.TimeUnit)"},{"p":"org.apache.pulsar.client.api.transaction","c":"TransactionCoordinatorClient","l":"newTransactionAsync()"},{"p":"org.apache.pulsar.client.api.transaction","c":"TransactionCoordinatorClient","l":"newTransactionAsync(long, TimeUnit)","u":"newTransactionAsync(long,java.util.concurrent.TimeUnit)"},{"p":"org.apache.pulsar.client.api","c":"RedeliveryBackoff","l":"next(int)"},{"p":"org.apache.pulsar.client.api","c":"SubscriptionMode","l":"NonDurable"},{"p":"org.apache.pulsar.client.api","c":"CompressionType","l":"NONE"},{"p":"org.apache.pulsar.client.api.transaction","c":"TransactionCoordinatorClient.State","l":"NONE"},{"p":"org.apache.pulsar.common.schema","c":"SchemaType","l":"NONE"},{"p":"org.apache.pulsar.client.api","c":"RegexSubscriptionMode","l":"NonPersistentOnly"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException.NotAllowedException","l":"NotAllowedException(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException.NotConnectedException","l":"NotConnectedException()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException.NotConnectedException","l":"NotConnectedException(long)","u":"%3Cinit%3E(long)"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException.NotConnectedException","l":"NotConnectedException(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException.NotFoundException","l":"NotFoundException(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException.NotFoundException","l":"NotFoundException(Throwable)","u":"%3Cinit%3E(java.lang.Throwable)"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException.NotSupportedException","l":"NotSupportedException(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"TopicMetadata","l":"numPartitions()"},{"p":"org.apache.pulsar.client.api","c":"Range","l":"of(int, int)","u":"of(int,int)"},{"p":"org.apache.pulsar.client.api.schema","c":"GenericSchema","l":"of(SchemaInfo)","u":"of(org.apache.pulsar.common.schema.SchemaInfo)"},{"p":"org.apache.pulsar.client.api.schema","c":"GenericSchema","l":"of(SchemaInfo, boolean)","u":"of(org.apache.pulsar.common.schema.SchemaInfo,boolean)"},{"p":"org.apache.pulsar.client.api","c":"ConsumerInterceptor","l":"onAcknowledge(Consumer, MessageId, Throwable)","u":"onAcknowledge(org.apache.pulsar.client.api.Consumer,org.apache.pulsar.client.api.MessageId,java.lang.Throwable)"},{"p":"org.apache.pulsar.client.api","c":"ConsumerInterceptor","l":"onAcknowledgeCumulative(Consumer, MessageId, Throwable)","u":"onAcknowledgeCumulative(org.apache.pulsar.client.api.Consumer,org.apache.pulsar.client.api.MessageId,java.lang.Throwable)"},{"p":"org.apache.pulsar.client.api","c":"ConsumerInterceptor","l":"onAckTimeoutSend(Consumer, Set)","u":"onAckTimeoutSend(org.apache.pulsar.client.api.Consumer,java.util.Set)"},{"p":"org.apache.pulsar.client.api","c":"ConsumerInterceptor","l":"onArrival(Consumer, Message)","u":"onArrival(org.apache.pulsar.client.api.Consumer,org.apache.pulsar.client.api.Message)"},{"p":"org.apache.pulsar.client.api","c":"ConsumerInterceptor","l":"onNegativeAcksSend(Consumer, Set)","u":"onNegativeAcksSend(org.apache.pulsar.client.api.Consumer,java.util.Set)"},{"p":"org.apache.pulsar.client.api","c":"ConsumerInterceptor","l":"onPartitionsChange(String, int)","u":"onPartitionsChange(java.lang.String,int)"},{"p":"org.apache.pulsar.client.api.interceptor","c":"ProducerInterceptor","l":"onPartitionsChange(String, int)","u":"onPartitionsChange(java.lang.String,int)"},{"p":"org.apache.pulsar.client.api.interceptor","c":"ProducerInterceptorWrapper","l":"onPartitionsChange(String, int)","u":"onPartitionsChange(java.lang.String,int)"},{"p":"org.apache.pulsar.client.api","c":"ProducerInterceptor","l":"onPartitionsChange(String, int)","u":"onPartitionsChange(java.lang.String,int)"},{"p":"org.apache.pulsar.client.api","c":"ReaderInterceptor","l":"onPartitionsChange(String, int)","u":"onPartitionsChange(java.lang.String,int)"},{"p":"org.apache.pulsar.client.api.interceptor","c":"ProducerInterceptor","l":"onSendAcknowledgement(Producer, Message, MessageId, Throwable)","u":"onSendAcknowledgement(org.apache.pulsar.client.api.Producer,org.apache.pulsar.client.api.Message,org.apache.pulsar.client.api.MessageId,java.lang.Throwable)"},{"p":"org.apache.pulsar.client.api.interceptor","c":"ProducerInterceptorWrapper","l":"onSendAcknowledgement(Producer, Message, MessageId, Throwable)","u":"onSendAcknowledgement(org.apache.pulsar.client.api.Producer,org.apache.pulsar.client.api.Message,org.apache.pulsar.client.api.MessageId,java.lang.Throwable)"},{"p":"org.apache.pulsar.client.api","c":"ProducerInterceptor","l":"onSendAcknowledgement(Producer, Message, MessageId, Throwable)","u":"onSendAcknowledgement(org.apache.pulsar.client.api.Producer,org.apache.pulsar.client.api.Message,org.apache.pulsar.client.api.MessageId,java.lang.Throwable)"},{"p":"org.apache.pulsar.client.api.transaction","c":"Transaction.State","l":"OPEN"},{"p":"org.apache.pulsar.client.api","c":"ClientBuilder","l":"openTelemetry(OpenTelemetry)","u":"openTelemetry(io.opentelemetry.api.OpenTelemetry)"},{"p":"org.apache.pulsar.client.api","c":"ClientBuilder","l":"operationTimeout(int, TimeUnit)","u":"operationTimeout(int,java.util.concurrent.TimeUnit)"},{"p":"org.apache.pulsar.client.api.schema","c":"FieldSchemaBuilder","l":"optional()"},{"p":"org.apache.pulsar.client.api","c":"AutoClusterFailoverBuilder.FailoverPolicy","l":"ORDER"},{"p":"org.apache.pulsar.client.api","c":"TypedMessageBuilder","l":"orderingKey(byte[])"},{"p":"org.apache.pulsar.client.api","c":"ConsumerBuilder","l":"patternAutoDiscoveryPeriod(int)"},{"p":"org.apache.pulsar.client.api","c":"ConsumerBuilder","l":"patternAutoDiscoveryPeriod(int, TimeUnit)","u":"patternAutoDiscoveryPeriod(int,java.util.concurrent.TimeUnit)"},{"p":"org.apache.pulsar.client.api","c":"Consumer","l":"pause()"},{"p":"org.apache.pulsar.client.api","c":"RegexSubscriptionMode","l":"PersistentOnly"},{"p":"org.apache.pulsar.client.api","c":"ConsumerBuilder","l":"poolMessages(boolean)"},{"p":"org.apache.pulsar.client.api","c":"ReaderBuilder","l":"poolMessages(boolean)"},{"p":"org.apache.pulsar.client.api","c":"AutoClusterFailoverBuilder","l":"primary(String)","u":"primary(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"ConsumerBuilder","l":"priorityLevel(int)"},{"p":"org.apache.pulsar.client.api","c":"TopicConsumerBuilder","l":"priorityLevel(int)"},{"p":"org.apache.pulsar.client.api","c":"MessagePayloadProcessor","l":"process(MessagePayload, MessagePayloadContext, Schema, Consumer>)","u":"process(org.apache.pulsar.client.api.MessagePayload,org.apache.pulsar.client.api.MessagePayloadContext,org.apache.pulsar.client.api.Schema,java.util.function.Consumer)"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException.ProducerBlockedQuotaExceededError","l":"ProducerBlockedQuotaExceededError(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException.ProducerBlockedQuotaExceededException","l":"ProducerBlockedQuotaExceededException(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException.ProducerBusyException","l":"ProducerBusyException(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException.ProducerFencedException","l":"ProducerFencedException(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"org.apache.pulsar.client.api.interceptor","c":"ProducerInterceptorWrapper","l":"ProducerInterceptorWrapper(ProducerInterceptor)","u":"%3Cinit%3E(org.apache.pulsar.client.api.ProducerInterceptor)"},{"p":"org.apache.pulsar.client.api","c":"ProducerBuilder","l":"producerName(String)","u":"producerName(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException.ProducerQueueIsFullError","l":"ProducerQueueIsFullError(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException.ProducerQueueIsFullError","l":"ProducerQueueIsFullError(String, long)","u":"%3Cinit%3E(java.lang.String,long)"},{"p":"org.apache.pulsar.client.api","c":"ConsumerBuilder","l":"properties(Map)","u":"properties(java.util.Map)"},{"p":"org.apache.pulsar.client.api","c":"ProducerBuilder","l":"properties(Map)","u":"properties(java.util.Map)"},{"p":"org.apache.pulsar.client.api","c":"TypedMessageBuilder","l":"properties(Map)","u":"properties(java.util.Map)"},{"p":"org.apache.pulsar.common.schema","c":"SchemaInfo.SchemaInfoBuilder","l":"properties(Map)","u":"properties(java.util.Map)"},{"p":"org.apache.pulsar.client.internal","c":"PropertiesUtils","l":"PropertiesUtils()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.client.api","c":"ConsumerBuilder","l":"property(String, String)","u":"property(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"ProducerBuilder","l":"property(String, String)","u":"property(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.api.schema","c":"FieldSchemaBuilder","l":"property(String, String)","u":"property(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.api.schema","c":"RecordSchemaBuilder","l":"property(String, String)","u":"property(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"TypedMessageBuilder","l":"property(String, String)","u":"property(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.common.schema","c":"SchemaType","l":"PROTOBUF"},{"p":"org.apache.pulsar.common.schema","c":"SchemaType","l":"PROTOBUF_NATIVE"},{"p":"org.apache.pulsar.client.api","c":"Schema","l":"PROTOBUF_NATIVE(Class)","u":"PROTOBUF_NATIVE(java.lang.Class)"},{"p":"org.apache.pulsar.client.api","c":"Schema","l":"PROTOBUF_NATIVE(SchemaDefinition)","u":"PROTOBUF_NATIVE(org.apache.pulsar.client.api.schema.SchemaDefinition)"},{"p":"org.apache.pulsar.client.api","c":"Schema","l":"PROTOBUF(Class)","u":"PROTOBUF(java.lang.Class)"},{"p":"org.apache.pulsar.client.api","c":"Schema","l":"PROTOBUF(SchemaDefinition)","u":"PROTOBUF(org.apache.pulsar.client.api.schema.SchemaDefinition)"},{"p":"org.apache.pulsar.client.api","c":"ClientBuilder","l":"proxyServiceUrl(String, ProxyProtocol)","u":"proxyServiceUrl(java.lang.String,org.apache.pulsar.client.api.ProxyProtocol)"},{"p":"org.apache.pulsar.client.api","c":"AuthenticationDataProvider","l":"PULSAR_AUTH_METHOD_NAME"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException","l":"PulsarClientException(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException","l":"PulsarClientException(String, long)","u":"%3Cinit%3E(java.lang.String,long)"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException","l":"PulsarClientException(String, Throwable)","u":"%3Cinit%3E(java.lang.String,java.lang.Throwable)"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException","l":"PulsarClientException(Throwable)","u":"%3Cinit%3E(java.lang.Throwable)"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException","l":"PulsarClientException(Throwable, long)","u":"%3Cinit%3E(java.lang.Throwable,long)"},{"p":"org.apache.pulsar.client.api","c":"Range","l":"Range(int, int)","u":"%3Cinit%3E(int,int)"},{"p":"org.apache.pulsar.client.api","c":"KeySharedPolicy.KeySharedPolicySticky","l":"ranges"},{"p":"org.apache.pulsar.client.api","c":"KeySharedPolicy.KeySharedPolicySticky","l":"ranges(List)","u":"ranges(java.util.List)"},{"p":"org.apache.pulsar.client.api","c":"KeySharedPolicy.KeySharedPolicySticky","l":"ranges(Range...)","u":"ranges(org.apache.pulsar.client.api.Range...)"},{"p":"org.apache.pulsar.client.api","c":"MessageListener","l":"reachedEndOfTopic(Consumer)","u":"reachedEndOfTopic(org.apache.pulsar.client.api.Consumer)"},{"p":"org.apache.pulsar.client.api","c":"ReaderListener","l":"reachedEndOfTopic(Reader)","u":"reachedEndOfTopic(org.apache.pulsar.client.api.Reader)"},{"p":"org.apache.pulsar.client.api.transaction","c":"TransactionBufferClientException.ReachMaxPendingOpsException","l":"ReachMaxPendingOpsException()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.client.api.transaction","c":"TransactionBufferClientException.ReachMaxPendingOpsException","l":"ReachMaxPendingOpsException(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"TransactionIsolationLevel","l":"READ_COMMITTED"},{"p":"org.apache.pulsar.client.api","c":"TransactionIsolationLevel","l":"READ_UNCOMMITTED"},{"p":"org.apache.pulsar.client.api.schema","c":"SchemaReader","l":"read(byte[])"},{"p":"org.apache.pulsar.client.api.schema","c":"SchemaReader","l":"read(byte[], byte[])","u":"read(byte[],byte[])"},{"p":"org.apache.pulsar.client.api.schema","c":"SchemaReader","l":"read(byte[], int, int)","u":"read(byte[],int,int)"},{"p":"org.apache.pulsar.client.api.schema","c":"SchemaReader","l":"read(InputStream)","u":"read(java.io.InputStream)"},{"p":"org.apache.pulsar.client.api.schema","c":"SchemaReader","l":"read(InputStream, byte[])","u":"read(java.io.InputStream,byte[])"},{"p":"org.apache.pulsar.client.api","c":"ConsumerBuilder","l":"readCompacted(boolean)"},{"p":"org.apache.pulsar.client.api","c":"ReaderBuilder","l":"readCompacted(boolean)"},{"p":"org.apache.pulsar.client.api","c":"ReaderBuilder","l":"readerListener(ReaderListener)","u":"readerListener(org.apache.pulsar.client.api.ReaderListener)"},{"p":"org.apache.pulsar.client.api","c":"ReaderBuilder","l":"readerName(String)","u":"readerName(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"Reader","l":"readNext()"},{"p":"org.apache.pulsar.client.api","c":"Reader","l":"readNext(int, TimeUnit)","u":"readNext(int,java.util.concurrent.TimeUnit)"},{"p":"org.apache.pulsar.client.api","c":"Reader","l":"readNextAsync()"},{"p":"org.apache.pulsar.client.api.transaction","c":"TransactionCoordinatorClient.State","l":"READY"},{"p":"org.apache.pulsar.client.api","c":"Consumer","l":"receive()"},{"p":"org.apache.pulsar.client.api","c":"Consumer","l":"receive(int, TimeUnit)","u":"receive(int,java.util.concurrent.TimeUnit)"},{"p":"org.apache.pulsar.client.api","c":"Consumer","l":"receiveAsync()"},{"p":"org.apache.pulsar.client.api","c":"MessageListener","l":"received(Consumer, Message)","u":"received(org.apache.pulsar.client.api.Consumer,org.apache.pulsar.client.api.Message)"},{"p":"org.apache.pulsar.client.api","c":"ReaderListener","l":"received(Reader, Message)","u":"received(org.apache.pulsar.client.api.Reader,org.apache.pulsar.client.api.Message)"},{"p":"org.apache.pulsar.client.api","c":"ConsumerBuilder","l":"receiverQueueSize(int)"},{"p":"org.apache.pulsar.client.api","c":"ReaderBuilder","l":"receiverQueueSize(int)"},{"p":"org.apache.pulsar.client.api","c":"Consumer","l":"reconsumeLater(Message, long, TimeUnit)","u":"reconsumeLater(org.apache.pulsar.client.api.Message,long,java.util.concurrent.TimeUnit)"},{"p":"org.apache.pulsar.client.api","c":"Consumer","l":"reconsumeLater(Message, Map, long, TimeUnit)","u":"reconsumeLater(org.apache.pulsar.client.api.Message,java.util.Map,long,java.util.concurrent.TimeUnit)"},{"p":"org.apache.pulsar.client.api","c":"Consumer","l":"reconsumeLater(Messages, long, TimeUnit)","u":"reconsumeLater(org.apache.pulsar.client.api.Messages,long,java.util.concurrent.TimeUnit)"},{"p":"org.apache.pulsar.client.api","c":"Consumer","l":"reconsumeLaterAsync(Message, long, TimeUnit)","u":"reconsumeLaterAsync(org.apache.pulsar.client.api.Message,long,java.util.concurrent.TimeUnit)"},{"p":"org.apache.pulsar.client.api","c":"Consumer","l":"reconsumeLaterAsync(Message, Map, long, TimeUnit)","u":"reconsumeLaterAsync(org.apache.pulsar.client.api.Message,java.util.Map,long,java.util.concurrent.TimeUnit)"},{"p":"org.apache.pulsar.client.api","c":"Consumer","l":"reconsumeLaterAsync(Messages, long, TimeUnit)","u":"reconsumeLaterAsync(org.apache.pulsar.client.api.Messages,long,java.util.concurrent.TimeUnit)"},{"p":"org.apache.pulsar.client.api","c":"Consumer","l":"reconsumeLaterCumulative(Message, long, TimeUnit)","u":"reconsumeLaterCumulative(org.apache.pulsar.client.api.Message,long,java.util.concurrent.TimeUnit)"},{"p":"org.apache.pulsar.client.api","c":"Consumer","l":"reconsumeLaterCumulativeAsync(Message, long, TimeUnit)","u":"reconsumeLaterCumulativeAsync(org.apache.pulsar.client.api.Message,long,java.util.concurrent.TimeUnit)"},{"p":"org.apache.pulsar.client.api","c":"Consumer","l":"reconsumeLaterCumulativeAsync(Message, Map, long, TimeUnit)","u":"reconsumeLaterCumulativeAsync(org.apache.pulsar.client.api.Message,java.util.Map,long,java.util.concurrent.TimeUnit)"},{"p":"org.apache.pulsar.client.api.schema","c":"SchemaBuilder","l":"record(String)","u":"record(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"Consumer","l":"redeliverUnacknowledgedMessages()"},{"p":"org.apache.pulsar.common.api","c":"AuthData","l":"REFRESH_AUTH_DATA"},{"p":"org.apache.pulsar.common.api","c":"AuthData","l":"REFRESH_AUTH_DATA_BYTES"},{"p":"org.apache.pulsar.client.api","c":"TableView","l":"refresh()"},{"p":"org.apache.pulsar.client.api","c":"TableView","l":"refreshAsync()"},{"p":"org.apache.pulsar.client.api","c":"Message","l":"release()"},{"p":"org.apache.pulsar.client.api","c":"MessagePayload","l":"release()"},{"p":"org.apache.pulsar.client.api","c":"MessageCrypto","l":"removeKeyCipher(String)","u":"removeKeyCipher(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"ConsumerBuilder","l":"replicateSubscriptionState(boolean)"},{"p":"org.apache.pulsar.client.api","c":"TypedMessageBuilder","l":"replicationClusters(List)","u":"replicationClusters(java.util.List)"},{"p":"org.apache.pulsar.client.api.transaction","c":"TransactionBufferClientException.RequestTimeoutException","l":"RequestTimeoutException()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.client.api.transaction","c":"TransactionBufferClientException.RequestTimeoutException","l":"RequestTimeoutException(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"org.apache.pulsar.client.api.schema","c":"FieldSchemaBuilder","l":"required()"},{"p":"org.apache.pulsar.client.api","c":"Schema","l":"requireFetchingSchemaInfo()"},{"p":"org.apache.pulsar.client.api","c":"Consumer","l":"resume()"},{"p":"org.apache.pulsar.client.api","c":"MessageRoutingMode","l":"RoundRobinPartition"},{"p":"org.apache.pulsar.client.api","c":"ProducerBuilder","l":"roundRobinRouterBatchingPartitionSwitchFrequency(int)"},{"p":"org.apache.pulsar.common.schema","c":"SchemaInfo.SchemaInfoBuilder","l":"schema(byte[])"},{"p":"org.apache.pulsar.common.schema","c":"SchemaInfoWithVersion","l":"SchemaInfoWithVersion()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.client.api","c":"SchemaSerializationException","l":"SchemaSerializationException(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"SchemaSerializationException","l":"SchemaSerializationException(Throwable)","u":"%3Cinit%3E(java.lang.Throwable)"},{"p":"org.apache.pulsar.client.api","c":"AutoClusterFailoverBuilder","l":"secondary(List)","u":"secondary(java.util.List)"},{"p":"org.apache.pulsar.client.api","c":"AutoClusterFailoverBuilder","l":"secondaryAuthentication(Map)","u":"secondaryAuthentication(java.util.Map)"},{"p":"org.apache.pulsar.client.api","c":"AutoClusterFailoverBuilder","l":"secondaryTlsTrustCertsFilePath(Map)","u":"secondaryTlsTrustCertsFilePath(java.util.Map)"},{"p":"org.apache.pulsar.client.api","c":"AutoClusterFailoverBuilder","l":"secondaryTlsTrustStorePassword(Map)","u":"secondaryTlsTrustStorePassword(java.util.Map)"},{"p":"org.apache.pulsar.client.api","c":"AutoClusterFailoverBuilder","l":"secondaryTlsTrustStorePath(Map)","u":"secondaryTlsTrustStorePath(java.util.Map)"},{"p":"org.apache.pulsar.client.api","c":"Consumer","l":"seek(Function)","u":"seek(java.util.function.Function)"},{"p":"org.apache.pulsar.client.api","c":"Reader","l":"seek(Function)","u":"seek(java.util.function.Function)"},{"p":"org.apache.pulsar.client.api","c":"Consumer","l":"seek(long)"},{"p":"org.apache.pulsar.client.api","c":"Reader","l":"seek(long)"},{"p":"org.apache.pulsar.client.api","c":"Consumer","l":"seek(MessageId)","u":"seek(org.apache.pulsar.client.api.MessageId)"},{"p":"org.apache.pulsar.client.api","c":"Reader","l":"seek(MessageId)","u":"seek(org.apache.pulsar.client.api.MessageId)"},{"p":"org.apache.pulsar.client.api","c":"Consumer","l":"seekAsync(Function)","u":"seekAsync(java.util.function.Function)"},{"p":"org.apache.pulsar.client.api","c":"Reader","l":"seekAsync(Function)","u":"seekAsync(java.util.function.Function)"},{"p":"org.apache.pulsar.client.api","c":"Consumer","l":"seekAsync(long)"},{"p":"org.apache.pulsar.client.api","c":"Reader","l":"seekAsync(long)"},{"p":"org.apache.pulsar.client.api","c":"Consumer","l":"seekAsync(MessageId)","u":"seekAsync(org.apache.pulsar.client.api.MessageId)"},{"p":"org.apache.pulsar.client.api","c":"Reader","l":"seekAsync(MessageId)","u":"seekAsync(org.apache.pulsar.client.api.MessageId)"},{"p":"org.apache.pulsar.client.api","c":"ProducerCryptoFailureAction","l":"SEND"},{"p":"org.apache.pulsar.client.api","c":"TypedMessageBuilder","l":"send()"},{"p":"org.apache.pulsar.client.api","c":"Producer","l":"send(T)"},{"p":"org.apache.pulsar.client.api","c":"TypedMessageBuilder","l":"sendAsync()"},{"p":"org.apache.pulsar.client.api","c":"Producer","l":"sendAsync(T)"},{"p":"org.apache.pulsar.client.api","c":"ProducerBuilder","l":"sendTimeout(int, TimeUnit)","u":"sendTimeout(int,java.util.concurrent.TimeUnit)"},{"p":"org.apache.pulsar.common.schema","c":"KeyValueEncodingType","l":"SEPARATED"},{"p":"org.apache.pulsar.client.api","c":"TypedMessageBuilder","l":"sequenceId(long)"},{"p":"org.apache.pulsar.client.api","c":"ClientBuilder","l":"serviceUrl(String)","u":"serviceUrl(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"ClientBuilder","l":"serviceUrlProvider(ServiceUrlProvider)","u":"serviceUrlProvider(org.apache.pulsar.client.api.ServiceUrlProvider)"},{"p":"org.apache.pulsar.client.api.schema","c":"GenericRecordBuilder","l":"set(Field, Object)","u":"set(org.apache.pulsar.client.api.schema.Field,java.lang.Object)"},{"p":"org.apache.pulsar.client.api.schema","c":"GenericRecordBuilder","l":"set(String, Object)","u":"set(java.lang.String,java.lang.Object)"},{"p":"org.apache.pulsar.client.api","c":"KeySharedPolicy","l":"setAllowOutOfOrderDelivery(boolean)"},{"p":"org.apache.pulsar.client.api","c":"EncryptionKeyInfo","l":"setKey(byte[])"},{"p":"org.apache.pulsar.client.api","c":"EncryptionKeyInfo","l":"setMetadata(Map)","u":"setMetadata(java.util.Map)"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException","l":"setPreviousExceptionCount(AtomicInteger)","u":"setPreviousExceptionCount(java.util.concurrent.atomic.AtomicInteger)"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException","l":"setPreviousExceptionCount(Throwable, AtomicInteger)","u":"setPreviousExceptionCount(java.lang.Throwable,java.util.concurrent.atomic.AtomicInteger)"},{"p":"org.apache.pulsar.client.api.schema","c":"SchemaReader","l":"setSchemaInfoProvider(SchemaInfoProvider)","u":"setSchemaInfoProvider(org.apache.pulsar.client.api.schema.SchemaInfoProvider)"},{"p":"org.apache.pulsar.client.api","c":"Schema","l":"setSchemaInfoProvider(SchemaInfoProvider)","u":"setSchemaInfoProvider(org.apache.pulsar.client.api.schema.SchemaInfoProvider)"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException","l":"setSequenceId(long)"},{"p":"org.apache.pulsar.client.api","c":"ProducerAccessMode","l":"Shared"},{"p":"org.apache.pulsar.client.api","c":"SubscriptionType","l":"Shared"},{"p":"org.apache.pulsar.client.api","c":"PulsarClient","l":"shutdown()"},{"p":"org.apache.pulsar.client.api","c":"MessageRoutingMode","l":"SinglePartition"},{"p":"org.apache.pulsar.client.api","c":"Message","l":"size()"},{"p":"org.apache.pulsar.client.api","c":"Messages","l":"size()"},{"p":"org.apache.pulsar.client.api","c":"Range","l":"size()"},{"p":"org.apache.pulsar.client.api","c":"TableView","l":"size()"},{"p":"org.apache.pulsar.client.api","c":"CompressionType","l":"SNAPPY"},{"p":"org.apache.pulsar.client.api","c":"ProxyProtocol","l":"SNI"},{"p":"org.apache.pulsar.client.api","c":"ClientBuilder","l":"socks5ProxyAddress(InetSocketAddress)","u":"socks5ProxyAddress(java.net.InetSocketAddress)"},{"p":"org.apache.pulsar.client.api","c":"ClientBuilder","l":"socks5ProxyPassword(String)","u":"socks5ProxyPassword(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"ClientBuilder","l":"socks5ProxyUsername(String)","u":"socks5ProxyUsername(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"ClientBuilder","l":"sslFactoryPlugin(String)","u":"sslFactoryPlugin(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"ClientBuilder","l":"sslFactoryPluginParams(String)","u":"sslFactoryPluginParams(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"ClientBuilder","l":"sslProvider(String)","u":"sslProvider(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"Authentication","l":"start()"},{"p":"org.apache.pulsar.client.api.transaction","c":"TransactionCoordinatorClient","l":"start()"},{"p":"org.apache.pulsar.client.api.transaction","c":"TransactionCoordinatorClient","l":"startAsync()"},{"p":"org.apache.pulsar.client.api.transaction","c":"TransactionCoordinatorClient.State","l":"STARTING"},{"p":"org.apache.pulsar.client.api","c":"ClientBuilder","l":"startingBackoffInterval(long, TimeUnit)","u":"startingBackoffInterval(long,java.util.concurrent.TimeUnit)"},{"p":"org.apache.pulsar.client.api","c":"ReaderBuilder","l":"startMessageFromRollbackDuration(long, TimeUnit)","u":"startMessageFromRollbackDuration(long,java.util.concurrent.TimeUnit)"},{"p":"org.apache.pulsar.client.api","c":"ReaderBuilder","l":"startMessageId(MessageId)","u":"startMessageId(org.apache.pulsar.client.api.MessageId)"},{"p":"org.apache.pulsar.client.api","c":"ConsumerBuilder","l":"startMessageIdInclusive()"},{"p":"org.apache.pulsar.client.api","c":"ReaderBuilder","l":"startMessageIdInclusive()"},{"p":"org.apache.pulsar.client.api","c":"ConsumerBuilder","l":"startPaused(boolean)"},{"p":"org.apache.pulsar.client.api","c":"ClientBuilder","l":"statsInterval(long, TimeUnit)","u":"statsInterval(long,java.util.concurrent.TimeUnit)"},{"p":"org.apache.pulsar.client.api","c":"KeySharedMode","l":"STICKY"},{"p":"org.apache.pulsar.client.api","c":"KeySharedPolicy","l":"stickyHashRange()"},{"p":"org.apache.pulsar.common.schema","c":"SchemaType","l":"STRING"},{"p":"org.apache.pulsar.client.api","c":"Schema","l":"STRING"},{"p":"org.apache.pulsar.client.api","c":"ConsumerBuilder","l":"subscribe()"},{"p":"org.apache.pulsar.client.api","c":"ConsumerBuilder","l":"subscribeAsync()"},{"p":"org.apache.pulsar.client.api","c":"ConsumerBuilder","l":"subscriptionInitialPosition(SubscriptionInitialPosition)","u":"subscriptionInitialPosition(org.apache.pulsar.client.api.SubscriptionInitialPosition)"},{"p":"org.apache.pulsar.client.api","c":"ConsumerBuilder","l":"subscriptionMode(SubscriptionMode)","u":"subscriptionMode(org.apache.pulsar.client.api.SubscriptionMode)"},{"p":"org.apache.pulsar.client.api","c":"ConsumerBuilder","l":"subscriptionName(String)","u":"subscriptionName(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"ReaderBuilder","l":"subscriptionName(String)","u":"subscriptionName(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"TableViewBuilder","l":"subscriptionName(String)","u":"subscriptionName(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException.SubscriptionNotFoundException","l":"SubscriptionNotFoundException(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"ConsumerBuilder","l":"subscriptionProperties(Map)","u":"subscriptionProperties(java.util.Map)"},{"p":"org.apache.pulsar.client.api","c":"ReaderBuilder","l":"subscriptionRolePrefix(String)","u":"subscriptionRolePrefix(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"ConsumerBuilder","l":"subscriptionTopicsMode(RegexSubscriptionMode)","u":"subscriptionTopicsMode(org.apache.pulsar.client.api.RegexSubscriptionMode)"},{"p":"org.apache.pulsar.client.api","c":"ConsumerBuilder","l":"subscriptionType(SubscriptionType)","u":"subscriptionType(org.apache.pulsar.client.api.SubscriptionType)"},{"p":"org.apache.pulsar.client.api","c":"Schema","l":"supportSchemaVersioning()"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException.FailedFeatureCheck","l":"SupportsGetPartitionedMetadataWithoutAutoCreation"},{"p":"org.apache.pulsar.client.api","c":"AutoClusterFailoverBuilder","l":"switchBackDelay(long, TimeUnit)","u":"switchBackDelay(long,java.util.concurrent.TimeUnit)"},{"p":"org.apache.pulsar.common.schema","c":"SchemaType","l":"TIME"},{"p":"org.apache.pulsar.client.api","c":"Schema","l":"TIME"},{"p":"org.apache.pulsar.client.api.transaction","c":"Transaction.State","l":"TIME_OUT"},{"p":"org.apache.pulsar.client.api","c":"BatchReceivePolicy.Builder","l":"timeout(int, TimeUnit)","u":"timeout(int,java.util.concurrent.TimeUnit)"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException.TimeoutException","l":"TimeoutException(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException.TimeoutException","l":"TimeoutException(String, long)","u":"%3Cinit%3E(java.lang.String,long)"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException.TimeoutException","l":"TimeoutException(Throwable)","u":"%3Cinit%3E(java.lang.Throwable)"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException.TimeoutException","l":"TimeoutException(Throwable, long)","u":"%3Cinit%3E(java.lang.Throwable,long)"},{"p":"org.apache.pulsar.common.schema","c":"SchemaType","l":"TIMESTAMP"},{"p":"org.apache.pulsar.client.api","c":"Schema","l":"TIMESTAMP"},{"p":"org.apache.pulsar.common.schema","c":"SchemaInfo.SchemaInfoBuilder","l":"timestamp(long)"},{"p":"org.apache.pulsar.client.api","c":"AuthenticationFactory","l":"TLS(String, String)","u":"TLS(java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"ClientBuilder","l":"tlsCertificateFilePath(String)","u":"tlsCertificateFilePath(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"ClientBuilder","l":"tlsCiphers(Set)","u":"tlsCiphers(java.util.Set)"},{"p":"org.apache.pulsar.client.api","c":"ClientBuilder","l":"tlsKeyFilePath(String)","u":"tlsKeyFilePath(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"ClientBuilder","l":"tlsKeyStorePassword(String)","u":"tlsKeyStorePassword(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"ClientBuilder","l":"tlsKeyStorePath(String)","u":"tlsKeyStorePath(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"ClientBuilder","l":"tlsKeyStoreType(String)","u":"tlsKeyStoreType(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"ClientBuilder","l":"tlsProtocols(Set)","u":"tlsProtocols(java.util.Set)"},{"p":"org.apache.pulsar.client.api","c":"ClientBuilder","l":"tlsTrustCertsFilePath(String)","u":"tlsTrustCertsFilePath(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"ClientBuilder","l":"tlsTrustStorePassword(String)","u":"tlsTrustStorePassword(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"ClientBuilder","l":"tlsTrustStorePath(String)","u":"tlsTrustStorePath(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"ClientBuilder","l":"tlsTrustStoreType(String)","u":"tlsTrustStoreType(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"MessageId","l":"toByteArray()"},{"p":"org.apache.pulsar.client.api","c":"SizeUnit","l":"toBytes(long)"},{"p":"org.apache.pulsar.client.api","c":"SizeUnit","l":"toGigaBytes(long)"},{"p":"org.apache.pulsar.client.api","c":"AuthenticationFactory","l":"token(String)","u":"token(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"AuthenticationFactory","l":"token(Supplier)","u":"token(java.util.function.Supplier)"},{"p":"org.apache.pulsar.client.api","c":"SizeUnit","l":"toKiloBytes(long)"},{"p":"org.apache.pulsar.client.api","c":"SizeUnit","l":"toMegaBytes(long)"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException.TooManyRequestsException","l":"TooManyRequestsException(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"ProducerBuilder","l":"topic(String)","u":"topic(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"ReaderBuilder","l":"topic(String)","u":"topic(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"TableViewBuilder","l":"topic(String)","u":"topic(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"ConsumerBuilder","l":"topic(String...)","u":"topic(java.lang.String...)"},{"p":"org.apache.pulsar.client.api","c":"ConsumerBuilder","l":"topicConfiguration(Pattern)","u":"topicConfiguration(java.util.regex.Pattern)"},{"p":"org.apache.pulsar.client.api","c":"ConsumerBuilder","l":"topicConfiguration(Pattern, Consumer>)","u":"topicConfiguration(java.util.regex.Pattern,java.util.function.Consumer)"},{"p":"org.apache.pulsar.client.api","c":"ConsumerBuilder","l":"topicConfiguration(String)","u":"topicConfiguration(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"ConsumerBuilder","l":"topicConfiguration(String, Consumer>)","u":"topicConfiguration(java.lang.String,java.util.function.Consumer)"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException.TopicDoesNotExistException","l":"TopicDoesNotExistException(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException.TopicMigrationException","l":"TopicMigrationException(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"ConsumerBuilder","l":"topics(List)","u":"topics(java.util.List)"},{"p":"org.apache.pulsar.client.api","c":"ReaderBuilder","l":"topics(List)","u":"topics(java.util.List)"},{"p":"org.apache.pulsar.client.api","c":"ConsumerBuilder","l":"topicsPattern(Pattern)","u":"topicsPattern(java.util.regex.Pattern)"},{"p":"org.apache.pulsar.client.api","c":"ConsumerBuilder","l":"topicsPattern(String)","u":"topicsPattern(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException.TopicTerminatedException","l":"TopicTerminatedException(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException.TopicTerminatedException","l":"TopicTerminatedException(String, long)","u":"%3Cinit%3E(java.lang.String,long)"},{"p":"org.apache.pulsar.client.api","c":"BatchReceivePolicy","l":"toString()"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException","l":"toString()"},{"p":"org.apache.pulsar.client.api","c":"Range","l":"toString()"},{"p":"org.apache.pulsar.client.api.transaction","c":"TxnID","l":"toString()"},{"p":"org.apache.pulsar.common.schema","c":"KeyValue","l":"toString()"},{"p":"org.apache.pulsar.common.schema","c":"SchemaInfoWithVersion","l":"toString()"},{"p":"org.apache.pulsar.client.api.transaction","c":"TransactionBufferClientException","l":"TransactionBufferClientException(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"org.apache.pulsar.client.api.transaction","c":"TransactionBufferClientException","l":"TransactionBufferClientException(Throwable)","u":"%3Cinit%3E(java.lang.Throwable)"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException.TransactionConflictException","l":"TransactionConflictException(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException.TransactionConflictException","l":"TransactionConflictException(Throwable)","u":"%3Cinit%3E(java.lang.Throwable)"},{"p":"org.apache.pulsar.client.api.transaction","c":"TransactionCoordinatorClientException","l":"TransactionCoordinatorClientException(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"org.apache.pulsar.client.api.transaction","c":"TransactionCoordinatorClientException","l":"TransactionCoordinatorClientException(Throwable)","u":"%3Cinit%3E(java.lang.Throwable)"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException.TransactionHasOperationFailedException","l":"TransactionHasOperationFailedException()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException.TransactionHasOperationFailedException","l":"TransactionHasOperationFailedException(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"org.apache.pulsar.client.api.transaction","c":"TransactionCoordinatorClientException.TransactionNotFoundException","l":"TransactionNotFoundException(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"org.apache.pulsar.client.api.transaction","c":"TxnID","l":"TxnID(long, long)","u":"%3Cinit%3E(long,long)"},{"p":"org.apache.pulsar.client.api.schema","c":"FieldSchemaBuilder","l":"type(SchemaType)","u":"type(org.apache.pulsar.common.schema.SchemaType)"},{"p":"org.apache.pulsar.common.schema","c":"SchemaInfo.SchemaInfoBuilder","l":"type(SchemaType)","u":"type(org.apache.pulsar.common.schema.SchemaType)"},{"p":"org.apache.pulsar.client.api","c":"Consumer","l":"unsubscribe()"},{"p":"org.apache.pulsar.client.api","c":"Consumer","l":"unsubscribe(boolean)"},{"p":"org.apache.pulsar.client.api","c":"Consumer","l":"unsubscribeAsync()"},{"p":"org.apache.pulsar.client.api","c":"Consumer","l":"unsubscribeAsync(boolean)"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException.UnsupportedAuthenticationException","l":"UnsupportedAuthenticationException(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException.UnsupportedAuthenticationException","l":"UnsupportedAuthenticationException(Throwable)","u":"%3Cinit%3E(java.lang.Throwable)"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException","l":"unwrap(Throwable)","u":"unwrap(java.lang.Throwable)"},{"p":"org.apache.pulsar.client.api.transaction","c":"TransactionBufferClientException","l":"unwrap(Throwable)","u":"unwrap(java.lang.Throwable)"},{"p":"org.apache.pulsar.client.api.transaction","c":"TransactionCoordinatorClientException","l":"unwrap(Throwable)","u":"unwrap(java.lang.Throwable)"},{"p":"org.apache.pulsar.client.api","c":"PulsarClient","l":"updateServiceUrl(String)","u":"updateServiceUrl(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"ControlledClusterFailoverBuilder","l":"urlProvider(String)","u":"urlProvider(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"ControlledClusterFailoverBuilder","l":"urlProviderHeader(Map)","u":"urlProviderHeader(java.util.Map)"},{"p":"org.apache.pulsar.client.api","c":"ClientBuilder","l":"useKeyStoreTls(boolean)"},{"p":"org.apache.pulsar.client.api","c":"KeySharedPolicy.KeySharedPolicyAutoSplit","l":"validate()"},{"p":"org.apache.pulsar.client.api","c":"KeySharedPolicy.KeySharedPolicySticky","l":"validate()"},{"p":"org.apache.pulsar.client.api","c":"KeySharedPolicy","l":"validate()"},{"p":"org.apache.pulsar.client.api","c":"Schema","l":"validate(byte[])"},{"p":"org.apache.pulsar.client.api","c":"TypedMessageBuilder","l":"value(T)"},{"p":"org.apache.pulsar.common.schema","c":"SchemaType","l":"valueOf(int)"},{"p":"org.apache.pulsar.client.api","c":"AutoClusterFailoverBuilder.FailoverPolicy","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"CompressionType","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"ConsumerCryptoFailureAction","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"HashingScheme","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"KeySharedMode","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"MessageRoutingMode","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"ProducerAccessMode","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"ProducerCryptoFailureAction","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"ProxyProtocol","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException.FailedFeatureCheck","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"RegexSubscriptionMode","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"SizeUnit","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"SubscriptionInitialPosition","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"SubscriptionMode","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"SubscriptionType","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"org.apache.pulsar.client.api.transaction","c":"Transaction.State","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"org.apache.pulsar.client.api.transaction","c":"TransactionCoordinatorClient.State","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"TransactionIsolationLevel","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"org.apache.pulsar.common.schema","c":"KeyValueEncodingType","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"org.apache.pulsar.common.schema","c":"SchemaType","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"org.apache.pulsar.client.api","c":"AutoClusterFailoverBuilder.FailoverPolicy","l":"values()"},{"p":"org.apache.pulsar.client.api","c":"CompressionType","l":"values()"},{"p":"org.apache.pulsar.client.api","c":"ConsumerCryptoFailureAction","l":"values()"},{"p":"org.apache.pulsar.client.api","c":"HashingScheme","l":"values()"},{"p":"org.apache.pulsar.client.api","c":"KeySharedMode","l":"values()"},{"p":"org.apache.pulsar.client.api","c":"MessageRoutingMode","l":"values()"},{"p":"org.apache.pulsar.client.api","c":"ProducerAccessMode","l":"values()"},{"p":"org.apache.pulsar.client.api","c":"ProducerCryptoFailureAction","l":"values()"},{"p":"org.apache.pulsar.client.api","c":"ProxyProtocol","l":"values()"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException.FailedFeatureCheck","l":"values()"},{"p":"org.apache.pulsar.client.api","c":"RegexSubscriptionMode","l":"values()"},{"p":"org.apache.pulsar.client.api","c":"SizeUnit","l":"values()"},{"p":"org.apache.pulsar.client.api","c":"SubscriptionInitialPosition","l":"values()"},{"p":"org.apache.pulsar.client.api","c":"SubscriptionMode","l":"values()"},{"p":"org.apache.pulsar.client.api","c":"SubscriptionType","l":"values()"},{"p":"org.apache.pulsar.client.api","c":"TableView","l":"values()"},{"p":"org.apache.pulsar.client.api.transaction","c":"Transaction.State","l":"values()"},{"p":"org.apache.pulsar.client.api.transaction","c":"TransactionCoordinatorClient.State","l":"values()"},{"p":"org.apache.pulsar.client.api","c":"TransactionIsolationLevel","l":"values()"},{"p":"org.apache.pulsar.common.schema","c":"KeyValueEncodingType","l":"values()"},{"p":"org.apache.pulsar.common.schema","c":"SchemaType","l":"values()"},{"p":"org.apache.pulsar.client.api","c":"BatchReceivePolicy","l":"verify()"},{"p":"org.apache.pulsar.client.api","c":"ProducerAccessMode","l":"WaitForExclusive"},{"p":"org.apache.pulsar.client.api.schema","c":"SchemaDefinitionBuilder","l":"withAlwaysAllowNull(boolean)"},{"p":"org.apache.pulsar.client.api.schema","c":"SchemaDefinitionBuilder","l":"withClassLoader(ClassLoader)","u":"withClassLoader(java.lang.ClassLoader)"},{"p":"org.apache.pulsar.client.api.schema","c":"SchemaDefinitionBuilder","l":"withJsonDef(String)","u":"withJsonDef(java.lang.String)"},{"p":"org.apache.pulsar.client.api.schema","c":"SchemaDefinitionBuilder","l":"withJSR310ConversionEnabled(boolean)"},{"p":"org.apache.pulsar.client.api.schema","c":"SchemaDefinitionBuilder","l":"withPojo(Class)","u":"withPojo(java.lang.Class)"},{"p":"org.apache.pulsar.client.api.schema","c":"SchemaDefinitionBuilder","l":"withProperties(Map)","u":"withProperties(java.util.Map)"},{"p":"org.apache.pulsar.client.api.schema","c":"SchemaDefinitionBuilder","l":"withSchemaReader(SchemaReader)","u":"withSchemaReader(org.apache.pulsar.client.api.schema.SchemaReader)"},{"p":"org.apache.pulsar.client.api.schema","c":"SchemaDefinitionBuilder","l":"withSchemaWriter(SchemaWriter)","u":"withSchemaWriter(org.apache.pulsar.client.api.schema.SchemaWriter)"},{"p":"org.apache.pulsar.client.api.schema","c":"SchemaDefinitionBuilder","l":"withSupportSchemaVersioning(boolean)"},{"p":"org.apache.pulsar.client.api.transaction","c":"TransactionBuilder","l":"withTransactionTimeout(long, TimeUnit)","u":"withTransactionTimeout(long,java.util.concurrent.TimeUnit)"},{"p":"org.apache.pulsar.client.api","c":"MessagePayloadFactory","l":"wrap(byte[])"},{"p":"org.apache.pulsar.client.api","c":"MessagePayloadFactory","l":"wrap(ByteBuffer)","u":"wrap(java.nio.ByteBuffer)"},{"p":"org.apache.pulsar.client.api","c":"PulsarClientException","l":"wrap(Throwable, String)","u":"wrap(java.lang.Throwable,java.lang.String)"},{"p":"org.apache.pulsar.client.api.schema","c":"SchemaWriter","l":"write(T)"},{"p":"org.apache.pulsar.client.api","c":"CompressionType","l":"ZLIB"},{"p":"org.apache.pulsar.client.api","c":"CompressionType","l":"ZSTD"}];updateSearchResults(); \ No newline at end of file diff --git a/static/api/client/4.0.x/module-search-index.js b/static/api/client/4.0.x/module-search-index.js new file mode 100644 index 000000000000..0d59754fc4ad --- /dev/null +++ b/static/api/client/4.0.x/module-search-index.js @@ -0,0 +1 @@ +moduleSearchIndex = [];updateSearchResults(); \ No newline at end of file diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/Authentication.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/Authentication.html new file mode 100644 index 000000000000..2c422c9355c8 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/Authentication.html @@ -0,0 +1,280 @@ + + + + +Authentication (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Interface Authentication

    +
    +
    +
    +
    All Superinterfaces:
    +
    AutoCloseable, Closeable, Serializable
    +
    +
    +
    @LimitedPrivate +@Stable +public interface Authentication +extends Closeable, Serializable
    +
    Interface of authentication providers.
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Method Details

      + +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/AuthenticationDataProvider.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/AuthenticationDataProvider.html new file mode 100644 index 000000000000..03a0996ef4fc --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/AuthenticationDataProvider.html @@ -0,0 +1,379 @@ + + + + +AuthenticationDataProvider (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Interface AuthenticationDataProvider

    +
    +
    +
    +
    All Superinterfaces:
    +
    Serializable
    +
    +
    +
    @LimitedPrivate +@Stable +public interface AuthenticationDataProvider +extends Serializable
    +
    Interface for accessing data which are used in variety of authentication schemes on client side.
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Field Details

      + +
      +
      • + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        hasDataForTls

        +
        default boolean hasDataForTls()
        +
        Check if data for TLS are available.
        +
        +
        Returns:
        +
        true if this authentication data contain data for TLS
        +
        +
        +
        • +
      • +
        +

        getTlsCertificates

        +
        default Certificate[] getTlsCertificates()
        +
        +
        Returns:
        +
        a client certificate chain, or null if the data are not available
        +
        +
        +
        • +
      • +
        +

        getTlsCertificateFilePath

        +
        default String getTlsCertificateFilePath()
        +
        +
        Returns:
        +
        a client certificate file path
        +
        +
        +
        • +
      • +
        +

        getTlsPrivateKey

        +
        default PrivateKey getTlsPrivateKey()
        +
        +
        Returns:
        +
        a private key for the client certificate, or null if the data are not available
        +
        +
        +
        • +
      • +
        +

        getTlsPrivateKeyFilePath

        +
        default String getTlsPrivateKeyFilePath()
        +
        +
        Returns:
        +
        a private key file path
        +
        +
        +
        • +
      • +
        +

        getTlsTrustStoreStream

        +
        default InputStream getTlsTrustStoreStream()
        +
        +
        Returns:
        +
        an input-stream of the trust store, or null if the trust-store provided at + +
        +invalid reference +
        ClientConfigurationData#getTlsTrustStorePath()
        +
        +
        +
        +
        +
        • +
      • +
        +

        getTlsKeyStoreParams

        +
        default KeyStoreParams getTlsKeyStoreParams()
        +
        Used for TLS authentication with keystore type.
        +
        +
        Returns:
        +
        a KeyStoreParams for the client certificate chain, or null if the data are not available
        +
        +
        +
        • +
      • +
        +

        hasDataForHttp

        +
        default boolean hasDataForHttp()
        +
        Check if data for HTTP are available.
        +
        +
        Returns:
        +
        true if this authentication data contain data for HTTP
        +
        +
        +
        • +
      • +
        +

        getHttpAuthType

        +
        default String getHttpAuthType()
        +
        +
        Returns:
        +
        a authentication scheme, or null if the request will not be authenticated.
        +
        +
        +
        • +
      • +
        +

        getHttpHeaders

        +
        default Set<Map.Entry<String,String>> getHttpHeaders() + throws Exception
        +
        +
        Returns:
        +
        an enumeration of all the header names
        +
        Throws:
        +
        Exception
        +
        +
        +
        • +
      • +
        +

        hasDataFromCommand

        +
        default boolean hasDataFromCommand()
        +
        Check if data from Pulsar protocol are available.
        +
        +
        Returns:
        +
        true if this authentication data contain data from Pulsar protocol
        +
        +
        +
        • +
      • +
        +

        getCommandData

        +
        default String getCommandData()
        +
        +
        Returns:
        +
        authentication data which will be stored in a command
        +
        +
        +
        • +
      • +
        +

        authenticate

        +
        default AuthData authenticate(AuthData data) + throws AuthenticationException
        +
        For mutual authentication, This method use passed in `data` to evaluate and challenge, + then returns null if authentication has completed; + returns authenticated data back to server side, if authentication has not completed. + +

        Mainly used for mutual authentication like sasl.

        +
        +
        Throws:
        +
        AuthenticationException
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/AuthenticationFactory.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/AuthenticationFactory.html new file mode 100644 index 000000000000..ed7c55acefd1 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/AuthenticationFactory.html @@ -0,0 +1,279 @@ + + + + +AuthenticationFactory (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Class AuthenticationFactory

    +
    +
    java.lang.Object +
    org.apache.pulsar.client.api.AuthenticationFactory
    +
    +
    +
    +
    @LimitedPrivate +@Stable +public final class AuthenticationFactory +extends Object
    +
    Factory class that allows to create Authentication instances + for all the supported authentication methods.
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        AuthenticationFactory

        +
        public AuthenticationFactory()
        +
        +
        • +
      +
      +
      • + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        token

        +
        public static Authentication token(String token)
        +
        Create an authentication provider for token based authentication.
        +
        +
        Parameters:
        +
        token - the client auth token
        +
        Returns:
        +
        the Authentication object initialized with the token credentials
        +
        +
        +
        • +
      • +
        +

        token

        +
        public static Authentication token(Supplier<String> tokenSupplier)
        +
        Create an authentication provider for token based authentication.
        +
        +
        Parameters:
        +
        tokenSupplier - a supplier of the client auth token
        +
        Returns:
        +
        the Authentication object initialized with the token credentials
        +
        +
        +
        • +
      • +
        +

        TLS

        +
        public static Authentication TLS(String certFilePath, + String keyFilePath)
        +
        Create an authentication provider for TLS based authentication.
        +
        +
        Parameters:
        +
        certFilePath - the path to the TLS client public key
        +
        keyFilePath - the path to the TLS client private key
        +
        Returns:
        +
        the Authentication object initialized with the TLS credentials
        +
        +
        +
        • +
      • +
        +

        create

        +
        public static Authentication create(String authPluginClassName, + String authParamsString) + throws PulsarClientException.UnsupportedAuthenticationException
        +
        Create an instance of the Authentication object by using + the plugin class name.
        +
        +
        Parameters:
        +
        authPluginClassName - name of the Authentication-Plugin you want to use
        +
        authParamsString - string which represents parameters for the Authentication-Plugin, e.g., "key1:val1,key2:val2"
        +
        Returns:
        +
        instance of the Authentication object
        +
        Throws:
        +
        PulsarClientException.UnsupportedAuthenticationException
        +
        +
        +
        • +
      • +
        +

        create

        +
        public static Authentication create(String authPluginClassName, + Map<String,String> authParams) + throws PulsarClientException.UnsupportedAuthenticationException
        +
        Create an instance of the Authentication-Plugin.
        +
        +
        Parameters:
        +
        authPluginClassName - name of the Authentication-Plugin you want to use
        +
        authParams - map which represents parameters for the Authentication-Plugin
        +
        Returns:
        +
        instance of the Authentication-Plugin
        +
        Throws:
        +
        PulsarClientException.UnsupportedAuthenticationException
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/AutoClusterFailoverBuilder.FailoverPolicy.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/AutoClusterFailoverBuilder.FailoverPolicy.html new file mode 100644 index 000000000000..4f2636bd1d0e --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/AutoClusterFailoverBuilder.FailoverPolicy.html @@ -0,0 +1,232 @@ + + + + +AutoClusterFailoverBuilder.FailoverPolicy (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Enum Class AutoClusterFailoverBuilder.FailoverPolicy

    +
    +
    java.lang.Object +
    java.lang.Enum<AutoClusterFailoverBuilder.FailoverPolicy> +
    org.apache.pulsar.client.api.AutoClusterFailoverBuilder.FailoverPolicy
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable, Comparable<AutoClusterFailoverBuilder.FailoverPolicy>, Constable
    +
    +
    +
    Enclosing interface:
    +
    AutoClusterFailoverBuilder
    +
    +
    +
    public static enum AutoClusterFailoverBuilder.FailoverPolicy +extends Enum<AutoClusterFailoverBuilder.FailoverPolicy>
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Enum Constant Details

      + +
      +
      • + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        values

        +
        public static AutoClusterFailoverBuilder.FailoverPolicy[] values()
        +
        Returns an array containing the constants of this enum class, in +the order they are declared.
        +
        +
        Returns:
        +
        an array containing the constants of this enum class, in the order they are declared
        +
        +
        +
        • +
      • +
        +

        valueOf

        +
        public static AutoClusterFailoverBuilder.FailoverPolicy valueOf(String name)
        +
        Returns the enum constant of this class with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this class. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        IllegalArgumentException - if this enum class has no constant with the specified name
        +
        NullPointerException - if the argument is null
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/AutoClusterFailoverBuilder.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/AutoClusterFailoverBuilder.html new file mode 100644 index 000000000000..59a3146831c9 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/AutoClusterFailoverBuilder.html @@ -0,0 +1,351 @@ + + + + +AutoClusterFailoverBuilder (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Interface AutoClusterFailoverBuilder

    +
    +
    +
    +
    @Public +@Evolving +public interface AutoClusterFailoverBuilder
    +
    AutoClusterFailoverBuilder is used to configure and create instance of ServiceUrlProvider.
    +
    +
    Since:
    +
    2.10.0
    +
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        primary

        +
        AutoClusterFailoverBuilder primary(String primary)
        +
        Set the primary service url.
        +
        +
        Parameters:
        +
        primary -
        +
        Returns:
        +
        +
        +
        • +
      • +
        +

        secondary

        +
        AutoClusterFailoverBuilder secondary(List<String> secondary)
        +
        Set the secondary service url.
        +
        +
        Parameters:
        +
        secondary -
        +
        Returns:
        +
        +
        +
        • +
      • +
        +

        failoverPolicy

        +
        AutoClusterFailoverBuilder failoverPolicy(AutoClusterFailoverBuilder.FailoverPolicy policy)
        +
        Set secondary choose policy. The default secondary choose policy is `ORDER`.
        +
        +
        Parameters:
        +
        policy -
        +
        Returns:
        +
        +
        +
        • +
      • +
        +

        secondaryAuthentication

        +
        AutoClusterFailoverBuilder secondaryAuthentication(Map<String,Authentication> authentication)
        +
        Set secondary authentication.
        +
        +
        Parameters:
        +
        authentication -
        +
        Returns:
        +
        +
        +
        • +
      • +
        +

        secondaryTlsTrustCertsFilePath

        +
        AutoClusterFailoverBuilder secondaryTlsTrustCertsFilePath(Map<String,String> tlsTrustCertsFilePath)
        +
        Set secondary tlsTrustCertsFilePath.
        +
        +
        Parameters:
        +
        tlsTrustCertsFilePath -
        +
        Returns:
        +
        +
        +
        • +
      • +
        +

        secondaryTlsTrustStorePath

        +
        AutoClusterFailoverBuilder secondaryTlsTrustStorePath(Map<String,String> tlsTrustStorePath)
        +
        Set secondary tlsTrustStorePath.
        +
        +
        Parameters:
        +
        tlsTrustStorePath -
        +
        Returns:
        +
        +
        +
        • +
      • +
        +

        secondaryTlsTrustStorePassword

        +
        AutoClusterFailoverBuilder secondaryTlsTrustStorePassword(Map<String,String> tlsTrustStorePassword)
        +
        Set secondary tlsTrustStorePassword.
        +
        +
        Parameters:
        +
        tlsTrustStorePassword -
        +
        Returns:
        +
        +
        +
        • +
      • +
        +

        failoverDelay

        +
        AutoClusterFailoverBuilder failoverDelay(long failoverDelay, + TimeUnit timeUnit)
        +
        Set the switch failoverDelay. When one cluster failed longer than failoverDelay, it will trigger cluster switch.
        +
        +
        Parameters:
        +
        failoverDelay -
        +
        timeUnit -
        +
        Returns:
        +
        +
        +
        • +
      • +
        +

        switchBackDelay

        +
        AutoClusterFailoverBuilder switchBackDelay(long switchBackDelay, + TimeUnit timeUnit)
        +
        Set the switchBackDelay. When switched to the secondary cluster, and after the primary cluster comes back, + it will wait for switchBackDelay to switch back to the primary cluster.
        +
        +
        Parameters:
        +
        switchBackDelay -
        +
        timeUnit -
        +
        Returns:
        +
        +
        +
        • +
      • +
        +

        checkInterval

        +
        AutoClusterFailoverBuilder checkInterval(long interval, + TimeUnit timeUnit)
        +
        Set the checkInterval for probe.
        +
        +
        Parameters:
        +
        interval -
        +
        timeUnit -
        +
        Returns:
        +
        +
        +
        • +
      • +
        +

        build

        +
        ServiceUrlProvider build()
        +
        Build the ServiceUrlProvider instance.
        +
        +
        Returns:
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/BatchMessageContainer.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/BatchMessageContainer.html new file mode 100644 index 000000000000..9765de8c853a --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/BatchMessageContainer.html @@ -0,0 +1,244 @@ + + + + +BatchMessageContainer (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Interface BatchMessageContainer

    +
    +
    +
    +
    @Public +@Stable +public interface BatchMessageContainer
    +
    Batch message container for individual messages being published until they are batched and sent to broker.
    +
    +
    +
      + +
    • +
      +

      Method Summary

      +
      +
      +
      +
      +
      Modifier and Type
      +
      Method
      +
      Description
      +
      void
      +
      clear()
      +
      +
      Clear the message batch container.
      +
      +
      void
      +
      discard(Exception ex)
      +
      +
      Release the payload and clear the container.
      +
      +
      int
      +
      getBatchAllocatedSizeBytes()
      +
      +
      Get current allocated buffer size of the message batch container in bytes.
      +
      +
      long
      +
      getCurrentBatchSize()
      +
      +
      Get current message batch size of the message batch container in bytes.
      +
      +
      int
      +
      getNumMessagesInBatch()
      +
      +
      Get count of messages in the message batch container.
      +
      +
      boolean
      +
      isEmpty()
      +
      +
      Check the message batch container is empty.
      +
      +
      boolean
      +
      isMultiBatches()
      +
      +
      Return the batch container batch message in multiple batches.
      +
      +
      +
      +
      +
      +
      • +
    +
    +
    +
      + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        clear

        +
        void clear()
        +
        Clear the message batch container.
        +
        +
        • +
      • +
        +

        isEmpty

        +
        boolean isEmpty()
        +
        Check the message batch container is empty.
        +
        +
        Returns:
        +
        return true if empty, otherwise return false.
        +
        +
        +
        • +
      • +
        +

        getNumMessagesInBatch

        +
        int getNumMessagesInBatch()
        +
        Get count of messages in the message batch container.
        +
        +
        Returns:
        +
        messages count
        +
        +
        +
        • +
      • +
        +

        getCurrentBatchSize

        +
        long getCurrentBatchSize()
        +
        Get current message batch size of the message batch container in bytes.
        +
        +
        Returns:
        +
        message batch size in bytes
        +
        +
        +
        • +
      • +
        +

        getBatchAllocatedSizeBytes

        +
        int getBatchAllocatedSizeBytes()
        +
        Get current allocated buffer size of the message batch container in bytes.
        +
        +
        Returns:
        +
        allocated buffer size in bytes
        +
        +
        +
        • +
      • +
        +

        discard

        +
        void discard(Exception ex)
        +
        Release the payload and clear the container.
        +
        +
        Parameters:
        +
        ex - cause
        +
        +
        +
        • +
      • +
        +

        isMultiBatches

        +
        boolean isMultiBatches()
        +
        Return the batch container batch message in multiple batches.
        +
        +
        Returns:
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/BatchReceivePolicy.Builder.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/BatchReceivePolicy.Builder.html new file mode 100644 index 000000000000..f2424c97669a --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/BatchReceivePolicy.Builder.html @@ -0,0 +1,220 @@ + + + + +BatchReceivePolicy.Builder (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Class BatchReceivePolicy.Builder

    +
    +
    java.lang.Object +
    org.apache.pulsar.client.api.BatchReceivePolicy.Builder
    +
    +
    +
    +
    Enclosing class:
    +
    BatchReceivePolicy
    +
    +
    +
    public static class BatchReceivePolicy.Builder +extends Object
    +
    Builder of BatchReceivePolicy.
    +
    +
    + +
    +
    + +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/BatchReceivePolicy.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/BatchReceivePolicy.html new file mode 100644 index 000000000000..9f7fb7d8786a --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/BatchReceivePolicy.html @@ -0,0 +1,304 @@ + + + + +BatchReceivePolicy (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Class BatchReceivePolicy

    +
    +
    java.lang.Object +
    org.apache.pulsar.client.api.BatchReceivePolicy
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable
    +
    +
    +
    @Public +@Stable +public class BatchReceivePolicy +extends Object +implements Serializable
    +
    Configuration for message batch receive Consumer.batchReceive() Consumer.batchReceiveAsync(). + +

    Batch receive policy can limit the number and bytes of messages in a single batch, and can specify a timeout + for waiting for enough messages for this batch. + +

    This batch receive will be completed as long as any one of the + conditions(has enough number of messages, has enough of size of messages, wait timeout) is met. + +

    Examples: + 1.If set maxNumMessages = 10, maxSizeOfMessages = 1MB and without timeout, it + means Consumer.batchReceive() will always wait until there is enough messages. + 2.If set maxNumberOfMessages = 0, maxNumBytes = 0 and timeout = 100ms, it + means Consumer.batchReceive() will waiting for 100ms whether or not there is enough messages. + +

    Note: + Must specify messages limitation(maxNumMessages, maxNumBytes) or wait timeout. + Otherwise, Messages ingest Message will never end.

    +
    +
    Since:
    +
    2.4.1
    +
    See Also:
    +
    + +
    +
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Field Details

      +
        +
      • +
        +

        DEFAULT_POLICY

        +
        public static final BatchReceivePolicy DEFAULT_POLICY
        +
        Default batch receive policy. + +

        Max number of messages: no limit + Max number of bytes: 10MB + Timeout: 100ms

        +
        +
        • +
      • +
        +

        DEFAULT_MULTI_TOPICS_DISABLE_POLICY

        +
        public static final BatchReceivePolicy DEFAULT_MULTI_TOPICS_DISABLE_POLICY
        +
        +
        • +
      +
      +
      • + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        verify

        +
        public void verify()
        +
        +
        • +
      • +
        +

        getTimeoutMs

        +
        public long getTimeoutMs()
        +
        +
        • +
      • +
        +

        getMaxNumMessages

        +
        public int getMaxNumMessages()
        +
        +
        • +
      • +
        +

        getMaxNumBytes

        +
        public int getMaxNumBytes()
        +
        +
        • +
      • +
        +

        isMessagesFromMultiTopicsEnabled

        +
        public boolean isMessagesFromMultiTopicsEnabled()
        +
        +
        • +
      • +
        +

        builder

        +
        public static BatchReceivePolicy.Builder builder()
        +
        +
        • +
      • +
        +

        toString

        +
        public String toString()
        +
        +
        Overrides:
        +
        toString in class Object
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/BatcherBuilder.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/BatcherBuilder.html new file mode 100644 index 000000000000..4327c9f73396 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/BatcherBuilder.html @@ -0,0 +1,214 @@ + + + + +BatcherBuilder (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Interface BatcherBuilder

    +
    +
    +
    +
    All Superinterfaces:
    +
    Serializable
    +
    +
    +
    @Public +@Stable +public interface BatcherBuilder +extends Serializable
    +
    Batcher builder.
    +
    +
    +
      + +
    • +
      +

      Field Summary

      +
      Fields
      +
      +
      Modifier and Type
      +
      Field
      +
      Description
      +
      static final BatcherBuilder
      +
      DEFAULT
      +
      +
      Default batch message container.
      +
      +
      static final BatcherBuilder
      +
      KEY_BASED
      +
      +
      Key based batch message container.
      +
      +
      +
      +
      • + +
    • +
      +

      Method Summary

      +
      +
      +
      +
      +
      Modifier and Type
      +
      Method
      +
      Description
      +
      BatchMessageContainer
      +
      build()
      +
      +
      Build a new batch message container.
      +
      +
      +
      +
      +
      +
      • +
    +
    +
    +
      + +
    • +
      +

      Field Details

      +
        +
      • +
        +

        DEFAULT

        +
        static final BatcherBuilder DEFAULT
        +
        Default batch message container. + +

        incoming single messages: + (k1, v1), (k2, v1), (k3, v1), (k1, v2), (k2, v2), (k3, v2), (k1, v3), (k2, v3), (k3, v3) + +

        batched into single batch message: + [(k1, v1), (k2, v1), (k3, v1), (k1, v2), (k2, v2), (k3, v2), (k1, v3), (k2, v3), (k3, v3)]

        +
        +
        • +
      • +
        +

        KEY_BASED

        +
        static final BatcherBuilder KEY_BASED
        +
        Key based batch message container. + +

        incoming single messages: + (k1, v1), (k2, v1), (k3, v1), (k1, v2), (k2, v2), (k3, v2), (k1, v3), (k2, v3), (k3, v3) + +

        batched into multiple batch messages: + [(k1, v1), (k1, v2), (k1, v3)], [(k2, v1), (k2, v2), (k2, v3)], [(k3, v1), (k3, v2), (k3, v3)]

        +
        +
        • +
      +
      +
      • + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        build

        +
        BatchMessageContainer build()
        +
        Build a new batch message container.
        +
        +
        Returns:
        +
        new batch message container
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/ClientBuilder.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/ClientBuilder.html new file mode 100644 index 000000000000..0fb586f5c851 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/ClientBuilder.html @@ -0,0 +1,1378 @@ + + + + +ClientBuilder (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Interface ClientBuilder

    +
    +
    +
    +
    All Superinterfaces:
    +
    Cloneable, Serializable
    +
    +
    +
    @Public +@Stable +public interface ClientBuilder +extends Serializable, Cloneable
    +
    Builder interface that is used to configure and construct a PulsarClient instance.
    +
    +
    Since:
    +
    2.0.0
    +
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        build

        +
        PulsarClient build() + throws PulsarClientException
        +
        Construct the final PulsarClient instance.
        +
        +
        Returns:
        +
        the new PulsarClient instance
        +
        Throws:
        +
        PulsarClientException
        +
        +
        +
        • +
      • +
        +

        loadConf

        +
        ClientBuilder loadConf(Map<String,Object> config)
        +
        Load the configuration from provided config map. + +

        Example: + + 

        + 
+ Map<String, Object> config = new HashMap<>();
+ config.put("serviceUrl", "pulsar://localhost:6650");
+ config.put("numIoThreads", 20);
+
+ ClientBuilder builder = ...;
+ builder = builder.loadConf(config);
+
+ PulsarClient client = builder.build();
+ 
+
        +
        +
        Parameters:
        +
        config - configuration to load
        +
        Returns:
        +
        the client builder instance
        +
        +
        +
        • +
      • +
        +

        clone

        +
        ClientBuilder clone()
        +
        Create a copy of the current client builder. + +

        Cloning the builder can be used to share an incomplete configuration and specialize it multiple times. For + example: + + 

        
+ ClientBuilder builder = PulsarClient.builder()
+               .ioThreads(8)
+               .listenerThreads(4);
+
+ PulsarClient client1 = builder.clone()
+                  .serviceUrl("pulsar://localhost:6650").build();
+ PulsarClient client2 = builder.clone()
+                  .serviceUrl("pulsar://other-host:6650").build();
+
        +
        +
        Returns:
        +
        a clone of the client builder instance
        +
        +
        +
        • +
      • +
        +

        serviceUrl

        +
        ClientBuilder serviceUrl(String serviceUrl)
        +
        Configure the service URL for the Pulsar service. + +

        This parameter is required. + +

        Examples: +

          +
        • pulsar://my-broker:6650 for regular endpoint
          • +
        • pulsar+ssl://my-broker:6651 for TLS encrypted endpoint
          • +
        +
        +
        Parameters:
        +
        serviceUrl - the URL of the Pulsar service that the client should connect to
        +
        Returns:
        +
        the client builder instance
        +
        +
        +
        • +
      • +
        +

        serviceUrlProvider

        +
        ClientBuilder serviceUrlProvider(ServiceUrlProvider serviceUrlProvider)
        +
        Configure the service URL provider for Pulsar service. + +

        Instead of specifying a static service URL string (with serviceUrl(String)), an application + can pass a ServiceUrlProvider instance that dynamically provide a service URL.

        +
        +
        Parameters:
        +
        serviceUrlProvider - the provider instance
        +
        Returns:
        +
        the client builder instance
        +
        +
        +
        • +
      • +
        +

        listenerName

        +
        ClientBuilder listenerName(String name)
        +
        Configure the listenerName that the broker will return the corresponding `advertisedListener`.
        +
        +
        Parameters:
        +
        name - the listener name
        +
        Returns:
        +
        the client builder instance
        +
        +
        +
        • +
      • +
        +

        connectionMaxIdleSeconds

        +
        ClientBuilder connectionMaxIdleSeconds(int connectionMaxIdleSeconds)
        +
        Release the connection if it is not used for more than seconds. + Defaults to 25 seconds.
        +
        +
        Returns:
        +
        the client builder instance
        +
        +
        +
        • +
      • +
        +

        authentication

        +
        ClientBuilder authentication(Authentication authentication)
        +
        Set the authentication provider to use in the Pulsar client instance. + +

        Example: + 

        
+ PulsarClient client = PulsarClient.builder()
+         .serviceUrl("pulsar+ssl://broker.example.com:6651/")
+         .authentication(
+               AuthenticationFactory.TLS("/my/cert/file", "/my/key/file")
+         .build();
+
        + +

        For token based authentication, this will look like: + 

        
+ AuthenticationFactory
+      .token("eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJKb2UifQ.ipevRNuRP6HflG8cFKnmUPtypruRC4fb1DWtoLL62SY")
+
        +
        +
        Parameters:
        +
        authentication - an instance of the Authentication provider already constructed
        +
        Returns:
        +
        the client builder instance
        +
        +
        +
        • +
      • +
        +

        authentication

        +
        ClientBuilder authentication(String authPluginClassName, + String authParamsString) + throws PulsarClientException.UnsupportedAuthenticationException
        +
        Configure the authentication provider to use in the Pulsar client instance. + +

        Example: + 

        + 
+ PulsarClient client = PulsarClient.builder()
+          .serviceUrl("pulsar+ssl://broker.example.com:6651/)
+          .authentication(
+              "org.apache.pulsar.client.impl.auth.AuthenticationTls",
+              "tlsCertFile:/my/cert/file,tlsKeyFile:/my/key/file")
+          .build();
+ 
+
        +
        +
        Parameters:
        +
        authPluginClassName - name of the Authentication-Plugin you want to use
        +
        authParamsString - string which represents parameters for the Authentication-Plugin, e.g., "key1:val1,key2:val2"
        +
        Returns:
        +
        the client builder instance
        +
        Throws:
        +
        PulsarClientException.UnsupportedAuthenticationException - failed to instantiate specified Authentication-Plugin
        +
        +
        +
        • +
      • +
        +

        authentication

        +
        ClientBuilder authentication(String authPluginClassName, + Map<String,String> authParams) + throws PulsarClientException.UnsupportedAuthenticationException
        +
        Configure the authentication provider to use in the Pulsar client instance + using a config map. + +

        Example: + 

        
+ Map<String, String> conf = new TreeMap<>();
+ conf.put("tlsCertFile", "/my/cert/file");
+ conf.put("tlsKeyFile", "/my/key/file");
+
+ PulsarClient client = PulsarClient.builder()
+          .serviceUrl("pulsar+ssl://broker.example.com:6651/)
+          .authentication(
+              "org.apache.pulsar.client.impl.auth.AuthenticationTls", conf)
+          .build();
+
        +
        +
        Parameters:
        +
        authPluginClassName - name of the Authentication-Plugin you want to use
        +
        authParams - map which represents parameters for the Authentication-Plugin
        +
        Returns:
        +
        the client builder instance
        +
        Throws:
        +
        PulsarClientException.UnsupportedAuthenticationException - failed to instantiate specified Authentication-Plugin
        +
        +
        +
        • +
      • +
        +

        operationTimeout

        +
        ClientBuilder operationTimeout(int operationTimeout, + TimeUnit unit)
        +
        Set the operation timeout (default: 30 seconds). + +

        Producer-create, subscribe and unsubscribe operations will be retried until this interval, after which the + operation will be marked as failed

        +
        +
        Parameters:
        +
        operationTimeout - operation timeout
        +
        unit - time unit for operationTimeout
        +
        Returns:
        +
        the client builder instance
        +
        +
        +
        • +
      • +
        +

        lookupTimeout

        +
        ClientBuilder lookupTimeout(int lookupTimeout, + TimeUnit unit)
        +
        Set lookup timeout (default: matches operation timeout) + +

        + Lookup operations have a different load pattern to other operations. + They can be handled by any broker, are not proportional to throughput, + and are harmless to retry. Given this, it makes sense to allow them to + retry longer than normal operation, especially if they experience a timeout. + +

        + By default, this is set to match operation timeout. This is to maintain legacy behaviour. + However, in practice it should be set to 5-10x the operation timeout.

        +
        +
        Parameters:
        +
        lookupTimeout - lookup timeout
        +
        unit - time unit for lookupTimeout
        +
        Returns:
        +
        the client builder instance
        +
        +
        +
        • +
      • +
        +

        ioThreads

        +
        ClientBuilder ioThreads(int numIoThreads)
        +
        Set the number of threads to be used for handling connections to brokers + (default: Runtime.getRuntime().availableProcessors()).
        +
        +
        Parameters:
        +
        numIoThreads - the number of IO threads
        +
        Returns:
        +
        the client builder instance
        +
        +
        +
        • +
      • +
        +

        listenerThreads

        +
        ClientBuilder listenerThreads(int numListenerThreads)
        +
        Set the number of threads to be used for message listeners + (default: Runtime.getRuntime().availableProcessors()). + +

        The listener thread pool is shared across all the consumers and readers that are + using a "listener" model to get messages. For a given consumer, the listener will + always be invoked from the same thread, to ensure ordering.

        +
        +
        Parameters:
        +
        numListenerThreads - the number of listener threads
        +
        Returns:
        +
        the client builder instance
        +
        +
        +
        • +
      • +
        +

        connectionsPerBroker

        +
        ClientBuilder connectionsPerBroker(int connectionsPerBroker)
        +
        Sets the max number of connection that the client library will open to a single broker. + +

        By default, the connection pool will use a single connection for all the producers and consumers. + Increasing this parameter may improve throughput when using many producers over a high latency connection.

        +
        +
        Parameters:
        +
        connectionsPerBroker - max number of connections per broker (needs to be greater than or equal to 0)
        +
        Returns:
        +
        the client builder instance
        +
        +
        +
        • +
      • +
        +

        enableTcpNoDelay

        +
        ClientBuilder enableTcpNoDelay(boolean enableTcpNoDelay)
        +
        Configure whether to use TCP no-delay flag on the connection, to disable Nagle algorithm. + +

        No-delay features make sure packets are sent out on the network as soon as possible, and it's critical + to achieve low latency publishes. On the other hand, sending out a huge number of small packets + might limit the overall throughput, so if latency is not a concern, + it's advisable to set the useTcpNoDelay flag to false. + +

        Default value is true.

        +
        +
        Parameters:
        +
        enableTcpNoDelay - whether to enable TCP no-delay feature
        +
        Returns:
        +
        the client builder instance
        +
        +
        +
        • +
      • +
        +

        enableTls

        +
        @Deprecated +ClientBuilder enableTls(boolean enableTls)
        +
        Deprecated. +
        use "pulsar+ssl://" in serviceUrl to enable
        +
        +
        Configure whether to use TLS encryption on the connection + (default: true if serviceUrl starts with "pulsar+ssl://", false otherwise).
        +
        +
        Parameters:
        +
        enableTls -
        +
        Returns:
        +
        the client builder instance
        +
        +
        +
        • +
      • +
        +

        tlsKeyFilePath

        +
        ClientBuilder tlsKeyFilePath(String tlsKeyFilePath)
        +
        Set the path to the TLS key file.
        +
        +
        Parameters:
        +
        tlsKeyFilePath -
        +
        Returns:
        +
        the client builder instance
        +
        +
        +
        • +
      • +
        +

        tlsCertificateFilePath

        +
        ClientBuilder tlsCertificateFilePath(String tlsCertificateFilePath)
        +
        Set the path to the TLS certificate file.
        +
        +
        Parameters:
        +
        tlsCertificateFilePath -
        +
        Returns:
        +
        the client builder instance
        +
        +
        +
        • +
      • +
        +

        tlsTrustCertsFilePath

        +
        ClientBuilder tlsTrustCertsFilePath(String tlsTrustCertsFilePath)
        +
        Set the path to the trusted TLS certificate file.
        +
        +
        Parameters:
        +
        tlsTrustCertsFilePath -
        +
        Returns:
        +
        the client builder instance
        +
        +
        +
        • +
      • +
        +

        allowTlsInsecureConnection

        +
        ClientBuilder allowTlsInsecureConnection(boolean allowTlsInsecureConnection)
        +
        Configure whether the Pulsar client accept untrusted TLS certificate from broker (default: false).
        +
        +
        Parameters:
        +
        allowTlsInsecureConnection - whether to accept a untrusted TLS certificate
        +
        Returns:
        +
        the client builder instance
        +
        +
        +
        • +
      • +
        +

        enableTlsHostnameVerification

        +
        ClientBuilder enableTlsHostnameVerification(boolean enableTlsHostnameVerification)
        +
        It allows to validate hostname verification when client connects to broker over tls. It validates incoming x509 + certificate and matches provided hostname(CN/SAN) with expected broker's host name. It follows RFC 2818, 3.1. + Server Identity hostname verification.
        +
        +
        Parameters:
        +
        enableTlsHostnameVerification - whether to enable TLS hostname verification
        +
        Returns:
        +
        the client builder instance
        +
        See Also:
        +
        + +
        +
        +
        +
        • +
      • +
        +

        useKeyStoreTls

        +
        ClientBuilder useKeyStoreTls(boolean useKeyStoreTls)
        +
        If Tls is enabled, whether use KeyStore type as tls configuration parameter. + False means use default pem type configuration.
        +
        +
        Parameters:
        +
        useKeyStoreTls -
        +
        Returns:
        +
        the client builder instance
        +
        +
        +
        • +
      • +
        +

        sslProvider

        +
        ClientBuilder sslProvider(String sslProvider)
        +
        The name of the security provider used for SSL connections. + Default value is the default security provider of the JVM.
        +
        +
        Parameters:
        +
        sslProvider -
        +
        Returns:
        +
        the client builder instance
        +
        +
        +
        • +
      • +
        +

        tlsKeyStoreType

        +
        ClientBuilder tlsKeyStoreType(String tlsKeyStoreType)
        +
        The file format of the key store file.
        +
        +
        Parameters:
        +
        tlsKeyStoreType -
        +
        Returns:
        +
        the client builder instance
        +
        +
        +
        • +
      • +
        +

        tlsKeyStorePath

        +
        ClientBuilder tlsKeyStorePath(String tlsTrustStorePath)
        +
        The location of the key store file.
        +
        +
        Parameters:
        +
        tlsTrustStorePath -
        +
        Returns:
        +
        the client builder instance
        +
        +
        +
        • +
      • +
        +

        tlsKeyStorePassword

        +
        ClientBuilder tlsKeyStorePassword(String tlsKeyStorePassword)
        +
        The store password for the key store file.
        +
        +
        Parameters:
        +
        tlsKeyStorePassword -
        +
        Returns:
        +
        the client builder instance
        +
        +
        +
        • +
      • +
        +

        tlsTrustStoreType

        +
        ClientBuilder tlsTrustStoreType(String tlsTrustStoreType)
        +
        The file format of the trust store file.
        +
        +
        Parameters:
        +
        tlsTrustStoreType -
        +
        Returns:
        +
        the client builder instance
        +
        +
        +
        • +
      • +
        +

        tlsTrustStorePath

        +
        ClientBuilder tlsTrustStorePath(String tlsTrustStorePath)
        +
        The location of the trust store file.
        +
        +
        Parameters:
        +
        tlsTrustStorePath -
        +
        Returns:
        +
        the client builder instance
        +
        +
        +
        • +
      • +
        +

        tlsTrustStorePassword

        +
        ClientBuilder tlsTrustStorePassword(String tlsTrustStorePassword)
        +
        The store password for the key store file.
        +
        +
        Parameters:
        +
        tlsTrustStorePassword -
        +
        Returns:
        +
        the client builder instance
        +
        +
        +
        • +
      • +
        +

        tlsCiphers

        +
        ClientBuilder tlsCiphers(Set<String> tlsCiphers)
        +
        A list of cipher suites. + This is a named combination of authentication, encryption, MAC and key exchange algorithm + used to negotiate the security settings for a network connection using TLS or SSL network protocol. + By default all the available cipher suites are supported.
        +
        +
        Parameters:
        +
        tlsCiphers -
        +
        Returns:
        +
        the client builder instance
        +
        +
        +
        • +
      • +
        +

        tlsProtocols

        +
        ClientBuilder tlsProtocols(Set<String> tlsProtocols)
        +
        The SSL protocol used to generate the SSLContext. + Default setting is TLS, which is fine for most cases. + Allowed values in recent JVMs are TLS, TLSv1.3, TLSv1.2 and TLSv1.1.
        +
        +
        Parameters:
        +
        tlsProtocols -
        +
        Returns:
        +
        the client builder instance
        +
        +
        +
        • +
      • +
        +

        memoryLimit

        +
        ClientBuilder memoryLimit(long memoryLimit, + SizeUnit unit)
        +
        Configure a limit on the amount of direct memory that will be allocated by this client instance. +

        + Note: at this moment this is only limiting the memory for producers. +

        + Setting this to 0 will disable the limit.

        +
        +
        Parameters:
        +
        memoryLimit - the limit
        +
        unit - the memory limit size unit
        +
        Returns:
        +
        the client builder instance
        +
        +
        +
        • +
      • +
        +

        statsInterval

        +
        @Deprecated +ClientBuilder statsInterval(long statsInterval, + TimeUnit unit)
        +
        Deprecated. +
        @see openTelemetry(OpenTelemetry)
        +
        +
        Set the interval between each stat info (default: 60 seconds) Stats will be activated with positive + statsInterval It should be set to at least 1 second.
        +
        +
        Parameters:
        +
        statsInterval - the interval between each stat info
        +
        unit - time unit for statsInterval
        +
        Returns:
        +
        the client builder instance
        +
        +
        +
        • +
      • +
        +

        maxConcurrentLookupRequests

        +
        ClientBuilder maxConcurrentLookupRequests(int maxConcurrentLookupRequests)
        +
        Number of concurrent lookup-requests allowed to send on each broker-connection to prevent overload on broker. + (default: 5000) It should be configured with higher value only in case of it requires to produce/subscribe + on thousands of topic using created PulsarClient.
        +
        +
        Parameters:
        +
        maxConcurrentLookupRequests -
        +
        Returns:
        +
        the client builder instance
        +
        +
        +
        • +
      • +
        +

        maxLookupRequests

        +
        ClientBuilder maxLookupRequests(int maxLookupRequests)
        +
        Number of max lookup-requests allowed on each broker-connection to prevent overload on broker. + (default: 50000) It should be bigger than maxConcurrentLookupRequests. + Requests that inside maxConcurrentLookupRequests already send to broker, and requests beyond + maxConcurrentLookupRequests and under maxLookupRequests will wait in each client cnx.
        +
        +
        Parameters:
        +
        maxLookupRequests -
        +
        Returns:
        +
        the client builder instance
        +
        +
        +
        • +
      • +
        +

        maxLookupRedirects

        +
        ClientBuilder maxLookupRedirects(int maxLookupRedirects)
        +
        Set the maximum number of times a lookup-request to a broker will be redirected.
        +
        +
        Parameters:
        +
        maxLookupRedirects - the maximum number of redirects
        +
        Returns:
        +
        the client builder instance
        +
        Since:
        +
        2.6.0
        +
        +
        +
        • +
      • +
        +

        maxNumberOfRejectedRequestPerConnection

        +
        ClientBuilder maxNumberOfRejectedRequestPerConnection(int maxNumberOfRejectedRequestPerConnection)
        +
        Set max number of broker-rejected requests in a certain time-frame (60 seconds) after which current connection + will be closed and client creates a new connection that give chance to connect a different broker (default: + 50).
        +
        +
        Parameters:
        +
        maxNumberOfRejectedRequestPerConnection -
        +
        Returns:
        +
        the client builder instance
        +
        +
        +
        • +
      • +
        +

        keepAliveInterval

        +
        ClientBuilder keepAliveInterval(int keepAliveInterval, + TimeUnit unit)
        +
        Set keep alive interval for each client-broker-connection. (default: 30 seconds).
        +
        +
        Parameters:
        +
        keepAliveInterval -
        +
        unit - the time unit in which the keepAliveInterval is defined
        +
        Returns:
        +
        the client builder instance
        +
        +
        +
        • +
      • +
        +

        connectionTimeout

        +
        ClientBuilder connectionTimeout(int duration, + TimeUnit unit)
        +
        Set the duration of time to wait for a connection to a broker to be established. If the duration passes without a + response from the broker, the connection attempt is dropped.
        +
        +
        Parameters:
        +
        duration - the duration to wait
        +
        unit - the time unit in which the duration is defined
        +
        Returns:
        +
        the client builder instance
        +
        Since:
        +
        2.3.0
        +
        +
        +
        • +
      • +
        +

        startingBackoffInterval

        +
        ClientBuilder startingBackoffInterval(long duration, + TimeUnit unit)
        +
        Set the duration of time for a backoff interval.
        +
        +
        Parameters:
        +
        duration - the duration of the interval
        +
        unit - the time unit in which the duration is defined
        +
        Returns:
        +
        the client builder instance
        +
        +
        +
        • +
      • +
        +

        maxBackoffInterval

        +
        ClientBuilder maxBackoffInterval(long duration, + TimeUnit unit)
        +
        Set the maximum duration of time for a backoff interval.
        +
        +
        Parameters:
        +
        duration - the duration of the interval
        +
        unit - the time unit in which the duration is defined
        +
        Returns:
        +
        the client builder instance
        +
        +
        +
        • +
      • +
        +

        enableBusyWait

        +
        ClientBuilder enableBusyWait(boolean enableBusyWait)
        +
        Option to enable busy-wait settings. Default is false. + + WARNING: This option will enable spin-waiting on executors and IO threads in order to reduce latency + during context switches. The spinning will consume 100% CPU even when the broker is not doing any work. It + is recommended to reduce the number of IO threads and BK client threads to only have few CPU cores busy.
        +
        +
        Parameters:
        +
        enableBusyWait - whether to enable busy wait
        +
        Returns:
        +
        the client builder instance
        +
        +
        +
        • +
      • +
        +

        openTelemetry

        +
        ClientBuilder openTelemetry(io.opentelemetry.api.OpenTelemetry openTelemetry)
        +
        Configure OpenTelemetry for Pulsar Client +

        + When you pass an OpenTelemetry instance, Pulsar client will emit metrics that can be exported in a variety + of different methods. +

        + Refer to OpenTelemetry Java SDK documentation for + how to configure OpenTelemetry and the metrics exporter. +

        + By default, Pulsar client will use the GlobalOpenTelemetry instance. If an + OpenTelemetry JVM agent is configured, the metrics will be reported, otherwise the metrics will be + completely disabled.

        +
        +
        Parameters:
        +
        openTelemetry - the OpenTelemetry instance
        +
        Returns:
        +
        the client builder instance
        +
        +
        +
        • +
      • +
        +

        clock

        +
        ClientBuilder clock(Clock clock)
        +
        The clock used by the pulsar client. + +

        The clock is currently used by producer for setting publish timestamps. + Clock.millis() is called to retrieve current timestamp as the publish + timestamp when producers produce messages. The default clock is a system default zone + clock. So the publish timestamp is same as calling System.currentTimeMillis(). + +

        Warning: the clock is used for TTL enforcement and timestamp based seeks. + so be aware of the impacts if you are going to use a different clock.

        +
        +
        Parameters:
        +
        clock - the clock used by the pulsar client to retrieve time information
        +
        Returns:
        +
        the client builder instance
        +
        +
        +
        • +
      • +
        +

        proxyServiceUrl

        +
        ClientBuilder proxyServiceUrl(String proxyServiceUrl, + ProxyProtocol proxyProtocol)
        +
        Proxy-service url when client would like to connect to broker via proxy. Client can choose type of proxy-routing + using ProxyProtocol.
        +
        +
        Parameters:
        +
        proxyServiceUrl - proxy service url
        +
        proxyProtocol - protocol to decide type of proxy routing eg: SNI-routing
        +
        Returns:
        +
        the client builder instance
        +
        +
        +
        • +
      • +
        +

        enableTransaction

        +
        ClientBuilder enableTransaction(boolean enableTransaction)
        +
        If enable transaction, start the transactionCoordinatorClient with pulsar client.
        +
        +
        Parameters:
        +
        enableTransaction - whether enable transaction feature
        +
        Returns:
        +
        the client builder instance
        +
        +
        +
        • +
      • +
        +

        dnsLookupBind

        +
        ClientBuilder dnsLookupBind(String address, + int port)
        +
        Set dns lookup bind address and port.
        +
        +
        Parameters:
        +
        address - dnsBindAddress
        +
        port - dnsBindPort
        +
        Returns:
        +
        the client builder instance
        +
        +
        +
        • +
      • +
        +

        dnsServerAddresses

        +
        ClientBuilder dnsServerAddresses(List<InetSocketAddress> addresses)
        +
        Set dns lookup server addresses.
        +
        +
        Parameters:
        +
        addresses - dnsServerAddresses
        +
        Returns:
        +
        the client builder instance
        +
        +
        +
        • +
      • +
        +

        socks5ProxyAddress

        +
        ClientBuilder socks5ProxyAddress(InetSocketAddress socks5ProxyAddress)
        +
        Set socks5 proxy address.
        +
        +
        Parameters:
        +
        socks5ProxyAddress -
        +
        Returns:
        +
        the client builder instance
        +
        +
        +
        • +
      • +
        +

        socks5ProxyUsername

        +
        ClientBuilder socks5ProxyUsername(String socks5ProxyUsername)
        +
        Set socks5 proxy username.
        +
        +
        Parameters:
        +
        socks5ProxyUsername -
        +
        Returns:
        +
        the client builder instance
        +
        +
        +
        • +
      • +
        +

        socks5ProxyPassword

        +
        ClientBuilder socks5ProxyPassword(String socks5ProxyPassword)
        +
        Set socks5 proxy password.
        +
        +
        Parameters:
        +
        socks5ProxyPassword -
        +
        Returns:
        +
        the client builder instance
        +
        +
        +
        • +
      • +
        +

        sslFactoryPlugin

        +
        ClientBuilder sslFactoryPlugin(String sslFactoryPlugin)
        +
        Set the SSL Factory Plugin for custom implementation to create SSL Context and SSLEngine.
        +
        +
        Parameters:
        +
        sslFactoryPlugin - ssl factory class name
        +
        Returns:
        +
        the client builder instance
        +
        +
        +
        • +
      • +
        +

        sslFactoryPluginParams

        +
        ClientBuilder sslFactoryPluginParams(String sslFactoryPluginParams)
        +
        Set the SSL Factory Plugin params for the ssl factory plugin to use.
        +
        +
        Parameters:
        +
        sslFactoryPluginParams - Params in String format that will be inputted to the SSL Factory Plugin
        +
        Returns:
        +
        the client builder instance
        +
        +
        +
        • +
      • +
        +

        autoCertRefreshSeconds

        +
        ClientBuilder autoCertRefreshSeconds(int autoCertRefreshSeconds)
        +
        Set Cert Refresh interval in seconds.
        +
        +
        Parameters:
        +
        autoCertRefreshSeconds -
        +
        Returns:
        +
        the client builder instance
        +
        +
        +
        • +
      • +
        +

        lookupProperties

        +
        ClientBuilder lookupProperties(Map<String,String> properties)
        +
        Set the properties used for topic lookup. +

        + When the broker performs topic lookup, these lookup properties will be taken into consideration in a customized + load manager. +

        + Note: The lookup properties are only used in topic lookup when: + - The protocol is binary protocol, i.e. the service URL starts with "pulsar://" or "pulsar+ssl://" + - The `loadManagerClassName` config in broker is a class that implements the `ExtensibleLoadManager` interface

        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/CompressionType.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/CompressionType.html new file mode 100644 index 000000000000..09d54e53f244 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/CompressionType.html @@ -0,0 +1,278 @@ + + + + +CompressionType (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Enum Class CompressionType

    +
    +
    java.lang.Object +
    java.lang.Enum<CompressionType> +
    org.apache.pulsar.client.api.CompressionType
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable, Comparable<CompressionType>, Constable
    +
    +
    +
    @Public +@Stable +public enum CompressionType +extends Enum<CompressionType>
    +
    The compression type that can be specified on a Producer.
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Enum Constant Details

      +
        +
      • +
        +

        NONE

        +
        public static final CompressionType NONE
        +
        No compression.
        +
        +
        • +
      • +
        +

        LZ4

        +
        public static final CompressionType LZ4
        +
        Compress with LZ4 algorithm. Faster but lower compression than ZLib.
        +
        +
        • +
      • +
        +

        ZLIB

        +
        public static final CompressionType ZLIB
        +
        Compress with ZLib.
        +
        +
        • +
      • +
        +

        ZSTD

        +
        public static final CompressionType ZSTD
        +
        Compress with Zstandard codec.
        +
        +
        • +
      • +
        +

        SNAPPY

        +
        public static final CompressionType SNAPPY
        +
        Compress with Snappy codec.
        +
        +
        • +
      +
      +
      • + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        values

        +
        public static CompressionType[] values()
        +
        Returns an array containing the constants of this enum class, in +the order they are declared.
        +
        +
        Returns:
        +
        an array containing the constants of this enum class, in the order they are declared
        +
        +
        +
        • +
      • +
        +

        valueOf

        +
        public static CompressionType valueOf(String name)
        +
        Returns the enum constant of this class with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this class. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        IllegalArgumentException - if this enum class has no constant with the specified name
        +
        NullPointerException - if the argument is null
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/Consumer.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/Consumer.html new file mode 100644 index 000000000000..a65f12f93513 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/Consumer.html @@ -0,0 +1,1194 @@ + + + + +Consumer (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Interface Consumer<T>

    +
    +
    +
    +
    All Superinterfaces:
    +
    AutoCloseable, Closeable, MessageAcknowledger
    +
    +
    +
    @Public +@Stable +public interface Consumer<T> +extends Closeable, MessageAcknowledger
    +
    An interface that abstracts behavior of Pulsar's consumer. + +

    All the operations on the consumer instance are thread safe.

    +
    +
    + +
    +
    +
      + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        getTopic

        +
        String getTopic()
        +
        Get a topic for the consumer.
        +
        +
        Returns:
        +
        topic for the consumer
        +
        +
        +
        • +
      • +
        +

        getSubscription

        +
        String getSubscription()
        +
        Get a subscription for the consumer.
        +
        +
        Returns:
        +
        subscription for the consumer
        +
        +
        +
        • +
      • +
        +

        unsubscribe

        +
        void unsubscribe() + throws PulsarClientException
        +
        Unsubscribe the consumer. + +

        This call blocks until the consumer is unsubscribed. + +

        Unsubscribing will the subscription to be deleted and all the + data retained can potentially be deleted as well. + +

        The operation will fail when performed on a shared subscription + where multiple consumers are currently connected.

        +
        +
        Throws:
        +
        PulsarClientException - if the operation fails
        +
        +
        +
        • +
      • +
        +

        unsubscribeAsync

        +
        CompletableFuture<Void> unsubscribeAsync()
        +
        Asynchronously unsubscribe the consumer.
        +
        +
        Returns:
        +
        CompletableFuture to track the operation
        +
        See Also:
        +
        + +
        +
        +
        +
        • +
      • +
        +

        unsubscribe

        +
        void unsubscribe(boolean force) + throws PulsarClientException
        +
        Unsubscribe the consumer. + +

        This call blocks until the consumer is unsubscribed. + +

        Unsubscribing will the subscription to be deleted and all the + data retained can potentially be deleted as well. + +

        The operation will fail when performed on a shared subscription + where multiple consumers are currently connected.

        +
        +
        Parameters:
        +
        force - forcefully unsubscribe by disconnecting connected consumers.
        +
        Throws:
        +
        PulsarClientException - if the operation fails
        +
        +
        +
        • +
      • +
        +

        unsubscribeAsync

        +
        CompletableFuture<Void> unsubscribeAsync(boolean force)
        +
        Asynchronously unsubscribe the consumer.
        +
        +
        Parameters:
        +
        force - forcefully unsubscribe by disconnecting connected consumers.
        +
        Returns:
        +
        CompletableFuture to track the operation
        +
        See Also:
        +
        + +
        +
        +
        +
        • +
      • +
        +

        receive

        +
        Message<T> receive() + throws PulsarClientException
        +
        Receives a single message. + +

        This calls blocks until a message is available. + +

        When thread is Interrupted, return a null value and reset interrupted flag.

        +
        +
        Returns:
        +
        the received message
        +
        Throws:
        +
        PulsarClientException.AlreadyClosedException - if the consumer was already closed
        +
        PulsarClientException.InvalidConfigurationException - if a message listener was defined in the configuration
        +
        PulsarClientException
        +
        +
        +
        • +
      • +
        +

        receiveAsync

        +
        CompletableFuture<Message<T>> receiveAsync()
        +
        Receive a single message + +

        Retrieves a message when it will be available and completes CompletableFuture with received message. + +

        receiveAsync() should be called subsequently once returned CompletableFuture gets complete + with received message. Else it creates backlog of receive requests in the application. + +

        The returned future can be cancelled before completion by calling .cancel(false) + (CompletableFuture.cancel(boolean)) to remove it from the the backlog of receive requests. Another + choice for ensuring a proper clean up of the returned future is to use the CompletableFuture.orTimeout method + which is available on JDK9+. That would remove it from the backlog of receive requests if receiving exceeds + the timeout.

        +
        +
        Returns:
        +
        CompletableFutureinvalid input: '<'Message> will be completed when message is available
        +
        +
        +
        • +
      • +
        +

        receive

        +
        Message<T> receive(int timeout, + TimeUnit unit) + throws PulsarClientException
        +
        Receive a single message. + +

        Retrieves a message, waiting up to the specified wait time if necessary.

        +
        +
        Parameters:
        +
        timeout - 0 or less means immediate rather than infinite
        +
        unit -
        +
        Returns:
        +
        the received Message or null if no message available before timeout
        +
        Throws:
        +
        PulsarClientException.AlreadyClosedException - if the consumer was already closed
        +
        PulsarClientException.InvalidConfigurationException - if a message listener was defined in the configuration
        +
        PulsarClientException
        +
        +
        +
        • +
      • +
        +

        batchReceive

        +
        Messages<T> batchReceive() + throws PulsarClientException
        +
        Batch receiving messages. + +

        This calls blocks until has enough messages or wait timeout, more details to see BatchReceivePolicy.

        +
        +
        Returns:
        +
        messages
        +
        Throws:
        +
        PulsarClientException
        +
        Since:
        +
        2.4.1
        +
        +
        +
        • +
      • +
        +

        batchReceiveAsync

        +
        CompletableFuture<Messages<T>> batchReceiveAsync()
        +
        Batch receiving messages. +

        + Retrieves messages when has enough messages or wait timeout and + completes CompletableFuture with received messages. +

        +

        + batchReceiveAsync() should be called subsequently once returned CompletableFuture gets complete + with received messages. Else it creates backlog of receive requests in the application. +

        + +

        The returned future can be cancelled before completion by calling .cancel(false) + (CompletableFuture.cancel(boolean)) to remove it from the the backlog of receive requests. Another + choice for ensuring a proper clean up of the returned future is to use the CompletableFuture.orTimeout method + which is available on JDK9+. That would remove it from the backlog of receive requests if receiving exceeds + the timeout.

        +
        +
        Returns:
        +
        messages
        +
        Throws:
        +
        PulsarClientException
        +
        Since:
        +
        2.4.1
        +
        +
        +
        • +
      • +
        +

        negativeAcknowledge

        +
        void negativeAcknowledge(Message<?> message)
        +
        Acknowledge the failure to process a single message. + +

        When a message is "negatively acked" it will be marked for redelivery after + some fixed delay. The delay is configurable when constructing the consumer + with ConsumerBuilder.negativeAckRedeliveryDelay(long, TimeUnit). + +

        This call is not blocking. + +

        Example of usage: + 

        
+ while (true) {
+     Message<String> msg = consumer.receive();
+
+     try {
+          // Process message...
+
+          consumer.acknowledge(msg);
+     } catch (Throwable t) {
+          log.warn("Failed to process message");
+          consumer.negativeAcknowledge(msg);
+     }
+ }
+
        +
        +
        Parameters:
        +
        message - The Message to be acknowledged
        +
        +
        +
        • +
      • +
        +

        negativeAcknowledge

        +
        void negativeAcknowledge(MessageId messageId)
        +
        Acknowledge the failure to process a single message. + +

        When a message is "negatively acked" it will be marked for redelivery after + some fixed delay. The delay is configurable when constructing the consumer + with ConsumerBuilder.negativeAckRedeliveryDelay(long, TimeUnit). + +

        This call is not blocking. + +

        This variation allows to pass a MessageId rather than a Message + object, in order to avoid keeping the payload in memory for extended amount + of time

        +
        +
        Parameters:
        +
        messageId - The MessageId to be acknowledged
        +
        See Also:
        +
        + +
        +
        +
        +
        • +
      • +
        +

        negativeAcknowledge

        +
        void negativeAcknowledge(Messages<?> messages)
        +
        Acknowledge the failure to process Messages. + +

        When messages is "negatively acked" it will be marked for redelivery after + some fixed delay. The delay is configurable when constructing the consumer + with ConsumerBuilder.negativeAckRedeliveryDelay(long, TimeUnit). + +

        This call is not blocking. + +

        Example of usage: + 

        
+ while (true) {
+     Messages<String> msgs = consumer.batchReceive();
+
+     try {
+          // Process message...
+
+          consumer.acknowledge(msgs);
+     } catch (Throwable t) {
+          log.warn("Failed to process message");
+          consumer.negativeAcknowledge(msgs);
+     }
+ }
+
        +
        +
        Parameters:
        +
        messages - The Message to be acknowledged
        +
        +
        +
        • +
      • +
        +

        reconsumeLater

        +
        void reconsumeLater(Message<?> message, + long delayTime, + TimeUnit unit) + throws PulsarClientException
        +
        reconsumeLater the consumption of Messages. + +

        When a message is "reconsumeLater" it will be marked for redelivery after + some custom delay. + +

        Example of usage: + 

        
+ while (true) {
+     Message<String> msg = consumer.receive();
+
+     try {
+          // Process message...
+
+          consumer.acknowledge(msg);
+     } catch (Throwable t) {
+          log.warn("Failed to process message");
+          consumer.reconsumeLater(msg, 1000, TimeUnit.MILLISECONDS);
+     }
+ }
+
        +
        +
        Parameters:
        +
        message - the Message to be reconsumeLater
        +
        delayTime - the amount of delay before the message will be delivered
        +
        unit - the time unit for the delay
        +
        Throws:
        +
        PulsarClientException.AlreadyClosedException - if the consumer was already closed
        +
        PulsarClientException
        +
        +
        +
        • +
      • +
        +

        reconsumeLater

        +
        void reconsumeLater(Message<?> message, + Map<String,String> customProperties, + long delayTime, + TimeUnit unit) + throws PulsarClientException
        +
        reconsumeLater the consumption of Messages. + +

        When a message is "reconsumeLater" it will be marked for redelivery after + some custom delay. + +

        Example of usage: + 

        
+ while (true) {
+     Message<String> msg = consumer.receive();
+
+     try {
+          // Process message...
+
+          consumer.acknowledge(msg);
+     } catch (Throwable t) {
+          log.warn("Failed to process message");
+          consumer.reconsumeLater(msg, 1000, TimeUnit.MILLISECONDS);
+     }
+ }
+
        +
        +
        Parameters:
        +
        message - the Message to be reconsumeLater
        +
        customProperties - the custom properties to be reconsumeLater
        +
        delayTime - the amount of delay before the message will be delivered
        +
        unit - the time unit for the delay
        +
        Throws:
        +
        PulsarClientException.AlreadyClosedException - if the consumer was already closed
        +
        PulsarClientException
        +
        +
        +
        • +
      • +
        +

        reconsumeLater

        +
        void reconsumeLater(Messages<?> messages, + long delayTime, + TimeUnit unit) + throws PulsarClientException
        +
        reconsumeLater the consumption of Messages.
        +
        +
        Parameters:
        +
        messages - the messages to be reconsumeLater
        +
        delayTime - the amount of delay before the message will be delivered
        +
        unit - the time unit for the delay
        +
        Throws:
        +
        PulsarClientException.AlreadyClosedException - if the consumer was already closed
        +
        PulsarClientException
        +
        +
        +
        • +
      • +
        +

        reconsumeLaterCumulative

        +
        void reconsumeLaterCumulative(Message<?> message, + long delayTime, + TimeUnit unit) + throws PulsarClientException
        +
        reconsumeLater the reception of all the messages in the stream up to (and including) the provided message.
        +
        +
        Parameters:
        +
        message - The message to be cumulatively reconsumeLater
        +
        delayTime - the amount of delay before the message will be delivered
        +
        unit - the time unit for the delay
        +
        Throws:
        +
        PulsarClientException.AlreadyClosedException - if the consumer was already closed
        +
        PulsarClientException
        +
        +
        +
        • +
      • +
        +

        reconsumeLaterAsync

        +
        CompletableFuture<Void> reconsumeLaterAsync(Message<?> message, + long delayTime, + TimeUnit unit)
        +
        Asynchronously reconsumeLater the consumption of a single message.
        +
        +
        Parameters:
        +
        message - The Message to be reconsumeLater
        +
        delayTime - the amount of delay before the message will be delivered
        +
        unit - the time unit for the delay
        +
        Returns:
        +
        a future that can be used to track the completion of the operation
        +
        +
        +
        • +
      • +
        +

        reconsumeLaterAsync

        +
        CompletableFuture<Void> reconsumeLaterAsync(Message<?> message, + Map<String,String> customProperties, + long delayTime, + TimeUnit unit)
        +
        Asynchronously reconsumeLater the consumption of a single message.
        +
        +
        Parameters:
        +
        message - The Message to be reconsumeLater
        +
        customProperties - The custom properties to be reconsumeLater
        +
        delayTime - the amount of delay before the message will be delivered
        +
        unit - the time unit for the delay
        +
        Returns:
        +
        a future that can be used to track the completion of the operation
        +
        +
        +
        • +
      • +
        +

        reconsumeLaterAsync

        +
        CompletableFuture<Void> reconsumeLaterAsync(Messages<?> messages, + long delayTime, + TimeUnit unit)
        +
        Asynchronously reconsumeLater the consumption of Messages.
        +
        +
        Parameters:
        +
        messages - The Messages to be reconsumeLater
        +
        delayTime - the amount of delay before the message will be delivered
        +
        unit - the time unit for the delay
        +
        Returns:
        +
        a future that can be used to track the completion of the operation
        +
        +
        +
        • +
      • +
        +

        reconsumeLaterCumulativeAsync

        +
        CompletableFuture<Void> reconsumeLaterCumulativeAsync(Message<?> message, + long delayTime, + TimeUnit unit)
        +
        Asynchronously ReconsumeLater the reception of all the messages in the stream up to (and including) the provided + message. + +

        Cumulative reconsumeLater cannot be used when the consumer type is set to ConsumerShared.

        +
        +
        Parameters:
        +
        message - The message to be cumulatively reconsumeLater
        +
        delayTime - the amount of delay before the message will be delivered
        +
        unit - the time unit for the delay
        +
        Returns:
        +
        a future that can be used to track the completion of the operation
        +
        +
        +
        • +
      • +
        +

        reconsumeLaterCumulativeAsync

        +
        CompletableFuture<Void> reconsumeLaterCumulativeAsync(Message<?> message, + Map<String,String> customProperties, + long delayTime, + TimeUnit unit)
        +
        Asynchronously ReconsumeLater the reception of all the messages in the stream up to (and including) the provided + message. + +

        Cumulative reconsumeLater cannot be used when the consumer type is set to ConsumerShared.

        +
        +
        Parameters:
        +
        message - The message to be cumulatively reconsumeLater
        +
        customProperties - The custom properties to be cumulatively reconsumeLater
        +
        delayTime - the amount of delay before the message will be delivered
        +
        unit - the time unit for the delay
        +
        Returns:
        +
        a future that can be used to track the completion of the operation
        +
        +
        +
        • +
      • +
        +

        getStats

        +
        ConsumerStats getStats()
        +
        Get statistics for the consumer. +
          +
        • numMsgsReceived : Number of messages received in the current interval +
        • numBytesReceived : Number of bytes received in the current interval +
        • numReceiveFailed : Number of messages failed to receive in the current interval +
        • numAcksSent : Number of acks sent in the current interval +
        • numAcksFailed : Number of acks failed to send in the current interval +
        • totalMsgsReceived : Total number of messages received +
        • totalBytesReceived : Total number of bytes received +
        • totalReceiveFailed : Total number of messages failed to receive +
        • totalAcksSent : Total number of acks sent +
        • totalAcksFailed : Total number of acks failed to sent +
        +
        +
        Returns:
        +
        statistic for the consumer
        +
        +
        +
        • +
      • +
        +

        close

        +
        void close() + throws PulsarClientException
        +
        Close the consumer and stop the broker to push more messages.
        +
        +
        Specified by:
        +
        close in interface AutoCloseable
        +
        Specified by:
        +
        close in interface Closeable
        +
        Throws:
        +
        PulsarClientException
        +
        +
        +
        • +
      • +
        +

        closeAsync

        +
        CompletableFuture<Void> closeAsync()
        +
        Asynchronously close the consumer and stop the broker to push more messages.
        +
        +
        Returns:
        +
        a future that can be used to track the completion of the operation
        +
        +
        +
        • +
      • +
        +

        hasReachedEndOfTopic

        +
        boolean hasReachedEndOfTopic()
        +
        Return true if the topic was terminated and this consumer has already consumed all the messages in the topic. + +

        Please note that this does not simply mean that the consumer is caught up with the last message published by + producers, rather the topic needs to be explicitly "terminated".

        +
        +
        • +
      • +
        +

        redeliverUnacknowledgedMessages

        +
        void redeliverUnacknowledgedMessages()
        +
        Redelivers all the unacknowledged messages. In Failover mode, the request is ignored if the consumer is not + active for the given topic. In Shared mode, the consumers messages to be redelivered are distributed across all + the connected consumers. This is a non blocking call and doesn't throw an exception. In case the connection + breaks, the messages are redelivered after reconnect.
        +
        +
        • +
      • +
        +

        seek

        +
        void seek(MessageId messageId) + throws PulsarClientException
        +
        Reset the subscription associated with this consumer to a specific message id. +

        + If there is already a seek operation in progress, the method will log a warning and + return a future completed exceptionally. + +

        The message id can either be a specific message or represent the first or last messages in the topic. +

          +
        • MessageId.earliest : Reset the subscription on the earliest message available in the topic +
        • MessageId.latest : Reset the subscription on the latest message in the topic +
        +

        + This effectively resets the acknowledgement state of the subscription: all messages up to and + including messageId will be marked as acknowledged and the rest unacknowledged. + +

        Note: For multi-topics consumer, if `messageId` is a TopicMessageId, the seek operation will happen + on the owner topic of the message, which is returned by TopicMessageId.getOwnerTopic(). Otherwise, you + can only seek to the earliest or latest message for all topics subscribed.

        +
        +
        Parameters:
        +
        messageId - the message id where to reposition the subscription
        +
        Throws:
        +
        PulsarClientException
        +
        +
        +
        • +
      • +
        +

        seek

        +
        void seek(long timestamp) + throws PulsarClientException
        +
        Reset the subscription associated with this consumer to a specific message publish time. +

        + If there is already a seek operation in progress, the method will log a warning and + return a future completed exceptionally.

        +
        +
        Parameters:
        +
        timestamp - the message publish time where to reposition the subscription + The timestamp format should be Unix time in milliseconds.
        +
        Throws:
        +
        PulsarClientException
        +
        +
        +
        • +
      • +
        +

        seek

        +
        void seek(Function<String,Object> function) + throws PulsarClientException
        +
        Reset the subscription associated with this consumer to a specific message ID or message publish time. +

        + If there is already a seek operation in progress, the method will log a warning and + return a future completed exceptionally. + +

        + The Function input is topic+partition. It returns only timestamp or MessageId. +

        + The return value is the seek position/timestamp of the current partition. + Exception is thrown if other object types are returned. +

        + If returns null, the current partition will not do any processing. + Exception in a partition may affect other partitions.

        +
        +
        Parameters:
        +
        function -
        +
        Throws:
        +
        PulsarClientException
        +
        +
        +
        • +
      • +
        +

        seekAsync

        +
        CompletableFuture<Void> seekAsync(Function<String,Object> function)
        +
        Reset the subscription associated with this consumer to a specific message ID + or message publish time asynchronously. +

        + The Function input is topic+partition. It returns only timestamp or MessageId. +

        + The return value is the seek position/timestamp of the current partition. + Exception is thrown if other object types are returned. +

        + If returns null, the current partition will not do any processing. + Exception in a partition may affect other partitions.

        +
        +
        Parameters:
        +
        function -
        +
        Returns:
        +
        +
        +
        • +
      • +
        +

        seekAsync

        +
        CompletableFuture<Void> seekAsync(MessageId messageId)
        +
        The asynchronous version of seek(MessageId). +

        + If there is already a seek operation in progress, the method will log a warning and + return a future completed exceptionally.

        +
        +
        • +
      • +
        +

        seekAsync

        +
        CompletableFuture<Void> seekAsync(long timestamp)
        +
        Reset the subscription associated with this consumer to a specific message publish time. +

        + If there is already a seek operation in progress, the method will log a warning and + return a future completed exceptionally.

        +
        +
        Parameters:
        +
        timestamp - the message publish time where to reposition the subscription + The timestamp format should be Unix time in milliseconds.
        +
        Returns:
        +
        a future to track the completion of the seek operation
        +
        +
        +
        • +
      • +
        +

        getLastMessageId

        +
        @Deprecated +MessageId getLastMessageId() + throws PulsarClientException
        +
        Deprecated. +
        Use getLastMessageIds() instead.
        +
        +
        Get the last message id available for consume.
        +
        +
        Returns:
        +
        the last message id.
        +
        Throws:
        +
        PulsarClientException
        +
        +
        +
        • +
      • +
        +

        getLastMessageIdAsync

        +
        @Deprecated +CompletableFuture<MessageId> getLastMessageIdAsync()
        +
        Deprecated. +
        Use getLastMessageIdsAsync()} instead.
        +
        +
        Get the last message id available for consume.
        +
        +
        Returns:
        +
        a future that can be used to track the completion of the operation.
        +
        +
        +
        • +
      • +
        +

        getLastMessageIds

        +
        List<TopicMessageId> getLastMessageIds() + throws PulsarClientException
        +
        Get all the last message id of the topics the consumer subscribed.
        +
        +
        Returns:
        +
        the list of TopicMessageId instances of all the topics that the consumer subscribed
        +
        Throws:
        +
        PulsarClientException - if failed to get last message id.
        +
        +
        +
        • +
      • +
        +

        getLastMessageIdsAsync

        +
        CompletableFuture<List<TopicMessageId>> getLastMessageIdsAsync()
        +
        The asynchronous version of getLastMessageIds().
        +
        +
        • +
      • +
        +

        isConnected

        +
        boolean isConnected()
        +
        +
        Returns:
        +
        Whether the consumer is connected to the broker
        +
        +
        +
        • +
      • +
        +

        getConsumerName

        +
        String getConsumerName()
        +
        Get the name of consumer.
        +
        +
        Returns:
        +
        consumer name.
        +
        +
        +
        • +
      • +
        +

        pause

        +
        void pause()
        +
        Stop requesting new messages from the broker until resume() is called. Note that this might cause + receive() to block until resume() is called and new messages are pushed by the broker.
        +
        +
        • +
      • +
        +

        resume

        +
        void resume()
        +
        Resume requesting messages from the broker.
        +
        +
        • +
      • +
        +

        getLastDisconnectedTimestamp

        +
        long getLastDisconnectedTimestamp()
        +
        +
        Returns:
        +
        The last disconnected timestamp of the consumer
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/ConsumerBuilder.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/ConsumerBuilder.html new file mode 100644 index 000000000000..5fd7f4281f5c --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/ConsumerBuilder.html @@ -0,0 +1,1623 @@ + + + + +ConsumerBuilder (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Interface ConsumerBuilder<T>

    +
    +
    +
    +
    All Superinterfaces:
    +
    Cloneable
    +
    +
    +
    @Public +@Stable +public interface ConsumerBuilder<T> +extends Cloneable
    +
    ConsumerBuilder is used to configure and create instances of Consumer.
    +
    +
    Since:
    +
    2.0.0
    +
    See Also:
    +
    + +
    +
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        clone

        +
        ConsumerBuilder<T> clone()
        +
        Create a copy of the current consumer builder. + +

        Cloning the builder can be used to share an incomplete configuration and specialize it multiple times. For + example: + 

        
+ ConsumerBuilder<String> builder = client.newConsumer(Schema.STRING)
+         .subscriptionName("my-subscription-name")
+         .subscriptionType(SubscriptionType.Shared)
+         .receiverQueueSize(10);
+
+ Consumer<String> consumer1 = builder.clone().topic("my-topic-1").subscribe();
+ Consumer<String> consumer2 = builder.clone().topic("my-topic-2").subscribe();
+
        +
        +
        Returns:
        +
        a cloned consumer builder object
        +
        +
        +
        • +
      • +
        +

        loadConf

        +
        ConsumerBuilder<T> loadConf(Map<String,Object> config)
        +
        Load the configuration from provided config map. + +

        Example: + 

        
+ Map<String, Object> config = new HashMap<>();
+ config.put("ackTimeoutMillis", 1000);
+ config.put("receiverQueueSize", 2000);
+
+ Consumer<byte[]> builder = client.newConsumer()
+              .loadConf(config)
+              .subscribe();
+
+ Consumer<byte[]> consumer = builder.subscribe();
+
        +
        +
        Parameters:
        +
        config - configuration to load
        +
        Returns:
        +
        the consumer builder instance
        +
        +
        +
        • +
      • +
        +

        subscribe

        +
        Consumer<T> subscribe() + throws PulsarClientException
        +
        Finalize the Consumer creation by subscribing to the topic. + +

        If the subscription does not exist, a new subscription is created. By default, the subscription + is created at the end of the topic. See subscriptionInitialPosition(SubscriptionInitialPosition) + to configure the initial position behavior. + +

        Once a subscription is created, it retains the data and the subscription cursor even if the consumer + is not connected.

        +
        +
        Returns:
        +
        the consumer builder instance
        +
        Throws:
        +
        PulsarClientException - if the subscribe operation fails
        +
        +
        +
        • +
      • +
        +

        subscribeAsync

        +
        CompletableFuture<Consumer<T>> subscribeAsync()
        +
        Finalize the Consumer creation by subscribing to the topic in asynchronous mode. + +

        If the subscription does not exist, a new subscription is created. By default, the subscription + is created at the end of the topic. See subscriptionInitialPosition(SubscriptionInitialPosition) + to configure the initial position behavior. + +

        Once a subscription is created, it retains the data and the subscription cursor even + if the consumer is not connected.

        +
        +
        Returns:
        +
        a future that yields a Consumer instance
        +
        Throws:
        +
        PulsarClientException - if the subscribe operation fails
        +
        +
        +
        • +
      • +
        +

        topic

        +
        ConsumerBuilder<T> topic(String... topicNames)
        +
        Specify the topics this consumer subscribes to.
        +
        +
        Parameters:
        +
        topicNames - a set of topics that the consumer subscribes to
        +
        Returns:
        +
        the consumer builder instance
        +
        +
        +
        • +
      • +
        +

        topics

        +
        ConsumerBuilder<T> topics(List<String> topicNames)
        +
        Specify a list of topics that this consumer subscribes to.
        +
        +
        Parameters:
        +
        topicNames - a list of topics that the consumer subscribes to
        +
        Returns:
        +
        the consumer builder instance
        +
        +
        +
        • +
      • +
        +

        topicsPattern

        +
        ConsumerBuilder<T> topicsPattern(Pattern topicsPattern)
        +
        Specify a pattern for topics(not contains the partition suffix) that this consumer subscribes to. + +

        The pattern is applied to subscribe to all topics, within a single namespace, that match the + pattern. + +

        The consumer automatically subscribes to topics created after itself.

        +
        +
        Parameters:
        +
        topicsPattern - a regular expression to select a list of topics(not contains the partition suffix) to subscribe to
        +
        Returns:
        +
        the consumer builder instance
        +
        +
        +
        • +
      • +
        +

        topicsPattern

        +
        ConsumerBuilder<T> topicsPattern(String topicsPattern)
        +
        Specify a pattern for topics(not contains the partition suffix) that this consumer subscribes to. + +

        It accepts a regular expression that is compiled into a pattern internally. E.g., + "persistent://public/default/pattern-topic-.*" + +

        The pattern is applied to subscribe to all topics, within a single namespace, that match the + pattern. + +

        The consumer automatically subscribes to topics created after itself.

        +
        +
        Parameters:
        +
        topicsPattern - given regular expression for topics(not contains the partition suffix) pattern
        +
        Returns:
        +
        the consumer builder instance
        +
        +
        +
        • +
      • +
        +

        subscriptionName

        +
        ConsumerBuilder<T> subscriptionName(String subscriptionName)
        +
        Specify the subscription name for this consumer. + +

        This argument is required when constructing the consumer.

        +
        +
        Parameters:
        +
        subscriptionName - the name of the subscription that this consumer should attach to
        +
        Returns:
        +
        the consumer builder instance
        +
        +
        +
        • +
      • +
        +

        subscriptionProperties

        +
        ConsumerBuilder<T> subscriptionProperties(Map<String,String> subscriptionProperties)
        +
        Specify the subscription properties for this subscription. + Properties are immutable, and consumers under the same subscription will fail to create a subscription + if they use different properties.
        +
        +
        Parameters:
        +
        subscriptionProperties - the properties of the subscription
        +
        Returns:
        +
        the consumer builder instance
        +
        +
        +
        • +
      • +
        +

        ackTimeout

        +
        ConsumerBuilder<T> ackTimeout(long ackTimeout, + TimeUnit timeUnit)
        +
        Sets the timeout for unacknowledged messages, truncated to the nearest millisecond. The timeout must be + greater than 1 second. + +

        By default, the acknowledgment timeout is disabled (set to `0`, which means infinite). + When a consumer with an infinite acknowledgment timeout terminates, any unacknowledged + messages that it receives are re-delivered to another consumer. + +

        When enabling acknowledgment timeout, if a message is not acknowledged within the specified timeout, + it is re-delivered to the consumer (possibly to a different consumer, in the case of + a shared subscription).

        +
        +
        Parameters:
        +
        ackTimeout - for unacked messages.
        +
        timeUnit - unit in which the timeout is provided.
        +
        Returns:
        +
        the consumer builder instance
        +
        +
        +
        • +
      • +
        +

        isAckReceiptEnabled

        +
        ConsumerBuilder<T> isAckReceiptEnabled(boolean isAckReceiptEnabled)
        +
        Enables or disables the acknowledgment receipt feature. + +

        When this feature is enabled, the consumer ensures that acknowledgments are processed by the broker by + waiting for a receipt from the broker. Even when the broker returns a receipt, it doesn't guarantee that the + message won't be redelivered later due to certain implementation details. + It is recommended to use the asynchronous MessageAcknowledger.acknowledgeAsync(Message) method for acknowledgment + when this feature is enabled. This is because using the synchronous MessageAcknowledger.acknowledge(Message) method + with acknowledgment receipt can cause performance issues due to the round trip to the server, which prevents + pipelining (having multiple messages in-flight). With the asynchronous method, the consumer can continue + consuming other messages while waiting for the acknowledgment receipts.

        +
        +
        Parameters:
        +
        isAckReceiptEnabled - true to enable acknowledgment receipt, false to disable it
        +
        Returns:
        +
        the consumer builder instance
        +
        +
        +
        • +
      • +
        +

        ackTimeoutTickTime

        +
        ConsumerBuilder<T> ackTimeoutTickTime(long tickTime, + TimeUnit timeUnit)
        +
        Define the granularity of the ack-timeout redelivery. + +

        By default, the tick time is set to 1 second. Using a higher tick time + reduces the memory overhead to track messages when the ack-timeout is set to + bigger values (e.g., 1 hour).

        +
        +
        Parameters:
        +
        tickTime - the min precision for the acknowledgment timeout messages tracker
        +
        timeUnit - unit in which the timeout is provided.
        +
        Returns:
        +
        the consumer builder instance
        +
        +
        +
        • +
      • +
        +

        negativeAckRedeliveryDelay

        +
        ConsumerBuilder<T> negativeAckRedeliveryDelay(long redeliveryDelay, + TimeUnit timeUnit)
        +
        Sets the delay to wait before re-delivering messages that have failed to be processed. + +

        When application uses Consumer.negativeAcknowledge(Message), the failed message + is redelivered after a fixed timeout. The default is 1 min.

        +
        +
        Parameters:
        +
        redeliveryDelay - redelivery delay for failed messages
        +
        timeUnit - unit in which the timeout is provided.
        +
        Returns:
        +
        the consumer builder instance
        +
        See Also:
        +
        + +
        +
        +
        +
        • +
      • +
        +

        subscriptionType

        +
        ConsumerBuilder<T> subscriptionType(SubscriptionType subscriptionType)
        +
        Select the subscription type to be used when subscribing to a topic. + +

        Options are: +

        +
        +
        Parameters:
        +
        subscriptionType - the subscription type value
        +
        Returns:
        +
        the consumer builder instance
        +
        +
        +
        • +
      • +
        +

        subscriptionMode

        +
        ConsumerBuilder<T> subscriptionMode(SubscriptionMode subscriptionMode)
        +
        Selects the subscription mode to be used when subscribing to a topic. + +

        Options are: +

        +
        +
        Parameters:
        +
        subscriptionMode - the subscription mode value
        +
        Returns:
        +
        the consumer builder instance
        +
        +
        +
        • +
      • +
        +

        messageListener

        +
        ConsumerBuilder<T> messageListener(MessageListener<T> messageListener)
        +
        Sets a MessageListener for the consumer. + +

        The application receives messages through the message listener, + and calls to Consumer.receive() are not allowed.

        +
        +
        Parameters:
        +
        messageListener - the listener object
        +
        Returns:
        +
        the consumer builder instance
        +
        +
        +
        • +
      • +
        +

        messageListenerExecutor

        +
        ConsumerBuilder<T> messageListenerExecutor(MessageListenerExecutor messageListenerExecutor)
        +
        Set the MessageListenerExecutor to be used for message listeners of current consumer. + (default: use executor from PulsarClient, + +
        +invalid reference +
        org.apache.pulsar.client.impl.PulsarClientImpl#externalExecutorProvider
        +
        +)        . + +

        The listener thread pool is exclusively owned by current consumer + that are using a "listener" model to get messages. For a given internal consumer, + the listener will always be invoked from the same thread, to ensure ordering. + +

        The caller need to shut down the thread pool after closing the consumer to avoid leaks.

        +
        +
        Parameters:
        +
        messageListenerExecutor - the executor of the consumer message listener
        +
        Returns:
        +
        the consumer builder instance
        +
        +
        +
        • +
      • +
        +

        cryptoKeyReader

        +
        ConsumerBuilder<T> cryptoKeyReader(CryptoKeyReader cryptoKeyReader)
        +
        Sets a CryptoKeyReader. + +

        Configure the key reader to be used to decrypt message payloads.

        +
        +
        Parameters:
        +
        cryptoKeyReader - CryptoKeyReader object
        +
        Returns:
        +
        the consumer builder instance
        +
        +
        +
        • +
      • +
        +

        defaultCryptoKeyReader

        +
        ConsumerBuilder<T> defaultCryptoKeyReader(String privateKey)
        +
        Sets the default implementation of CryptoKeyReader. + +

        Configure the key reader to be used to decrypt message payloads.

        +
        +
        Parameters:
        +
        privateKey - the private key that is always used to decrypt message payloads.
        +
        Returns:
        +
        the consumer builder instance
        +
        Since:
        +
        2.8.0
        +
        +
        +
        • +
      • +
        +

        defaultCryptoKeyReader

        +
        ConsumerBuilder<T> defaultCryptoKeyReader(Map<String,String> privateKeys)
        +
        Sets the default implementation of CryptoKeyReader. + +

        Configure the key reader to be used to decrypt the message payloads.

        +
        +
        Parameters:
        +
        privateKeys - the map of private key names and their URIs used to decrypt message payloads.
        +
        Returns:
        +
        the consumer builder instance
        +
        Since:
        +
        2.8.0
        +
        +
        +
        • +
      • +
        +

        messageCrypto

        +
        ConsumerBuilder<T> messageCrypto(MessageCrypto messageCrypto)
        +
        Sets a MessageCrypto. + +

        Contains methods to encrypt/decrypt messages for end-to-end encryption.

        +
        +
        Parameters:
        +
        messageCrypto - MessageCrypto object
        +
        Returns:
        +
        the consumer builder instance
        +
        +
        +
        • +
      • +
        +

        cryptoFailureAction

        +
        ConsumerBuilder<T> cryptoFailureAction(ConsumerCryptoFailureAction action)
        +
        Sets the ConsumerCryptoFailureAction to the value specified.
        +
        +
        Parameters:
        +
        action - the action the consumer takes in case of decryption failures
        +
        Returns:
        +
        the consumer builder instance
        +
        +
        +
        • +
      • +
        +

        receiverQueueSize

        +
        ConsumerBuilder<T> receiverQueueSize(int receiverQueueSize)
        +
        Sets the size of the consumer receive queue. + +

        The consumer receive queue controls how many messages can be accumulated by the Consumer before the + application calls Consumer.receive(). Using a higher value can potentially increase consumer + throughput at the expense of bigger memory utilization. + +

        For the consumer that subscribes to the partitioned topic, the parameter + maxTotalReceiverQueueSizeAcrossPartitions(int) also affects + the number of messages accumulated in the consumer. + +

        Setting the consumer queue size as zero +

          +
        • Decreases the throughput of the consumer by disabling pre-fetching of messages. This approach improves the + message distribution on shared subscriptions by pushing messages only to the consumers that are ready to process + them. Neither Consumer.receive(int, TimeUnit) nor Partitioned Topics can be used if the consumer queue + size is zero. Consumer.receive() function call should not be interrupted when the consumer queue size is + zero.
          • +
        • Doesn't support Batch-Message. If a consumer receives a batch-message, it closes the consumer connection with + the broker and Consumer.receive() calls remain blocked while Consumer.receiveAsync() receives + exception in callback. + + The consumer is not able to receive any further messages unless batch-message in pipeline + is removed.
          • +
        + The default value is 1000 messages and should be adequate for most use cases.
        +
        +
        Parameters:
        +
        receiverQueueSize - the new receiver queue size value
        +
        Returns:
        +
        the consumer builder instance
        +
        +
        +
        • +
      • +
        +

        acknowledgmentGroupTime

        +
        ConsumerBuilder<T> acknowledgmentGroupTime(long delay, + TimeUnit unit)
        +
        Sets amount of time for group consumer acknowledgments. + +

        By default, the consumer uses a 100 ms grouping time to send out acknowledgments to the broker. + +

        Setting a group time of 0 sends out acknowledgments immediately. A longer acknowledgment group time + is more efficient, but at the expense of a slight increase in message re-deliveries after a failure.

        +
        +
        Parameters:
        +
        delay - the max amount of time an acknowledgement can be delayed
        +
        unit - the time unit for the delay
        +
        Returns:
        +
        the consumer builder instance
        +
        +
        +
        • +
      • +
        +

        maxAcknowledgmentGroupSize

        +
        ConsumerBuilder<T> maxAcknowledgmentGroupSize(int messageNum)
        +
        Set the number of messages for group consumer acknowledgments. + +

        By default, the consumer uses at most 1000 messages to send out acknowledgments to the broker.

        +
        +
        Parameters:
        +
        messageNum -
        +
        Returns:
        +
        the consumer builder instance
        +
        +
        +
        • +
      • +
        +

        replicateSubscriptionState

        +
        ConsumerBuilder<T> replicateSubscriptionState(boolean replicateSubscriptionState)
        +
        +
        Parameters:
        +
        replicateSubscriptionState -
        +
        +
        +
        • +
      • +
        +

        maxTotalReceiverQueueSizeAcrossPartitions

        +
        ConsumerBuilder<T> maxTotalReceiverQueueSizeAcrossPartitions(int maxTotalReceiverQueueSizeAcrossPartitions)
        +
        Sets the max total receiver queue size across partitions. + +

        This setting is used to reduce the receiver queue size for individual partitions + receiverQueueSize(int) if the total exceeds this value (default: 50000). + The purpose of this setting is to have an upper-limit on the number + of messages that a consumer can be pushed at once from a broker, across all + the partitions. + +

        This setting is applicable only to consumers subscribing to partitioned topics. In such cases, there will + be multiple queues for each partition and a single queue for the parent consumer. This setting controls the + queues of all partitions, not the parent queue. For instance, if a consumer subscribes to a single partitioned + topic, the total number of messages accumulated in this consumer will be the sum of + receiverQueueSize(int) and maxTotalReceiverQueueSizeAcrossPartitions.

        +
        +
        Parameters:
        +
        maxTotalReceiverQueueSizeAcrossPartitions - max pending messages across all the partitions
        +
        Returns:
        +
        the consumer builder instance
        +
        +
        +
        • +
      • +
        +

        consumerName

        +
        ConsumerBuilder<T> consumerName(String consumerName)
        +
        Sets the consumer name. + +

        Consumer names are informative, and can be used to identify a particular consumer + instance from the topic stats.

        +
        +
        Parameters:
        +
        consumerName -
        +
        Returns:
        +
        the consumer builder instance
        +
        +
        +
        • +
      • +
        +

        consumerEventListener

        +
        ConsumerBuilder<T> consumerEventListener(ConsumerEventListener consumerEventListener)
        +
        Sets a ConsumerEventListener for the consumer. + +

        The consumer group listener is used for receiving consumer state changes in a consumer group for failover + subscriptions. The application can then react to the consumer state changes.

        +
        +
        Parameters:
        +
        consumerEventListener - the consumer group listener object
        +
        Returns:
        +
        the consumer builder instance
        +
        +
        +
        • +
      • +
        +

        readCompacted

        +
        ConsumerBuilder<T> readCompacted(boolean readCompacted)
        +
        If enabled, the consumer reads messages from the compacted topic rather than the full message topic backlog. + This means that, if the topic has been compacted, the consumer will only see the latest value for + each key in the topic, up until the point in the topic message backlog that has been compacted. Beyond that + point, the messages are sent as normal. + +

        readCompacted can only be enabled on subscriptions to persistent topics with a single active consumer + (i.e. failover or exclusive subscriptions). Enabling readCompacted on subscriptions to non-persistent + topics or on shared subscriptions will cause the subscription call to throw a PulsarClientException.

        +
        +
        Parameters:
        +
        readCompacted - whether to read from the compacted topic or full message topic backlog
        +
        Returns:
        +
        the consumer builder instance
        +
        +
        +
        • +
      • +
        +

        patternAutoDiscoveryPeriod

        +
        ConsumerBuilder<T> patternAutoDiscoveryPeriod(int periodInMinutes)
        +
        Sets topic's auto-discovery period when using a pattern for topic's consumer. + The period is in minutes, and the default and minimum values are 1 minute.
        +
        +
        Parameters:
        +
        periodInMinutes - number of minutes between checks for + new topics matching pattern set with topicsPattern(String)
        +
        Returns:
        +
        the consumer builder instance
        +
        +
        +
        • +
      • +
        +

        patternAutoDiscoveryPeriod

        +
        ConsumerBuilder<T> patternAutoDiscoveryPeriod(int interval, + TimeUnit unit)
        +
        Sets topic's auto-discovery period when using a pattern for topic's consumer. + The default value of period is 1 minute, with a minimum of 1 second.
        +
        +
        Parameters:
        +
        interval - the amount of delay between checks for + new topics matching pattern set with topicsPattern(String)
        +
        unit - the unit of the topics auto discovery period
        +
        Returns:
        +
        the consumer builder instance
        +
        +
        +
        • +
      • +
        +

        priorityLevel

        +
        ConsumerBuilder<T> priorityLevel(int priorityLevel)
        +
        Shared subscription +

        Sets priority level for shared subscription consumers to determine which consumers the broker prioritizes when + dispatching messages. Here, the broker follows descending priorities. (eg: 0=max-priority, 1, 2,..) + +

        In Shared subscription mode, the broker first dispatches messages to max priority-level + consumers if they have permits, otherwise the broker considers next priority level consumers. + +

        If a subscription has consumer-A with priorityLevel 0 and Consumer-B with priorityLevel 1, + then the broker dispatches messages to only consumer-A until it is drained, and then the broker will + start dispatching messages to Consumer-B. + + 

        + Consumer PriorityLevel Permits
+ C1       0             2
+ C2       0             1
+ C3       0             1
+ C4       1             2
+ C5       1             1
+ Order in which broker dispatches messages to consumers: C1, C2, C3, C1, C4, C5, C4
+
        + +

        Failover subscription for partitioned topic + The broker selects the active consumer for a failover subscription for a partitioned topic + based on consumer's priority-level and lexicographical sorting of consumer name. + eg: + 

        + 1. Active consumer = C1 : Same priority-level and lexicographical sorting
+ Consumer PriorityLevel Name
+ C1       0             aaa
+ C2       0             bbb
+
+ 2. Active consumer = C2 : Consumer with highest priority
+ Consumer PriorityLevel Name
+ C1       1             aaa
+ C2       0             bbb
+
+ Partitioned-topics:
+ Broker evenly assigns partitioned topics to highest priority consumers.
+
        + +

        Priority level has no effect on failover subscriptions for non-partitioned topics.

        +
        +
        Parameters:
        +
        priorityLevel - the priority of this consumer
        +
        Returns:
        +
        the consumer builder instance
        +
        +
        +
        • +
      • +
        +

        property

        +
        ConsumerBuilder<T> property(String key, + String value)
        +
        Sets a name/value property with this consumer. + +

        Properties are application-defined metadata that can be attached to the consumer. + When getting topic stats, this metadata is associated with the consumer stats for easier identification.

        +
        +
        Parameters:
        +
        key - the property key
        +
        value - the property value
        +
        Returns:
        +
        the consumer builder instance
        +
        +
        +
        • +
      • +
        +

        properties

        +
        ConsumerBuilder<T> properties(Map<String,String> properties)
        +
        Add all the properties in the provided map to the consumer. + +

        Properties are application-defined metadata that can be attached to the consumer. + When getting topic stats, this metadata is associated with the consumer stats for easier identification.

        +
        +
        Parameters:
        +
        properties - the map with properties
        +
        Returns:
        +
        the consumer builder instance
        +
        +
        +
        • +
      • +
        +

        subscriptionInitialPosition

        +
        ConsumerBuilder<T> subscriptionInitialPosition(SubscriptionInitialPosition subscriptionInitialPosition)
        +
        Sets the SubscriptionInitialPosition for the consumer.
        +
        +
        Parameters:
        +
        subscriptionInitialPosition - the position where to initialize a newly created subscription
        +
        Returns:
        +
        the consumer builder instance
        +
        +
        +
        • +
      • +
        +

        subscriptionTopicsMode

        +
        ConsumerBuilder<T> subscriptionTopicsMode(RegexSubscriptionMode regexSubscriptionMode)
        +
        Determines which topics this consumer should be subscribed to - Persistent, Non-Persistent, or both. Only used + with pattern subscriptions.
        +
        +
        Parameters:
        +
        regexSubscriptionMode - Pattern subscription mode
        +
        +
        +
        • +
      • +
        +

        intercept

        +
        ConsumerBuilder<T> intercept(ConsumerInterceptor<T>... interceptors)
        +
        Intercept Consumer.
        +
        +
        Parameters:
        +
        interceptors - the list of interceptors to intercept the consumer created by this builder.
        +
        +
        +
        • +
      • +
        +

        deadLetterPolicy

        +
        ConsumerBuilder<T> deadLetterPolicy(DeadLetterPolicy deadLetterPolicy)
        +
        Sets dead letter policy for a consumer. + +

        By default, messages are redelivered as many times as possible until they are acknowledged. + If you enable a dead letter mechanism, messages will have a maxRedeliverCount. When a message exceeds the maximum + number of redeliveries, the message is sent to the Dead Letter Topic and acknowledged automatically. + +

        Enable the dead letter mechanism by setting dead letter policy. + example: + 

        + client.newConsumer()
+          .deadLetterPolicy(DeadLetterPolicy.builder().maxRedeliverCount(10).build())
+          .subscribe();
+
        + Default dead letter topic name is {TopicName}-{Subscription}-DLQ. + To set a custom dead letter topic name: + 
        + client.newConsumer()
+          .deadLetterPolicy(DeadLetterPolicy
+              .builder()
+              .maxRedeliverCount(10)
+              .deadLetterTopic("your-topic-name")
+              .build())
+          .subscribe();
+
        +
        +
        • +
      • +
        +

        autoUpdatePartitions

        +
        ConsumerBuilder<T> autoUpdatePartitions(boolean autoUpdate)
        +
        If enabled, the consumer auto-subscribes for partition increases. + This is only for partitioned consumers.
        +
        +
        Parameters:
        +
        autoUpdate - whether to auto-update partition increases
        +
        +
        +
        • +
      • +
        +

        autoUpdatePartitionsInterval

        +
        ConsumerBuilder<T> autoUpdatePartitionsInterval(int interval, + TimeUnit unit)
        +
        Sets the interval of updating partitions (default: 1 minute). This only works if autoUpdatePartitions is + enabled.
        +
        +
        Parameters:
        +
        interval - the interval of updating partitions
        +
        unit - the time unit of the interval.
        +
        Returns:
        +
        the consumer builder instance
        +
        +
        +
        • +
      • +
        +

        keySharedPolicy

        +
        ConsumerBuilder<T> keySharedPolicy(KeySharedPolicy keySharedPolicy)
        +
        Sets KeyShared subscription policy for consumer. + +

        By default, KeyShared subscriptions use auto split hash ranges to maintain consumers. If you want to + set a different KeyShared policy, set a policy by using one of the following examples: + +

        Sticky hash range policy

        + 
        + client.newConsumer()
+          .keySharedPolicy(KeySharedPolicy.stickyHashRange().ranges(Range.of(0, 10)))
+          .subscribe();
+
        + For details about sticky hash range policies, see KeySharedPolicy.KeySharedPolicySticky. + +

        Auto-split hash range policy

        + 
        + client.newConsumer()
+          .keySharedPolicy(KeySharedPolicy.autoSplitHashRange())
+          .subscribe();
+
        + For details about auto-split hash range policies, see KeySharedPolicy.KeySharedPolicyAutoSplit.
        +
        +
        Parameters:
        +
        keySharedPolicy - The KeySharedPolicy to specify
        +
        +
        +
        • +
      • +
        +

        startMessageIdInclusive

        +
        ConsumerBuilder<T> startMessageIdInclusive()
        +
        Sets the consumer to include the given position of any reset operation like Consumer.seek(long) or + Consumer.seek(MessageId)}.
        +
        +
        Returns:
        +
        the consumer builder instance
        +
        +
        +
        • +
      • +
        +

        batchReceivePolicy

        +
        ConsumerBuilder<T> batchReceivePolicy(BatchReceivePolicy batchReceivePolicy)
        +
        Sets BatchReceivePolicy for the consumer. + By default, consumer uses BatchReceivePolicy.DEFAULT_POLICY as batch receive policy. + +

        Example: + 

        + client.newConsumer().batchReceivePolicy(BatchReceivePolicy.builder()
+              .maxNumMessages(100)
+              .maxNumBytes(5 * 1024 * 1024)
+              .timeout(100, TimeUnit.MILLISECONDS)
+              .build()).subscribe();
+
        +
        +
        • +
      • +
        +

        enableRetry

        +
        ConsumerBuilder<T> enableRetry(boolean retryEnable)
        +
        If enabled, the consumer auto-retries messages. + Default: disabled.
        +
        +
        Parameters:
        +
        retryEnable - whether to auto retry message
        +
        +
        +
        • +
      • +
        +

        enableBatchIndexAcknowledgment

        +
        ConsumerBuilder<T> enableBatchIndexAcknowledgment(boolean batchIndexAcknowledgmentEnabled)
        +
        Enable or disable batch index acknowledgment. To enable this feature, ensure batch index acknowledgment + is enabled on the broker side.
        +
        +
        • +
      • +
        +

        maxPendingChuckedMessage

        +
        @Deprecated +ConsumerBuilder<T> maxPendingChuckedMessage(int maxPendingChuckedMessage)
        +
        Deprecated. +
        use maxPendingChunkedMessage(int)
        +
        +
        Consumer buffers chunk messages into memory until it receives all the chunks of the original message. While + consuming chunk-messages, chunks from same message might not be contiguous in the stream and they might be mixed + with other messages' chunks. so, consumer has to maintain multiple buffers to manage chunks coming from different + messages. This mainly happens when multiple publishers are publishing messages on the topic concurrently or + publisher failed to publish all chunks of the messages. + + 
        + eg: M1-C1, M2-C1, M1-C2, M2-C2
+ Here, Messages M1-C1 and M1-C2 belong to original message M1, M2-C1 and M2-C2 messages belong to M2 message.
+
        + Buffering large number of outstanding uncompleted chunked messages can create memory pressure and it can be + guarded by providing this @maxPendingChuckedMessage threshold. Once, consumer reaches this threshold, it drops + the outstanding unchunked-messages by silently acking or asking broker to redeliver later by marking it unacked. + This behavior can be controlled by configuration: @autoAckOldestChunkedMessageOnQueueFull + + The default value is 10.
        +
        +
        Parameters:
        +
        maxPendingChuckedMessage -
        +
        Returns:
        +
        +
        +
        • +
      • +
        +

        maxPendingChunkedMessage

        +
        ConsumerBuilder<T> maxPendingChunkedMessage(int maxPendingChunkedMessage)
        +
        Consumer buffers chunk messages into memory until it receives all the chunks of the original message. While + consuming chunk-messages, chunks from same message might not be contiguous in the stream and they might be mixed + with other messages' chunks. so, consumer has to maintain multiple buffers to manage chunks coming from different + messages. This mainly happens when multiple publishers are publishing messages on the topic concurrently or + publisher failed to publish all chunks of the messages. + + 
        + eg: M1-C1, M2-C1, M1-C2, M2-C2
+ Here, Messages M1-C1 and M1-C2 belong to original message M1, M2-C1 and M2-C2 messages belong to M2 message.
+
        + Buffering large number of outstanding uncompleted chunked messages can create memory pressure and it can be + guarded by providing this @maxPendingChunkedMessage threshold. Once, consumer reaches this threshold, it drops + the outstanding unchunked-messages by silently acking or asking broker to redeliver later by marking it unacked. + This behavior can be controlled by configuration: @autoAckOldestChunkedMessageOnQueueFull + + The default value is 10.
        +
        +
        Parameters:
        +
        maxPendingChunkedMessage -
        +
        Returns:
        +
        +
        +
        • +
      • +
        +

        autoAckOldestChunkedMessageOnQueueFull

        +
        ConsumerBuilder<T> autoAckOldestChunkedMessageOnQueueFull(boolean autoAckOldestChunkedMessageOnQueueFull)
        +
        Buffering large number of outstanding uncompleted chunked messages can create memory pressure and it can be + guarded by providing this @maxPendingChunkedMessage threshold. Once the consumer reaches this threshold, it drops + the outstanding unchunked-messages by silently acknowledging if autoAckOldestChunkedMessageOnQueueFull is true, + otherwise it marks them for redelivery.
        +
        +
        Parameters:
        +
        autoAckOldestChunkedMessageOnQueueFull -
        +
        Returns:
        +
        +
        +
        • +
      • +
        +

        expireTimeOfIncompleteChunkedMessage

        +
        ConsumerBuilder<T> expireTimeOfIncompleteChunkedMessage(long duration, + TimeUnit unit)
        +
        If the producer fails to publish all the chunks of a message, then the consumer can expire incomplete chunks if + the consumer doesn't receive all chunks during the expiration period (default 1 minute).
        +
        +
        Parameters:
        +
        duration -
        +
        unit -
        +
        Returns:
        +
        +
        +
        • +
      • +
        +

        poolMessages

        +
        ConsumerBuilder<T> poolMessages(boolean poolMessages)
        +
        Enable pooling of messages and the underlying data buffers. +

        + When pooling is enabled, the application is responsible for calling Message.release() after the handling of every + received message. If “release()” is not called on a received message, it causes a memory leak. If an + application attempts to use an already “released” message, it might experience undefined behavior (eg: memory + corruption, deserialization error, etc.).

        +
        +
        • +
      • +
        +

        messagePayloadProcessor

        +
        ConsumerBuilder<T> messagePayloadProcessor(MessagePayloadProcessor payloadProcessor)
        +
        If configured with a non-null value, the consumer uses the processor to process the payload, including + decoding it to messages and triggering the listener. + + Default: null
        +
        +
        • +
      • +
        +

        negativeAckRedeliveryBackoff

        +
        ConsumerBuilder<T> negativeAckRedeliveryBackoff(RedeliveryBackoff negativeAckRedeliveryBackoff)
        +
        negativeAckRedeliveryBackoff sets the redelivery backoff policy for messages that are negatively acknowledged + using + `consumer.negativeAcknowledge(Messageinvalid input: '<'?> message)` but not with `consumer.negativeAcknowledge(MessageId + messageId)`. + This setting allows specifying a backoff policy for messages that are negatively acknowledged, + enabling more flexible control over the delay before such messages are redelivered. + +

        This configuration accepts a RedeliveryBackoff object that defines the backoff policy. + The policy can be either a fixed delay or an exponential backoff. An exponential backoff policy + is beneficial in scenarios where increasing the delay between consecutive redeliveries can help + mitigate issues like temporary resource constraints or processing bottlenecks. + +

        Note: This backoff policy does not apply when using `consumer.negativeAcknowledge(MessageId messageId)` + because the redelivery count cannot be determined from just the message ID. It is recommended to use + `consumer.negativeAcknowledge(Messageinvalid input: '<'?> message)` if you want to leverage the redelivery backoff policy. + +

        Example usage: + 

        
+ client.newConsumer()
+       .negativeAckRedeliveryBackoff(ExponentialRedeliveryBackoff.builder()
+           .minDelayMs(1000)   // Set minimum delay to 1 second
+           .maxDelayMs(60000)  // Set maximum delay to 60 seconds
+           .build())
+       .subscribe();
+
        +
        +
        Parameters:
        +
        negativeAckRedeliveryBackoff - the backoff policy to use for negatively acknowledged messages
        +
        Returns:
        +
        the consumer builder instance
        +
        +
        +
        • +
      • +
        +

        ackTimeoutRedeliveryBackoff

        +
        ConsumerBuilder<T> ackTimeoutRedeliveryBackoff(RedeliveryBackoff ackTimeoutRedeliveryBackoff)
        +
        Sets the redelivery backoff policy for messages that are redelivered due to acknowledgement timeout. + This setting allows you to specify a backoff policy for messages that are not acknowledged within + the specified ack timeout. By using a backoff policy, you can control the delay before a message + is redelivered, potentially improving consumer performance by avoiding immediate redelivery of + messages that might still be processing. + +

        This method accepts a RedeliveryBackoff object that defines the backoff policy to be used. + You can use either a fixed backoff policy or an exponential backoff policy. The exponential backoff + policy is particularly useful for scenarios where it may be beneficial to progressively increase the + delay between redeliveries, reducing the load on the consumer and giving more time to process messages. + +

        Example usage: + 

        
+ client.newConsumer()
+       .ackTimeout(10, TimeUnit.SECONDS)
+       .ackTimeoutRedeliveryBackoff(ExponentialRedeliveryBackoff.builder()
+           .minDelayMs(1000)   // Set minimum delay to 1 second
+           .maxDelayMs(60000)  // Set maximum delay to 60 seconds
+           .build())
+       .subscribe();
+
        + +

        Note: This configuration is effective only if the ack timeout is triggered. It does not apply to + messages negatively acknowledged using the negative acknowledgment API.

        +
        +
        Parameters:
        +
        ackTimeoutRedeliveryBackoff - the backoff policy to use for messages that exceed their ack timeout
        +
        Returns:
        +
        the consumer builder instance
        +
        +
        +
        • +
      • +
        +

        startPaused

        +
        ConsumerBuilder<T> startPaused(boolean paused)
        +
        Starts the consumer in a paused state. When enabled, the consumer does not immediately fetch messages when + subscribe() is called. Instead, the consumer waits to fetch messages until Consumer.resume() is + called. +

        + See also Consumer.pause().

        +
        +
        • +
      • +
        +

        autoScaledReceiverQueueSizeEnabled

        +
        ConsumerBuilder<T> autoScaledReceiverQueueSizeEnabled(boolean enabled)
        +
        If this is enabled, the consumer receiver queue size is initialized as a very small value, 1 by default, + and will double itself until it reaches the value set by receiverQueueSize(int), if and only if: +

        1) User calls receive() and there are no messages in receiver queue. +

        2) The last message we put in the receiver queue took the last space available in receiver queue. + + This is disabled by default and currentReceiverQueueSize is initialized as maxReceiverQueueSize. + + The feature should be able to reduce client memory usage.

        +
        +
        Parameters:
        +
        enabled - whether to enable AutoScaledReceiverQueueSize.
        +
        +
        +
        • +
      • +
        +

        topicConfiguration

        +
        TopicConsumerBuilder<T> topicConfiguration(String topicName)
        +
        Configure topic specific options to override those set at the ConsumerBuilder level.
        +
        +
        Parameters:
        +
        topicName - a topic name
        +
        Returns:
        +
        a TopicConsumerBuilder instance
        +
        +
        +
        • +
      • +
        +

        topicConfiguration

        +
        ConsumerBuilder<T> topicConfiguration(String topicName, + Consumer<TopicConsumerBuilder<T>> builderConsumer)
        +
        Configure topic specific options to override those set at the ConsumerBuilder level.
        +
        +
        Parameters:
        +
        topicName - a topic name
        +
        builderConsumer - a consumer to allow the configuration of the TopicConsumerBuilder instance
        +
        +
        +
        • +
      • +
        +

        topicConfiguration

        +
        TopicConsumerBuilder<T> topicConfiguration(Pattern topicsPattern)
        +
        Configure topic specific options to override those set at the ConsumerBuilder level.
        +
        +
        Parameters:
        +
        topicsPattern - a regular expression to match a topic name
        +
        Returns:
        +
        a TopicConsumerBuilder instance
        +
        +
        +
        • +
      • +
        +

        topicConfiguration

        +
        ConsumerBuilder<T> topicConfiguration(Pattern topicsPattern, + Consumer<TopicConsumerBuilder<T>> builderConsumer)
        +
        Configure topic specific options to override those set at the ConsumerBuilder level.
        +
        +
        Parameters:
        +
        topicsPattern - a regular expression to match a topic name
        +
        builderConsumer - a consumer to allow the configuration of the TopicConsumerBuilder instance
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/ConsumerCryptoFailureAction.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/ConsumerCryptoFailureAction.html new file mode 100644 index 000000000000..5f9b42c0747b --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/ConsumerCryptoFailureAction.html @@ -0,0 +1,263 @@ + + + + +ConsumerCryptoFailureAction (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Enum Class ConsumerCryptoFailureAction

    +
    +
    java.lang.Object +
    java.lang.Enum<ConsumerCryptoFailureAction> +
    org.apache.pulsar.client.api.ConsumerCryptoFailureAction
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable, Comparable<ConsumerCryptoFailureAction>, Constable
    +
    +
    +
    @Public +@Stable +public enum ConsumerCryptoFailureAction +extends Enum<ConsumerCryptoFailureAction>
    +
    The action a consumer should take when a consumer receives a + message that it cannot decrypt.
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Enum Constant Details

      +
        +
      • +
        +

        FAIL

        +
        public static final ConsumerCryptoFailureAction FAIL
        +
        This is the default option to fail consume messages until crypto succeeds.
        +
        +
        • +
      • +
        +

        DISCARD

        +
        public static final ConsumerCryptoFailureAction DISCARD
        +
        Message is silently acknowledged and not delivered to the application.
        +
        +
        • +
      • +
        +

        CONSUME

        +
        public static final ConsumerCryptoFailureAction CONSUME
        +
        Deliver the encrypted message to the application. It's the application's responsibility to decrypt the message. + +

        If message is also compressed, decompression will fail. If message contain batch messages, client will not be + able to retrieve individual messages in the batch. + +

        Delivered encrypted message contains EncryptionContext which contains + encryption and compression information in it using which application can decrypt consumed message payload.

        +
        +
        • +
      +
      +
      • + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        values

        +
        public static ConsumerCryptoFailureAction[] values()
        +
        Returns an array containing the constants of this enum class, in +the order they are declared.
        +
        +
        Returns:
        +
        an array containing the constants of this enum class, in the order they are declared
        +
        +
        +
        • +
      • +
        +

        valueOf

        +
        public static ConsumerCryptoFailureAction valueOf(String name)
        +
        Returns the enum constant of this class with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this class. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        IllegalArgumentException - if this enum class has no constant with the specified name
        +
        NullPointerException - if the argument is null
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/ConsumerEventListener.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/ConsumerEventListener.html new file mode 100644 index 000000000000..ee9e1144d027 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/ConsumerEventListener.html @@ -0,0 +1,180 @@ + + + + +ConsumerEventListener (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Interface ConsumerEventListener

    +
    +
    +
    +
    All Superinterfaces:
    +
    Serializable
    +
    +
    +
    @Public +@Stable +public interface ConsumerEventListener +extends Serializable
    +
    Listener on the consumer state changes.
    +
    +
    +
      + +
    • +
      +

      Method Summary

      +
      +
      +
      +
      +
      Modifier and Type
      +
      Method
      +
      Description
      +
      void
      +
      becameActive(Consumer<?> consumer, + int partitionId)
      +
      +
      Notified when the consumer group is changed, and the consumer becomes the active consumer.
      +
      +
      void
      +
      becameInactive(Consumer<?> consumer, + int partitionId)
      +
      +
      Notified when the consumer group is changed, and the consumer is still inactive or becomes inactive.
      +
      +
      +
      +
      +
      +
      • +
    +
    +
    +
      + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        becameActive

        +
        void becameActive(Consumer<?> consumer, + int partitionId)
        +
        Notified when the consumer group is changed, and the consumer becomes the active consumer.
        +
        +
        Parameters:
        +
        consumer - the consumer that originated the event
        +
        partitionId - the id of the partition that became active
        +
        +
        +
        • +
      • +
        +

        becameInactive

        +
        void becameInactive(Consumer<?> consumer, + int partitionId)
        +
        Notified when the consumer group is changed, and the consumer is still inactive or becomes inactive.
        +
        +
        Parameters:
        +
        consumer - the consumer that originated the event
        +
        partitionId - the id of the partition that became inactive
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/ConsumerInterceptor.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/ConsumerInterceptor.html new file mode 100644 index 000000000000..1270200d62e7 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/ConsumerInterceptor.html @@ -0,0 +1,373 @@ + + + + +ConsumerInterceptor (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Interface ConsumerInterceptor<T>

    +
    +
    +
    +
    All Superinterfaces:
    +
    AutoCloseable
    +
    +
    +
    @Public +@Stable +public interface ConsumerInterceptor<T> +extends AutoCloseable
    +
    A plugin interface that allows you to intercept (and possibly mutate) + messages received by the consumer. + +

    A primary use case is to hook into consumer applications for custom + monitoring, logging, etc. + +

    Exceptions thrown by interceptor methods will be caught, logged, but + not propagated further.

    +
    +
    + +
    +
    +
      + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        close

        +
        void close()
        +
        Close the interceptor.
        +
        +
        Specified by:
        +
        close in interface AutoCloseable
        +
        +
        +
        • +
      • +
        +

        onArrival

        +
        default Message<T> onArrival(Consumer<T> consumer, + Message<T> message)
        +
        This method is called when a message arrives in the consumer. + +

        This method provides visibility into the messages that have been received + by the consumer but have not yet been processed. This can be useful for + monitoring the state of the consumer's receiver queue and understanding + the consumer's processing rate. + +

        The method is allowed to modify the message, in which case the modified + message will be returned. + +

        Any exception thrown by this method will be caught by the caller, logged, + but not propagated to the client. + +

        Since the consumer may run multiple interceptors, a particular + interceptor's onArrival callback will be called in the order + specified by ConsumerBuilder.intercept(ConsumerInterceptor[]). The + first interceptor in the list gets the consumed message, the following + interceptor will be passed the message returned by the previous interceptor, + and so on. Since interceptors are allowed to modify the message, interceptors + may potentially get the messages already modified by other interceptors. + However, building a pipeline of mutable interceptors that depend on the output + of the previous interceptor is discouraged, because of potential side-effects + caused by interceptors potentially failing to modify the message and throwing + an exception. If one of the interceptors in the list throws an exception from + onArrival, the exception is caught, logged, and the next interceptor + is called with the message returned by the last successful interceptor in the + list, or otherwise the original consumed message.

        +
        +
        Parameters:
        +
        consumer - the consumer which contains the interceptor
        +
        message - the message that has arrived in the receiver queue
        +
        Returns:
        +
        the message that is either modified by the interceptor or the same + message passed into the method
        +
        +
        +
        • +
      • +
        +

        beforeConsume

        +
        Message<T> beforeConsume(Consumer<T> consumer, + Message<T> message)
        +
        This is called just before the message is returned by + Consumer.receive(), MessageListener.received(Consumer, Message) or the CompletableFuture returned by + Consumer.receiveAsync() completes. + +

        This method is allowed to modify message, in which case the new message + will be returned. + +

        Any exception thrown by this method will be caught by the caller, logged, + but not propagated to client. + +

        Since the consumer may run multiple interceptors, a particular + interceptor's + beforeConsume callback will be called in the order specified by + ConsumerBuilder.intercept(ConsumerInterceptor[]). The first + interceptor in the list gets the consumed message, the following + interceptor will be passed + the message returned by the previous interceptor, and so on. Since + interceptors are allowed to modify message, interceptors may potentially + get the messages already modified by other interceptors. However building a + pipeline of mutable + interceptors that depend on the output of the previous interceptor is + discouraged, because of potential side-effects caused by interceptors + potentially failing to modify the message and throwing an exception. + if one of interceptors in the list throws an exception from + beforeConsume, the exception is caught, logged, + and the next interceptor is called with the message returned by the last + successful interceptor in the list, or otherwise the original consumed + message.

        +
        +
        Parameters:
        +
        consumer - the consumer which contains the interceptor
        +
        message - the message to be consumed by the client.
        +
        Returns:
        +
        message that is either modified by the interceptor or same message + passed into the method.
        +
        +
        +
        • +
      • +
        +

        onAcknowledge

        +
        void onAcknowledge(Consumer<T> consumer, + MessageId messageId, + Throwable exception)
        +
        This is called consumer sends the acknowledgment to the broker. + +

        Any exception thrown by this method will be ignored by the caller.

        +
        +
        Parameters:
        +
        consumer - the consumer which contains the interceptor
        +
        messageId - message to ack, null if acknowledge fail.
        +
        exception - the exception on acknowledge.
        +
        +
        +
        • +
      • +
        +

        onAcknowledgeCumulative

        +
        void onAcknowledgeCumulative(Consumer<T> consumer, + MessageId messageId, + Throwable exception)
        +
        This is called consumer send the cumulative acknowledgment to the broker. + +

        Any exception thrown by this method will be ignored by the caller.

        +
        +
        Parameters:
        +
        consumer - the consumer which contains the interceptor
        +
        messageId - message to ack, null if acknowledge fail.
        +
        exception - the exception on acknowledge.
        +
        +
        +
        • +
      • +
        +

        onNegativeAcksSend

        +
        void onNegativeAcksSend(Consumer<T> consumer, + Set<MessageId> messageIds)
        +
        This method will be called when a redelivery from a negative acknowledge occurs. + +

        Any exception thrown by this method will be ignored by the caller.

        +
        +
        Parameters:
        +
        consumer - the consumer which contains the interceptor
        +
        messageIds - the set of message ids to negatively ack
        +
        +
        +
        • +
      • +
        +

        onAckTimeoutSend

        +
        void onAckTimeoutSend(Consumer<T> consumer, + Set<MessageId> messageIds)
        +
        This method will be called when a redelivery from an acknowledge timeout occurs. + +

        Any exception thrown by this method will be ignored by the caller.

        +
        +
        Parameters:
        +
        consumer - the consumer which contains the interceptor
        +
        messageIds - message to ack, null if acknowledge fail.
        +
        +
        +
        • +
      • +
        +

        onPartitionsChange

        +
        default void onPartitionsChange(String topicName, + int partitions)
        +
        This method is called when partitions of the topic (partitioned-topic) changes.
        +
        +
        Parameters:
        +
        topicName - topic name
        +
        partitions - new updated number of partitions
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/ConsumerStats.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/ConsumerStats.html new file mode 100644 index 000000000000..d9627a2f5dbd --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/ConsumerStats.html @@ -0,0 +1,459 @@ + + + + +ConsumerStats (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Interface ConsumerStats

    +
    +
    +
    +
    All Superinterfaces:
    +
    Serializable
    +
    +
    +
    All Known Subinterfaces:
    +
    MultiTopicConsumerStats
    +
    +
    +
    @Public +@Evolving +@Deprecated +public interface ConsumerStats +extends Serializable
    +
    Deprecated. +
    use ClientBuilder.openTelemetry(OpenTelemetry) to enable stats
    +
    +
    Consumer statistics recorded by client. + +

    All the stats are relative to the last recording period. The interval of the stats refreshes is configured with + ClientBuilder.statsInterval(long, java.util.concurrent.TimeUnit) with a default of 1 minute.

    +
    +
    + +
    +
    +
      + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        getNumMsgsReceived

        +
        long getNumMsgsReceived()
        +
        Deprecated.
        +
        +
        Returns:
        +
        Number of messages received in the last interval
        +
        +
        +
        • +
      • +
        +

        getNumBytesReceived

        +
        long getNumBytesReceived()
        +
        Deprecated.
        +
        +
        Returns:
        +
        Number of bytes received in the last interval
        +
        +
        +
        • +
      • +
        +

        getRateMsgsReceived

        +
        double getRateMsgsReceived()
        +
        Deprecated.
        +
        +
        Returns:
        +
        Rate of bytes per second received in the last interval
        +
        +
        +
        • +
      • +
        +

        getRateBytesReceived

        +
        double getRateBytesReceived()
        +
        Deprecated.
        +
        +
        Returns:
        +
        Rate of bytes per second received in the last interval
        +
        +
        +
        • +
      • +
        +

        getNumAcksSent

        +
        long getNumAcksSent()
        +
        Deprecated.
        +
        +
        Returns:
        +
        Number of message acknowledgments sent in the last interval
        +
        +
        +
        • +
      • +
        +

        getNumAcksFailed

        +
        long getNumAcksFailed()
        +
        Deprecated.
        +
        +
        Returns:
        +
        Number of message acknowledgments failed in the last interval
        +
        +
        +
        • +
      • +
        +

        getNumReceiveFailed

        +
        long getNumReceiveFailed()
        +
        Deprecated.
        +
        +
        Returns:
        +
        Number of message receive failed in the last interval
        +
        +
        +
        • +
      • +
        +

        getNumBatchReceiveFailed

        +
        long getNumBatchReceiveFailed()
        +
        Deprecated.
        +
        +
        Returns:
        +
        Number of message batch receive failed in the last interval
        +
        +
        +
        • +
      • +
        +

        getTotalMsgsReceived

        +
        long getTotalMsgsReceived()
        +
        Deprecated.
        +
        +
        Returns:
        +
        Total number of messages received by this consumer
        +
        +
        +
        • +
      • +
        +

        getTotalBytesReceived

        +
        long getTotalBytesReceived()
        +
        Deprecated.
        +
        +
        Returns:
        +
        Total number of bytes received by this consumer
        +
        +
        +
        • +
      • +
        +

        getTotalReceivedFailed

        +
        long getTotalReceivedFailed()
        +
        Deprecated.
        +
        +
        Returns:
        +
        Total number of messages receive failures
        +
        +
        +
        • +
      • +
        +

        getTotaBatchReceivedFailed

        +
        long getTotaBatchReceivedFailed()
        +
        Deprecated.
        +
        +
        Returns:
        +
        Total number of messages batch receive failures
        +
        +
        +
        • +
      • +
        +

        getTotalAcksSent

        +
        long getTotalAcksSent()
        +
        Deprecated.
        +
        +
        Returns:
        +
        Total number of message acknowledgments sent by this consumer
        +
        +
        +
        • +
      • +
        +

        getTotalAcksFailed

        +
        long getTotalAcksFailed()
        +
        Deprecated.
        +
        +
        Returns:
        +
        Total number of message acknowledgments failures on this consumer
        +
        +
        +
        • +
      • +
        +

        getMsgNumInReceiverQueue

        +
        Integer getMsgNumInReceiverQueue()
        +
        Deprecated.
        +
        Get the size of receiver queue.
        +
        +
        Returns:
        +
        +
        +
        • +
      • +
        +

        getMsgNumInSubReceiverQueue

        +
        Map<Long,Integer> getMsgNumInSubReceiverQueue()
        +
        Deprecated.
        +
        Get the receiver queue size of sub-consumers.
        +
        +
        Returns:
        +
        +
        +
        • +
      • +
        +

        getPartitionStats

        +
        default Map<String,ConsumerStats> getPartitionStats()
        +
        Deprecated.
        +
        +
        Returns:
        +
        stats for each partition if topic is partitioned topic
        +
        +
        +
        • +
      • +
        +

        getDeadLetterProducerStats

        +
        ProducerStats getDeadLetterProducerStats()
        +
        Deprecated.
        +
        +
        Returns:
        +
        producer stats for deadLetterProducer if available
        +
        +
        +
        • +
      • +
        +

        getRetryLetterProducerStats

        +
        ProducerStats getRetryLetterProducerStats()
        +
        Deprecated.
        +
        +
        Returns:
        +
        producer stats for retryLetterProducer if available
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/ControlledClusterFailoverBuilder.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/ControlledClusterFailoverBuilder.html new file mode 100644 index 000000000000..551967dfffd2 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/ControlledClusterFailoverBuilder.html @@ -0,0 +1,230 @@ + + + + +ControlledClusterFailoverBuilder (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Interface ControlledClusterFailoverBuilder

    +
    +
    +
    +
    @Public +@Evolving +public interface ControlledClusterFailoverBuilder
    +
    ControlledClusterFailoverBuilder is used to configure and create instance of ServiceUrlProvider.
    +
    +
    Since:
    +
    2.10.0
    +
    +
    +
    + +
    +
    + +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/CryptoKeyReader.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/CryptoKeyReader.html new file mode 100644 index 000000000000..c85145f02898 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/CryptoKeyReader.html @@ -0,0 +1,189 @@ + + + + +CryptoKeyReader (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Interface CryptoKeyReader

    +
    +
    +
    +
    All Superinterfaces:
    +
    Serializable
    +
    +
    +
    All Known Implementing Classes:
    +
    DummyCryptoKeyReaderImpl
    +
    +
    +
    @Public +@Stable +public interface CryptoKeyReader +extends Serializable
    +
    Interface that abstracts the access to a key store.
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        getPublicKey

        +
        EncryptionKeyInfo getPublicKey(String keyName, + Map<String,String> metadata)
        +
        Return the encryption key corresponding to the key name in the argument. + +

        This method should be implemented to return the EncryptionKeyInfo. This method will be called at the time of + producer creation as well as consumer receiving messages. Hence, application should not make any blocking calls + within the implementation.

        +
        +
        Parameters:
        +
        keyName - Unique name to identify the key
        +
        metadata - Additional information needed to identify the key
        +
        Returns:
        +
        EncryptionKeyInfo with details about the public key
        +
        +
        +
        • +
      • +
        +

        getPrivateKey

        +
        EncryptionKeyInfo getPrivateKey(String keyName, + Map<String,String> metadata)
        +
        +
        Parameters:
        +
        keyName - Unique name to identify the key
        +
        metadata - Additional information needed to identify the key
        +
        Returns:
        +
        byte array of the private key value
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/DeadLetterPolicy.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/DeadLetterPolicy.html new file mode 100644 index 000000000000..a924bec77787 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/DeadLetterPolicy.html @@ -0,0 +1,161 @@ + + + + +DeadLetterPolicy (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Class DeadLetterPolicy

    +
    +
    java.lang.Object +
    org.apache.pulsar.client.api.DeadLetterPolicy
    +
    +
    +
    +
    @Public +@Stable +public class DeadLetterPolicy +extends Object
    +
    Configuration for the "dead letter queue" feature in consumer.
    +
    +
    See Also:
    +
    + +
    +
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        DeadLetterPolicy

        +
        public DeadLetterPolicy()
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/DummyCryptoKeyReaderImpl.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/DummyCryptoKeyReaderImpl.html new file mode 100644 index 000000000000..0c7ee6cbe31f --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/DummyCryptoKeyReaderImpl.html @@ -0,0 +1,232 @@ + + + + +DummyCryptoKeyReaderImpl (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Class DummyCryptoKeyReaderImpl

    +
    +
    java.lang.Object +
    org.apache.pulsar.client.api.DummyCryptoKeyReaderImpl
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable, CryptoKeyReader
    +
    +
    +
    public class DummyCryptoKeyReaderImpl +extends Object +implements CryptoKeyReader
    +
    An empty implement. Doesn't provide any public key or private key, and just returns `null`.
    +
    +
    See Also:
    +
    + +
    +
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Field Details

      + +
      +
      • + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        getPublicKey

        +
        public EncryptionKeyInfo getPublicKey(String keyName, + Map<String,String> metadata)
        +
        Description copied from interface: CryptoKeyReader
        +
        Return the encryption key corresponding to the key name in the argument. + +

        This method should be implemented to return the EncryptionKeyInfo. This method will be called at the time of + producer creation as well as consumer receiving messages. Hence, application should not make any blocking calls + within the implementation.

        +
        +
        Specified by:
        +
        getPublicKey in interface CryptoKeyReader
        +
        Parameters:
        +
        keyName - Unique name to identify the key
        +
        metadata - Additional information needed to identify the key
        +
        Returns:
        +
        EncryptionKeyInfo with details about the public key
        +
        +
        +
        • +
      • +
        +

        getPrivateKey

        +
        public EncryptionKeyInfo getPrivateKey(String keyName, + Map<String,String> metadata)
        +
        +
        Specified by:
        +
        getPrivateKey in interface CryptoKeyReader
        +
        Parameters:
        +
        keyName - Unique name to identify the key
        +
        metadata - Additional information needed to identify the key
        +
        Returns:
        +
        byte array of the private key value
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/EncodedAuthenticationParameterSupport.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/EncodedAuthenticationParameterSupport.html new file mode 100644 index 000000000000..f61dc8c684ba --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/EncodedAuthenticationParameterSupport.html @@ -0,0 +1,154 @@ + + + + +EncodedAuthenticationParameterSupport (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Interface EncodedAuthenticationParameterSupport

    +
    +
    +
    +
    @Public +@Stable +public interface EncodedAuthenticationParameterSupport
    +
    Support for encoded authentication configuration parameters.
    +
    +
    +
      + +
    • +
      +

      Method Summary

      +
      +
      +
      +
      +
      Modifier and Type
      +
      Method
      +
      Description
      +
      void
      +
      configure(String encodedAuthParamString)
      +
      +
      Plugins which use ":" and/or "," in a configuration parameter value need to implement this interface.
      +
      +
      +
      +
      +
      +
      • +
    +
    +
    +
      + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        configure

        +
        void configure(String encodedAuthParamString)
        +
        Plugins which use ":" and/or "," in a configuration parameter value need to implement this interface. + This interface will be integrated into Authentication interface and be required for all plugins on version 2.0.
        +
        +
        Parameters:
        +
        encodedAuthParamString -
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/EncryptionKeyInfo.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/EncryptionKeyInfo.html new file mode 100644 index 000000000000..9b9223137c97 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/EncryptionKeyInfo.html @@ -0,0 +1,218 @@ + + + + +EncryptionKeyInfo (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Class EncryptionKeyInfo

    +
    +
    java.lang.Object +
    org.apache.pulsar.client.api.EncryptionKeyInfo
    +
    +
    +
    +
    @Private +@Stable +public class EncryptionKeyInfo +extends Object
    +
    EncryptionKeyInfo contains the encryption key and corresponding metadata which contains additional information about + the key such as version, timestamp.
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        EncryptionKeyInfo

        +
        public EncryptionKeyInfo()
        +
        +
        • +
      • +
        +

        EncryptionKeyInfo

        +
        public EncryptionKeyInfo(byte[] key, + Map<String,String> metadata)
        +
        +
        • +
      +
      +
      • + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        getKey

        +
        public byte[] getKey()
        +
        +
        • +
      • +
        +

        setKey

        +
        public void setKey(byte[] key)
        +
        +
        • +
      • +
        +

        getMetadata

        +
        public Map<String,String> getMetadata()
        +
        +
        • +
      • +
        +

        setMetadata

        +
        public void setMetadata(Map<String,String> metadata)
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/HashingScheme.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/HashingScheme.html new file mode 100644 index 000000000000..e8debdce3469 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/HashingScheme.html @@ -0,0 +1,246 @@ + + + + +HashingScheme (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Enum Class HashingScheme

    +
    +
    java.lang.Object +
    java.lang.Enum<HashingScheme> +
    org.apache.pulsar.client.api.HashingScheme
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable, Comparable<HashingScheme>, Constable
    +
    +
    +
    @Public +@Stable +public enum HashingScheme +extends Enum<HashingScheme>
    +
    Standard hashing functions available when choosing the partition to use for a particular message.
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Enum Constant Details

      + +
      +
      • + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        values

        +
        public static HashingScheme[] values()
        +
        Returns an array containing the constants of this enum class, in +the order they are declared.
        +
        +
        Returns:
        +
        an array containing the constants of this enum class, in the order they are declared
        +
        +
        +
        • +
      • +
        +

        valueOf

        +
        public static HashingScheme valueOf(String name)
        +
        Returns the enum constant of this class with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this class. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        IllegalArgumentException - if this enum class has no constant with the specified name
        +
        NullPointerException - if the argument is null
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/KeySharedMode.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/KeySharedMode.html new file mode 100644 index 000000000000..49b68a376a51 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/KeySharedMode.html @@ -0,0 +1,247 @@ + + + + +KeySharedMode (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Enum Class KeySharedMode

    +
    +
    java.lang.Object +
    java.lang.Enum<KeySharedMode> +
    org.apache.pulsar.client.api.KeySharedMode
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable, Comparable<KeySharedMode>, Constable
    +
    +
    +
    @Public +@Stable +public enum KeySharedMode +extends Enum<KeySharedMode>
    +
    KeyShared mode of KeyShared subscription.
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Enum Constant Details

      +
        +
      • +
        +

        AUTO_SPLIT

        +
        public static final KeySharedMode AUTO_SPLIT
        +
        Auto split while new consumer connected.
        +
        +
        • +
      • +
        +

        STICKY

        +
        public static final KeySharedMode STICKY
        +
        New consumer with fixed hash range to attach the topic, if new consumer use conflict hash range with + exits consumers, new consumer will be rejected.
        +
        +
        • +
      +
      +
      • + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        values

        +
        public static KeySharedMode[] values()
        +
        Returns an array containing the constants of this enum class, in +the order they are declared.
        +
        +
        Returns:
        +
        an array containing the constants of this enum class, in the order they are declared
        +
        +
        +
        • +
      • +
        +

        valueOf

        +
        public static KeySharedMode valueOf(String name)
        +
        Returns the enum constant of this class with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this class. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        IllegalArgumentException - if this enum class has no constant with the specified name
        +
        NullPointerException - if the argument is null
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/KeySharedPolicy.KeySharedPolicyAutoSplit.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/KeySharedPolicy.KeySharedPolicyAutoSplit.html new file mode 100644 index 000000000000..af36256cff9a --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/KeySharedPolicy.KeySharedPolicyAutoSplit.html @@ -0,0 +1,182 @@ + + + + +KeySharedPolicy.KeySharedPolicyAutoSplit (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Class KeySharedPolicy.KeySharedPolicyAutoSplit

    +
    +
    java.lang.Object +
    org.apache.pulsar.client.api.KeySharedPolicy +
    org.apache.pulsar.client.api.KeySharedPolicy.KeySharedPolicyAutoSplit
    +
    +
    +
    +
    +
    Enclosing class:
    +
    KeySharedPolicy
    +
    +
    +
    public static class KeySharedPolicy.KeySharedPolicyAutoSplit +extends KeySharedPolicy
    +
    Auto split hash range key shared policy.
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Method Details

      + +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/KeySharedPolicy.KeySharedPolicySticky.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/KeySharedPolicy.KeySharedPolicySticky.html new file mode 100644 index 000000000000..b8b7d260cf98 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/KeySharedPolicy.KeySharedPolicySticky.html @@ -0,0 +1,236 @@ + + + + +KeySharedPolicy.KeySharedPolicySticky (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Class KeySharedPolicy.KeySharedPolicySticky

    +
    +
    java.lang.Object +
    org.apache.pulsar.client.api.KeySharedPolicy +
    org.apache.pulsar.client.api.KeySharedPolicy.KeySharedPolicySticky
    +
    +
    +
    +
    +
    Enclosing class:
    +
    KeySharedPolicy
    +
    +
    +
    public static class KeySharedPolicy.KeySharedPolicySticky +extends KeySharedPolicy
    +
    Sticky attach topic with fixed hash range. + +

    Total hash range size is 65536, using the sticky hash range policy should ensure that the provided ranges by + all consumers can cover the total hash range [0, 65535]. If not, while broker dispatcher can't find the consumer + for message, the cursor will rewind.

    +
    +
    + +
    +
    + +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/KeySharedPolicy.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/KeySharedPolicy.html new file mode 100644 index 000000000000..92aa32643212 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/KeySharedPolicy.html @@ -0,0 +1,328 @@ + + + + +KeySharedPolicy (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Class KeySharedPolicy

    +
    +
    java.lang.Object +
    org.apache.pulsar.client.api.KeySharedPolicy
    +
    +
    +
    +
    Direct Known Subclasses:
    +
    KeySharedPolicy.KeySharedPolicyAutoSplit, KeySharedPolicy.KeySharedPolicySticky
    +
    +
    +
    @Public +@Stable +public abstract class KeySharedPolicy +extends Object
    +
    KeyShared policy for KeyShared subscription.
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Field Details

      +
        +
      • +
        +

        keySharedMode

        +
        protected KeySharedMode keySharedMode
        +
        +
        • +
      • +
        +

        allowOutOfOrderDelivery

        +
        protected boolean allowOutOfOrderDelivery
        +
        +
        • +
      • +
        +

        DEFAULT_HASH_RANGE_SIZE

        +
        public static final int DEFAULT_HASH_RANGE_SIZE
        +
        +
        See Also:
        +
        + +
        +
        +
        +
        • +
      +
      +
      • + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        KeySharedPolicy

        +
        public KeySharedPolicy()
        +
        +
        • +
      +
      +
      • + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        autoSplitHashRange

        +
        public static KeySharedPolicy.KeySharedPolicyAutoSplit autoSplitHashRange()
        +
        +
        • +
      • +
        +

        stickyHashRange

        +
        public static KeySharedPolicy.KeySharedPolicySticky stickyHashRange()
        +
        +
        • +
      • +
        +

        validate

        +
        public abstract void validate()
        +
        +
        • +
      • +
        +

        setAllowOutOfOrderDelivery

        +
        public KeySharedPolicy setAllowOutOfOrderDelivery(boolean allowOutOfOrderDelivery)
        +
        If enabled, it will relax the ordering requirement, allowing the broker to send out-of-order messages in case of + failures. This will make it faster for new consumers to join without being stalled by an existing slow consumer. + +

        In this case, a single consumer will still receive all the keys, but they may be coming in different orders.

        +
        +
        Parameters:
        +
        allowOutOfOrderDelivery - whether to allow for out of order delivery
        +
        Returns:
        +
        KeySharedPolicy instance
        +
        +
        +
        • +
      • +
        +

        isAllowOutOfOrderDelivery

        +
        public boolean isAllowOutOfOrderDelivery()
        +
        +
        • +
      • +
        +

        getKeySharedMode

        +
        public KeySharedMode getKeySharedMode()
        +
        +
        • +
      • +
        +

        getHashRangeTotal

        +
        public int getHashRangeTotal()
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/KeyStoreParams.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/KeyStoreParams.html new file mode 100644 index 000000000000..a9872deec67e --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/KeyStoreParams.html @@ -0,0 +1,153 @@ + + + + +KeyStoreParams (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Class KeyStoreParams

    +
    +
    java.lang.Object +
    org.apache.pulsar.client.api.KeyStoreParams
    +
    +
    +
    +
    @Private +@Stable +public class KeyStoreParams +extends Object
    +
    KeyStore parameters used for tls authentication.
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        KeyStoreParams

        +
        public KeyStoreParams()
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/Message.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/Message.html new file mode 100644 index 000000000000..a382a6c217a8 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/Message.html @@ -0,0 +1,702 @@ + + + + +Message (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Interface Message<T>

    +
    +
    +
    +
    @Public +@Stable +public interface Message<T>
    +
    The message abstraction used in Pulsar.
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        getProperties

        +
        Map<String,String> getProperties()
        +
        Return the properties attached to the message. + +

        Properties are application defined key/value pairs that will be attached to the message.

        +
        +
        Returns:
        +
        an unmodifiable view of the properties map
        +
        +
        +
        • +
      • +
        +

        hasProperty

        +
        boolean hasProperty(String name)
        +
        Check whether the message has a specific property attached.
        +
        +
        Parameters:
        +
        name - the name of the property to check
        +
        Returns:
        +
        true if the message has the specified property and false if the properties is not defined
        +
        +
        +
        • +
      • +
        +

        getProperty

        +
        String getProperty(String name)
        +
        Get the value of a specific property.
        +
        +
        Parameters:
        +
        name - the name of the property
        +
        Returns:
        +
        the value of the property or null if the property was not defined
        +
        +
        +
        • +
      • +
        +

        getData

        +
        byte[] getData()
        +
        Get the raw payload of the message. + +

        Even when using the Schema and type-safe API, an application + has access to the underlying raw message payload.

        +
        +
        Returns:
        +
        the byte array with the message payload
        +
        +
        +
        • +
      • +
        +

        size

        +
        int size()
        +
        Get the uncompressed message payload size in bytes.
        +
        +
        Returns:
        +
        size in bytes.
        +
        +
        +
        • +
      • +
        +

        getValue

        +
        T getValue()
        +
        Get the de-serialized value of the message, according the configured Schema.
        +
        +
        Returns:
        +
        the deserialized value of the message
        +
        +
        +
        • +
      • +
        +

        getMessageId

        +
        MessageId getMessageId()
        +
        Get the unique message ID associated with this message. + +

        The message id can be used to univocally refer to a message without having the keep + the entire payload in memory. + +

        Only messages received from the consumer will have a message id assigned.

        +
        +
        Returns:
        +
        the message id null if this message was not received by this client instance
        +
        +
        +
        • +
      • +
        +

        getPublishTime

        +
        long getPublishTime()
        +
        Get the publish time of this message. The publish time is the timestamp that a client publish the message.
        +
        +
        Returns:
        +
        publish time of this message.
        +
        See Also:
        +
        + +
        +
        +
        +
        • +
      • +
        +

        getEventTime

        +
        long getEventTime()
        +
        Get the event time associated with this message. It is typically set by the applications via + +
        +invalid reference +
        MessageBuilder#setEventTime(long)
        +
        +. + +

        If there isn't any event time associated with this event, it will return 0.

        +
        +
        Returns:
        +
        the message event time or 0 if event time wasn't set
        +
        Since:
        +
        1.20.0
        +
        See Also:
        +
        +
          +
        • +
          +invalid reference +
          MessageBuilder#setEventTime(long)
          +
          +
          • +
        +
        +
        +
        +
        • +
      • +
        +

        getSequenceId

        +
        long getSequenceId()
        +
        Get the sequence id associated with this message. It is typically set by the applications via + +
        +invalid reference +
        MessageBuilder#setSequenceId(long)
        +
        +.
        +
        +
        Returns:
        +
        sequence id associated with this message.
        +
        Since:
        +
        1.22.0
        +
        See Also:
        +
        +
          +
        • +
          +invalid reference +
          MessageBuilder#setEventTime(long)
          +
          +
          • +
        +
        +
        +
        +
        • +
      • +
        +

        getProducerName

        +
        String getProducerName()
        +
        Get the producer name who produced this message.
        +
        +
        Returns:
        +
        producer name who produced this message, null if producer name is not set.
        +
        Since:
        +
        1.22.0
        +
        +
        +
        • +
      • +
        +

        hasKey

        +
        boolean hasKey()
        +
        Check whether the message has a key.
        +
        +
        Returns:
        +
        true if the key was set while creating the message and false if the key was not set + while creating the message
        +
        +
        +
        • +
      • +
        +

        getKey

        +
        String getKey()
        +
        Get the key of the message.
        +
        +
        Returns:
        +
        the key of the message
        +
        +
        +
        • +
      • +
        +

        hasBase64EncodedKey

        +
        boolean hasBase64EncodedKey()
        +
        Check whether the key has been base64 encoded.
        +
        +
        Returns:
        +
        true if the key is base64 encoded, false otherwise
        +
        +
        +
        • +
      • +
        +

        getKeyBytes

        +
        byte[] getKeyBytes()
        +
        Get bytes in key. If the key has been base64 encoded, it is decoded before being returned. + Otherwise, if the key is a plain string, this method returns the UTF_8 encoded bytes of the string.
        +
        +
        Returns:
        +
        the key in byte[] form
        +
        +
        +
        • +
      • +
        +

        hasOrderingKey

        +
        boolean hasOrderingKey()
        +
        Check whether the message has a ordering key.
        +
        +
        Returns:
        +
        true if the ordering key was set while creating the message + false if the ordering key was not set while creating the message
        +
        +
        +
        • +
      • +
        +

        getOrderingKey

        +
        byte[] getOrderingKey()
        +
        Get the ordering key of the message.
        +
        +
        Returns:
        +
        the ordering key of the message
        +
        +
        +
        • +
      • +
        +

        getTopicName

        +
        String getTopicName()
        +
        Get the topic the message was published to.
        +
        +
        Returns:
        +
        the topic the message was published to
        +
        +
        +
        • +
      • +
        +

        getEncryptionCtx

        +
        Optional<EncryptionContext> getEncryptionCtx()
        +
        EncryptionContext contains encryption and compression information in it using which application can + decrypt consumed message with encrypted-payload.
        +
        +
        Returns:
        +
        the optiona encryption context
        +
        +
        +
        • +
      • +
        +

        getRedeliveryCount

        +
        int getRedeliveryCount()
        +
        Get message redelivery count, redelivery count maintain in pulsar broker. When client acknowledge message + timeout, broker will dispatch message again with message redelivery count in CommandMessage defined. + +

        Message redelivery increases monotonically in a broker, when topic switch ownership to a another broker + redelivery count will be recalculated.

        +
        +
        Returns:
        +
        message redelivery count
        +
        Since:
        +
        2.3.0
        +
        +
        +
        • +
      • +
        +

        getSchemaVersion

        +
        byte[] getSchemaVersion()
        +
        Get schema version of the message.
        +
        +
        Returns:
        +
        Schema version of the message if the message is produced with schema otherwise null.
        +
        Since:
        +
        2.4.0
        +
        +
        +
        • +
      • +
        +

        getReaderSchema

        +
        default Optional<Schema<?>> getReaderSchema()
        +
        Get the schema associated to the message. + Please note that this schema is usually equal to the Schema you passed + during the construction of the Consumer or the Reader. + But if you are consuming the topic using the GenericObject interface + this method will return the schema associated with the message.
        +
        +
        Returns:
        +
        The schema used to decode the payload of message.
        +
        See Also:
        +
        + +
        +
        +
        +
        • +
      • +
        +

        isReplicated

        +
        boolean isReplicated()
        +
        Check whether the message is replicated from other cluster.
        +
        +
        Returns:
        +
        true if the message is replicated from other cluster. + false otherwise.
        +
        Since:
        +
        2.4.0
        +
        +
        +
        • +
      • +
        +

        getReplicatedFrom

        +
        String getReplicatedFrom()
        +
        Get name of cluster, from which the message is replicated.
        +
        +
        Returns:
        +
        the name of cluster, from which the message is replicated.
        +
        Since:
        +
        2.4.0
        +
        +
        +
        • +
      • +
        +

        release

        +
        void release()
        +
        Release a message back to the pool. This is required only if the consumer was created with the option to pool + messages, otherwise it will have no effect.
        +
        +
        Since:
        +
        2.8.0
        +
        +
        +
        • +
      • +
        +

        hasBrokerPublishTime

        +
        boolean hasBrokerPublishTime()
        +
        Check whether the message has a broker publish time.
        +
        +
        Returns:
        +
        true if the message has a broker publish time, otherwise false.
        +
        Since:
        +
        2.9.0
        +
        +
        +
        • +
      • +
        +

        getBrokerPublishTime

        +
        Optional<Long> getBrokerPublishTime()
        +
        Get broker publish time from broker entry metadata. + Note that only if the feature is enabled in the broker then the value is available.
        +
        +
        Returns:
        +
        broker publish time from broker entry metadata, or empty if the feature is not enabled in the broker.
        +
        Since:
        +
        2.9.0
        +
        +
        +
        • +
      • +
        +

        hasIndex

        +
        boolean hasIndex()
        +
        Check whether the message has an index.
        +
        +
        Returns:
        +
        true if the message has an index, otherwise false.
        +
        Since:
        +
        2.9.0
        +
        +
        +
        • +
      • +
        +

        getIndex

        +
        Optional<Long> getIndex()
        +
        Get index from broker entry metadata. + Note that only if the feature is enabled in the broker then the value is available.
        +
        +
        Returns:
        +
        index from broker entry metadata, or empty if the feature is not enabled in the broker.
        +
        Since:
        +
        2.9.0
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/MessageAcknowledger.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/MessageAcknowledger.html new file mode 100644 index 000000000000..6e2cf2d349d8 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/MessageAcknowledger.html @@ -0,0 +1,406 @@ + + + + +MessageAcknowledger (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Interface MessageAcknowledger

    +
    +
    +
    +
    All Known Subinterfaces:
    +
    Consumer<T>
    +
    +
    +
    public interface MessageAcknowledger
    +
    The interface to acknowledge one or more messages individually or cumulatively. +

    + It contains two methods of various overloads: + - `acknowledge`: acknowledge individually + - `acknowledgeCumulative`: acknowledge cumulatively + Each of them has an associated asynchronous API that has the "Async" suffix in the name. +

    + The 1st method parameter is + - MessageId or Message when acknowledging a single message + - List<MessageId> or Messages when acknowledging multiple messages +

    + The 2nd method parameter is optional. Specify a non-null Transaction instance for transaction usages: + - After the transaction is committed, the message will be actually acknowledged (individually or cumulatively). + - After the transaction is aborted, the message will be redelivered.

    +
    +
    See Also:
    +
    + +
    +
    +
    +
    + +
    +
    + +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/MessageCrypto.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/MessageCrypto.html new file mode 100644 index 000000000000..d0fb7a8b3f9c --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/MessageCrypto.html @@ -0,0 +1,256 @@ + + + + +MessageCrypto (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Interface MessageCrypto<MetadataT,BuilderT>

    +
    +
    +
    +
    @Public +@Stable +public interface MessageCrypto<MetadataT,BuilderT>
    +
    Interface that abstracts the method to encrypt/decrypt message for End to End Encryption.
    +
    +
    + +
    +
    + +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/MessageId.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/MessageId.html new file mode 100644 index 000000000000..5b0feb6e9ab8 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/MessageId.html @@ -0,0 +1,264 @@ + + + + +MessageId (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Interface MessageId

    +
    +
    +
    +
    All Superinterfaces:
    +
    Comparable<MessageId>, Serializable
    +
    +
    +
    All Known Subinterfaces:
    +
    TopicMessageId
    +
    +
    +
    @Public +@Stable +public interface MessageId +extends Comparable<MessageId>, Serializable
    +
    Opaque unique identifier of a single message + +

    The MessageId can be used to reference a specific message, for example when acknowledging, without having + to retain the message content in memory for an extended period of time. + +

    Message ids are Comparable and a bigger message id will imply that a message was published "after" + the other one.

    +
    +
    +
      + +
    • +
      +

      Field Summary

      +
      Fields
      +
      +
      Modifier and Type
      +
      Field
      +
      Description
      +
      static final MessageId
      +
      earliest
      +
      +
      MessageId that represents the oldest message available in the topic.
      +
      +
      static final MessageId
      +
      latest
      +
      +
      MessageId that represents the next message published in the topic.
      +
      +
      +
      +
      • + +
    • +
      +

      Method Summary

      +
      +
      +
      +
      +
      Modifier and Type
      +
      Method
      +
      Description
      +
      static MessageId
      +
      fromByteArray(byte[] data)
      +
      +
      De-serialize a message id from a byte array.
      +
      +
      static MessageId
      +
      fromByteArrayWithTopic(byte[] data, + String topicName)
      +
      +
      De-serialize a message id from a byte array with its topic + information attached.
      +
      +
      byte[]
      +
      toByteArray()
      +
      +
      Serialize the message ID into a byte array.
      +
      +
      +
      +
      +
      +

      Methods inherited from interface java.lang.Comparable

      +compareTo
      +
      +
      • +
    +
    +
    +
      + +
    • +
      +

      Field Details

      +
        +
      • +
        +

        earliest

        +
        static final MessageId earliest
        +
        MessageId that represents the oldest message available in the topic.
        +
        +
        • +
      • +
        +

        latest

        +
        static final MessageId latest
        +
        MessageId that represents the next message published in the topic.
        +
        +
        • +
      +
      +
      • + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        toByteArray

        +
        byte[] toByteArray()
        +
        Serialize the message ID into a byte array. + +

        The serialized message id can be stored away and later get deserialized by + using fromByteArray(byte[]).

        +
        +
        • +
      • +
        +

        fromByteArray

        +
        static MessageId fromByteArray(byte[] data) + throws IOException
        +
        De-serialize a message id from a byte array.
        +
        +
        Parameters:
        +
        data - byte array containing the serialized message id
        +
        Returns:
        +
        the de-serialized messageId object
        +
        Throws:
        +
        IOException - if the de-serialization fails
        +
        +
        +
        • +
      • +
        +

        fromByteArrayWithTopic

        +
        static MessageId fromByteArrayWithTopic(byte[] data, + String topicName) + throws IOException
        +
        De-serialize a message id from a byte array with its topic + information attached. + +

        The topic information is needed when acknowledging a MessageId on + a consumer that is consuming from multiple topics.

        +
        +
        Parameters:
        +
        data - the byte array with the serialized message id
        +
        topicName - the topic name
        +
        Returns:
        +
        a instance
        +
        Throws:
        +
        IOException - if the de-serialization fails
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/MessageListener.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/MessageListener.html new file mode 100644 index 000000000000..85cf384aa9e6 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/MessageListener.html @@ -0,0 +1,185 @@ + + + + +MessageListener (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Interface MessageListener<T>

    +
    +
    +
    +
    All Superinterfaces:
    +
    Serializable
    +
    +
    +
    @Public +@Stable +public interface MessageListener<T> +extends Serializable
    +
    A listener that will be called in order for every message received.
    +
    +
    +
      + +
    • +
      +

      Method Summary

      +
      +
      +
      +
      +
      Modifier and Type
      +
      Method
      +
      Description
      +
      default void
      +
      reachedEndOfTopic(Consumer<T> consumer)
      +
      +
      Get the notification when a topic is terminated.
      +
      +
      void
      +
      received(Consumer<T> consumer, + Message<T> msg)
      +
      +
      This method is called whenever a new message is received.
      +
      +
      +
      +
      +
      +
      • +
    +
    +
    +
      + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        received

        +
        void received(Consumer<T> consumer, + Message<T> msg)
        +
        This method is called whenever a new message is received. + +

        Messages are guaranteed to be delivered in order and from the same thread for a single consumer + +

        This method will only be called once for each message, unless either application or broker crashes. + +

        Application is responsible for acking message by calling any of consumer acknowledgement methods. + +

        Application is responsible of handling any exception that could be thrown while processing the message.

        +
        +
        Parameters:
        +
        consumer - the consumer that received the message
        +
        msg - the message object
        +
        +
        +
        • +
      • +
        +

        reachedEndOfTopic

        +
        default void reachedEndOfTopic(Consumer<T> consumer)
        +
        Get the notification when a topic is terminated.
        +
        +
        Parameters:
        +
        consumer - the Consumer object associated with the terminated topic
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/MessageListenerExecutor.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/MessageListenerExecutor.html new file mode 100644 index 000000000000..2f8d10da0bc6 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/MessageListenerExecutor.html @@ -0,0 +1,165 @@ + + + + +MessageListenerExecutor (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Interface MessageListenerExecutor

    +
    +
    +
    +
    public interface MessageListenerExecutor
    +
    Interface for providing service to execute message listeners.
    +
    +
    +
      + +
    • +
      +

      Method Summary

      +
      +
      +
      +
      +
      Modifier and Type
      +
      Method
      +
      Description
      +
      void
      +
      execute(Message<?> message, + Runnable runnable)
      +
      +
      select a thread by message to execute the runnable!
      +
      +
      +
      +
      +
      +
      • +
    +
    +
    +
      + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        execute

        +
        void execute(Message<?> message, + Runnable runnable)
        +
        select a thread by message to execute the runnable! +

        + Suggestions: +

        + 1. The message listener task will be submitted to this executor for execution, + so the implementations of this interface should carefully consider execution + order if sequential consumption is required. +

        +

        + 2. The users should release resources(e.g. threads) of the executor after closing + the consumer to avoid leaks. +

        +
        +
        Parameters:
        +
        message - the message
        +
        runnable - the runnable to execute, that is, the message listener task
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/MessagePayload.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/MessagePayload.html new file mode 100644 index 000000000000..82eb7d9fb9cc --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/MessagePayload.html @@ -0,0 +1,166 @@ + + + + +MessagePayload (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Interface MessagePayload

    +
    +
    +
    +
    public interface MessagePayload
    +
    The abstraction of a message's payload.
    +
    +
    +
      + +
    • +
      +

      Method Summary

      +
      +
      +
      +
      +
      Modifier and Type
      +
      Method
      +
      Description
      +
      byte[]
      +
      copiedBuffer()
      +
      +
      Copy the bytes of the payload into the byte array.
      +
      +
      default void
      +
      release()
      +
      +
      Release the resources if necessary.
      +
      +
      +
      +
      +
      +
      • +
    +
    +
    +
      + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        copiedBuffer

        +
        byte[] copiedBuffer()
        +
        Copy the bytes of the payload into the byte array.
        +
        +
        Returns:
        +
        the byte array that is filled with the readable bytes of the payload, it should not be null
        +
        +
        +
        • +
      • +
        +

        release

        +
        default void release()
        +
        Release the resources if necessary. + + NOTE: For a MessagePayload object that is created from MessagePayloadFactory.DEFAULT, this method must be + called to avoid memory leak.
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/MessagePayloadContext.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/MessagePayloadContext.html new file mode 100644 index 000000000000..b391f34d881c --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/MessagePayloadContext.html @@ -0,0 +1,243 @@ + + + + +MessagePayloadContext (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Interface MessagePayloadContext

    +
    +
    +
    +
    public interface MessagePayloadContext
    +
    The context of the message payload, which usually represents a batched message (batch) or a single message.
    +
    +
    +
      + +
    • +
      +

      Method Summary

      +
      +
      +
      +
      +
      Modifier and Type
      +
      Method
      +
      Description
      +
      <T> Message<T>
      +
      asSingleMessage(MessagePayload payload, + Schema<T> schema)
      +
      +
      Convert the given payload to a single message if the entry is not a batch.
      +
      +
      <T> Message<T>
      +
      getMessageAt(int index, + int numMessages, + MessagePayload payload, + boolean containMetadata, + Schema<T> schema)
      +
      +
      Get the internal single message with a specific index from a payload if the payload is a batch.
      +
      +
      int
      +
      getNumMessages()
      +
      +
      Get the number of messages when the payload is produced by Pulsar producer.
      +
      +
      String
      +
      getProperty(String key)
      +
      +
      Get a value associated with the given key.
      +
      +
      boolean
      +
      isBatch()
      +
      +
      Check whether the payload is a batch when the payload is produced by Pulsar producer.
      +
      +
      +
      +
      +
      +
      • +
    +
    +
    +
      + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        getProperty

        +
        String getProperty(String key)
        +
        Get a value associated with the given key. + + When the message payload is not produced by Pulsar producer, a specific property is usually added to indicate the + format. So this method is useful to determine whether the payload is produced by Pulsar producer.
        +
        +
        Parameters:
        +
        key -
        +
        Returns:
        +
        the value associated with the key or null if the key or value doesn't exist
        +
        +
        +
        • +
      • +
        +

        getNumMessages

        +
        int getNumMessages()
        +
        Get the number of messages when the payload is produced by Pulsar producer.
        +
        +
        Returns:
        +
        the number of messages
        +
        +
        +
        • +
      • +
        +

        isBatch

        +
        boolean isBatch()
        +
        Check whether the payload is a batch when the payload is produced by Pulsar producer.
        +
        +
        Returns:
        +
        true if the payload is a batch
        +
        +
        +
        • +
      • +
        +

        getMessageAt

        +
        <T> Message<T> getMessageAt(int index, + int numMessages, + MessagePayload payload, + boolean containMetadata, + Schema<T> schema)
        +
        Get the internal single message with a specific index from a payload if the payload is a batch.
        +
        +
        Type Parameters:
        +
        T -
        +
        Parameters:
        +
        index - the batch index
        +
        numMessages - the number of messages in the batch
        +
        payload - the message payload
        +
        containMetadata - whether the payload contains the single message metadata
        +
        schema - the schema of the batch
        +
        Returns:
        +
        the created message
        +
        +
        +
        • +
      • +
        +

        asSingleMessage

        +
        <T> Message<T> asSingleMessage(MessagePayload payload, + Schema<T> schema)
        +
        Convert the given payload to a single message if the entry is not a batch.
        +
        +
        Type Parameters:
        +
        T -
        +
        Parameters:
        +
        payload - the message payload
        +
        schema - the schema of the message
        +
        Returns:
        +
        the created message
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/MessagePayloadFactory.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/MessagePayloadFactory.html new file mode 100644 index 000000000000..3187834fa25b --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/MessagePayloadFactory.html @@ -0,0 +1,200 @@ + + + + +MessagePayloadFactory (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Interface MessagePayloadFactory

    +
    +
    +
    +
    public interface MessagePayloadFactory
    +
    The factory class of MessagePayload.
    +
    +
    +
      + +
    • +
      +

      Field Summary

      +
      Fields
      +
      +
      Modifier and Type
      +
      Field
      +
      Description
      +
      static final MessagePayloadFactory
      +
      DEFAULT
      +
       
      +
      +
      +
      • + +
    • +
      +

      Method Summary

      +
      +
      +
      +
      +
      Modifier and Type
      +
      Method
      +
      Description
      +
      MessagePayload
      +
      wrap(byte[] bytes)
      +
      +
      Create a payload whose underlying buffer refers to a byte array.
      +
      +
      MessagePayload
      +
      wrap(ByteBuffer buffer)
      +
      +
      Create a payload whose underlying buffer refers to a NIO buffer.
      +
      +
      +
      +
      +
      +
      • +
    +
    +
    +
      + +
    • +
      +

      Field Details

      + +
      +
      • + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        wrap

        +
        MessagePayload wrap(byte[] bytes)
        +
        Create a payload whose underlying buffer refers to a byte array.
        +
        +
        Parameters:
        +
        bytes - the byte array
        +
        Returns:
        +
        the created MessagePayload object
        +
        +
        +
        • +
      • +
        +

        wrap

        +
        MessagePayload wrap(ByteBuffer buffer)
        +
        Create a payload whose underlying buffer refers to a NIO buffer.
        +
        +
        Parameters:
        +
        buffer - the NIO buffer
        +
        Returns:
        +
        the created MessagePayload object
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/MessagePayloadProcessor.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/MessagePayloadProcessor.html new file mode 100644 index 000000000000..1efd1c110b30 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/MessagePayloadProcessor.html @@ -0,0 +1,202 @@ + + + + +MessagePayloadProcessor (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Interface MessagePayloadProcessor

    +
    +
    +
    +
    public interface MessagePayloadProcessor
    +
    The processor to process a message payload. + + It's responsible to convert the raw buffer to some messages, then trigger some callbacks so that consumer can consume + these messages and handle the exception if it existed. + + The most important part is to decode the raw buffer. After that, we can call + MessagePayloadContext.getMessageAt(int, int, org.apache.pulsar.client.api.MessagePayload, boolean, org.apache.pulsar.client.api.Schema<T>) or MessagePayloadContext.asSingleMessage(org.apache.pulsar.client.api.MessagePayload, org.apache.pulsar.client.api.Schema<T>) to construct + Message for consumer to consume. Since we need to pass the MessagePayload object to these methods, we + can use MessagePayloadFactory.DEFAULT to create it or just reuse the payload argument.
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Field Details

      + +
      +
      • + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        process

        +
        <T> void process(MessagePayload payload, + MessagePayloadContext context, + Schema<T> schema, + Consumer<Message<T>> messageConsumer) + throws Exception
        +
        Process the message payload.
        +
        +
        Type Parameters:
        +
        T -
        +
        Parameters:
        +
        payload - the payload whose underlying buffer is a Netty ByteBuf
        +
        context - the message context that contains the message format information and methods to create a message
        +
        schema - the message's schema
        +
        messageConsumer - the callback to consume each message
        +
        Throws:
        +
        Exception
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/MessageRouter.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/MessageRouter.html new file mode 100644 index 000000000000..26d12b1a5c16 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/MessageRouter.html @@ -0,0 +1,198 @@ + + + + +MessageRouter (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Interface MessageRouter

    +
    +
    +
    +
    All Superinterfaces:
    +
    Serializable
    +
    +
    +
    @Public +@Stable +public interface MessageRouter +extends Serializable
    +
    Interface for custom message router that can be passed + to a producer to select the partition that a particular + messsage should be published on.
    +
    +
    See Also:
    +
    + +
    +
    +
    +
    +
      + +
    • +
      +

      Method Summary

      +
      +
      +
      +
      +
      Modifier and Type
      +
      Method
      +
      Description
      +
      default int
      +
      choosePartition(Message<?> msg)
      +
      +
      Deprecated. +
      since 1.22.0.
      +
      +
      +
      default int
      +
      choosePartition(Message<?> msg, + TopicMetadata metadata)
      +
      +
      Choose a partition based on msg and the topic metadata.
      +
      +
      +
      +
      +
      +
      • +
    +
    +
    +
      + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        choosePartition

        +
        @Deprecated +default int choosePartition(Message<?> msg)
        +
        Deprecated. +
        since 1.22.0. Please use choosePartition(Message, TopicMetadata) instead.
        +
        +
        +
        Parameters:
        +
        msg - Message object
        +
        Returns:
        +
        The index of the partition to use for the message
        +
        +
        +
        • +
      • +
        +

        choosePartition

        +
        default int choosePartition(Message<?> msg, + TopicMetadata metadata)
        +
        Choose a partition based on msg and the topic metadata.
        +
        +
        Parameters:
        +
        msg - message to route
        +
        metadata - topic metadata
        +
        Returns:
        +
        the partition to route the message.
        +
        Since:
        +
        1.22.0
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/MessageRoutingMode.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/MessageRoutingMode.html new file mode 100644 index 000000000000..dbd1c0a32919 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/MessageRoutingMode.html @@ -0,0 +1,271 @@ + + + + +MessageRoutingMode (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Enum Class MessageRoutingMode

    +
    +
    java.lang.Object +
    java.lang.Enum<MessageRoutingMode> +
    org.apache.pulsar.client.api.MessageRoutingMode
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable, Comparable<MessageRoutingMode>, Constable
    +
    +
    +
    @Public +@Stable +public enum MessageRoutingMode +extends Enum<MessageRoutingMode>
    +
    Default routing mode for messages to partition. + +

    This logic is applied when the application is not setting a key TypedMessageBuilder.key(String) + on a particular message.

    +
    +
    + +
    +
    +
      + +
    • +
      +

      Enum Constant Details

      +
        +
      • +
        +

        SinglePartition

        +
        public static final MessageRoutingMode SinglePartition
        +
        If no key is provided, The partitioned producer will randomly pick one single partition + and publish all the messages into that partition. + If a key is provided on the message, the partitioned producer will hash the key + and assign message to a particular partition.
        +
        +
        • +
      • +
        +

        RoundRobinPartition

        +
        public static final MessageRoutingMode RoundRobinPartition
        +
        If no key is provided, the producer will publish messages across all partitions in round-robin fashion + to achieve maximum throughput. Please note that round-robin is not done per individual message but rather + it's set to the same boundary of batching delay, to ensure batching is effective. + +

        While if a key is specified on the message, the partitioned producer will hash the key + and assign message to a particular partition.

        +
        +
        • +
      • +
        +

        CustomPartition

        +
        public static final MessageRoutingMode CustomPartition
        +
        Use custom message router implementation that will be called to determine the partition + for a particular message.
        +
        +
        • +
      +
      +
      • + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        values

        +
        public static MessageRoutingMode[] values()
        +
        Returns an array containing the constants of this enum class, in +the order they are declared.
        +
        +
        Returns:
        +
        an array containing the constants of this enum class, in the order they are declared
        +
        +
        +
        • +
      • +
        +

        valueOf

        +
        public static MessageRoutingMode valueOf(String name)
        +
        Returns the enum constant of this class with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this class. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        IllegalArgumentException - if this enum class has no constant with the specified name
        +
        NullPointerException - if the argument is null
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/Messages.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/Messages.html new file mode 100644 index 000000000000..1eb039312a00 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/Messages.html @@ -0,0 +1,161 @@ + + + + +Messages (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Interface Messages<T>

    +
    +
    +
    +
    Type Parameters:
    +
    T -
    +
    +
    +
    All Superinterfaces:
    +
    Iterable<Message<T>>
    +
    +
    +
    @Public +@Stable +public interface Messages<T> +extends Iterable<Message<T>>
    +
    A container that holds the list Message for a topic.
    +
    +
    +
      + +
    • +
      +

      Method Summary

      +
      +
      +
      +
      +
      Modifier and Type
      +
      Method
      +
      Description
      +
      int
      +
      size()
      +
      +
      Get number of messages.
      +
      +
      +
      +
      +
      +

      Methods inherited from interface java.lang.Iterable

      +forEach, iterator, spliterator
      +
      +
      • +
    +
    +
    +
      + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        size

        +
        int size()
        +
        Get number of messages.
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/MultiTopicConsumerStats.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/MultiTopicConsumerStats.html new file mode 100644 index 000000000000..f71875f58bb8 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/MultiTopicConsumerStats.html @@ -0,0 +1,163 @@ + + + + +MultiTopicConsumerStats (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Interface MultiTopicConsumerStats

    +
    +
    +
    +
    All Superinterfaces:
    +
    ConsumerStats, Serializable
    +
    +
    +
    @Public +@Stable +public interface MultiTopicConsumerStats +extends ConsumerStats
    +
    Multi-topic Consumer statistics recorded by client. + +

    All the stats are relative to the last recording period. The interval of the stats refreshes is configured with + ClientBuilder.statsInterval(long, java.util.concurrent.TimeUnit) with a default of 1 minute.

    +
    +
    + +
    +
    + +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/PartitionedTopicProducerStats.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/PartitionedTopicProducerStats.html new file mode 100644 index 000000000000..1c9fc7e7d0af --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/PartitionedTopicProducerStats.html @@ -0,0 +1,163 @@ + + + + +PartitionedTopicProducerStats (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Interface PartitionedTopicProducerStats

    +
    +
    +
    +
    All Superinterfaces:
    +
    ProducerStats, Serializable
    +
    +
    +
    @Public +@Stable +public interface PartitionedTopicProducerStats +extends ProducerStats
    +
    Partitioned topic Producer statistics recorded by client. + +

    All the stats are relative to the last recording period. The interval of the stats refreshes is configured with + ClientBuilder.statsInterval(long, java.util.concurrent.TimeUnit) with a default of 1 minute.

    +
    +
    + +
    +
    + +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/Producer.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/Producer.html new file mode 100644 index 000000000000..2375bd7b3bea --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/Producer.html @@ -0,0 +1,479 @@ + + + + +Producer (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Interface Producer<T>

    +
    +
    +
    +
    All Superinterfaces:
    +
    AutoCloseable, Closeable
    +
    +
    +
    @Public +@Stable +public interface Producer<T> +extends Closeable
    +
    Producer is used to publish messages on a topic. + +

    A single producer instance can be used across multiple threads.

    +
    +
    + +
    +
    +
      + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        getTopic

        +
        String getTopic()
        +
        +
        Returns:
        +
        the topic which producer is publishing to
        +
        +
        +
        • +
      • +
        +

        getProducerName

        +
        String getProducerName()
        +
        +
        Returns:
        +
        the producer name which could have been assigned by the system or specified by the client
        +
        +
        +
        • +
      • +
        +

        send

        +
        MessageId send(T message) + throws PulsarClientException
        +
        Sends a message. + +

        This call will be blocking until is successfully acknowledged by the Pulsar broker. + +

        Use newMessage() to specify more properties than just the value on the message to be sent.

        +
        +
        Parameters:
        +
        message - a message
        +
        Returns:
        +
        the message id assigned to the published message
        +
        Throws:
        +
        PulsarClientException.TimeoutException - if the message was not correctly received by the system within the timeout period
        +
        PulsarClientException.AlreadyClosedException - if the producer was already closed
        +
        PulsarClientException
        +
        +
        +
        • +
      • +
        +

        sendAsync

        +
        CompletableFuture<MessageId> sendAsync(T message)
        +
        Send a message asynchronously. + +

        When the producer queue is full, by default this method will complete the future with an exception + PulsarClientException.ProducerQueueIsFullError + +

        See ProducerBuilder.maxPendingMessages(int) to configure the producer queue size and + ProducerBuilder.blockIfQueueFull(boolean) to change the blocking behavior. + +

        Use newMessage() to specify more properties than just the value on the message to be sent.

        +
        +
        Parameters:
        +
        message - a byte array with the payload of the message
        +
        Returns:
        +
        a future that can be used to track when the message will have been safely persisted
        +
        +
        +
        • +
      • +
        +

        flush

        +
        void flush() + throws PulsarClientException
        +
        Flush all the messages buffered in the client and wait until all messages have been successfully persisted.
        +
        +
        Throws:
        +
        PulsarClientException
        +
        Since:
        +
        2.1.0
        +
        See Also:
        +
        + +
        +
        +
        +
        • +
      • +
        +

        flushAsync

        +
        CompletableFuture<Void> flushAsync()
        +
        Flush all the messages buffered in the client and wait until all messages have been successfully persisted.
        +
        +
        Returns:
        +
        a future that can be used to track when all the messages have been safely persisted.
        +
        Since:
        +
        2.1.0
        +
        See Also:
        +
        + +
        +
        +
        +
        • +
      • +
        +

        newMessage

        +
        TypedMessageBuilder<T> newMessage()
        +
        Create a new message builder. + +

        This message builder allows to specify additional properties on the message. For example: + 

        
+ producer.newMessage()
+       .key(messageKey)
+       .value(myValue)
+       .property("user-defined-property", "value")
+       .send();
+
        +
        +
        Returns:
        +
        a typed message builder that can be used to construct the message to be sent through this producer
        +
        +
        +
        • +
      • +
        +

        newMessage

        +
        <V> TypedMessageBuilder<V> newMessage(Schema<V> schema)
        +
        Create a new message builder with schema, not required same parameterized type with the producer.
        +
        +
        Returns:
        +
        a typed message builder that can be used to construct the message to be sent through this producer
        +
        See Also:
        +
        + +
        +
        +
        +
        • +
      • +
        +

        newMessage

        +
        TypedMessageBuilder<T> newMessage(Transaction txn)
        +
        Create a new message builder with transaction. + +

        After the transaction commit, it will be made visible to consumer. + +

        After the transaction abort, it will never be visible to consumer.

        +
        +
        Returns:
        +
        a typed message builder that can be used to construct the message to be sent through this producer
        +
        Since:
        +
        2.7.0
        +
        See Also:
        +
        + +
        +
        +
        +
        • +
      • +
        +

        getLastSequenceId

        +
        long getLastSequenceId()
        +
        Get the last sequence id that was published by this producer. + +

        This represent either the automatically assigned + or custom sequence id (set on the TypedMessageBuilder) + that was published and acknowledged by the broker. + +

        After recreating a producer with the same producer name, this will return the last message that was + published in the previous producer session, or -1 if there no message was ever published.

        +
        +
        Returns:
        +
        the last sequence id published by this producer
        +
        +
        +
        • +
      • +
        +

        getStats

        +
        ProducerStats getStats()
        +
        Get statistics for the producer. +
          +
        • numMsgsSent : Number of messages sent in the current interval +
        • numBytesSent : Number of bytes sent in the current interval +
        • numSendFailed : Number of messages failed to send in the current interval +
        • numAcksReceived : Number of acks received in the current interval +
        • totalMsgsSent : Total number of messages sent +
        • totalBytesSent : Total number of bytes sent +
        • totalSendFailed : Total number of messages failed to send +
        • totalAcksReceived: Total number of acks received +
        +
        +
        Returns:
        +
        statistic for the producer or null if ProducerStatsRecorderImpl is disabled.
        +
        +
        +
        • +
      • +
        +

        close

        +
        void close() + throws PulsarClientException
        +
        Close the producer and releases resources allocated. + +

        No more writes will be accepted from this producer. Waits until all pending write request are persisted. + In case of errors, pending writes will not be retried.

        +
        +
        Specified by:
        +
        close in interface AutoCloseable
        +
        Specified by:
        +
        close in interface Closeable
        +
        Throws:
        +
        PulsarClientException.AlreadyClosedException - if the producer was already closed
        +
        PulsarClientException
        +
        +
        +
        • +
      • +
        +

        closeAsync

        +
        CompletableFuture<Void> closeAsync()
        +
        Close the producer and releases resources allocated. + +

        No more writes will be accepted from this producer. Waits until all pending write request are persisted. + In case of errors, pending writes will not be retried.

        +
        +
        Returns:
        +
        a future that can used to track when the producer has been closed
        +
        +
        +
        • +
      • +
        +

        isConnected

        +
        boolean isConnected()
        +
        +
        Returns:
        +
        Whether the producer is currently connected to the broker
        +
        +
        +
        • +
      • +
        +

        getLastDisconnectedTimestamp

        +
        long getLastDisconnectedTimestamp()
        +
        +
        Returns:
        +
        The last disconnected timestamp of the producer
        +
        +
        +
        • +
      • +
        +

        getNumOfPartitions

        +
        int getNumOfPartitions()
        +
        +
        Returns:
        +
        the number of partitions per topic.
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/ProducerAccessMode.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/ProducerAccessMode.html new file mode 100644 index 000000000000..3e8d45727e7e --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/ProducerAccessMode.html @@ -0,0 +1,266 @@ + + + + +ProducerAccessMode (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Enum Class ProducerAccessMode

    +
    +
    java.lang.Object +
    java.lang.Enum<ProducerAccessMode> +
    org.apache.pulsar.client.api.ProducerAccessMode
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable, Comparable<ProducerAccessMode>, Constable
    +
    +
    +
    public enum ProducerAccessMode +extends Enum<ProducerAccessMode>
    +
    The type of access to the topic that the producer requires.
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Enum Constant Details

      +
        +
      • +
        +

        Shared

        +
        public static final ProducerAccessMode Shared
        +
        By default multiple producers can publish on a topic.
        +
        +
        • +
      • +
        +

        Exclusive

        +
        public static final ProducerAccessMode Exclusive
        +
        Require exclusive access for producer. Fail immediately if there's already a producer connected.
        +
        +
        • +
      • +
        +

        ExclusiveWithFencing

        +
        public static final ProducerAccessMode ExclusiveWithFencing
        +
        Acquire exclusive access for the producer. Any existing producer will be removed and + invalidated immediately.
        +
        +
        • +
      • +
        +

        WaitForExclusive

        +
        public static final ProducerAccessMode WaitForExclusive
        +
        Producer creation is pending until it can acquire exclusive access.
        +
        +
        • +
      +
      +
      • + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        values

        +
        public static ProducerAccessMode[] values()
        +
        Returns an array containing the constants of this enum class, in +the order they are declared.
        +
        +
        Returns:
        +
        an array containing the constants of this enum class, in the order they are declared
        +
        +
        +
        • +
      • +
        +

        valueOf

        +
        public static ProducerAccessMode valueOf(String name)
        +
        Returns the enum constant of this class with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this class. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        IllegalArgumentException - if this enum class has no constant with the specified name
        +
        NullPointerException - if the argument is null
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/ProducerBuilder.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/ProducerBuilder.html new file mode 100644 index 000000000000..b726aaa3656e --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/ProducerBuilder.html @@ -0,0 +1,1138 @@ + + + + +ProducerBuilder (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Interface ProducerBuilder<T>

    +
    +
    +
    +
    All Superinterfaces:
    +
    Cloneable
    +
    +
    +
    @Public +@Stable +public interface ProducerBuilder<T> +extends Cloneable
    +
    ProducerBuilder is used to configure and create instances of Producer.
    +
    +
    See Also:
    +
    + +
    +
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        create

        +
        Producer<T> create() + throws PulsarClientException
        +
        Finalize the creation of the Producer instance. + +

        This method will block until the producer is created successfully.

        +
        +
        Returns:
        +
        the producer instance
        +
        Throws:
        +
        PulsarClientException.ProducerBusyException - if a producer with the same "producer name" is already connected to the topic
        +
        PulsarClientException - if the producer creation fails
        +
        +
        +
        • +
      • +
        +

        createAsync

        +
        CompletableFuture<Producer<T>> createAsync()
        +
        Finalize the creation of the Producer instance in asynchronous mode. + +

        This method will return a CompletableFuture that can be used to access the instance when it's ready.

        +
        +
        Returns:
        +
        a future that will yield the created producer instance
        +
        Throws:
        +
        PulsarClientException.ProducerBusyException - if a producer with the same "producer name" is already connected to the topic
        +
        PulsarClientException - if the producer creation fails
        +
        +
        +
        • +
      • +
        +

        loadConf

        +
        ProducerBuilder<T> loadConf(Map<String,Object> config)
        +
        Load the configuration from provided config map. + +

        Example: + 

        
+ Map<String, Object> config = new HashMap<>();
+ config.put("producerName", "test-producer");
+ config.put("sendTimeoutMs", 2000);
+
+ ProducerBuilder<byte[]> builder = client.newProducer()
+                  .loadConf(config);
+
+ Producer<byte[]> producer = builder.create();
+
        +
        +
        Parameters:
        +
        config - configuration map to load
        +
        Returns:
        +
        the producer builder instance
        +
        +
        +
        • +
      • +
        +

        clone

        +
        ProducerBuilder<T> clone()
        +
        Create a copy of the current ProducerBuilder. + +

        Cloning the builder can be used to share an incomplete configuration and specialize it multiple times. For + example: + 

        
+ ProducerBuilder<String> builder = client.newProducer(Schema.STRING)
+                  .sendTimeout(10, TimeUnit.SECONDS)
+                  .blockIfQueueFull(true);
+
+ Producer<String> producer1 = builder.clone().topic("topic-1").create();
+ Producer<String> producer2 = builder.clone().topic("topic-2").create();
+
        +
        +
        Returns:
        +
        a clone of the producer builder instance
        +
        +
        +
        • +
      • +
        +

        topic

        +
        ProducerBuilder<T> topic(String topicName)
        +
        Specify the topic this producer will be publishing on. + +

        This argument is required when constructing the producer.

        +
        +
        Parameters:
        +
        topicName - the name of the topic
        +
        Returns:
        +
        the producer builder instance
        +
        +
        +
        • +
      • +
        +

        producerName

        +
        ProducerBuilder<T> producerName(String producerName)
        +
        Specify a name for the producer. + +

        If not assigned, the system will generate a globally unique name which can be accessed with + Producer.getProducerName(). + +

        Warning: When specifying a name, it is up to the user to ensure that, for a given topic, + the producer name is unique across all Pulsar's clusters. + Brokers will enforce that only a single producer a given name can be publishing on a topic.

        +
        +
        Parameters:
        +
        producerName - the custom name to use for the producer
        +
        Returns:
        +
        the producer builder instance
        +
        +
        +
        • +
      • +
        +

        accessMode

        +
        ProducerBuilder<T> accessMode(ProducerAccessMode accessMode)
        +
        Configure the type of access mode that the producer requires on the topic. + +

        Possible values are: +

        +
        +
        Parameters:
        +
        accessMode - The type of access to the topic that the producer requires
        +
        Returns:
        +
        the producer builder instance
        +
        See Also:
        +
        + +
        +
        +
        +
        • +
      • +
        +

        sendTimeout

        +
        ProducerBuilder<T> sendTimeout(int sendTimeout, + TimeUnit unit)
        +
        Set the send timeout (default: 30 seconds). + +

        If a message is not acknowledged by the server before the sendTimeout expires, an error will be reported. + +

        Setting the timeout to zero with setTimeout(0, TimeUnit.SECONDS) will set the timeout + to infinity. This can be useful when using Pulsar's message deduplication feature, since the client + library will retry forever to publish a message. No errors will be propagated back to the application.

        +
        +
        Parameters:
        +
        sendTimeout - the send timeout
        +
        unit - the time unit of the sendTimeout
        +
        Returns:
        +
        the producer builder instance
        +
        +
        +
        • +
      • +
        +

        maxPendingMessages

        +
        ProducerBuilder<T> maxPendingMessages(int maxPendingMessages)
        +
        Set the max size of the queue holding the messages pending to receive an acknowledgment from the broker. + +

        When the queue is full, by default, all calls to Producer.send(T) and Producer.sendAsync(T) + will fail unless blockIfQueueFull=true. Use blockIfQueueFull(boolean) + to change the blocking behavior. + +

        The producer queue size also determines the max amount of memory that will be required by + the client application. Until the producer gets a successful acknowledgment back from the broker, + it will keep in memory (direct memory pool) all the messages in the pending queue. + +

        Default is 0, which disables the pending messages check.

        +
        +
        Parameters:
        +
        maxPendingMessages - the max size of the pending messages queue for the producer
        +
        Returns:
        +
        the producer builder instance
        +
        +
        +
        • +
      • +
        +

        maxPendingMessagesAcrossPartitions

        +
        @Deprecated +ProducerBuilder<T> maxPendingMessagesAcrossPartitions(int maxPendingMessagesAcrossPartitions)
        +
        Deprecated.
        +
        Set the number of max pending messages across all partitions. + +

        This setting will be used to lower the max pending messages for each partition + (maxPendingMessages(int)), if the total exceeds the configured value. + The purpose of this setting is to have an upper-limit on the number + of pending messages when publishing on a partitioned topic. + +

        Default is 0, which disables the pending messages across partitions check. + +

        If publishing at a high rate over a topic with many partitions (especially when publishing messages without a + partitioning key), it might be beneficial to increase this parameter to allow for more pipelining within the + individual partitions' producers.

        +
        +
        Parameters:
        +
        maxPendingMessagesAcrossPartitions - max pending messages across all the partitions
        +
        Returns:
        +
        the producer builder instance
        +
        +
        +
        • +
      • +
        +

        blockIfQueueFull

        +
        ProducerBuilder<T> blockIfQueueFull(boolean blockIfQueueFull)
        +
        Set whether the Producer.send(T) and Producer.sendAsync(T) operations should block when the outgoing + message queue is full. + +

        Default is false. If set to false, send operations will immediately fail with + PulsarClientException.ProducerQueueIsFullError when there is no space left in pending queue. If set to + true, the Producer.sendAsync(T) operation will instead block. + +

        Setting blockIfQueueFull=true simplifies the task of an application that + just wants to publish messages as fast as possible, without having to worry + about overflowing the producer send queue. + +

        For example: + 

        
+ Producer<String> producer = client.newProducer()
+                  .topic("my-topic")
+                  .blockIfQueueFull(true)
+                  .create();
+
+ while (true) {
+     producer.sendAsync("my-message")
+          .thenAccept(messageId -> {
+              System.out.println("Published message: " + messageId);
+          })
+          .exceptionally(ex -> {
+              System.err.println("Failed to publish: " + e);
+              return null;
+          });
+ }
+
        +
        +
        Parameters:
        +
        blockIfQueueFull - whether to block Producer.send(T) and Producer.sendAsync(T) operations on queue full
        +
        Returns:
        +
        the producer builder instance
        +
        +
        +
        • +
      • +
        +

        messageRoutingMode

        +
        ProducerBuilder<T> messageRoutingMode(MessageRoutingMode messageRoutingMode)
        +
        Set the MessageRoutingMode for a partitioned producer. + +

        Default routing mode is to round-robin across the available partitions. + +

        This logic is applied when the application is not setting a key on a + particular message. If the key is set with +

        +invalid reference +
        MessageBuilder#setKey(String)
        +
        +, + then the hash of the key will be used to select a partition for the message.
        +
        +
        Parameters:
        +
        messageRoutingMode - the message routing mode
        +
        Returns:
        +
        the producer builder instance
        +
        See Also:
        +
        + +
        +
        +
        +
        • +
      • +
        +

        hashingScheme

        +
        ProducerBuilder<T> hashingScheme(HashingScheme hashingScheme)
        +
        Change the HashingScheme used to choose the partition on which to publish a particular message. + +

        Standard hashing functions available are: +

        +
        +
        Parameters:
        +
        hashingScheme - the chosen HashingScheme
        +
        Returns:
        +
        the producer builder instance
        +
        +
        +
        • +
      • +
        +

        compressionType

        +
        ProducerBuilder<T> compressionType(CompressionType compressionType)
        +
        Set the compression type for the producer. + +

        By default, message payloads are not compressed. +

        Supported compression types are: +

        +
        +
        Parameters:
        +
        compressionType - the selected compression type
        +
        Returns:
        +
        the producer builder instance
        +
        +
        +
        • +
      • +
        +

        messageRouter

        +
        ProducerBuilder<T> messageRouter(MessageRouter messageRouter)
        +
        Set a custom message routing policy by passing an implementation of MessageRouter.
        +
        +
        Parameters:
        +
        messageRouter -
        +
        Returns:
        +
        the producer builder instance
        +
        +
        +
        • +
      • +
        +

        enableBatching

        +
        ProducerBuilder<T> enableBatching(boolean enableBatching)
        +
        Set automatic batching of messages for the producer. default: enabled + +

        When batching is enabled, multiple calls to Producer.sendAsync(T) can result in a single batch + being sent to the broker, leading to better throughput, especially when publishing small messages. + If compression is enabled, messages will be compressed at the batch level, leading to a much better + compression ratio for similar headers or contents. + +

        When enabled, default batch delay is set to 1 ms and default batch size is 1000 messages. + +

        Batching is enabled by default since 2.0.0.

        +
        +
        Returns:
        +
        the producer builder instance
        +
        See Also:
        +
        + +
        +
        +
        +
        • +
      • +
        +

        enableChunking

        +
        ProducerBuilder<T> enableChunking(boolean enableChunking)
        +
        If a message's size is higher than the broker's allowed max publish-payload size, enableChunking allows + the producer to split the message into multiple chunks and publish it to the broker separately and in order. + +

        This feature allows the publishing of large messages by splitting messages into multiple chunks and + re-assembling them with the consumer to form the original large published message. Therefore, this configuration + of the pulsar producer and consumer is recommended to use this feature: + + 

        + 1. This feature is currently only supported for non-shared subscriptions and persistent topics.
+ 2. Disable batching to use chunking feature.
+ 3. Pulsar-client stores published messages in buffer cache until it receives acknowledgement from the broker.
+ Therefore, it's best practice to reduce the "maxPendingMessages" size to avoid the producer occupying large
+ amounts of memory with buffered messages.
+ 4. Set message-ttl on the namespace to clean up incomplete chunked messages.
+ (If a producer fails to publish an entire large message, the consumer will be unable to consume and acknowledge
+ those messages. These messages can only be discarded by message TTL or by configuring
+ ConsumerBuilder.expireTimeOfIncompleteChunkedMessage(long, java.util.concurrent.TimeUnit).
+ 5. Consumer configuration: consumer should also configure receiverQueueSize and maxPendingChunkedMessage
+
        +
        +
        Parameters:
        +
        enableChunking -
        +
        Returns:
        +
        +
        +
        • +
      • +
        +

        chunkMaxMessageSize

        +
        ProducerBuilder<T> chunkMaxMessageSize(int chunkMaxMessageSize)
        +
        Max chunk-message size in bytes. Producer chunks the message if chunking is enabled and message size is larger + than max chunk-message size. By default, chunkMaxMessageSize value is -1 and the producer chunks based + on the max-message size configured on the broker.
        +
        +
        Parameters:
        +
        chunkMaxMessageSize -
        +
        Returns:
        +
        +
        +
        • +
      • +
        +

        cryptoKeyReader

        +
        ProducerBuilder<T> cryptoKeyReader(CryptoKeyReader cryptoKeyReader)
        +
        Sets a CryptoKeyReader. + +

        Configure the key reader to be used to encrypt the message payloads.

        +
        +
        Parameters:
        +
        cryptoKeyReader - CryptoKeyReader object
        +
        Returns:
        +
        the producer builder instance
        +
        +
        +
        • +
      • +
        +

        defaultCryptoKeyReader

        +
        ProducerBuilder<T> defaultCryptoKeyReader(String publicKey)
        +
        Sets the default implementation of CryptoKeyReader. + +

        Configure the key reader to be used to encrypt the message payloads.

        +
        +
        Parameters:
        +
        publicKey - the public key that is always used to encrypt message payloads.
        +
        Returns:
        +
        the producer builder instance
        +
        Since:
        +
        2.8.0
        +
        +
        +
        • +
      • +
        +

        defaultCryptoKeyReader

        +
        ProducerBuilder<T> defaultCryptoKeyReader(Map<String,String> publicKeys)
        +
        Sets the default implementation of CryptoKeyReader. + +

        Configure the key reader to be used to encrypt the message payloads.

        +
        +
        Parameters:
        +
        publicKeys - the map of public key names and their URIs used to encrypt message payloads.
        +
        Returns:
        +
        the producer builder instance
        +
        Since:
        +
        2.8.0
        +
        +
        +
        • +
      • +
        +

        messageCrypto

        +
        ProducerBuilder<T> messageCrypto(MessageCrypto messageCrypto)
        +
        Sets a MessageCrypto. + +

        Contains methods to encrypt/decrypt messages for end-to-end encryption.

        +
        +
        Parameters:
        +
        messageCrypto - MessageCrypto object
        +
        Returns:
        +
        the producer builder instance
        +
        +
        +
        • +
      • +
        +

        addEncryptionKey

        +
        ProducerBuilder<T> addEncryptionKey(String key)
        +
        Add public encryption key, used by producer to encrypt the data key. + +

        At the time of producer creation, the Pulsar client checks if there are keys added to encryptionKeys. If keys + are found, a callback CryptoKeyReader.getPrivateKey(String, Map) and + CryptoKeyReader.getPublicKey(String, Map) is invoked against each key to load the values of the key. + +

        Application should implement this callback to return the key in pkcs8 format. If compression is enabled, + message is encrypted after compression. If batch messaging is enabled, the batched message is encrypted.

        +
        +
        Parameters:
        +
        key - the name of the encryption key in the key store
        +
        Returns:
        +
        the producer builder instance
        +
        +
        +
        • +
      • +
        +

        cryptoFailureAction

        +
        ProducerBuilder<T> cryptoFailureAction(ProducerCryptoFailureAction action)
        +
        Set the ProducerCryptoFailureAction to the value specified.
        +
        +
        Parameters:
        +
        action - the action the producer will take in case of encryption failures
        +
        Returns:
        +
        the producer builder instance
        +
        +
        +
        • +
      • +
        +

        batchingMaxPublishDelay

        +
        ProducerBuilder<T> batchingMaxPublishDelay(long batchDelay, + TimeUnit timeUnit)
        +
        Set the time period within which messages sent will be batched if batch messages are + enabled. The default value is 1 ms. If set to a non-zero value, messages will be queued until either: +
          +
        • this time interval expires
          • +
        • the max number of messages in a batch is reached (batchingMaxMessages(int)) +
        • the max size of batch is reached +
        + +

        All messages will be published as a single batch message. The consumer will be delivered individual + messages in the batch in the same order they were enqueued.

        +
        +
        Parameters:
        +
        batchDelay - the batch delay
        +
        timeUnit - the time unit of the batchDelay
        +
        Returns:
        +
        the producer builder instance
        +
        See Also:
        +
        + +
        +
        +
        +
        • +
      • +
        +

        roundRobinRouterBatchingPartitionSwitchFrequency

        +
        ProducerBuilder<T> roundRobinRouterBatchingPartitionSwitchFrequency(int frequency)
        +
        Set the partition switch frequency while batching of messages is enabled and + using round-robin routing mode for non-keyed messages. Default: 10. + +

        The time period of partition switch is frequency * batchingMaxPublishDelay. During this period, + all arriving messages will be routed to the same partition.

        +
        +
        Parameters:
        +
        frequency - the frequency of partition switch
        +
        Returns:
        +
        the producer builder instance
        +
        See Also:
        +
        + +
        +
        +
        +
        • +
      • +
        +

        batchingMaxMessages

        +
        ProducerBuilder<T> batchingMaxMessages(int batchMessagesMaxMessagesPerBatch)
        +
        Set the maximum number of messages permitted in a batch. The default value is 1000. If set to a value greater + than 1, messages will be queued until this threshold is reached or batch interval has elapsed. + +

        All messages in batch will be published as a single batch message. The consumer will be delivered individual + messages in the batch in the same order they were enqueued.

        +
        +
        Parameters:
        +
        batchMessagesMaxMessagesPerBatch - maximum number of messages in a batch
        +
        Returns:
        +
        the producer builder instance
        +
        See Also:
        +
        + +
        +
        +
        +
        • +
      • +
        +

        batchingMaxBytes

        +
        ProducerBuilder<T> batchingMaxBytes(int batchingMaxBytes)
        +
        Set the maximum number of bytes permitted in a batch. The default value is 128KB. + If set to a value greater than 0, messages will be queued until this threshold is reached + or other batching conditions are met. + +

        All messages in a batch will be published as a single batched message. The consumer will be delivered + individual messages in the batch in the same order they were enqueued.

        +
        +
        Parameters:
        +
        batchingMaxBytes - maximum number of bytes in a batch
        +
        Returns:
        +
        the producer builder instance
        +
        See Also:
        +
        + +
        +
        +
        +
        • +
      • +
        +

        batcherBuilder

        +
        ProducerBuilder<T> batcherBuilder(BatcherBuilder batcherBuilder)
        +
        Set the batcher builder BatcherBuilder of the producer. Producer will use the batcher builder to + build a batch message container.This is only be used when batching is enabled.
        +
        +
        Parameters:
        +
        batcherBuilder - batcher builder
        +
        Returns:
        +
        the producer builder instance
        +
        +
        +
        • +
      • +
        +

        initialSequenceId

        +
        ProducerBuilder<T> initialSequenceId(long initialSequenceId)
        +
        Set the baseline for sequence ids for messages published by the producer. + +

        First message will use (initialSequenceId + 1) as its sequence id, and + subsequent messages will be assigned incremental sequence ids, if not otherwise specified.

        +
        +
        Parameters:
        +
        initialSequenceId - the initial sequence id for the producer
        +
        Returns:
        +
        the producer builder instance
        +
        +
        +
        • +
      • +
        +

        property

        +
        ProducerBuilder<T> property(String key, + String value)
        +
        Set a name/value property for this producer. + +

        Properties are application-defined metadata that can be attached to the producer. + When getting topic stats, this metadata will be associated to the producer + stats for easier identification.

        +
        +
        Parameters:
        +
        key - the property key
        +
        value - the property value
        +
        Returns:
        +
        the producer builder instance
        +
        +
        +
        • +
      • +
        +

        properties

        +
        ProducerBuilder<T> properties(Map<String,String> properties)
        +
        Add all the properties in the provided map to the producer. + +

        Properties are application-defined metadata that can be attached to the producer. + When getting topic stats, this metadata will be associated to the producer + stats for easier identification.

        +
        +
        Parameters:
        +
        properties - the map of properties
        +
        Returns:
        +
        the producer builder instance
        +
        +
        +
        • +
      • +
        +

        intercept

        +
        @Deprecated +ProducerBuilder<T> intercept(ProducerInterceptor<T>... interceptors)
        +
        Deprecated.
        +
        Add a set of ProducerInterceptors to the producer. + +

        Interceptors can be used to trace the publish and acknowledgments operations happening in a producer.

        +
        +
        Parameters:
        +
        interceptors - the list of interceptors to intercept the producer created by this builder.
        +
        Returns:
        +
        the producer builder instance
        +
        +
        +
        • +
      • +
        +

        intercept

        +
        ProducerBuilder<T> intercept(ProducerInterceptor... interceptors)
        +
        Add a set of ProducerInterceptor to the producer. + +

        Interceptors can be used to trace the publish and acknowledgments operation happening in a producer.

        +
        +
        Parameters:
        +
        interceptors - the list of interceptors to intercept the producer created by this builder.
        +
        Returns:
        +
        the producer builder instance
        +
        +
        +
        • +
      • +
        +

        autoUpdatePartitions

        +
        ProducerBuilder<T> autoUpdatePartitions(boolean autoUpdate)
        +
        If enabled, partitioned producer will automatically discover new partitions at runtime. This is only applied on + partitioned topics. + +

        Default is true.

        +
        +
        Parameters:
        +
        autoUpdate - whether to auto discover partition configuration changes
        +
        Returns:
        +
        the producer builder instance
        +
        +
        +
        • +
      • +
        +

        autoUpdatePartitionsInterval

        +
        ProducerBuilder<T> autoUpdatePartitionsInterval(int interval, + TimeUnit unit)
        +
        Set the interval of updating partitions. The default value is 1 minute. This only works if autoUpdatePartitions + is enabled.
        +
        +
        Parameters:
        +
        interval - the interval of updating partitions
        +
        unit - the time unit of the interval.
        +
        Returns:
        +
        the producer builder instance
        +
        +
        +
        • +
      • +
        +

        enableMultiSchema

        +
        ProducerBuilder<T> enableMultiSchema(boolean multiSchema)
        +
        Set the multiple schema mode for producer. + If enabled, the producer can send a message with a schema different from the schema specified at creation. +

        >Otherwise, if the producer wanted to send a message with different schema, + an invalid message exception would be thrown + +

        Enabled by default.

        +
        +
        Parameters:
        +
        multiSchema - enable or disable multiple schema mode
        +
        Returns:
        +
        the producer builder instance
        +
        Since:
        +
        2.5.0
        +
        +
        +
        • +
      • +
        +

        enableLazyStartPartitionedProducers

        +
        ProducerBuilder<T> enableLazyStartPartitionedProducers(boolean lazyStartPartitionedProducers)
        +
        This config affects Shared mode producers of partitioned topics only. It controls whether + producers register and connect immediately to the owner broker of each partition + or start lazily on demand. The internal producer of one partition always + starts immediately, as chosen by the routing policy, but the internal producers of + any additional partitions are started on demand upon receiving their first + message. + Using this mode can reduce the strain on brokers for topics with large numbers of + partitions and when the SinglePartition or some custom partial partition routing policy + like PartialRoundRobinMessageRouterImpl is used without keyed messages. + Because producer connection can be on demand, this can produce extra send latency + for the first messages of a given partition.
        +
        +
        Parameters:
        +
        lazyStartPartitionedProducers - enable or disable starting partition producers lazily
        +
        Returns:
        +
        the producer builder instance
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/ProducerCryptoFailureAction.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/ProducerCryptoFailureAction.html new file mode 100644 index 000000000000..8d0005420e65 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/ProducerCryptoFailureAction.html @@ -0,0 +1,245 @@ + + + + +ProducerCryptoFailureAction (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Enum Class ProducerCryptoFailureAction

    +
    +
    java.lang.Object +
    java.lang.Enum<ProducerCryptoFailureAction> +
    org.apache.pulsar.client.api.ProducerCryptoFailureAction
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable, Comparable<ProducerCryptoFailureAction>, Constable
    +
    +
    +
    @Public +@Stable +public enum ProducerCryptoFailureAction +extends Enum<ProducerCryptoFailureAction>
    +
    The action the producer will take in case of encryption failures.
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Enum Constant Details

      +
        +
      • +
        +

        FAIL

        +
        public static final ProducerCryptoFailureAction FAIL
        +
        This is the default option to fail send if crypto operation fails.
        +
        +
        • +
      • +
        +

        SEND

        +
        public static final ProducerCryptoFailureAction SEND
        +
        Ignore crypto failure and proceed with sending unencrypted messages.
        +
        +
        • +
      +
      +
      • + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        values

        +
        public static ProducerCryptoFailureAction[] values()
        +
        Returns an array containing the constants of this enum class, in +the order they are declared.
        +
        +
        Returns:
        +
        an array containing the constants of this enum class, in the order they are declared
        +
        +
        +
        • +
      • +
        +

        valueOf

        +
        public static ProducerCryptoFailureAction valueOf(String name)
        +
        Returns the enum constant of this class with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this class. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        IllegalArgumentException - if this enum class has no constant with the specified name
        +
        NullPointerException - if the argument is null
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/ProducerInterceptor.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/ProducerInterceptor.html new file mode 100644 index 000000000000..89967d21f25d --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/ProducerInterceptor.html @@ -0,0 +1,281 @@ + + + + +ProducerInterceptor (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Interface ProducerInterceptor<T>

    +
    +
    +
    +
    All Superinterfaces:
    +
    AutoCloseable
    +
    +
    +
    @Public +@Stable +@Deprecated +public interface ProducerInterceptor<T> +extends AutoCloseable
    +
    Deprecated.
    +
    A plugin interface that allows you to intercept (and possibly mutate) the + messages received by the producer before they are published to the Pulsar + brokers. + +

    Exceptions thrown by ProducerInterceptor methods will be caught, logged, but + not propagated further. + +

    ProducerInterceptor callbacks may be called from multiple threads. Interceptor + implementation must ensure thread-safety, if needed.

    +
    +
    +
      + +
    • +
      +

      Method Summary

      +
      +
      +
      +
      +
      Modifier and Type
      +
      Method
      +
      Description
      +
      Message<T>
      +
      beforeSend(Producer<T> producer, + Message<T> message)
      +
      +
      Deprecated.
      +
      This is called from Producer.send(Object) and Producer.sendAsync(Object) methods, before + send the message to the brokers.
      +
      +
      void
      +
      close()
      +
      +
      Deprecated.
      +
      Close the interceptor.
      +
      +
      default void
      +
      onPartitionsChange(String topicName, + int partitions)
      +
      +
      Deprecated.
      +
      This method is called when partitions of the topic (partitioned-topic) changes.
      +
      +
      void
      +
      onSendAcknowledgement(Producer<T> producer, + Message<T> message, + MessageId msgId, + Throwable exception)
      +
      +
      Deprecated.
      +
      This method is called when the message sent to the broker has been + acknowledged, or when sending the message fails.
      +
      +
      +
      +
      +
      +
      • +
    +
    +
    +
      + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        close

        +
        void close()
        +
        Deprecated.
        +
        Close the interceptor.
        +
        +
        Specified by:
        +
        close in interface AutoCloseable
        +
        +
        +
        • +
      • +
        +

        beforeSend

        +
        Message<T> beforeSend(Producer<T> producer, + Message<T> message)
        +
        Deprecated.
        +
        This is called from Producer.send(Object) and Producer.sendAsync(Object) methods, before + send the message to the brokers. This method is allowed to modify the + record, in which case, the new record + will be returned. + +

        Any exception thrown by this method will be caught by the caller and + logged, but not propagated further. + +

        Since the producer may run multiple interceptors, a particular + interceptor's beforeSend(Producer, Message) callback will be called in the + order specified by + ProducerBuilder.intercept(ProducerInterceptor[]). + +

        The first interceptor in the list gets the message passed from the client, + the following interceptor will be passed the message returned by the + previous interceptor, and so on. Since interceptors are allowed to modify + messages, interceptors may potentially get the message already modified by + other interceptors. However, building a pipeline of mutable interceptors + that depend on the output of the previous interceptor is discouraged, + because of potential side-effects caused by interceptors potentially + failing to modify the message and throwing an exception. If one of the + interceptors in the list throws an exception from + +

        +invalid reference +
        #beforeSend(Message)
        +
        +, the exception is caught, logged, and the next + interceptor is called with the message returned by the last successful + interceptor in the list, or otherwise the client.
        +
        +
        Parameters:
        +
        producer - the producer which contains the interceptor.
        +
        message - message to send
        +
        Returns:
        +
        the intercepted message
        +
        +
        +
        • +
      • +
        +

        onSendAcknowledgement

        +
        void onSendAcknowledgement(Producer<T> producer, + Message<T> message, + MessageId msgId, + Throwable exception)
        +
        Deprecated.
        +
        This method is called when the message sent to the broker has been + acknowledged, or when sending the message fails. + This method is generally called just before the user callback is + called, and in additional cases when an exception on the producer side. + +

        Any exception thrown by this method will be ignored by the caller. + +

        This method will generally execute in the background I/O thread, so the + implementation should be reasonably fast. Otherwise, sending of messages + from other threads could be delayed.

        +
        +
        Parameters:
        +
        producer - the producer which contains the interceptor.
        +
        message - the message that application sends
        +
        msgId - the message id that assigned by the broker; null if send failed.
        +
        exception - the exception on sending messages, null indicates send has succeed.
        +
        +
        +
        • +
      • +
        +

        onPartitionsChange

        +
        default void onPartitionsChange(String topicName, + int partitions)
        +
        Deprecated.
        +
        This method is called when partitions of the topic (partitioned-topic) changes.
        +
        +
        Parameters:
        +
        topicName - topic name
        +
        partitions - new updated partitions
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/ProducerStats.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/ProducerStats.html new file mode 100644 index 000000000000..9f50eac05ead --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/ProducerStats.html @@ -0,0 +1,441 @@ + + + + +ProducerStats (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Interface ProducerStats

    +
    +
    +
    +
    All Superinterfaces:
    +
    Serializable
    +
    +
    +
    All Known Subinterfaces:
    +
    PartitionedTopicProducerStats
    +
    +
    +
    @Public +@Evolving +@Deprecated +public interface ProducerStats +extends Serializable
    +
    Deprecated. +
    use ClientBuilder.openTelemetry(OpenTelemetry) to enable stats
    +
    +
    Producer statistics recorded by client. + +

    All the stats are relative to the last recording period. The interval of the stats refreshes is configured with + ClientBuilder.statsInterval(long, java.util.concurrent.TimeUnit) with a default of 1 minute.

    +
    +
    + +
    +
    +
      + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        getNumMsgsSent

        +
        long getNumMsgsSent()
        +
        Deprecated.
        +
        +
        Returns:
        +
        the number of messages published in the last interval
        +
        +
        +
        • +
      • +
        +

        getNumBytesSent

        +
        long getNumBytesSent()
        +
        Deprecated.
        +
        +
        Returns:
        +
        the number of bytes sent in the last interval
        +
        +
        +
        • +
      • +
        +

        getNumSendFailed

        +
        long getNumSendFailed()
        +
        Deprecated.
        +
        +
        Returns:
        +
        the number of failed send operations in the last interval
        +
        +
        +
        • +
      • +
        +

        getNumAcksReceived

        +
        long getNumAcksReceived()
        +
        Deprecated.
        +
        +
        Returns:
        +
        the number of send acknowledges received by broker in the last interval
        +
        +
        +
        • +
      • +
        +

        getSendMsgsRate

        +
        double getSendMsgsRate()
        +
        Deprecated.
        +
        +
        Returns:
        +
        the messages send rate in the last interval
        +
        +
        +
        • +
      • +
        +

        getSendBytesRate

        +
        double getSendBytesRate()
        +
        Deprecated.
        +
        +
        Returns:
        +
        the bytes send rate in the last interval
        +
        +
        +
        • +
      • +
        +

        getSendLatencyMillis50pct

        +
        double getSendLatencyMillis50pct()
        +
        Deprecated.
        +
        +
        Returns:
        +
        the 50th percentile of the send latency in milliseconds for the last interval
        +
        +
        +
        • +
      • +
        +

        getSendLatencyMillis75pct

        +
        double getSendLatencyMillis75pct()
        +
        Deprecated.
        +
        +
        Returns:
        +
        the 75th percentile of the send latency in milliseconds for the last interval
        +
        +
        +
        • +
      • +
        +

        getSendLatencyMillis95pct

        +
        double getSendLatencyMillis95pct()
        +
        Deprecated.
        +
        +
        Returns:
        +
        the 95th percentile of the send latency in milliseconds for the last interval
        +
        +
        +
        • +
      • +
        +

        getSendLatencyMillis99pct

        +
        double getSendLatencyMillis99pct()
        +
        Deprecated.
        +
        +
        Returns:
        +
        the 99th percentile of the send latency in milliseconds for the last interval
        +
        +
        +
        • +
      • +
        +

        getSendLatencyMillis999pct

        +
        double getSendLatencyMillis999pct()
        +
        Deprecated.
        +
        +
        Returns:
        +
        the 99.9th percentile of the send latency in milliseconds for the last interval
        +
        +
        +
        • +
      • +
        +

        getSendLatencyMillisMax

        +
        double getSendLatencyMillisMax()
        +
        Deprecated.
        +
        +
        Returns:
        +
        the max send latency in milliseconds for the last interval
        +
        +
        +
        • +
      • +
        +

        getTotalMsgsSent

        +
        long getTotalMsgsSent()
        +
        Deprecated.
        +
        +
        Returns:
        +
        the total number of messages published by this producer
        +
        +
        +
        • +
      • +
        +

        getTotalBytesSent

        +
        long getTotalBytesSent()
        +
        Deprecated.
        +
        +
        Returns:
        +
        the total number of bytes sent by this producer
        +
        +
        +
        • +
      • +
        +

        getTotalSendFailed

        +
        long getTotalSendFailed()
        +
        Deprecated.
        +
        +
        Returns:
        +
        the total number of failed send operations
        +
        +
        +
        • +
      • +
        +

        getTotalAcksReceived

        +
        long getTotalAcksReceived()
        +
        Deprecated.
        +
        +
        Returns:
        +
        the total number of send acknowledges received by broker
        +
        +
        +
        • +
      • +
        +

        getPendingQueueSize

        +
        int getPendingQueueSize()
        +
        Deprecated.
        +
        +
        Returns:
        +
        current pending send-message queue size of the producer
        +
        +
        +
        • +
      • +
        +

        getPartitionStats

        +
        default Map<String,ProducerStats> getPartitionStats()
        +
        Deprecated.
        +
        +
        Returns:
        +
        stats for each partition if topic is partitioned topic
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/ProxyProtocol.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/ProxyProtocol.html new file mode 100644 index 000000000000..c691be2a92fe --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/ProxyProtocol.html @@ -0,0 +1,242 @@ + + + + +ProxyProtocol (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Enum Class ProxyProtocol

    +
    +
    java.lang.Object +
    java.lang.Enum<ProxyProtocol> +
    org.apache.pulsar.client.api.ProxyProtocol
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable, Comparable<ProxyProtocol>, Constable
    +
    +
    +
    @Public +@Stable +public enum ProxyProtocol +extends Enum<ProxyProtocol>
    +
    Protcol type to determine type of proxy routing when client connects to proxy using + +
    +invalid @link +
    {@link ClientBuilder::proxyServiceUrl
    +
    +}.
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Enum Constant Details

      +
        +
      • +
        +

        SNI

        +
        public static final ProxyProtocol SNI
        +
        Follows SNI-routing + https://docs.trafficserver.apache.org/en/latest/admin-guide/layer-4-routing.en.html#sni-routing.
        +
        +
        • +
      +
      +
      • + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        values

        +
        public static ProxyProtocol[] values()
        +
        Returns an array containing the constants of this enum class, in +the order they are declared.
        +
        +
        Returns:
        +
        an array containing the constants of this enum class, in the order they are declared
        +
        +
        +
        • +
      • +
        +

        valueOf

        +
        public static ProxyProtocol valueOf(String name)
        +
        Returns the enum constant of this class with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this class. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        IllegalArgumentException - if this enum class has no constant with the specified name
        +
        NullPointerException - if the argument is null
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClient.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClient.html new file mode 100644 index 000000000000..36058077bfdc --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClient.html @@ -0,0 +1,688 @@ + + + + +PulsarClient (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Interface PulsarClient

    +
    +
    +
    +
    All Superinterfaces:
    +
    AutoCloseable, Closeable
    +
    +
    +
    @Public +@Stable +public interface PulsarClient +extends Closeable
    +
    Class that provides a client interface to Pulsar. + +

    Client instances are thread-safe and can be reused for managing multiple Producer, Consumer and + Reader instances. + +

    Example of constructing a client: + + 

    
+ PulsarClient client = PulsarClient.builder()
+                              .serviceUrl("pulsar://broker:6650")
+                              .build();
+
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        builder

        +
        static ClientBuilder builder()
        +
        Get a new builder instance that can used to configure and build a PulsarClient instance.
        +
        +
        Returns:
        +
        the ClientBuilder
        +
        Since:
        +
        2.0.0
        +
        +
        +
        • +
      • +
        +

        newProducer

        +
        ProducerBuilder<byte[]> newProducer()
        +
        Create a producer builder that can be used to configure + and construct a producer with default Schema.BYTES. + +

        Example: + + 

        
+ Producer<byte[]> producer = client.newProducer()
+                  .topic("my-topic")
+                  .create();
+ producer.send("test".getBytes());
+
        +
        +
        Returns:
        +
        a ProducerBuilder object to configure and construct the Producer instance
        +
        Since:
        +
        2.0.0
        +
        +
        +
        • +
      • +
        +

        newProducer

        +
        <T> ProducerBuilder<T> newProducer(Schema<T> schema)
        +
        Create a producer builder that can be used to configure + and construct a producer with the specified schema. + +

        Example: + + 

        
+ Producer<String> producer = client.newProducer(Schema.STRING)
+                  .topic("my-topic")
+                  .create();
+ producer.send("test");
+
        +
        +
        Parameters:
        +
        schema - provide a way to convert between serialized data and domain objects
        +
        Returns:
        +
        a ProducerBuilder object to configure and construct the Producer instance
        +
        Since:
        +
        2.0.0
        +
        +
        +
        • +
      • +
        +

        newConsumer

        +
        ConsumerBuilder<byte[]> newConsumer()
        +
        Create a consumer builder with no schema (Schema.BYTES) for subscribing to + one or more topics. + + 
        
+ Consumer<byte[]> consumer = client.newConsumer()
+        .topic("my-topic")
+        .subscriptionName("my-subscription-name")
+        .subscribe();
+
+ while (true) {
+     Message<byte[]> message = consumer.receive();
+     System.out.println("Got message: " + message.getValue());
+     consumer.acknowledge(message);
+ }
+
        +
        +
        Returns:
        +
        a ConsumerBuilder object to configure and construct the Consumer instance
        +
        Since:
        +
        2.0.0
        +
        +
        +
        • +
      • +
        +

        newConsumer

        +
        <T> ConsumerBuilder<T> newConsumer(Schema<T> schema)
        +
        Create a consumer builder with a specific schema for subscribing on a specific topic + +

        Since 2.2, if you are creating a consumer with non-bytes schema on a non-existence topic, it will + automatically create the topic with the provided schema. + + 

        
+ Consumer<String> consumer = client.newConsumer(Schema.STRING)
+        .topic("my-topic")
+        .subscriptionName("my-subscription-name")
+        .subscribe();
+
+ while (true) {
+     Message<String> message = consumer.receive();
+     System.out.println("Got message: " + message.getValue());
+     consumer.acknowledge(message);
+ }
+
        +
        +
        Parameters:
        +
        schema - provide a way to convert between serialized data and domain objects
        +
        Returns:
        +
        a ConsumerBuilder object to configure and construct the Consumer instance
        +
        Since:
        +
        2.0.0
        +
        +
        +
        • +
      • +
        +

        newReader

        +
        ReaderBuilder<byte[]> newReader()
        +
        Create a topic reader builder with no schema (Schema.BYTES) to read from the specified topic. + +

        The Reader provides a low-level abstraction that allows for manual positioning in the topic, without using a + subscription. A reader needs to be specified a ReaderBuilder.startMessageId(MessageId) + that can either be: +

          +
        • MessageId.earliest: Start reading from the earliest message available in the topic
          • +
        • MessageId.latest: Start reading from end of the topic. The first message read will be the one + published *after* the creation of the builder
          • +
        • MessageId: Position the reader on a particular message. The first message read will be the one + immediately *after* the specified message
          • +
        + +

        A Reader can only from non-partitioned topics. In case of partitioned topics, one can create the readers + directly on the individual partitions. See getPartitionsForTopic(String) for how to get the + topic partitions names. + +

        Example of usage of Reader: + 

        
+ Reader<byte[]> reader = client.newReader()
+        .topic("my-topic")
+        .startMessageId(MessageId.earliest)
+        .create();
+
+ while (true) {
+     Message<byte[]> message = reader.readNext();
+     System.out.println("Got message: " + message.getValue());
+     // Reader doesn't need acknowledgments
+ }
+
        +
        +
        Returns:
        +
        a ReaderBuilder that can be used to configure and construct a Reader instance
        +
        Since:
        +
        2.0.0
        +
        +
        +
        • +
      • +
        +

        newReader

        +
        <T> ReaderBuilder<T> newReader(Schema<T> schema)
        +
        Create a topic reader builder with a specific Schema) to read from the specified topic. + +

        The Reader provides a low-level abstraction that allows for manual positioning in the topic, without using a + subscription. A reader needs to be specified a ReaderBuilder.startMessageId(MessageId) that can either + be: +

          +
        • MessageId.earliest: Start reading from the earliest message available in the topic
          • +
        • MessageId.latest: Start reading from end of the topic. The first message read will be the one + published *after* the creation of the builder
          • +
        • MessageId: Position the reader on a particular message. The first message read will be the one + immediately *after* the specified message
          • +
        + +

        A Reader can only from non-partitioned topics. In case of partitioned topics, one can create the readers + directly on the individual partitions. See getPartitionsForTopic(String) for how to get the + topic partitions names. + +

        Example of usage of Reader: + 

        + 
+ Reader<String> reader = client.newReader(Schema.STRING)
+        .topic("my-topic")
+        .startMessageId(MessageId.earliest)
+        .create();
+
+ while (true) {
+     Message<String> message = reader.readNext();
+     System.out.println("Got message: " + message.getValue());
+     // Reader doesn't need acknowledgments
+ }
+
        +
        +
        Returns:
        +
        a ReaderBuilder that can be used to configure and construct a Reader instance
        +
        Since:
        +
        2.0.0
        +
        +
        +
        • +
      • +
        +

        newTableViewBuilder

        +
        @Deprecated +<T> TableViewBuilder<T> newTableViewBuilder(Schema<T> schema)
        +
        Deprecated. +
        Use newTableView(Schema) to build and configure a TableViewBuilder + instance
        +
        +
        Create a table view builder with a specific schema for subscribing on a specific topic. + +

        The TableView provides a key-value map view of a compacted topic. Messages without keys will + be ignored. + +

        Example: + 

        
+  TableView<byte[]> tableView = client.newTableViewBuilder(Schema.BYTES)
+            .topic("my-topic")
+            .autoUpdatePartitionsInterval(5, TimeUnit.SECONDS)
+            .create();
+
+  tableView.forEach((k, v) -> System.out.println(k + ":" + v));
+
        +
        +
        Parameters:
        +
        schema - provide a way to convert between serialized data and domain objects
        +
        Returns:
        +
        a TableViewBuilder object to configure and construct the TableView instance
        +
        +
        +
        • +
      • +
        +

        newTableView

        +
        TableViewBuilder<byte[]> newTableView()
        +
        Create a table view builder for subscribing on a specific topic. + +

        The TableView provides a key-value map view of a compacted topic. Messages without keys will + be ignored. + +

        Example: + 

        
+  TableView<byte[]> tableView = client.newTableView()
+            .topic("my-topic")
+            .autoUpdatePartitionsInterval(5, TimeUnit.SECONDS)
+            .create();
+
+  tableView.forEach((k, v) -> System.out.println(k + ":" + v));
+
        +
        +
        Returns:
        +
        a TableViewBuilder object to configure and construct the TableView instance
        +
        +
        +
        • +
      • +
        +

        newTableView

        +
        <T> TableViewBuilder<T> newTableView(Schema<T> schema)
        +
        Create a table view builder with a specific schema for subscribing on a specific topic. + +

        The TableView provides a key-value map view of a compacted topic. Messages without keys will + be ignored. + +

        Example: + 

        
+  TableView<byte[]> tableView = client.newTableView(Schema.BYTES)
+            .topic("my-topic")
+            .autoUpdatePartitionsInterval(5, TimeUnit.SECONDS)
+            .create();
+
+  tableView.forEach((k, v) -> System.out.println(k + ":" + v));
+
        +
        +
        Parameters:
        +
        schema - provide a way to convert between serialized data and domain objects
        +
        Returns:
        +
        a TableViewBuilder object to configure and construct the TableView instance
        +
        +
        +
        • +
      • +
        +

        updateServiceUrl

        +
        void updateServiceUrl(String serviceUrl) + throws PulsarClientException
        +
        Update the service URL this client is using. + +

        This will force the client close all existing connections and to restart service discovery to the new service + endpoint.

        +
        +
        Parameters:
        +
        serviceUrl - the new service URL this client should connect to
        +
        Throws:
        +
        PulsarClientException - in case the serviceUrl is not valid
        +
        +
        +
        • +
      • +
        +

        getPartitionsForTopic

        +
        @Deprecated +default CompletableFuture<List<String>> getPartitionsForTopic(String topic)
        +
        Deprecated.
        +
        Get the list of partitions for a given topic. + +

        If the topic is partitioned, this will return a list of partition names. If the topic is not partitioned, the + returned list will contain the topic name itself. + +

        This can be used to discover the partitions and create Reader, Consumer or Producer + instances directly on a particular partition.

        +
        +
        Parameters:
        +
        topic - the topic name
        +
        Returns:
        +
        a future that will yield a list of the topic partitions or PulsarClientException if there was any + error in the operation.
        +
        Since:
        +
        2.3.0
        +
        +
        +
        • +
      • +
        +

        getPartitionsForTopic

        +
        CompletableFuture<List<String>> getPartitionsForTopic(String topic, + boolean metadataAutoCreationEnabled)
        +
        1. Get the partitions if the topic exists. Return "[{partition-0}, {partition-1}....{partition-n}}]" if a + partitioned topic exists; return "[{topic}]" if a non-partitioned topic exists. + 2. When is "false", neither the partitioned topic nor non-partitioned + topic does not exist. You will get an PulsarClientException.NotFoundException or a + PulsarClientException.TopicDoesNotExistException. + 2-1. You will get a PulsarClientException.NotSupportedException with metadataAutoCreationEnabled=false + on an old broker version which does not support getting partitions without partitioned metadata auto-creation. + 3. When is "true," it will trigger an auto-creation for this topic(using + the default topic auto-creation strategy you set for the broker), and the corresponding result is returned. + For the result, see case 1.
        +
        +
        • +
      • +
        +

        close

        +
        void close() + throws PulsarClientException
        +
        Close the PulsarClient and release all the resources. + +

        This operation will trigger a graceful close of all producer, consumer and reader instances that + this client has currently active. That implies that close will block and wait until all pending producer + send requests are persisted.

        +
        +
        Specified by:
        +
        close in interface AutoCloseable
        +
        Specified by:
        +
        close in interface Closeable
        +
        Throws:
        +
        PulsarClientException - if the close operation fails
        +
        +
        +
        • +
      • +
        +

        closeAsync

        +
        CompletableFuture<Void> closeAsync()
        +
        Asynchronously close the PulsarClient and release all the resources. + +

        This operation will trigger a graceful close of all producer, consumer and reader instances that + this client has currently active. That implies that close and wait, asynchronously, until all pending producer + send requests are persisted.

        +
        +
        Returns:
        +
        a future that can be used to track the completion of the operation
        +
        +
        +
        • +
      • +
        +

        shutdown

        +
        void shutdown() + throws PulsarClientException
        +
        Perform immediate shutdown of PulsarClient. + +

        Release all the resources and close all the producer, consumer and reader instances without waiting + for ongoing operations to complete.

        +
        +
        Throws:
        +
        PulsarClientException - if the forceful shutdown fails
        +
        +
        +
        • +
      • +
        +

        isClosed

        +
        boolean isClosed()
        +
        Return internal state of the client. Useful if you want to check that current client is valid.
        +
        +
        Returns:
        +
        true is the client has been closed
        +
        See Also:
        +
        + +
        +
        +
        +
        • +
      • +
        +

        newTransaction

        +
        TransactionBuilder newTransaction()
        +
        Create a transaction builder that can be used to configure + and construct a transaction. + +

        Example: + + 

        
+ Transaction txn = client.newTransaction()
+                         .withTransactionTimeout(1, TimeUnit.MINUTES)
+                         .build().get();
+
        +
        +
        Returns:
        +
        a TransactionBuilder object to configure and construct + the Transaction instance
        +
        Throws:
        +
        PulsarClientException - if transactions are not enabled
        +
        Since:
        +
        2.7.0
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.AlreadyClosedException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.AlreadyClosedException.html new file mode 100644 index 000000000000..3c34581ce924 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.AlreadyClosedException.html @@ -0,0 +1,217 @@ + + + + +PulsarClientException.AlreadyClosedException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Class PulsarClientException.AlreadyClosedException

    +
    +
    java.lang.Object +
    java.lang.Throwable +
    java.lang.Exception +
    java.io.IOException +
    org.apache.pulsar.client.api.PulsarClientException +
    org.apache.pulsar.client.api.PulsarClientException.AlreadyClosedException
    +
    +
    +
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable
    +
    +
    +
    Enclosing class:
    +
    PulsarClientException
    +
    +
    +
    public static class PulsarClientException.AlreadyClosedException +extends PulsarClientException
    +
    Already closed exception thrown by Pulsar client.
    +
    +
    See Also:
    +
    + +
    +
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        AlreadyClosedException

        +
        public AlreadyClosedException(String msg)
        +
        Constructs an AlreadyClosedException with the specified detail message.
        +
        +
        Parameters:
        +
        msg - The detail message (which is saved for later retrieval + by the Throwable.getMessage() method)
        +
        +
        +
        • +
      • +
        +

        AlreadyClosedException

        +
        public AlreadyClosedException(String msg, + long sequenceId)
        +
        Constructs an AlreadyClosedException with the specified detail message.
        +
        +
        Parameters:
        +
        msg - The detail message (which is saved for later retrieval + by the Throwable.getMessage() method)
        +
        sequenceId - The sequenceId of the message
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.AuthenticationException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.AuthenticationException.html new file mode 100644 index 000000000000..a83035ff4a3f --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.AuthenticationException.html @@ -0,0 +1,198 @@ + + + + +PulsarClientException.AuthenticationException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Class PulsarClientException.AuthenticationException

    +
    +
    java.lang.Object +
    java.lang.Throwable +
    java.lang.Exception +
    java.io.IOException +
    org.apache.pulsar.client.api.PulsarClientException +
    org.apache.pulsar.client.api.PulsarClientException.AuthenticationException
    +
    +
    +
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable
    +
    +
    +
    Enclosing class:
    +
    PulsarClientException
    +
    +
    +
    public static class PulsarClientException.AuthenticationException +extends PulsarClientException
    +
    Authentication exception thrown by Pulsar client.
    +
    +
    See Also:
    +
    + +
    +
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        AuthenticationException

        +
        public AuthenticationException(String msg)
        +
        Constructs an AuthenticationException with the specified detail message.
        +
        +
        Parameters:
        +
        msg - The detail message (which is saved for later retrieval + by the Throwable.getMessage() method)
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.AuthorizationException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.AuthorizationException.html new file mode 100644 index 000000000000..e4845c095f27 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.AuthorizationException.html @@ -0,0 +1,198 @@ + + + + +PulsarClientException.AuthorizationException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Class PulsarClientException.AuthorizationException

    +
    +
    java.lang.Object +
    java.lang.Throwable +
    java.lang.Exception +
    java.io.IOException +
    org.apache.pulsar.client.api.PulsarClientException +
    org.apache.pulsar.client.api.PulsarClientException.AuthorizationException
    +
    +
    +
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable
    +
    +
    +
    Enclosing class:
    +
    PulsarClientException
    +
    +
    +
    public static class PulsarClientException.AuthorizationException +extends PulsarClientException
    +
    Authorization exception thrown by Pulsar client.
    +
    +
    See Also:
    +
    + +
    +
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        AuthorizationException

        +
        public AuthorizationException(String msg)
        +
        Constructs an AuthorizationException with the specified detail message.
        +
        +
        Parameters:
        +
        msg - The detail message (which is saved for later retrieval + by the Throwable.getMessage() method)
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.BrokerMetadataException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.BrokerMetadataException.html new file mode 100644 index 000000000000..973f86d27c61 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.BrokerMetadataException.html @@ -0,0 +1,198 @@ + + + + +PulsarClientException.BrokerMetadataException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Class PulsarClientException.BrokerMetadataException

    +
    +
    java.lang.Object +
    java.lang.Throwable +
    java.lang.Exception +
    java.io.IOException +
    org.apache.pulsar.client.api.PulsarClientException +
    org.apache.pulsar.client.api.PulsarClientException.BrokerMetadataException
    +
    +
    +
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable
    +
    +
    +
    Enclosing class:
    +
    PulsarClientException
    +
    +
    +
    public static class PulsarClientException.BrokerMetadataException +extends PulsarClientException
    +
    Broker metadata exception thrown by Pulsar client.
    +
    +
    See Also:
    +
    + +
    +
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        BrokerMetadataException

        +
        public BrokerMetadataException(String msg)
        +
        Constructs an BrokerMetadataException with the specified detail message.
        +
        +
        Parameters:
        +
        msg - The detail message (which is saved for later retrieval + by the Throwable.getMessage() method)
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.BrokerPersistenceException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.BrokerPersistenceException.html new file mode 100644 index 000000000000..a5ae548ca8e2 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.BrokerPersistenceException.html @@ -0,0 +1,198 @@ + + + + +PulsarClientException.BrokerPersistenceException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Class PulsarClientException.BrokerPersistenceException

    +
    +
    java.lang.Object +
    java.lang.Throwable +
    java.lang.Exception +
    java.io.IOException +
    org.apache.pulsar.client.api.PulsarClientException +
    org.apache.pulsar.client.api.PulsarClientException.BrokerPersistenceException
    +
    +
    +
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable
    +
    +
    +
    Enclosing class:
    +
    PulsarClientException
    +
    +
    +
    public static class PulsarClientException.BrokerPersistenceException +extends PulsarClientException
    +
    Broker persistence exception thrown by Pulsar client.
    +
    +
    See Also:
    +
    + +
    +
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        BrokerPersistenceException

        +
        public BrokerPersistenceException(String msg)
        +
        Constructs an BrokerPersistenceException with the specified detail message.
        +
        +
        Parameters:
        +
        msg - The detail message (which is saved for later retrieval + by the Throwable.getMessage() method)
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.ChecksumException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.ChecksumException.html new file mode 100644 index 000000000000..2ea93d198f55 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.ChecksumException.html @@ -0,0 +1,198 @@ + + + + +PulsarClientException.ChecksumException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Class PulsarClientException.ChecksumException

    +
    +
    java.lang.Object +
    java.lang.Throwable +
    java.lang.Exception +
    java.io.IOException +
    org.apache.pulsar.client.api.PulsarClientException +
    org.apache.pulsar.client.api.PulsarClientException.ChecksumException
    +
    +
    +
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable
    +
    +
    +
    Enclosing class:
    +
    PulsarClientException
    +
    +
    +
    public static class PulsarClientException.ChecksumException +extends PulsarClientException
    +
    Checksum exception thrown by Pulsar client.
    +
    +
    See Also:
    +
    + +
    +
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        ChecksumException

        +
        public ChecksumException(String msg)
        +
        Constructs an ChecksumException with the specified detail message.
        +
        +
        Parameters:
        +
        msg - The detail message (which is saved for later retrieval + by the Throwable.getMessage() method)
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.ConnectException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.ConnectException.html new file mode 100644 index 000000000000..a6a330949951 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.ConnectException.html @@ -0,0 +1,215 @@ + + + + +PulsarClientException.ConnectException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Class PulsarClientException.ConnectException

    +
    +
    java.lang.Object +
    java.lang.Throwable +
    java.lang.Exception +
    java.io.IOException +
    org.apache.pulsar.client.api.PulsarClientException +
    org.apache.pulsar.client.api.PulsarClientException.ConnectException
    +
    +
    +
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable
    +
    +
    +
    Enclosing class:
    +
    PulsarClientException
    +
    +
    +
    public static class PulsarClientException.ConnectException +extends PulsarClientException
    +
    Connect exception thrown by Pulsar client.
    +
    +
    See Also:
    +
    + +
    +
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        ConnectException

        +
        public ConnectException(Throwable t)
        +
        Constructs an ConnectException with the specified cause.
        +
        +
        Parameters:
        +
        t - The cause (which is saved for later retrieval by the + Throwable.getCause() method). (A null value is permitted, + and indicates that the cause is nonexistent or unknown.)
        +
        +
        +
        • +
      • +
        +

        ConnectException

        +
        public ConnectException(String msg)
        +
        Constructs an ConnectException with the specified detail message.
        +
        +
        Parameters:
        +
        msg - The detail message (which is saved for later retrieval + by the Throwable.getMessage() method)
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.ConsumerAssignException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.ConsumerAssignException.html new file mode 100644 index 000000000000..4a22aa3e71e9 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.ConsumerAssignException.html @@ -0,0 +1,197 @@ + + + + +PulsarClientException.ConsumerAssignException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Class PulsarClientException.ConsumerAssignException

    +
    +
    java.lang.Object +
    java.lang.Throwable +
    java.lang.Exception +
    java.io.IOException +
    org.apache.pulsar.client.api.PulsarClientException +
    org.apache.pulsar.client.api.PulsarClientException.ConsumerAssignException
    +
    +
    +
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable
    +
    +
    +
    Enclosing class:
    +
    PulsarClientException
    +
    +
    +
    public static class PulsarClientException.ConsumerAssignException +extends PulsarClientException
    +
    Consumer assign exception thrown by Pulsar client.
    +
    +
    See Also:
    +
    + +
    +
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        ConsumerAssignException

        +
        public ConsumerAssignException(String msg)
        +
        Constructs an ConsumerAssignException with the specified detail message.
        +
        +
        Parameters:
        +
        msg - The detail message.
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.ConsumerBusyException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.ConsumerBusyException.html new file mode 100644 index 000000000000..d7fd6c8f3602 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.ConsumerBusyException.html @@ -0,0 +1,198 @@ + + + + +PulsarClientException.ConsumerBusyException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Class PulsarClientException.ConsumerBusyException

    +
    +
    java.lang.Object +
    java.lang.Throwable +
    java.lang.Exception +
    java.io.IOException +
    org.apache.pulsar.client.api.PulsarClientException +
    org.apache.pulsar.client.api.PulsarClientException.ConsumerBusyException
    +
    +
    +
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable
    +
    +
    +
    Enclosing class:
    +
    PulsarClientException
    +
    +
    +
    public static class PulsarClientException.ConsumerBusyException +extends PulsarClientException
    +
    Consumer busy exception thrown by Pulsar client.
    +
    +
    See Also:
    +
    + +
    +
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        ConsumerBusyException

        +
        public ConsumerBusyException(String msg)
        +
        Constructs an ConsumerBusyException with the specified detail message.
        +
        +
        Parameters:
        +
        msg - The detail message (which is saved for later retrieval + by the Throwable.getMessage() method)
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.CryptoException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.CryptoException.html new file mode 100644 index 000000000000..783c9e0f399d --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.CryptoException.html @@ -0,0 +1,198 @@ + + + + +PulsarClientException.CryptoException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Class PulsarClientException.CryptoException

    +
    +
    java.lang.Object +
    java.lang.Throwable +
    java.lang.Exception +
    java.io.IOException +
    org.apache.pulsar.client.api.PulsarClientException +
    org.apache.pulsar.client.api.PulsarClientException.CryptoException
    +
    +
    +
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable
    +
    +
    +
    Enclosing class:
    +
    PulsarClientException
    +
    +
    +
    public static class PulsarClientException.CryptoException +extends PulsarClientException
    +
    Crypto exception thrown by Pulsar client.
    +
    +
    See Also:
    +
    + +
    +
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        CryptoException

        +
        public CryptoException(String msg)
        +
        Constructs an CryptoException with the specified detail message.
        +
        +
        Parameters:
        +
        msg - The detail message (which is saved for later retrieval + by the Throwable.getMessage() method)
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.FailedFeatureCheck.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.FailedFeatureCheck.html new file mode 100644 index 000000000000..30c915f0c891 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.FailedFeatureCheck.html @@ -0,0 +1,236 @@ + + + + +PulsarClientException.FailedFeatureCheck (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Enum Class PulsarClientException.FailedFeatureCheck

    +
    +
    java.lang.Object +
    java.lang.Enum<PulsarClientException.FailedFeatureCheck> +
    org.apache.pulsar.client.api.PulsarClientException.FailedFeatureCheck
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable, Comparable<PulsarClientException.FailedFeatureCheck>, Constable
    +
    +
    +
    Enclosing class:
    +
    PulsarClientException
    +
    +
    +
    public static enum PulsarClientException.FailedFeatureCheck +extends Enum<PulsarClientException.FailedFeatureCheck>
    +
    "supports_auth_refresh" was introduced at "2.6" and is no longer supported, so skip this enum. + "supports_broker_entry_metadata" was introduced at "2.8" and is no longer supported, so skip this enum. + "supports_partial_producer" was introduced at "2.10" and is no longer supported, so skip this enum. + "supports_topic_watchers" was introduced at "2.11" and is no longer supported, so skip this enum.
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Enum Constant Details

      + +
      +
      • + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        values

        +
        public static PulsarClientException.FailedFeatureCheck[] values()
        +
        Returns an array containing the constants of this enum class, in +the order they are declared.
        +
        +
        Returns:
        +
        an array containing the constants of this enum class, in the order they are declared
        +
        +
        +
        • +
      • +
        +

        valueOf

        +
        public static PulsarClientException.FailedFeatureCheck valueOf(String name)
        +
        Returns the enum constant of this class with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this class. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        IllegalArgumentException - if this enum class has no constant with the specified name
        +
        NullPointerException - if the argument is null
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.FeatureNotSupportedException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.FeatureNotSupportedException.html new file mode 100644 index 000000000000..809e1f91e5d2 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.FeatureNotSupportedException.html @@ -0,0 +1,194 @@ + + + + +PulsarClientException.FeatureNotSupportedException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Class PulsarClientException.FeatureNotSupportedException

    +
    +
    java.lang.Object +
    java.lang.Throwable +
    java.lang.Exception +
    java.io.IOException +
    org.apache.pulsar.client.api.PulsarClientException +
    org.apache.pulsar.client.api.PulsarClientException.NotSupportedException +
    org.apache.pulsar.client.api.PulsarClientException.FeatureNotSupportedException
    +
    +
    +
    +
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable
    +
    +
    +
    Enclosing class:
    +
    PulsarClientException
    +
    +
    +
    public static class PulsarClientException.FeatureNotSupportedException +extends PulsarClientException.NotSupportedException
    +
    Not supported exception thrown by Pulsar client.
    +
    +
    See Also:
    +
    + +
    +
    +
    +
    + +
    +
    + +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.GettingAuthenticationDataException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.GettingAuthenticationDataException.html new file mode 100644 index 000000000000..495bb6e2845e --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.GettingAuthenticationDataException.html @@ -0,0 +1,215 @@ + + + + +PulsarClientException.GettingAuthenticationDataException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Class PulsarClientException.GettingAuthenticationDataException

    +
    +
    java.lang.Object +
    java.lang.Throwable +
    java.lang.Exception +
    java.io.IOException +
    org.apache.pulsar.client.api.PulsarClientException +
    org.apache.pulsar.client.api.PulsarClientException.GettingAuthenticationDataException
    +
    +
    +
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable
    +
    +
    +
    Enclosing class:
    +
    PulsarClientException
    +
    +
    +
    public static class PulsarClientException.GettingAuthenticationDataException +extends PulsarClientException
    +
    Getting authentication data exception thrown by Pulsar client.
    +
    +
    See Also:
    +
    + +
    +
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        GettingAuthenticationDataException

        +
        public GettingAuthenticationDataException(Throwable t)
        +
        Constructs an GettingAuthenticationDataException with the specified cause.
        +
        +
        Parameters:
        +
        t - The cause (which is saved for later retrieval by the + Throwable.getCause() method). (A null value is permitted, + and indicates that the cause is nonexistent or unknown.)
        +
        +
        +
        • +
      • +
        +

        GettingAuthenticationDataException

        +
        public GettingAuthenticationDataException(String msg)
        +
        Constructs an GettingAuthenticationDataException with the specified detail message.
        +
        +
        Parameters:
        +
        msg - The detail message (which is saved for later retrieval + by the Throwable.getMessage() method)
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.IncompatibleSchemaException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.IncompatibleSchemaException.html new file mode 100644 index 000000000000..bc4680a9dd09 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.IncompatibleSchemaException.html @@ -0,0 +1,215 @@ + + + + +PulsarClientException.IncompatibleSchemaException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Class PulsarClientException.IncompatibleSchemaException

    +
    +
    java.lang.Object +
    java.lang.Throwable +
    java.lang.Exception +
    java.io.IOException +
    org.apache.pulsar.client.api.PulsarClientException +
    org.apache.pulsar.client.api.PulsarClientException.IncompatibleSchemaException
    +
    +
    +
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable
    +
    +
    +
    Enclosing class:
    +
    PulsarClientException
    +
    +
    +
    public static class PulsarClientException.IncompatibleSchemaException +extends PulsarClientException
    +
    Incompatible schema exception thrown by Pulsar client.
    +
    +
    See Also:
    +
    + +
    +
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        IncompatibleSchemaException

        +
        public IncompatibleSchemaException(Throwable t)
        +
        Constructs an IncompatibleSchemaException with the specified cause.
        +
        +
        Parameters:
        +
        t - The cause (which is saved for later retrieval by the + Throwable.getCause() method). (A null value is permitted, + and indicates that the cause is nonexistent or unknown.)
        +
        +
        +
        • +
      • +
        +

        IncompatibleSchemaException

        +
        public IncompatibleSchemaException(String msg)
        +
        Constructs an IncompatibleSchemaException with the specified detail message.
        +
        +
        Parameters:
        +
        msg - The detail message (which is saved for later retrieval + by the Throwable.getMessage() method)
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.InvalidConfigurationException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.InvalidConfigurationException.html new file mode 100644 index 000000000000..427087ebe06c --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.InvalidConfigurationException.html @@ -0,0 +1,236 @@ + + + + +PulsarClientException.InvalidConfigurationException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Class PulsarClientException.InvalidConfigurationException

    +
    +
    java.lang.Object +
    java.lang.Throwable +
    java.lang.Exception +
    java.io.IOException +
    org.apache.pulsar.client.api.PulsarClientException +
    org.apache.pulsar.client.api.PulsarClientException.InvalidConfigurationException
    +
    +
    +
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable
    +
    +
    +
    Enclosing class:
    +
    PulsarClientException
    +
    +
    +
    public static class PulsarClientException.InvalidConfigurationException +extends PulsarClientException
    +
    Invalid Configuration exception thrown by Pulsar client.
    +
    +
    See Also:
    +
    + +
    +
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        InvalidConfigurationException

        +
        public InvalidConfigurationException(String msg)
        +
        Constructs an InvalidConfigurationException with the specified detail message.
        +
        +
        Parameters:
        +
        msg - The detail message (which is saved for later retrieval + by the Throwable.getMessage() method)
        +
        +
        +
        • +
      • +
        +

        InvalidConfigurationException

        +
        public InvalidConfigurationException(Throwable t)
        +
        Constructs an InvalidConfigurationException with the specified cause.
        +
        +
        Parameters:
        +
        t - The cause (which is saved for later retrieval by the + Throwable.getCause() method). (A null value is permitted, + and indicates that the cause is nonexistent or unknown.)
        +
        +
        +
        • +
      • +
        +

        InvalidConfigurationException

        +
        public InvalidConfigurationException(String msg, + Throwable t)
        +
        Constructs an InvalidConfigurationException with the specified cause.
        +
        +
        Parameters:
        +
        msg - The detail message (which is saved for later retrieval + by the Throwable.getMessage() method)
        +
        t - The cause (which is saved for later retrieval by the + Throwable.getCause() method). (A null value is permitted, + and indicates that the cause is nonexistent or unknown.)
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.InvalidMessageException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.InvalidMessageException.html new file mode 100644 index 000000000000..81f91bcf6092 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.InvalidMessageException.html @@ -0,0 +1,217 @@ + + + + +PulsarClientException.InvalidMessageException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Class PulsarClientException.InvalidMessageException

    +
    +
    java.lang.Object +
    java.lang.Throwable +
    java.lang.Exception +
    java.io.IOException +
    org.apache.pulsar.client.api.PulsarClientException +
    org.apache.pulsar.client.api.PulsarClientException.InvalidMessageException
    +
    +
    +
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable
    +
    +
    +
    Enclosing class:
    +
    PulsarClientException
    +
    +
    +
    public static class PulsarClientException.InvalidMessageException +extends PulsarClientException
    +
    Invalid message exception thrown by Pulsar client.
    +
    +
    See Also:
    +
    + +
    +
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        InvalidMessageException

        +
        public InvalidMessageException(String msg)
        +
        Constructs an InvalidMessageException with the specified detail message.
        +
        +
        Parameters:
        +
        msg - The detail message (which is saved for later retrieval + by the Throwable.getMessage() method)
        +
        +
        +
        • +
      • +
        +

        InvalidMessageException

        +
        public InvalidMessageException(String msg, + long sequenceId)
        +
        Constructs an InvalidMessageException with the specified detail message.
        +
        +
        Parameters:
        +
        msg - The detail message (which is saved for later retrieval + by the Throwable.getMessage() method)
        +
        sequenceId - The sequenceId of the message
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.InvalidServiceURL.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.InvalidServiceURL.html new file mode 100644 index 000000000000..6e8a87e7c8da --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.InvalidServiceURL.html @@ -0,0 +1,220 @@ + + + + +PulsarClientException.InvalidServiceURL (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Class PulsarClientException.InvalidServiceURL

    +
    +
    java.lang.Object +
    java.lang.Throwable +
    java.lang.Exception +
    java.io.IOException +
    org.apache.pulsar.client.api.PulsarClientException +
    org.apache.pulsar.client.api.PulsarClientException.InvalidServiceURL
    +
    +
    +
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable
    +
    +
    +
    Enclosing class:
    +
    PulsarClientException
    +
    +
    +
    public static class PulsarClientException.InvalidServiceURL +extends PulsarClientException
    +
    Invalid Service URL exception thrown by Pulsar client.
    +
    +
    See Also:
    +
    + +
    +
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        InvalidServiceURL

        +
        public InvalidServiceURL(Throwable t)
        +
        Constructs an InvalidServiceURL with the specified cause.
        +
        +
        Parameters:
        +
        t - The cause (which is saved for later retrieval by the + Throwable.getCause() method). (A null value is permitted, + and indicates that the cause is nonexistent or unknown.)
        +
        +
        +
        • +
      • +
        +

        InvalidServiceURL

        +
        public InvalidServiceURL(String msg, + Throwable t)
        +
        Constructs an InvalidServiceURL with the specified cause.
        +
        +
        Parameters:
        +
        msg - The detail message (which is saved for later retrieval + by the Throwable.getMessage() method)
        +
        t - The cause (which is saved for later retrieval by the + Throwable.getCause() method). (A null value is permitted, + and indicates that the cause is nonexistent or unknown.)
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.InvalidTopicNameException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.InvalidTopicNameException.html new file mode 100644 index 000000000000..5de745ff3b26 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.InvalidTopicNameException.html @@ -0,0 +1,198 @@ + + + + +PulsarClientException.InvalidTopicNameException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Class PulsarClientException.InvalidTopicNameException

    +
    +
    java.lang.Object +
    java.lang.Throwable +
    java.lang.Exception +
    java.io.IOException +
    org.apache.pulsar.client.api.PulsarClientException +
    org.apache.pulsar.client.api.PulsarClientException.InvalidTopicNameException
    +
    +
    +
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable
    +
    +
    +
    Enclosing class:
    +
    PulsarClientException
    +
    +
    +
    public static class PulsarClientException.InvalidTopicNameException +extends PulsarClientException
    +
    Invalid topic name exception thrown by Pulsar client.
    +
    +
    See Also:
    +
    + +
    +
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        InvalidTopicNameException

        +
        public InvalidTopicNameException(String msg)
        +
        Constructs an InvalidTopicNameException with the specified detail message.
        +
        +
        Parameters:
        +
        msg - The detail message (which is saved for later retrieval + by the Throwable.getMessage() method)
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.LookupException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.LookupException.html new file mode 100644 index 000000000000..a8fda80d714c --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.LookupException.html @@ -0,0 +1,202 @@ + + + + +PulsarClientException.LookupException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Class PulsarClientException.LookupException

    +
    +
    java.lang.Object +
    java.lang.Throwable +
    java.lang.Exception +
    java.io.IOException +
    org.apache.pulsar.client.api.PulsarClientException +
    org.apache.pulsar.client.api.PulsarClientException.LookupException
    +
    +
    +
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable
    +
    +
    +
    Direct Known Subclasses:
    +
    PulsarClientException.TooManyRequestsException
    +
    +
    +
    Enclosing class:
    +
    PulsarClientException
    +
    +
    +
    public static class PulsarClientException.LookupException +extends PulsarClientException
    +
    Lookup exception thrown by Pulsar client.
    +
    +
    See Also:
    +
    + +
    +
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        LookupException

        +
        public LookupException(String msg)
        +
        Constructs an LookupException with the specified detail message.
        +
        +
        Parameters:
        +
        msg - The detail message (which is saved for later retrieval + by the Throwable.getMessage() method)
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.MemoryBufferIsFullError.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.MemoryBufferIsFullError.html new file mode 100644 index 000000000000..53e5201aef4b --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.MemoryBufferIsFullError.html @@ -0,0 +1,217 @@ + + + + +PulsarClientException.MemoryBufferIsFullError (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Class PulsarClientException.MemoryBufferIsFullError

    +
    +
    java.lang.Object +
    java.lang.Throwable +
    java.lang.Exception +
    java.io.IOException +
    org.apache.pulsar.client.api.PulsarClientException +
    org.apache.pulsar.client.api.PulsarClientException.MemoryBufferIsFullError
    +
    +
    +
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable
    +
    +
    +
    Enclosing class:
    +
    PulsarClientException
    +
    +
    +
    public static class PulsarClientException.MemoryBufferIsFullError +extends PulsarClientException
    +
    Memory buffer full error thrown by Pulsar client.
    +
    +
    See Also:
    +
    + +
    +
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        MemoryBufferIsFullError

        +
        public MemoryBufferIsFullError(String msg)
        +
        Constructs an MemoryBufferIsFullError with the specified detail message.
        +
        +
        Parameters:
        +
        msg - The detail message (which is saved for later retrieval + by the Throwable.getMessage() method)
        +
        +
        +
        • +
      • +
        +

        MemoryBufferIsFullError

        +
        public MemoryBufferIsFullError(String msg, + long sequenceId)
        +
        Constructs an MemoryBufferIsFullError with the specified detail message.
        +
        +
        Parameters:
        +
        msg - The detail message (which is saved for later retrieval + by the Throwable.getMessage() method)
        +
        sequenceId - The sequenceId of the message
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.MessageAcknowledgeException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.MessageAcknowledgeException.html new file mode 100644 index 000000000000..400fedba4d09 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.MessageAcknowledgeException.html @@ -0,0 +1,214 @@ + + + + +PulsarClientException.MessageAcknowledgeException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Class PulsarClientException.MessageAcknowledgeException

    +
    +
    java.lang.Object +
    java.lang.Throwable +
    java.lang.Exception +
    java.io.IOException +
    org.apache.pulsar.client.api.PulsarClientException +
    org.apache.pulsar.client.api.PulsarClientException.MessageAcknowledgeException
    +
    +
    +
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable
    +
    +
    +
    Enclosing class:
    +
    PulsarClientException
    +
    +
    +
    public static class PulsarClientException.MessageAcknowledgeException +extends PulsarClientException
    +
    Consumer assign exception thrown by Pulsar client.
    +
    +
    See Also:
    +
    + +
    +
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        MessageAcknowledgeException

        +
        public MessageAcknowledgeException(Throwable t)
        +
        Constructs an MessageAcknowledgeException with the specified cause.
        +
        +
        Parameters:
        +
        t - The cause (which is saved for later retrieval by the + Throwable.getCause() method). (A null value is permitted, + and indicates that the cause is nonexistent or unknown.)
        +
        +
        +
        • +
      • +
        +

        MessageAcknowledgeException

        +
        public MessageAcknowledgeException(String msg)
        +
        Constructs an MessageAcknowledgeException with the specified detail message.
        +
        +
        Parameters:
        +
        msg - The detail message.
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.NotAllowedException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.NotAllowedException.html new file mode 100644 index 000000000000..f4b2219c39de --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.NotAllowedException.html @@ -0,0 +1,198 @@ + + + + +PulsarClientException.NotAllowedException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Class PulsarClientException.NotAllowedException

    +
    +
    java.lang.Object +
    java.lang.Throwable +
    java.lang.Exception +
    java.io.IOException +
    org.apache.pulsar.client.api.PulsarClientException +
    org.apache.pulsar.client.api.PulsarClientException.NotAllowedException
    +
    +
    +
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable
    +
    +
    +
    Enclosing class:
    +
    PulsarClientException
    +
    +
    +
    public static class PulsarClientException.NotAllowedException +extends PulsarClientException
    +
    Not allowed exception thrown by Pulsar client.
    +
    +
    See Also:
    +
    + +
    +
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        NotAllowedException

        +
        public NotAllowedException(String msg)
        +
        Constructs an NotAllowedException with the specified detail message.
        +
        +
        Parameters:
        +
        msg - The detail message (which is saved for later retrieval + by the Throwable.getMessage() method)
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.NotConnectedException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.NotConnectedException.html new file mode 100644 index 000000000000..c2b2bd795c7a --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.NotConnectedException.html @@ -0,0 +1,206 @@ + + + + +PulsarClientException.NotConnectedException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Class PulsarClientException.NotConnectedException

    +
    +
    java.lang.Object +
    java.lang.Throwable +
    java.lang.Exception +
    java.io.IOException +
    org.apache.pulsar.client.api.PulsarClientException +
    org.apache.pulsar.client.api.PulsarClientException.NotConnectedException
    +
    +
    +
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable
    +
    +
    +
    Enclosing class:
    +
    PulsarClientException
    +
    +
    +
    public static class PulsarClientException.NotConnectedException +extends PulsarClientException
    +
    Not connected exception thrown by Pulsar client.
    +
    +
    See Also:
    +
    + +
    +
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        NotConnectedException

        +
        public NotConnectedException()
        +
        +
        • +
      • +
        +

        NotConnectedException

        +
        public NotConnectedException(long sequenceId)
        +
        +
        • +
      • +
        +

        NotConnectedException

        +
        public NotConnectedException(String msg)
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.NotFoundException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.NotFoundException.html new file mode 100644 index 000000000000..f515c63d8e75 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.NotFoundException.html @@ -0,0 +1,215 @@ + + + + +PulsarClientException.NotFoundException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Class PulsarClientException.NotFoundException

    +
    +
    java.lang.Object +
    java.lang.Throwable +
    java.lang.Exception +
    java.io.IOException +
    org.apache.pulsar.client.api.PulsarClientException +
    org.apache.pulsar.client.api.PulsarClientException.NotFoundException
    +
    +
    +
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable
    +
    +
    +
    Enclosing class:
    +
    PulsarClientException
    +
    +
    +
    public static class PulsarClientException.NotFoundException +extends PulsarClientException
    +
    Not Found exception thrown by Pulsar client.
    +
    +
    See Also:
    +
    + +
    +
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        NotFoundException

        +
        public NotFoundException(String msg)
        +
        Constructs an NotFoundException with the specified detail message.
        +
        +
        Parameters:
        +
        msg - The detail message (which is saved for later retrieval + by the Throwable.getMessage() method)
        +
        +
        +
        • +
      • +
        +

        NotFoundException

        +
        public NotFoundException(Throwable t)
        +
        Constructs an NotFoundException with the specified cause.
        +
        +
        Parameters:
        +
        t - The cause (which is saved for later retrieval by the + Throwable.getCause() method). (A null value is permitted, + and indicates that the cause is nonexistent or unknown.)
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.NotSupportedException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.NotSupportedException.html new file mode 100644 index 000000000000..7a234022322b --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.NotSupportedException.html @@ -0,0 +1,202 @@ + + + + +PulsarClientException.NotSupportedException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Class PulsarClientException.NotSupportedException

    +
    +
    java.lang.Object +
    java.lang.Throwable +
    java.lang.Exception +
    java.io.IOException +
    org.apache.pulsar.client.api.PulsarClientException +
    org.apache.pulsar.client.api.PulsarClientException.NotSupportedException
    +
    +
    +
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable
    +
    +
    +
    Direct Known Subclasses:
    +
    PulsarClientException.FeatureNotSupportedException
    +
    +
    +
    Enclosing class:
    +
    PulsarClientException
    +
    +
    +
    public static class PulsarClientException.NotSupportedException +extends PulsarClientException
    +
    Not supported exception thrown by Pulsar client.
    +
    +
    See Also:
    +
    + +
    +
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        NotSupportedException

        +
        public NotSupportedException(String msg)
        +
        Constructs an NotSupportedException with the specified detail message.
        +
        +
        Parameters:
        +
        msg - The detail message (which is saved for later retrieval + by the Throwable.getMessage() method)
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.ProducerBlockedQuotaExceededError.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.ProducerBlockedQuotaExceededError.html new file mode 100644 index 000000000000..bf08b5ee1c91 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.ProducerBlockedQuotaExceededError.html @@ -0,0 +1,198 @@ + + + + +PulsarClientException.ProducerBlockedQuotaExceededError (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Class PulsarClientException.ProducerBlockedQuotaExceededError

    +
    +
    java.lang.Object +
    java.lang.Throwable +
    java.lang.Exception +
    java.io.IOException +
    org.apache.pulsar.client.api.PulsarClientException +
    org.apache.pulsar.client.api.PulsarClientException.ProducerBlockedQuotaExceededError
    +
    +
    +
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable
    +
    +
    +
    Enclosing class:
    +
    PulsarClientException
    +
    +
    +
    public static class PulsarClientException.ProducerBlockedQuotaExceededError +extends PulsarClientException
    +
    Producer blocked quota exceeded error thrown by Pulsar client.
    +
    +
    See Also:
    +
    + +
    +
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        ProducerBlockedQuotaExceededError

        +
        public ProducerBlockedQuotaExceededError(String msg)
        +
        Constructs an ProducerBlockedQuotaExceededError with the specified detail message.
        +
        +
        Parameters:
        +
        msg - The detail message (which is saved for later retrieval + by the Throwable.getMessage() method)
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.ProducerBlockedQuotaExceededException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.ProducerBlockedQuotaExceededException.html new file mode 100644 index 000000000000..a063a3679ea6 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.ProducerBlockedQuotaExceededException.html @@ -0,0 +1,198 @@ + + + + +PulsarClientException.ProducerBlockedQuotaExceededException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Class PulsarClientException.ProducerBlockedQuotaExceededException

    +
    +
    java.lang.Object +
    java.lang.Throwable +
    java.lang.Exception +
    java.io.IOException +
    org.apache.pulsar.client.api.PulsarClientException +
    org.apache.pulsar.client.api.PulsarClientException.ProducerBlockedQuotaExceededException
    +
    +
    +
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable
    +
    +
    +
    Enclosing class:
    +
    PulsarClientException
    +
    +
    +
    public static class PulsarClientException.ProducerBlockedQuotaExceededException +extends PulsarClientException
    +
    Producer blocked quota exceeded exception thrown by Pulsar client.
    +
    +
    See Also:
    +
    + +
    +
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        ProducerBlockedQuotaExceededException

        +
        public ProducerBlockedQuotaExceededException(String msg)
        +
        Constructs an ProducerBlockedQuotaExceededException with the specified detail message.
        +
        +
        Parameters:
        +
        msg - The detail message (which is saved for later retrieval + by the Throwable.getMessage() method)
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.ProducerBusyException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.ProducerBusyException.html new file mode 100644 index 000000000000..0915d0b72415 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.ProducerBusyException.html @@ -0,0 +1,198 @@ + + + + +PulsarClientException.ProducerBusyException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Class PulsarClientException.ProducerBusyException

    +
    +
    java.lang.Object +
    java.lang.Throwable +
    java.lang.Exception +
    java.io.IOException +
    org.apache.pulsar.client.api.PulsarClientException +
    org.apache.pulsar.client.api.PulsarClientException.ProducerBusyException
    +
    +
    +
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable
    +
    +
    +
    Enclosing class:
    +
    PulsarClientException
    +
    +
    +
    public static class PulsarClientException.ProducerBusyException +extends PulsarClientException
    +
    Producer busy exception thrown by Pulsar client.
    +
    +
    See Also:
    +
    + +
    +
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        ProducerBusyException

        +
        public ProducerBusyException(String msg)
        +
        Constructs an ProducerBusyException with the specified detail message.
        +
        +
        Parameters:
        +
        msg - The detail message (which is saved for later retrieval + by the Throwable.getMessage() method)
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.ProducerFencedException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.ProducerFencedException.html new file mode 100644 index 000000000000..760aef9942c9 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.ProducerFencedException.html @@ -0,0 +1,198 @@ + + + + +PulsarClientException.ProducerFencedException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Class PulsarClientException.ProducerFencedException

    +
    +
    java.lang.Object +
    java.lang.Throwable +
    java.lang.Exception +
    java.io.IOException +
    org.apache.pulsar.client.api.PulsarClientException +
    org.apache.pulsar.client.api.PulsarClientException.ProducerFencedException
    +
    +
    +
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable
    +
    +
    +
    Enclosing class:
    +
    PulsarClientException
    +
    +
    +
    public static class PulsarClientException.ProducerFencedException +extends PulsarClientException
    +
    Producer fenced exception thrown by Pulsar client.
    +
    +
    See Also:
    +
    + +
    +
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        ProducerFencedException

        +
        public ProducerFencedException(String msg)
        +
        Constructs a ProducerFencedException with the specified detail message.
        +
        +
        Parameters:
        +
        msg - The detail message (which is saved for later retrieval + by the Throwable.getMessage() method)
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.ProducerQueueIsFullError.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.ProducerQueueIsFullError.html new file mode 100644 index 000000000000..6f81275f1bb6 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.ProducerQueueIsFullError.html @@ -0,0 +1,217 @@ + + + + +PulsarClientException.ProducerQueueIsFullError (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Class PulsarClientException.ProducerQueueIsFullError

    +
    +
    java.lang.Object +
    java.lang.Throwable +
    java.lang.Exception +
    java.io.IOException +
    org.apache.pulsar.client.api.PulsarClientException +
    org.apache.pulsar.client.api.PulsarClientException.ProducerQueueIsFullError
    +
    +
    +
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable
    +
    +
    +
    Enclosing class:
    +
    PulsarClientException
    +
    +
    +
    public static class PulsarClientException.ProducerQueueIsFullError +extends PulsarClientException
    +
    Full producer queue error thrown by Pulsar client.
    +
    +
    See Also:
    +
    + +
    +
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        ProducerQueueIsFullError

        +
        public ProducerQueueIsFullError(String msg)
        +
        Constructs an ProducerQueueIsFullError with the specified detail message.
        +
        +
        Parameters:
        +
        msg - The detail message (which is saved for later retrieval + by the Throwable.getMessage() method)
        +
        +
        +
        • +
      • +
        +

        ProducerQueueIsFullError

        +
        public ProducerQueueIsFullError(String msg, + long sequenceId)
        +
        Constructs an ProducerQueueIsFullError with the specified detail message.
        +
        +
        Parameters:
        +
        msg - The detail message (which is saved for later retrieval + by the Throwable.getMessage() method)
        +
        sequenceId - The sequenceId of the message
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.SubscriptionNotFoundException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.SubscriptionNotFoundException.html new file mode 100644 index 000000000000..0d513bd0ea3e --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.SubscriptionNotFoundException.html @@ -0,0 +1,198 @@ + + + + +PulsarClientException.SubscriptionNotFoundException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Class PulsarClientException.SubscriptionNotFoundException

    +
    +
    java.lang.Object +
    java.lang.Throwable +
    java.lang.Exception +
    java.io.IOException +
    org.apache.pulsar.client.api.PulsarClientException +
    org.apache.pulsar.client.api.PulsarClientException.SubscriptionNotFoundException
    +
    +
    +
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable
    +
    +
    +
    Enclosing class:
    +
    PulsarClientException
    +
    +
    +
    public static class PulsarClientException.SubscriptionNotFoundException +extends PulsarClientException
    +
    Not found subscription that cannot be created.
    +
    +
    See Also:
    +
    + +
    +
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        SubscriptionNotFoundException

        +
        public SubscriptionNotFoundException(String msg)
        +
        Constructs an SubscriptionNotFoundException with the specified detail message.
        +
        +
        Parameters:
        +
        msg - The detail message (which is saved for later retrieval + by the Throwable.getMessage() method)
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.TimeoutException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.TimeoutException.html new file mode 100644 index 000000000000..b138612791cb --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.TimeoutException.html @@ -0,0 +1,253 @@ + + + + +PulsarClientException.TimeoutException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Class PulsarClientException.TimeoutException

    +
    +
    java.lang.Object +
    java.lang.Throwable +
    java.lang.Exception +
    java.io.IOException +
    org.apache.pulsar.client.api.PulsarClientException +
    org.apache.pulsar.client.api.PulsarClientException.TimeoutException
    +
    +
    +
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable
    +
    +
    +
    Enclosing class:
    +
    PulsarClientException
    +
    +
    +
    public static class PulsarClientException.TimeoutException +extends PulsarClientException
    +
    Timeout exception thrown by Pulsar client.
    +
    +
    See Also:
    +
    + +
    +
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        TimeoutException

        +
        public TimeoutException(Throwable t)
        +
        Constructs an TimeoutException with the specified cause.
        +
        +
        Parameters:
        +
        t - The cause (which is saved for later retrieval by the + Throwable.getCause() method). (A null value is permitted, + and indicates that the cause is nonexistent or unknown.)
        +
        +
        +
        • +
      • +
        +

        TimeoutException

        +
        public TimeoutException(Throwable t, + long sequenceId)
        +
        Constructs an TimeoutException with the specified cause.
        +
        +
        Parameters:
        +
        t - The cause (which is saved for later retrieval by the + Throwable.getCause() method). (A null value is permitted, + and indicates that the cause is nonexistent or unknown.)
        +
        sequenceId - The sequenceId of the message
        +
        +
        +
        • +
      • +
        +

        TimeoutException

        +
        public TimeoutException(String msg)
        +
        Constructs an TimeoutException with the specified detail message.
        +
        +
        Parameters:
        +
        msg - The detail message (which is saved for later retrieval + by the Throwable.getMessage() method)
        +
        +
        +
        • +
      • +
        +

        TimeoutException

        +
        public TimeoutException(String msg, + long sequenceId)
        +
        Constructs an TimeoutException with the specified detail message.
        +
        +
        Parameters:
        +
        msg - The detail message (which is saved for later retrieval + by the Throwable.getMessage() method)
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.TooManyRequestsException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.TooManyRequestsException.html new file mode 100644 index 000000000000..8ba9f8f48790 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.TooManyRequestsException.html @@ -0,0 +1,200 @@ + + + + +PulsarClientException.TooManyRequestsException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Class PulsarClientException.TooManyRequestsException

    +
    +
    java.lang.Object +
    java.lang.Throwable +
    java.lang.Exception +
    java.io.IOException +
    org.apache.pulsar.client.api.PulsarClientException +
    org.apache.pulsar.client.api.PulsarClientException.LookupException +
    org.apache.pulsar.client.api.PulsarClientException.TooManyRequestsException
    +
    +
    +
    +
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable
    +
    +
    +
    Enclosing class:
    +
    PulsarClientException
    +
    +
    +
    public static class PulsarClientException.TooManyRequestsException +extends PulsarClientException.LookupException
    +
    Too many requests exception thrown by Pulsar client.
    +
    +
    See Also:
    +
    + +
    +
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        TooManyRequestsException

        +
        public TooManyRequestsException(String msg)
        +
        Constructs an TooManyRequestsException with the specified detail message.
        +
        +
        Parameters:
        +
        msg - The detail message (which is saved for later retrieval + by the Throwable.getMessage() method)
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.TopicDoesNotExistException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.TopicDoesNotExistException.html new file mode 100644 index 000000000000..f16be89de9a3 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.TopicDoesNotExistException.html @@ -0,0 +1,198 @@ + + + + +PulsarClientException.TopicDoesNotExistException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Class PulsarClientException.TopicDoesNotExistException

    +
    +
    java.lang.Object +
    java.lang.Throwable +
    java.lang.Exception +
    java.io.IOException +
    org.apache.pulsar.client.api.PulsarClientException +
    org.apache.pulsar.client.api.PulsarClientException.TopicDoesNotExistException
    +
    +
    +
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable
    +
    +
    +
    Enclosing class:
    +
    PulsarClientException
    +
    +
    +
    public static class PulsarClientException.TopicDoesNotExistException +extends PulsarClientException
    +
    Topic does not exist and cannot be created.
    +
    +
    See Also:
    +
    + +
    +
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        TopicDoesNotExistException

        +
        public TopicDoesNotExistException(String msg)
        +
        Constructs an TopicDoesNotExistException with the specified detail message.
        +
        +
        Parameters:
        +
        msg - The detail message (which is saved for later retrieval + by the Throwable.getMessage() method)
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.TopicMigrationException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.TopicMigrationException.html new file mode 100644 index 000000000000..c018b6a5570e --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.TopicMigrationException.html @@ -0,0 +1,198 @@ + + + + +PulsarClientException.TopicMigrationException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Class PulsarClientException.TopicMigrationException

    +
    +
    java.lang.Object +
    java.lang.Throwable +
    java.lang.Exception +
    java.io.IOException +
    org.apache.pulsar.client.api.PulsarClientException +
    org.apache.pulsar.client.api.PulsarClientException.TopicMigrationException
    +
    +
    +
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable
    +
    +
    +
    Enclosing class:
    +
    PulsarClientException
    +
    +
    +
    public static class PulsarClientException.TopicMigrationException +extends PulsarClientException
    +
    TopicMigration exception thrown by Pulsar client.
    +
    +
    See Also:
    +
    + +
    +
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        TopicMigrationException

        +
        public TopicMigrationException(String msg)
        +
        Constructs an TopicMigrationException with the specified detail message.
        +
        +
        Parameters:
        +
        msg - The detail message (which is saved for later retrieval + by the Throwable.getMessage() method)
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.TopicTerminatedException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.TopicTerminatedException.html new file mode 100644 index 000000000000..54ec3c94b772 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.TopicTerminatedException.html @@ -0,0 +1,217 @@ + + + + +PulsarClientException.TopicTerminatedException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Class PulsarClientException.TopicTerminatedException

    +
    +
    java.lang.Object +
    java.lang.Throwable +
    java.lang.Exception +
    java.io.IOException +
    org.apache.pulsar.client.api.PulsarClientException +
    org.apache.pulsar.client.api.PulsarClientException.TopicTerminatedException
    +
    +
    +
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable
    +
    +
    +
    Enclosing class:
    +
    PulsarClientException
    +
    +
    +
    public static class PulsarClientException.TopicTerminatedException +extends PulsarClientException
    +
    Topic terminated exception thrown by Pulsar client.
    +
    +
    See Also:
    +
    + +
    +
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        TopicTerminatedException

        +
        public TopicTerminatedException(String msg)
        +
        Constructs an TopicTerminatedException with the specified detail message.
        +
        +
        Parameters:
        +
        msg - The detail message (which is saved for later retrieval + by the Throwable.getMessage() method)
        +
        +
        +
        • +
      • +
        +

        TopicTerminatedException

        +
        public TopicTerminatedException(String msg, + long sequenceId)
        +
        Constructs an TopicTerminatedException with the specified detail message.
        +
        +
        Parameters:
        +
        msg - The detail message (which is saved for later retrieval + by the Throwable.getMessage() method)
        +
        sequenceId - The sequenceId of the message
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.TransactionConflictException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.TransactionConflictException.html new file mode 100644 index 000000000000..0a750801dd0c --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.TransactionConflictException.html @@ -0,0 +1,214 @@ + + + + +PulsarClientException.TransactionConflictException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Class PulsarClientException.TransactionConflictException

    +
    +
    java.lang.Object +
    java.lang.Throwable +
    java.lang.Exception +
    java.io.IOException +
    org.apache.pulsar.client.api.PulsarClientException +
    org.apache.pulsar.client.api.PulsarClientException.TransactionConflictException
    +
    +
    +
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable
    +
    +
    +
    Enclosing class:
    +
    PulsarClientException
    +
    +
    +
    public static class PulsarClientException.TransactionConflictException +extends PulsarClientException
    +
    Consumer assign exception thrown by Pulsar client.
    +
    +
    See Also:
    +
    + +
    +
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        TransactionConflictException

        +
        public TransactionConflictException(Throwable t)
        +
        Constructs an TransactionConflictException with the specified cause.
        +
        +
        Parameters:
        +
        t - The cause (which is saved for later retrieval by the + Throwable.getCause() method). (A null value is permitted, + and indicates that the cause is nonexistent or unknown.)
        +
        +
        +
        • +
      • +
        +

        TransactionConflictException

        +
        public TransactionConflictException(String msg)
        +
        Constructs an TransactionConflictException with the specified detail message.
        +
        +
        Parameters:
        +
        msg - The detail message.
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.TransactionHasOperationFailedException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.TransactionHasOperationFailedException.html new file mode 100644 index 000000000000..d4c3edf1eac8 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.TransactionHasOperationFailedException.html @@ -0,0 +1,207 @@ + + + + +PulsarClientException.TransactionHasOperationFailedException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Class PulsarClientException.TransactionHasOperationFailedException

    +
    +
    java.lang.Object +
    java.lang.Throwable +
    java.lang.Exception +
    java.io.IOException +
    org.apache.pulsar.client.api.PulsarClientException +
    org.apache.pulsar.client.api.PulsarClientException.TransactionHasOperationFailedException
    +
    +
    +
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable
    +
    +
    +
    Enclosing class:
    +
    PulsarClientException
    +
    +
    +
    public static class PulsarClientException.TransactionHasOperationFailedException +extends PulsarClientException
    +
    +
    See Also:
    +
    + +
    +
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        TransactionHasOperationFailedException

        +
        public TransactionHasOperationFailedException()
        +
        Constructs an TransactionHasOperationFailedException.
        +
        +
        • +
      • +
        +

        TransactionHasOperationFailedException

        +
        public TransactionHasOperationFailedException(String msg)
        +
        Constructs an TransactionHasOperationFailedException with the specified detail message.
        +
        +
        Parameters:
        +
        msg - The detail message.
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.UnsupportedAuthenticationException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.UnsupportedAuthenticationException.html new file mode 100644 index 000000000000..872b23a984e3 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.UnsupportedAuthenticationException.html @@ -0,0 +1,215 @@ + + + + +PulsarClientException.UnsupportedAuthenticationException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Class PulsarClientException.UnsupportedAuthenticationException

    +
    +
    java.lang.Object +
    java.lang.Throwable +
    java.lang.Exception +
    java.io.IOException +
    org.apache.pulsar.client.api.PulsarClientException +
    org.apache.pulsar.client.api.PulsarClientException.UnsupportedAuthenticationException
    +
    +
    +
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable
    +
    +
    +
    Enclosing class:
    +
    PulsarClientException
    +
    +
    +
    public static class PulsarClientException.UnsupportedAuthenticationException +extends PulsarClientException
    +
    Unsupported authentication exception thrown by Pulsar client.
    +
    +
    See Also:
    +
    + +
    +
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        UnsupportedAuthenticationException

        +
        public UnsupportedAuthenticationException(Throwable t)
        +
        Constructs an UnsupportedAuthenticationException with the specified cause.
        +
        +
        Parameters:
        +
        t - The cause (which is saved for later retrieval by the + Throwable.getCause() method). (A null value is permitted, + and indicates that the cause is nonexistent or unknown.)
        +
        +
        +
        • +
      • +
        +

        UnsupportedAuthenticationException

        +
        public UnsupportedAuthenticationException(String msg)
        +
        Constructs an UnsupportedAuthenticationException with the specified detail message.
        +
        +
        Parameters:
        +
        msg - The detail message (which is saved for later retrieval + by the Throwable.getMessage() method)
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.html new file mode 100644 index 000000000000..e255e9ee158d --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/PulsarClientException.html @@ -0,0 +1,563 @@ + + + + +PulsarClientException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Class PulsarClientException

    +
    +
    java.lang.Object +
    java.lang.Throwable +
    java.lang.Exception +
    java.io.IOException +
    org.apache.pulsar.client.api.PulsarClientException
    +
    +
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable
    +
    +
    +
    Direct Known Subclasses:
    +
    PulsarClientException.AlreadyClosedException, PulsarClientException.AuthenticationException, PulsarClientException.AuthorizationException, PulsarClientException.BrokerMetadataException, PulsarClientException.BrokerPersistenceException, PulsarClientException.ChecksumException, PulsarClientException.ConnectException, PulsarClientException.ConsumerAssignException, PulsarClientException.ConsumerBusyException, PulsarClientException.CryptoException, PulsarClientException.GettingAuthenticationDataException, PulsarClientException.IncompatibleSchemaException, PulsarClientException.InvalidConfigurationException, PulsarClientException.InvalidMessageException, PulsarClientException.InvalidServiceURL, PulsarClientException.InvalidTopicNameException, PulsarClientException.LookupException, PulsarClientException.MemoryBufferIsFullError, PulsarClientException.MessageAcknowledgeException, PulsarClientException.NotAllowedException, PulsarClientException.NotConnectedException, PulsarClientException.NotFoundException, PulsarClientException.NotSupportedException, PulsarClientException.ProducerBlockedQuotaExceededError, PulsarClientException.ProducerBlockedQuotaExceededException, PulsarClientException.ProducerBusyException, PulsarClientException.ProducerFencedException, PulsarClientException.ProducerQueueIsFullError, PulsarClientException.SubscriptionNotFoundException, PulsarClientException.TimeoutException, PulsarClientException.TopicDoesNotExistException, PulsarClientException.TopicMigrationException, PulsarClientException.TopicTerminatedException, PulsarClientException.TransactionConflictException, PulsarClientException.TransactionHasOperationFailedException, PulsarClientException.UnsupportedAuthenticationException
    +
    +
    +
    @Public +@Stable +public class PulsarClientException +extends IOException
    +
    Base type of exception thrown by Pulsar client.
    +
    +
    See Also:
    +
    + +
    +
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        PulsarClientException

        +
        public PulsarClientException(String msg)
        +
        Constructs an PulsarClientException with the specified detail message.
        +
        +
        Parameters:
        +
        msg - The detail message (which is saved for later retrieval + by the Throwable.getMessage() method)
        +
        +
        +
        • +
      • +
        +

        PulsarClientException

        +
        public PulsarClientException(String msg, + long sequenceId)
        +
        Constructs an PulsarClientException with the specified detail message.
        +
        +
        Parameters:
        +
        msg - The detail message (which is saved for later retrieval + by the Throwable.getMessage() method)
        +
        sequenceId - The sequenceId of the message
        +
        +
        +
        • +
      • +
        +

        PulsarClientException

        +
        public PulsarClientException(Throwable t)
        +
        Constructs an PulsarClientException with the specified cause.
        +
        +
        Parameters:
        +
        t - The cause (which is saved for later retrieval by the + Throwable.getCause() method). (A null value is permitted, + and indicates that the cause is nonexistent or unknown.)
        +
        +
        +
        • +
      • +
        +

        PulsarClientException

        +
        public PulsarClientException(String msg, + Throwable t)
        +
        Constructs an PulsarClientException with the specified cause.
        +
        +
        Parameters:
        +
        msg - The detail message (which is saved for later retrieval by the Throwable.getMessage() method)
        +
        t - The cause (which is saved for later retrieval by the Throwable.getCause() method). (A null value is + permitted, and indicates that the cause is nonexistent or unknown.)
        +
        +
        +
        • +
      • +
        +

        PulsarClientException

        +
        public PulsarClientException(Throwable t, + long sequenceId)
        +
        Constructs an PulsarClientException with the specified cause.
        +
        +
        Parameters:
        +
        t - The cause (which is saved for later retrieval by the Throwable.getCause() method). (A null value is + permitted, and indicates that the cause is nonexistent or unknown.)
        +
        sequenceId - The sequenceId of the message
        +
        +
        +
        • +
      +
      +
      • + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        setPreviousExceptionCount

        +
        public void setPreviousExceptionCount(AtomicInteger previousExceptionCount)
        +
        +
        • +
      • +
        +

        toString

        +
        public String toString()
        +
        +
        Overrides:
        +
        toString in class Throwable
        +
        +
        +
        • +
      • +
        +

        wrap

        +
        public static Throwable wrap(Throwable t, + String msg)
        +
        +
        • +
      • +
        +

        unwrap

        +
        public static PulsarClientException unwrap(Throwable t)
        +
        +
        • +
      • +
        +

        getSequenceId

        +
        public long getSequenceId()
        +
        +
        • +
      • +
        +

        setSequenceId

        +
        public void setSequenceId(long sequenceId)
        +
        +
        • +
      • +
        +

        isRetriableError

        +
        public static boolean isRetriableError(Throwable t)
        +
        +
        • +
      • +
        +

        setPreviousExceptionCount

        +
        public static void setPreviousExceptionCount(Throwable e, + AtomicInteger previousExceptionCount)
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/Range.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/Range.html new file mode 100644 index 000000000000..f0b0277950dd --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/Range.html @@ -0,0 +1,320 @@ + + + + +Range (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Class Range

    +
    +
    java.lang.Object +
    org.apache.pulsar.client.api.Range
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Comparable<Range>
    +
    +
    +
    @Public +@Stable +public class Range +extends Object +implements Comparable<Range>
    +
    Int range.
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        Range

        +
        public Range(int start, + int end)
        +
        +
        • +
      +
      +
      • + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        of

        +
        public static Range of(int start, + int end)
        +
        +
        • +
      • +
        +

        getStart

        +
        public int getStart()
        +
        +
        • +
      • +
        +

        getEnd

        +
        public int getEnd()
        +
        +
        • +
      • +
        +

        intersect

        +
        public Range intersect(Range range)
        +
        +
        • +
      • +
        +

        equals

        +
        public boolean equals(Object o)
        +
        +
        Overrides:
        +
        equals in class Object
        +
        +
        +
        • +
      • +
        +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class Object
        +
        +
        +
        • +
      • +
        +

        toString

        +
        public String toString()
        +
        +
        Overrides:
        +
        toString in class Object
        +
        +
        +
        • +
      • +
        +

        compareTo

        +
        public int compareTo(Range o)
        +
        +
        Specified by:
        +
        compareTo in interface Comparable<Range>
        +
        +
        +
        • +
      • +
        +

        contains

        +
        public boolean contains(int value)
        +
        Check if the value is in the range.
        +
        +
        Parameters:
        +
        value -
        +
        Returns:
        +
        true if the value is in the range.
        +
        +
        +
        • +
      • +
        +

        contains

        +
        public boolean contains(Range otherRange)
        +
        Check if the range is fully contained in the other range.
        +
        +
        Parameters:
        +
        otherRange -
        +
        Returns:
        +
        true if the range is fully contained in the other range.
        +
        +
        +
        • +
      • +
        +

        size

        +
        public int size()
        +
        Get the size of the range.
        +
        +
        Returns:
        +
        the size of the range.
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/Reader.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/Reader.html new file mode 100644 index 000000000000..b3ee915582c7 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/Reader.html @@ -0,0 +1,513 @@ + + + + +Reader (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Interface Reader<T>

    +
    +
    +
    +
    All Superinterfaces:
    +
    AutoCloseable, Closeable
    +
    +
    +
    @Public +@Stable +public interface Reader<T> +extends Closeable
    +
    A Reader can be used to scan through all the messages currently available in a topic.
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        getTopic

        +
        String getTopic()
        +
        +
        Returns:
        +
        the topic from which this reader is reading from
        +
        +
        +
        • +
      • +
        +

        readNext

        +
        Message<T> readNext() + throws PulsarClientException
        +
        Read the next message in the topic. + +

        This method will block until a message is available.

        +
        +
        Returns:
        +
        the next message
        +
        Throws:
        +
        PulsarClientException
        +
        +
        +
        • +
      • +
        +

        readNext

        +
        Message<T> readNext(int timeout, + TimeUnit unit) + throws PulsarClientException
        +
        Read the next message in the topic waiting for a maximum time. + +

        Returns null if no message is received before the timeout.

        +
        +
        Returns:
        +
        the next message(Could be null if none received in time)
        +
        Throws:
        +
        PulsarClientException
        +
        +
        +
        • +
      • +
        +

        readNextAsync

        +
        CompletableFuture<Message<T>> readNextAsync()
        +
        Read asynchronously the next message in the topic. + +

        readNextAsync() should be called subsequently once returned CompletableFuture gets complete + with received message. Else it creates backlog of receive requests in the application. + +

        The returned future can be cancelled before completion by calling .cancel(false) + (CompletableFuture.cancel(boolean)) to remove it from the the backlog of receive requests. Another + choice for ensuring a proper clean up of the returned future is to use the CompletableFuture.orTimeout method + which is available on JDK9+. That would remove it from the backlog of receive requests if receiving exceeds + the timeout.

        +
        +
        Returns:
        +
        a future that will yield a message (when it's available) or PulsarClientException if the reader + is already closed.
        +
        +
        +
        • +
      • +
        +

        closeAsync

        +
        CompletableFuture<Void> closeAsync()
        +
        Asynchronously close the reader and stop the broker to push more messages.
        +
        +
        Returns:
        +
        a future that can be used to track the completion of the operation
        +
        +
        +
        • +
      • +
        +

        hasReachedEndOfTopic

        +
        boolean hasReachedEndOfTopic()
        +
        Return true if the topic was terminated and this reader has reached the end of the topic. + +

        Note that this only applies to a "terminated" topic (where the topic is "sealed" and no + more messages can be published) and not just that the reader is simply caught up with + the publishers. Use hasMessageAvailable() to check for for that.

        +
        +
        • +
      • +
        +

        hasMessageAvailable

        +
        boolean hasMessageAvailable() + throws PulsarClientException
        +
        Check if there is any message available to read from the current position. + +

        This check can be used by an application to scan through a topic and stop + when the reader reaches the current last published message. For example: + + 

        
+ while (reader.hasMessageAvailable()) {
+     Message<String> msg = reader.readNext();
+     // Do something
+ }
+
+ // Done reading
+
        + +

        Note that this call might be blocking (see hasMessageAvailableAsync() for async version) and + that even if this call returns true, that will not guarantee that a subsequent call to readNext() + will not block.

        +
        +
        Returns:
        +
        true if the are messages available to be read, false otherwise
        +
        Throws:
        +
        PulsarClientException - if there was any error in the operation
        +
        +
        +
        • +
      • +
        +

        hasMessageAvailableAsync

        +
        CompletableFuture<Boolean> hasMessageAvailableAsync()
        +
        Asynchronously check if there is any message available to read from the current position. + +

        This check can be used by an application to scan through a topic and stop when the reader reaches the current + last published message.

        +
        +
        Returns:
        +
        a future that will yield true if the are messages available to be read, false otherwise, or a + PulsarClientException if there was any error in the operation
        +
        +
        +
        • +
      • +
        +

        isConnected

        +
        boolean isConnected()
        +
        +
        Returns:
        +
        Whether the reader is connected to the broker
        +
        +
        +
        • +
      • +
        +

        seek

        +
        void seek(MessageId messageId) + throws PulsarClientException
        +
        Reset the subscription associated with this reader to a specific message id. + +

        The message id can either be a specific message or represent the first or last messages in the topic. +

          +
        • MessageId.earliest : Reset the reader on the earliest message available in the topic +
        • MessageId.latest : Reset the reader on the latest message in the topic +
        + +

        Note: this operation can only be done on non-partitioned topics. For these, one can rather perform + the seek() on the individual partitions.

        +
        +
        Parameters:
        +
        messageId - the message id where to reposition the reader
        +
        Throws:
        +
        PulsarClientException
        +
        +
        +
        • +
      • +
        +

        seek

        +
        void seek(long timestamp) + throws PulsarClientException
        +
        Reset the subscription associated with this reader to a specific message publish time. + +

        Note: this operation can only be done on non-partitioned topics. For these, one can rather perform + the seek() on the individual partitions.

        +
        +
        Parameters:
        +
        timestamp - the message publish time where to reposition the reader + The timestamp format should be Unix time in milliseconds.
        +
        Throws:
        +
        PulsarClientException
        +
        +
        +
        • +
      • +
        +

        seek

        +
        void seek(Function<String,Object> function) + throws PulsarClientException
        +
        Reset the subscription associated with this consumer to a specific message ID or message publish time. +

        + The Function input is topic+partition. It returns only timestamp or MessageId. +

        + The return value is the seek position/timestamp of the current partition. + Exception is thrown if other object types are returned. +

        + If returns null, the current partition will not do any processing. + Exception in a partition may affect other partitions.

        +
        +
        Parameters:
        +
        function -
        +
        Throws:
        +
        PulsarClientException
        +
        +
        +
        • +
      • +
        +

        seekAsync

        +
        CompletableFuture<Void> seekAsync(Function<String,Object> function)
        +
        Reset the subscription associated with this consumer to a specific message ID + or message publish time asynchronously. +

        + The Function input is topic+partition. It returns only timestamp or MessageId. +

        + The return value is the seek position/timestamp of the current partition. + Exception is thrown if other object types are returned. +

        + If returns null, the current partition will not do any processing. + Exception in a partition may affect other partitions.

        +
        +
        Parameters:
        +
        function -
        +
        Returns:
        +
        +
        +
        • +
      • +
        +

        seekAsync

        +
        CompletableFuture<Void> seekAsync(MessageId messageId)
        +
        Reset the subscription associated with this reader to a specific message id. + +

        The message id can either be a specific message or represent the first or last messages in the topic. +

          +
        • MessageId.earliest : Reset the reader on the earliest message available in the topic +
        • MessageId.latest : Reset the reader on the latest message in the topic +
        + +

        Note: this operation can only be done on non-partitioned topics. For these, one can rather perform + the seek() on the individual partitions.

        +
        +
        Parameters:
        +
        messageId - the message id where to position the reader
        +
        Returns:
        +
        a future to track the completion of the seek operation
        +
        +
        +
        • +
      • +
        +

        seekAsync

        +
        CompletableFuture<Void> seekAsync(long timestamp)
        +
        Reset the subscription associated with this reader to a specific message publish time. + +

        Note: this operation can only be done on non-partitioned topics. For these, one can rather perform + the seek() on the individual partitions.

        +
        +
        Parameters:
        +
        timestamp - the message publish time where to position the reader + The timestamp format should be Unix time in milliseconds.
        +
        Returns:
        +
        a future to track the completion of the seek operation
        +
        +
        +
        • +
      • +
        +

        getLastMessageIds

        +
        List<TopicMessageId> getLastMessageIds() + throws PulsarClientException
        +
        Get all the last message id of the topics the reader subscribed.
        +
        +
        Returns:
        +
        the list of TopicMessageId instances of all the topics that the reader subscribed
        +
        Throws:
        +
        PulsarClientException - if failed to get last message id.
        +
        +
        +
        • +
      • +
        +

        getLastMessageIdsAsync

        +
        CompletableFuture<List<TopicMessageId>> getLastMessageIdsAsync()
        +
        The asynchronous version of getLastMessageIds().
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/ReaderBuilder.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/ReaderBuilder.html new file mode 100644 index 000000000000..6576cce8d27a --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/ReaderBuilder.html @@ -0,0 +1,758 @@ + + + + +ReaderBuilder (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Interface ReaderBuilder<T>

    +
    +
    +
    +
    All Superinterfaces:
    +
    Cloneable
    +
    +
    +
    @Public +@Stable +public interface ReaderBuilder<T> +extends Cloneable
    +
    ReaderBuilder is used to configure and create instances of Reader.
    +
    +
    Since:
    +
    2.0.0
    +
    See Also:
    +
    + +
    +
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        create

        +
        Reader<T> create() + throws PulsarClientException
        +
        Finalize the creation of the Reader instance. + +

        This method will block until the reader is created successfully or an exception is thrown.

        +
        +
        Returns:
        +
        the reader instance
        +
        Throws:
        +
        PulsarClientException - if the reader creation fails
        +
        +
        +
        • +
      • +
        +

        createAsync

        +
        CompletableFuture<Reader<T>> createAsync()
        +
        Finalize the creation of the Reader instance in asynchronous mode. + +

        This method will return a CompletableFuture that can be used to access the instance when it's ready.

        +
        +
        Returns:
        +
        the reader instance
        +
        Throws:
        +
        PulsarClientException - if the reader creation fails
        +
        +
        +
        • +
      • +
        +

        loadConf

        +
        ReaderBuilder<T> loadConf(Map<String,Object> config)
        +
        Load the configuration from provided config map. + +

        Example: + + 

        
+ Map<String, Object> config = new HashMap<>();
+ config.put("topicName", "test-topic");
+ config.put("receiverQueueSize", 2000);
+
+ ReaderBuilder<byte[]> builder = ...;
+ builder = builder.loadConf(config);
+
+ Reader<byte[]> reader = builder.create();
+
        +
        +
        Parameters:
        +
        config - configuration to load
        +
        Returns:
        +
        the reader builder instance
        +
        +
        +
        • +
      • +
        +

        clone

        +
        ReaderBuilder<T> clone()
        +
        Create a copy of the current ReaderBuilder. + +

        Cloning the builder can be used to share an incomplete configuration and specialize it multiple times. For + example: + + 

        
+ ReaderBuilder<String> builder = client.newReader(Schema.STRING)
+             .readerName("my-reader")
+             .receiverQueueSize(10);
+
+ Reader<String> reader1 = builder.clone().topic("topic-1").create();
+ Reader<String> reader2 = builder.clone().topic("topic-2").create();
+
        +
        +
        Returns:
        +
        a clone of the reader builder instance
        +
        +
        +
        • +
      • +
        +

        topic

        +
        ReaderBuilder<T> topic(String topicName)
        +
        Specify the topic this reader will read from. + +

        This argument is required when constructing the reader.

        +
        +
        Parameters:
        +
        topicName - the name of the topic
        +
        Returns:
        +
        the reader builder instance
        +
        +
        +
        • +
      • +
        +

        topics

        +
        ReaderBuilder<T> topics(List<String> topicNames)
        +
        Specify topics this reader will read from.
        +
        +
        Parameters:
        +
        topicNames -
        +
        Returns:
        +
        +
        +
        • +
      • +
        +

        startMessageId

        +
        ReaderBuilder<T> startMessageId(MessageId startMessageId)
        +
        The initial reader positioning is done by specifying a message id. The options are: +
          +
        • MessageId.earliest: Start reading from the earliest message available in the topic
          • +
        • MessageId.latest: Start reading from end of the topic. The first message read will be the one + published *after* the creation of the builder
          • +
        • MessageId: Position the reader on a particular message. The first message read will be the one + immediately *after* the specified message
          • +
        + +

        If the first message *after* the specified message is not the desired behaviour, use + startMessageIdInclusive().

        +
        +
        Parameters:
        +
        startMessageId - the message id where the reader will be initially positioned on
        +
        Returns:
        +
        the reader builder instance
        +
        +
        +
        • +
      • +
        +

        startMessageFromRollbackDuration

        +
        ReaderBuilder<T> startMessageFromRollbackDuration(long rollbackDuration, + TimeUnit timeunit)
        +
        The initial reader positioning can be set at specific timestamp by providing total rollback duration. so, broker + can find a latest message that was published before given duration.
        + eg: rollbackDuration in minute = 5 suggests broker to find message which was published 5 mins back and set the + inital position on that messageId.
        +
        +
        Parameters:
        +
        rollbackDuration - duration which position should be rolled back.
        +
        Returns:
        +
        +
        +
        • +
      • +
        +

        startMessageIdInclusive

        +
        ReaderBuilder<T> startMessageIdInclusive()
        +
        Set the reader to include the given position of startMessageId(MessageId) + +

        This configuration option also applies for any cursor reset operation like Reader.seek(MessageId).

        +
        +
        Returns:
        +
        the reader builder instance
        +
        +
        +
        • +
      • +
        +

        readerListener

        +
        ReaderBuilder<T> readerListener(ReaderListener<T> readerListener)
        +
        Sets a ReaderListener for the reader. + +

        When a ReaderListener is set, application will receive messages through it. Calls to + Reader.readNext() will not be allowed.

        +
        +
        Parameters:
        +
        readerListener - the listener object
        +
        Returns:
        +
        the reader builder instance
        +
        +
        +
        • +
      • +
        +

        cryptoKeyReader

        +
        ReaderBuilder<T> cryptoKeyReader(CryptoKeyReader cryptoKeyReader)
        +
        Sets a CryptoKeyReader to decrypt the message payloads.
        +
        +
        Parameters:
        +
        cryptoKeyReader - CryptoKeyReader object
        +
        Returns:
        +
        the reader builder instance
        +
        +
        +
        • +
      • +
        +

        defaultCryptoKeyReader

        +
        ReaderBuilder<T> defaultCryptoKeyReader(String privateKey)
        +
        Sets the default implementation of CryptoKeyReader. + +

        Configure the key reader to be used to decrypt the message payloads.

        +
        +
        Parameters:
        +
        privateKey - the private key that is always used to decrypt message payloads.
        +
        Returns:
        +
        the reader builder instance
        +
        Since:
        +
        2.8.0
        +
        +
        +
        • +
      • +
        +

        defaultCryptoKeyReader

        +
        ReaderBuilder<T> defaultCryptoKeyReader(Map<String,String> privateKeys)
        +
        Sets the default implementation of CryptoKeyReader. + +

        Configure the key reader to be used to decrypt the message payloads.

        +
        +
        Parameters:
        +
        privateKeys - the map of private key names and their URIs used to decrypt message payloads.
        +
        Returns:
        +
        the reader builder instance
        +
        Since:
        +
        2.8.0
        +
        +
        +
        • +
      • +
        +

        cryptoFailureAction

        +
        ReaderBuilder<T> cryptoFailureAction(ConsumerCryptoFailureAction action)
        +
        Sets the ConsumerCryptoFailureAction to specify.
        +
        +
        Parameters:
        +
        action - The action to take when the decoding fails
        +
        Returns:
        +
        the reader builder instance
        +
        +
        +
        • +
      • +
        +

        messageCrypto

        +
        ReaderBuilder<T> messageCrypto(MessageCrypto messageCrypto)
        +
        Sets a MessageCrypto. + +

        Contains methods to encrypt/decrypt message for End to End Encryption.

        +
        +
        Parameters:
        +
        messageCrypto - message Crypto Object
        +
        Returns:
        +
        ReaderBuilder instance
        +
        +
        +
        • +
      • +
        +

        receiverQueueSize

        +
        ReaderBuilder<T> receiverQueueSize(int receiverQueueSize)
        +
        Sets the size of the consumer receive queue. + +

        The consumer receive queue controls how many messages can be accumulated by the Consumer before the + application calls Consumer.receive(). Using a higher value could potentially increase the consumer + throughput at the expense of bigger memory utilization. + +

        Default value is 1000 messages and should be good for most use cases.

        +
        +
        Parameters:
        +
        receiverQueueSize - the new receiver queue size value
        +
        Returns:
        +
        the reader builder instance
        +
        +
        +
        • +
      • +
        +

        readerName

        +
        ReaderBuilder<T> readerName(String readerName)
        +
        Specify a reader name. + +

        The reader name is purely informational and can used to track a particular reader in the reported stats. + By default a randomly generated name is used.

        +
        +
        Parameters:
        +
        readerName - the name to use for the reader
        +
        Returns:
        +
        the reader builder instance
        +
        +
        +
        • +
      • +
        +

        subscriptionRolePrefix

        +
        ReaderBuilder<T> subscriptionRolePrefix(String subscriptionRolePrefix)
        +
        Set the subscription role prefix. The default prefix is "reader".
        +
        +
        Parameters:
        +
        subscriptionRolePrefix -
        +
        Returns:
        +
        the reader builder instance
        +
        +
        +
        • +
      • +
        +

        subscriptionName

        +
        ReaderBuilder<T> subscriptionName(String subscriptionName)
        +
        Set the subscription name. +

        If subscriptionRolePrefix is set at the same time, this configuration will prevail

        +
        +
        Parameters:
        +
        subscriptionName -
        +
        Returns:
        +
        the reader builder instance
        +
        +
        +
        • +
      • +
        +

        readCompacted

        +
        ReaderBuilder<T> readCompacted(boolean readCompacted)
        +
        If enabled, the reader will read messages from the compacted topic rather than reading the full message backlog + of the topic. This means that, if the topic has been compacted, the reader will only see the latest value for + each key in the topic, up until the point in the topic message backlog that has been compacted. Beyond that + point, the messages will be sent as normal. + +

        readCompacted can only be enabled when reading from a persistent topic. Attempting to enable it + on non-persistent topics will lead to the reader create call throwing a PulsarClientException.

        +
        +
        Parameters:
        +
        readCompacted - whether to read from the compacted topic
        +
        Returns:
        +
        the reader builder instance
        +
        +
        +
        • +
      • +
        +

        keyHashRange

        +
        ReaderBuilder<T> keyHashRange(Range... ranges)
        +
        Set key hash range of the reader, broker will only dispatch messages which hash of the message key contains by + the specified key hash range. Multiple key hash ranges can be specified on a reader. + +

        Total hash range size is 65536, so the max end of the range should be less than or equal to 65535.

        +
        +
        Parameters:
        +
        ranges - key hash ranges for a reader
        +
        Returns:
        +
        the reader builder instance
        +
        +
        +
        • +
      • +
        +

        poolMessages

        +
        ReaderBuilder<T> poolMessages(boolean poolMessages)
        +
        Enable pooling of messages and the underlying data buffers. +

        + When pooling is enabled, the application is responsible for calling Message.release() after the handling of every + received message. If “release()” is not called on a received message, there will be a memory leak. If an + application attempts to use and already “released” message, it might experience undefined behavior (for example, + memory corruption, deserialization error, etc.).

        +
        +
        • +
      • +
        +

        autoUpdatePartitions

        +
        ReaderBuilder<T> autoUpdatePartitions(boolean autoUpdate)
        +
        If enabled, the reader will auto subscribe for partitions increasement. + This is only for partitioned reader.
        +
        +
        Parameters:
        +
        autoUpdate - whether to auto update partition increasement
        +
        Returns:
        +
        the reader builder instance
        +
        +
        +
        • +
      • +
        +

        autoUpdatePartitionsInterval

        +
        ReaderBuilder<T> autoUpdatePartitionsInterval(int interval, + TimeUnit unit)
        +
        Set the interval of updating partitions (default: 1 minute). This only works if autoUpdatePartitions is + enabled.
        +
        +
        Parameters:
        +
        interval - the interval of updating partitions
        +
        unit - the time unit of the interval.
        +
        Returns:
        +
        the reader builder instance
        +
        +
        +
        • +
      • +
        +

        intercept

        +
        ReaderBuilder<T> intercept(ReaderInterceptor<T>... interceptors)
        +
        Intercept Reader.
        +
        +
        Parameters:
        +
        interceptors - the list of interceptors to intercept the reader created by this builder.
        +
        Returns:
        +
        the reader builder instance
        +
        +
        +
        • +
      • +
        +

        maxPendingChunkedMessage

        +
        ReaderBuilder<T> maxPendingChunkedMessage(int maxPendingChunkedMessage)
        +
        Consumer buffers chunk messages into memory until it receives all the chunks of the original message. While + consuming chunk-messages, chunks from same message might not be contiguous in the stream and they might be mixed + with other messages' chunks. so, consumer has to maintain multiple buffers to manage chunks coming from different + messages. This mainly happens when multiple publishers are publishing messages on the topic concurrently or + publisher failed to publish all chunks of the messages. + + 
        + eg: M1-C1, M2-C1, M1-C2, M2-C2
+ Here, Messages M1-C1 and M1-C2 belong to original message M1, M2-C1 and M2-C2 messages belong to M2 message.
+
        + Buffering large number of outstanding uncompleted chunked messages can create memory pressure and it can be + guarded by providing this @maxPendingChunkedMessage threshold. Once, consumer reaches this threshold, it drops + the outstanding unchunked-messages by silently acking or asking broker to redeliver later by marking it unacked. + This behavior can be controlled by configuration: @autoAckOldestChunkedMessageOnQueueFull + + The default value is 10.
        +
        +
        Parameters:
        +
        maxPendingChunkedMessage -
        +
        Returns:
        +
        +
        +
        • +
      • +
        +

        autoAckOldestChunkedMessageOnQueueFull

        +
        ReaderBuilder<T> autoAckOldestChunkedMessageOnQueueFull(boolean autoAckOldestChunkedMessageOnQueueFull)
        +
        Buffering large number of outstanding uncompleted chunked messages can create memory pressure and it can be + guarded by providing this @maxPendingChunkedMessage threshold. Once, consumer reaches this threshold, it drops + the outstanding unchunked-messages by silently acking if autoAckOldestChunkedMessageOnQueueFull is true else it + marks them for redelivery.
        +
        +
        Parameters:
        +
        autoAckOldestChunkedMessageOnQueueFull -
        +
        Returns:
        +
        +
        +
        • +
      • +
        +

        expireTimeOfIncompleteChunkedMessage

        +
        ReaderBuilder<T> expireTimeOfIncompleteChunkedMessage(long duration, + TimeUnit unit)
        +
        If producer fails to publish all the chunks of a message then consumer can expire incomplete chunks if consumer + won't be able to receive all chunks in expire times (default 1 minute).
        +
        +
        Parameters:
        +
        duration -
        +
        unit -
        +
        Returns:
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/ReaderInterceptor.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/ReaderInterceptor.html new file mode 100644 index 000000000000..007192e52349 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/ReaderInterceptor.html @@ -0,0 +1,203 @@ + + + + +ReaderInterceptor (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Interface ReaderInterceptor<T>

    +
    +
    +
    +
    Type Parameters:
    +
    T -
    +
    +
    +
    @Public +@Stable +public interface ReaderInterceptor<T>
    +
    Reader interceptor.
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        close

        +
        void close()
        +
        Close the interceptor.
        +
        +
        • +
      • +
        +

        beforeRead

        +
        Message<T> beforeRead(Reader<T> reader, + Message<T> message)
        +
        This is called just before the message is returned by + Reader.readNext(), ReaderListener.received(Reader, Message) + or the CompletableFuture returned by + Reader.readNextAsync() completes. + + This method is based on ConsumerInterceptor.beforeConsume(Consumer, Message), + so it has the same features.
        +
        +
        Parameters:
        +
        reader - the reader which contains the interceptor
        +
        message - the message to be read by the client.
        +
        Returns:
        +
        message that is either modified by the interceptor or same message + passed into the method.
        +
        +
        +
        • +
      • +
        +

        onPartitionsChange

        +
        default void onPartitionsChange(String topicName, + int partitions)
        +
        This method is called when partitions of the topic (partitioned-topic) changes.
        +
        +
        Parameters:
        +
        topicName - topic name
        +
        partitions - new updated number of partitions
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/ReaderListener.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/ReaderListener.html new file mode 100644 index 000000000000..182516f92473 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/ReaderListener.html @@ -0,0 +1,183 @@ + + + + +ReaderListener (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Interface ReaderListener<T>

    +
    +
    +
    +
    All Superinterfaces:
    +
    Serializable
    +
    +
    +
    @Public +@Stable +public interface ReaderListener<T> +extends Serializable
    +
    A listener that will be called in order for every message received.
    +
    +
    +
      + +
    • +
      +

      Method Summary

      +
      +
      +
      +
      +
      Modifier and Type
      +
      Method
      +
      Description
      +
      default void
      +
      reachedEndOfTopic(Reader<T> reader)
      +
      +
      Get the notification when a topic is terminated.
      +
      +
      void
      +
      received(Reader<T> reader, + Message<T> msg)
      +
      +
      This method is called whenever a new message is received.
      +
      +
      +
      +
      +
      +
      • +
    +
    +
    +
      + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        received

        +
        void received(Reader<T> reader, + Message<T> msg)
        +
        This method is called whenever a new message is received. + +

        Messages are guaranteed to be delivered in order and from the same thread for a single consumer + +

        This method will only be called once for each message, unless either application or broker crashes. + +

        Application is responsible of handling any exception that could be thrown while processing the message.

        +
        +
        Parameters:
        +
        reader - the Reader object from where the message was received
        +
        msg - the message object
        +
        +
        +
        • +
      • +
        +

        reachedEndOfTopic

        +
        default void reachedEndOfTopic(Reader<T> reader)
        +
        Get the notification when a topic is terminated.
        +
        +
        Parameters:
        +
        reader - the Reader object associated with the terminated topic
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/RedeliveryBackoff.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/RedeliveryBackoff.html new file mode 100644 index 000000000000..d41eca9bbed5 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/RedeliveryBackoff.html @@ -0,0 +1,160 @@ + + + + +RedeliveryBackoff (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Interface RedeliveryBackoff

    +
    +
    +
    +
    All Superinterfaces:
    +
    Serializable
    +
    +
    +
    @Public +@Stable +public interface RedeliveryBackoff +extends Serializable
    +
    Interface for custom message is negativeAcked policy, users can specify a RedeliveryBackoff for + a consumer. + + Notice: the consumer crashes will trigger the redelivery of the unacked message, this case will not respect the + RedeliveryBackoff, which means the message might get redelivered earlier than the delay time + from the backoff.
    +
    +
    +
      + +
    • +
      +

      Method Summary

      +
      +
      +
      +
      +
      Modifier and Type
      +
      Method
      +
      Description
      +
      long
      +
      next(int redeliveryCount)
      +
       
      +
      +
      +
      +
      +
      • +
    +
    +
    +
      + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        next

        +
        long next(int redeliveryCount)
        +
        +
        Parameters:
        +
        redeliveryCount - indicates the number of times the message was redelivered
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/RegexSubscriptionMode.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/RegexSubscriptionMode.html new file mode 100644 index 000000000000..36896f08aaa5 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/RegexSubscriptionMode.html @@ -0,0 +1,257 @@ + + + + +RegexSubscriptionMode (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Enum Class RegexSubscriptionMode

    +
    +
    java.lang.Object +
    java.lang.Enum<RegexSubscriptionMode> +
    org.apache.pulsar.client.api.RegexSubscriptionMode
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable, Comparable<RegexSubscriptionMode>, Constable
    +
    +
    +
    @Public +@Stable +public enum RegexSubscriptionMode +extends Enum<RegexSubscriptionMode>
    +
    When subscribing to topics using a regular expression, one can specify + to only pick a certain type of topics.
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Enum Constant Details

      +
        +
      • +
        +

        PersistentOnly

        +
        public static final RegexSubscriptionMode PersistentOnly
        +
        Only subscribe to persistent topics.
        +
        +
        • +
      • +
        +

        NonPersistentOnly

        +
        public static final RegexSubscriptionMode NonPersistentOnly
        +
        Only subscribe to non-persistent topics.
        +
        +
        • +
      • +
        +

        AllTopics

        +
        public static final RegexSubscriptionMode AllTopics
        +
        Subscribe to both persistent and non-persistent topics.
        +
        +
        • +
      +
      +
      • + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        values

        +
        public static RegexSubscriptionMode[] values()
        +
        Returns an array containing the constants of this enum class, in +the order they are declared.
        +
        +
        Returns:
        +
        an array containing the constants of this enum class, in the order they are declared
        +
        +
        +
        • +
      • +
        +

        valueOf

        +
        public static RegexSubscriptionMode valueOf(String name)
        +
        Returns the enum constant of this class with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this class. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        IllegalArgumentException - if this enum class has no constant with the specified name
        +
        NullPointerException - if the argument is null
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/Schema.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/Schema.html new file mode 100644 index 000000000000..7c8ed677efb0 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/Schema.html @@ -0,0 +1,978 @@ + + + + +Schema (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Interface Schema<T>

    +
    +
    +
    +
    All Superinterfaces:
    +
    Cloneable
    +
    +
    +
    All Known Subinterfaces:
    +
    GenericSchema<T>, KeyValueSchema<K,V>
    +
    +
    +
    @Public +@Stable +public interface Schema<T> +extends Cloneable
    +
    Message schema definition.
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Field Details

      +
        +
      • +
        +

        BYTES

        +
        static final Schema<byte[]> BYTES
        +
        Schema that doesn't perform any encoding on the message payloads. Accepts a byte array and it passes it through.
        +
        +
        • +
      • +
        +

        BYTEBUFFER

        +
        static final Schema<ByteBuffer> BYTEBUFFER
        +
        ByteBuffer Schema.
        +
        +
        • +
      • +
        +

        STRING

        +
        static final Schema<String> STRING
        +
        Schema that can be used to encode/decode messages whose values are String. The payload is encoded with UTF-8.
        +
        +
        • +
      • +
        +

        INT8

        +
        static final Schema<Byte> INT8
        +
        INT8 Schema.
        +
        +
        • +
      • +
        +

        INT16

        +
        static final Schema<Short> INT16
        +
        INT16 Schema.
        +
        +
        • +
      • +
        +

        INT32

        +
        static final Schema<Integer> INT32
        +
        INT32 Schema.
        +
        +
        • +
      • +
        +

        INT64

        +
        static final Schema<Long> INT64
        +
        INT64 Schema.
        +
        +
        • +
      • +
        +

        BOOL

        +
        static final Schema<Boolean> BOOL
        +
        Boolean Schema.
        +
        +
        • +
      • +
        +

        FLOAT

        +
        static final Schema<Float> FLOAT
        +
        Float Schema.
        +
        +
        • +
      • +
        +

        DOUBLE

        +
        static final Schema<Double> DOUBLE
        +
        Double Schema.
        +
        +
        • +
      • +
        +

        DATE

        +
        static final Schema<Date> DATE
        +
        Date Schema.
        +
        +
        • +
      • +
        +

        TIME

        +
        static final Schema<Time> TIME
        +
        Time Schema.
        +
        +
        • +
      • +
        +

        TIMESTAMP

        +
        static final Schema<Timestamp> TIMESTAMP
        +
        Timestamp Schema.
        +
        +
        • +
      • +
        +

        INSTANT

        +
        static final Schema<Instant> INSTANT
        +
        Instant Schema.
        +
        +
        • +
      • +
        +

        LOCAL_DATE

        +
        static final Schema<LocalDate> LOCAL_DATE
        +
        LocalDate Schema.
        +
        +
        • +
      • +
        +

        LOCAL_TIME

        +
        static final Schema<LocalTime> LOCAL_TIME
        +
        LocalTime Schema.
        +
        +
        • +
      • +
        +

        LOCAL_DATE_TIME

        +
        static final Schema<LocalDateTime> LOCAL_DATE_TIME
        +
        LocalDateTime Schema.
        +
        +
        • +
      +
      +
      • + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        validate

        +
        default void validate(byte[] message)
        +
        Check if the message is a valid object for this schema. + +

        The implementation can choose what its most efficient approach to validate the schema. + If the implementation doesn't provide it, it will attempt to use decode(byte[]) + to see if this schema can decode this message or not as a validation mechanism to verify + the bytes.

        +
        +
        Parameters:
        +
        message - the messages to verify
        +
        Throws:
        +
        SchemaSerializationException - if it is not a valid message
        +
        +
        +
        • +
      • +
        +

        encode

        +
        byte[] encode(T message)
        +
        Encode an object representing the message content into a byte array.
        +
        +
        Parameters:
        +
        message - the message object
        +
        Returns:
        +
        a byte array with the serialized content
        +
        Throws:
        +
        SchemaSerializationException - if the serialization fails
        +
        +
        +
        • +
      • +
        +

        supportSchemaVersioning

        +
        default boolean supportSchemaVersioning()
        +
        Returns whether this schema supports versioning. + +

        Most of the schema implementations don't really support schema versioning, or it just doesn't + make any sense to support schema versionings (e.g. primitive schemas). Only schema returns + GenericRecord should support schema versioning. + +

        If a schema implementation returns false, it should implement decode(byte[]); + while a schema implementation returns true, it should implement decode(byte[], byte[]) + instead.

        +
        +
        Returns:
        +
        true if this schema implementation supports schema versioning; otherwise returns false.
        +
        +
        +
        • +
      • +
        +

        setSchemaInfoProvider

        +
        default void setSchemaInfoProvider(SchemaInfoProvider schemaInfoProvider)
        +
        +
        • +
      • +
        +

        decode

        +
        default T decode(byte[] bytes)
        +
        Decode a byte array into an object using the schema definition and deserializer implementation.
        +
        +
        Parameters:
        +
        bytes - the byte array to decode
        +
        Returns:
        +
        the deserialized object
        +
        +
        +
        • +
      • +
        +

        decode

        +
        default T decode(byte[] bytes, + byte[] schemaVersion)
        +
        Decode a byte array into an object using a given version.
        +
        +
        Parameters:
        +
        bytes - the byte array to decode
        +
        schemaVersion - the schema version to decode the object. null indicates using latest version.
        +
        Returns:
        +
        the deserialized object
        +
        +
        +
        • +
      • +
        +

        decode

        +
        default T decode(ByteBuffer data)
        +
        Decode a ByteBuffer into an object using a given version.
        +
        +
        Parameters:
        +
        data - the ByteBuffer to decode
        +
        Returns:
        +
        the deserialized object
        +
        +
        +
        • +
      • +
        +

        decode

        +
        default T decode(ByteBuffer data, + byte[] schemaVersion)
        +
        Decode a ByteBuffer into an object using a given version.
        +
        +
        Parameters:
        +
        data - the ByteBuffer to decode
        +
        schemaVersion - the schema version to decode the object. null indicates using latest version.
        +
        Returns:
        +
        the deserialized object
        +
        +
        +
        • +
      • +
        +

        getSchemaInfo

        +
        SchemaInfo getSchemaInfo()
        +
        +
        Returns:
        +
        an object that represents the Schema associated metadata
        +
        +
        +
        • +
      • +
        +

        requireFetchingSchemaInfo

        +
        default boolean requireFetchingSchemaInfo()
        +
        Check if this schema requires fetching schema info to configure the schema.
        +
        +
        Returns:
        +
        true if the schema requires fetching schema info to configure the schema, + otherwise false.
        +
        +
        +
        • +
      • +
        +

        configureSchemaInfo

        +
        default void configureSchemaInfo(String topic, + String componentName, + SchemaInfo schemaInfo)
        +
        Configure the schema to use the provided schema info.
        +
        +
        Parameters:
        +
        topic - topic name
        +
        componentName - component name
        +
        schemaInfo - schema info
        +
        +
        +
        • +
      • +
        +

        clone

        +
        Schema<T> clone()
        +
        Duplicates the schema.
        +
        +
        Returns:
        +
        The duplicated schema.
        +
        +
        +
        • +
      • +
        +

        getNativeSchema

        +
        default Optional<Object> getNativeSchema()
        +
        Return the native schema that is wrapped by Pulsar API. + For instance with this method you can access the Avro schema
        +
        +
        Returns:
        +
        the internal schema or null if not present
        +
        +
        +
        • +
      • +
        +

        PROTOBUF

        +
        static <T extends com.google.protobuf.GeneratedMessageV3> +Schema<T> PROTOBUF(Class<T> clazz)
        +
        Create a Protobuf schema type by extracting the fields of the specified class.
        +
        +
        Parameters:
        +
        clazz - the Protobuf generated class to be used to extract the schema
        +
        Returns:
        +
        a Schema instance
        +
        +
        +
        • +
      • +
        +

        PROTOBUF

        +
        static <T extends com.google.protobuf.GeneratedMessageV3> +Schema<T> PROTOBUF(SchemaDefinition<T> schemaDefinition)
        +
        Create a Protobuf schema type with schema definition.
        +
        +
        Parameters:
        +
        schemaDefinition - schemaDefinition the definition of the schema
        +
        Returns:
        +
        a Schema instance
        +
        +
        +
        • +
      • +
        +

        PROTOBUF_NATIVE

        +
        static <T extends com.google.protobuf.GeneratedMessageV3> +Schema<T> PROTOBUF_NATIVE(Class<T> clazz)
        +
        Create a Protobuf-Native schema type by extracting the fields of the specified class.
        +
        +
        Parameters:
        +
        clazz - the Protobuf generated class to be used to extract the schema
        +
        Returns:
        +
        a Schema instance
        +
        +
        +
        • +
      • +
        +

        PROTOBUF_NATIVE

        +
        static <T extends com.google.protobuf.GeneratedMessageV3> +Schema<T> PROTOBUF_NATIVE(SchemaDefinition<T> schemaDefinition)
        +
        Create a Protobuf-Native schema type with schema definition.
        +
        +
        Parameters:
        +
        schemaDefinition - schemaDefinition the definition of the schema
        +
        Returns:
        +
        a Schema instance
        +
        +
        +
        • +
      • +
        +

        AVRO

        +
        static <T> Schema<T> AVRO(Class<T> pojo)
        +
        Create a Avro schema type by default configuration of the class.
        +
        +
        Parameters:
        +
        pojo - the POJO class to be used to extract the Avro schema
        +
        Returns:
        +
        a Schema instance
        +
        +
        +
        • +
      • +
        +

        AVRO

        +
        static <T> Schema<T> AVRO(SchemaDefinition<T> schemaDefinition)
        +
        Create a Avro schema type with schema definition.
        +
        +
        Parameters:
        +
        schemaDefinition - the definition of the schema
        +
        Returns:
        +
        a Schema instance
        +
        +
        +
        • +
      • +
        +

        JSON

        +
        static <T> Schema<T> JSON(Class<T> pojo)
        +
        Create a JSON schema type by extracting the fields of the specified class.
        +
        +
        Parameters:
        +
        pojo - the POJO class to be used to extract the JSON schema
        +
        Returns:
        +
        a Schema instance
        +
        +
        +
        • +
      • +
        +

        JSON

        +
        static <T> Schema<T> JSON(SchemaDefinition schemaDefinition)
        +
        Create a JSON schema type with schema definition.
        +
        +
        Parameters:
        +
        schemaDefinition - the definition of the schema
        +
        Returns:
        +
        a Schema instance
        +
        +
        +
        • +
      • +
        +

        KeyValue

        +
        static <K, +V> Schema<KeyValue<K,V>> KeyValue(Class<K> key, + Class<V> value, + SchemaType type)
        +
        Key Value Schema using passed in schema type, support JSON and AVRO currently.
        +
        +
        • +
      • +
        +

        KV_BYTES

        +
        static Schema<KeyValue<byte[],byte[]>> KV_BYTES()
        +
        Schema that can be used to encode/decode KeyValue.
        +
        +
        • +
      • +
        +

        KeyValue

        +
        static <K, +V> Schema<KeyValue<K,V>> KeyValue(Class<K> key, + Class<V> value)
        +
        Key Value Schema whose underneath key and value schemas are JSONSchema.
        +
        +
        • +
      • +
        +

        KeyValue

        +
        static <K, +V> Schema<KeyValue<K,V>> KeyValue(Schema<K> key, + Schema<V> value)
        +
        Key Value Schema using passed in key and value schemas with KeyValueEncodingType.INLINE encoding type.
        +
        +
        See Also:
        +
        + +
        +
        +
        +
        • +
      • +
        +

        KeyValue

        +
        static <K, +V> Schema<KeyValue<K,V>> KeyValue(Schema<K> key, + Schema<V> value, + KeyValueEncodingType keyValueEncodingType)
        +
        Key Value Schema using passed in key, value and encoding type schemas.
        +
        +
        • +
      • +
        +

        AUTO

        +
        @Deprecated +static Schema<GenericRecord> AUTO()
        +
        Deprecated.
        +
        +
        • +
      • +
        +

        AUTO_CONSUME

        +
        static Schema<GenericRecord> AUTO_CONSUME()
        +
        Create a schema instance that automatically deserialize messages + based on the current topic schema. + +

        The messages values are deserialized into a GenericRecord object, + that extends the GenericObject interface.

        +
        +
        Returns:
        +
        the auto schema instance
        +
        +
        +
        • +
      • +
        +

        AUTO_PRODUCE_BYTES

        +
        static Schema<byte[]> AUTO_PRODUCE_BYTES()
        +
        Create a schema instance that accepts a serialized payload + and validates it against the topic schema. + +

        Currently this is only supported with Avro and JSON schema types. + +

        This method can be used when publishing a raw JSON payload, + for which the format is known and a POJO class is not available.

        +
        +
        Returns:
        +
        the auto schema instance
        +
        +
        +
        • +
      • +
        +

        AUTO_PRODUCE_BYTES

        +
        static Schema<byte[]> AUTO_PRODUCE_BYTES(Schema<?> schema)
        +
        Create a schema instance that accepts a serialized payload + and validates it against the schema specified.
        +
        +
        Returns:
        +
        the auto schema instance
        +
        Since:
        +
        2.5.0
        +
        See Also:
        +
        + +
        +
        +
        +
        • +
      • +
        +

        NATIVE_AVRO

        +
        static Schema<byte[]> NATIVE_AVRO(Object schema)
        +
        Create a schema instance that accepts a serialized Avro payload + without validating it against the schema specified. + It can be useful when migrating data from existing event or message stores.
        +
        +
        Returns:
        +
        the auto schema instance
        +
        Since:
        +
        2.9.0
        +
        +
        +
        • +
      • +
        +

        getSchema

        +
        static Schema<?> getSchema(SchemaInfo schemaInfo)
        +
        +
        • +
      • +
        +

        generic

        +
        static GenericSchema<GenericRecord> generic(SchemaInfo schemaInfo)
        +
        Returns a generic schema of existing schema info. + +

        Only supports AVRO and JSON.

        +
        +
        Parameters:
        +
        schemaInfo - schema info
        +
        Returns:
        +
        a generic schema instance
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/SchemaSerializationException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/SchemaSerializationException.html new file mode 100644 index 000000000000..bc6a3ebe0ffb --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/SchemaSerializationException.html @@ -0,0 +1,199 @@ + + + + +SchemaSerializationException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Class SchemaSerializationException

    +
    +
    java.lang.Object +
    java.lang.Throwable +
    java.lang.Exception +
    java.lang.RuntimeException +
    org.apache.pulsar.client.api.SchemaSerializationException
    +
    +
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable
    +
    +
    +
    @Public +@Stable +public class SchemaSerializationException +extends RuntimeException
    +
    Schema serialization exception.
    +
    +
    See Also:
    +
    + +
    +
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        SchemaSerializationException

        +
        public SchemaSerializationException(String message)
        +
        Constructs an SchemaSerializationException with the specified detail message.
        +
        +
        Parameters:
        +
        message - The detail message (which is saved for later retrieval + by the Throwable.getMessage() method)
        +
        +
        +
        • +
      • +
        +

        SchemaSerializationException

        +
        public SchemaSerializationException(Throwable cause)
        +
        Constructs an SchemaSerializationException with the specified cause.
        +
        +
        Parameters:
        +
        cause - The cause (which is saved for later retrieval by the + Throwable.getCause() method). (A null value is permitted, + and indicates that the cause is nonexistent or unknown.)
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/ServiceUrlProvider.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/ServiceUrlProvider.html new file mode 100644 index 000000000000..103e45dc2bdb --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/ServiceUrlProvider.html @@ -0,0 +1,201 @@ + + + + +ServiceUrlProvider (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Interface ServiceUrlProvider

    +
    +
    +
    +
    All Superinterfaces:
    +
    AutoCloseable
    +
    +
    +
    @Public +@Stable +public interface ServiceUrlProvider +extends AutoCloseable
    +
    The provider to provide the service url. + +

    This allows applications to retrieve the service URL from an external configuration provider and, + more importantly, to force the Pulsar client to reconnect if the service URL has been changed. + +

    It can be passed with ClientBuilder.serviceUrlProvider(ServiceUrlProvider)

    +
    +
    +
      + +
    • +
      +

      Method Summary

      +
      +
      +
      +
      +
      Modifier and Type
      +
      Method
      +
      Description
      +
      default void
      +
      close()
      +
      +
      Close the resource that the provider allocated.
      +
      +
      String
      +
      getServiceUrl()
      +
      +
      Get the current service URL the Pulsar client should connect to.
      +
      +
      void
      +
      initialize(PulsarClient client)
      +
      +
      Initialize the service url provider with Pulsar client instance.
      +
      +
      +
      +
      +
      +
      • +
    +
    +
    +
      + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        initialize

        +
        void initialize(PulsarClient client)
        +
        Initialize the service url provider with Pulsar client instance. + +

        This can be used by the provider to force the Pulsar client to reconnect whenever the service url might have + changed. See PulsarClient.updateServiceUrl(String).

        +
        +
        Parameters:
        +
        client - created pulsar client.
        +
        +
        +
        • +
      • +
        +

        getServiceUrl

        +
        String getServiceUrl()
        +
        Get the current service URL the Pulsar client should connect to.
        +
        +
        Returns:
        +
        the pulsar service url.
        +
        +
        +
        • +
      • +
        +

        close

        +
        default void close() + throws Exception
        +
        Close the resource that the provider allocated.
        +
        +
        Specified by:
        +
        close in interface AutoCloseable
        +
        Throws:
        +
        Exception
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/SizeUnit.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/SizeUnit.html new file mode 100644 index 000000000000..a14c00ab6a7d --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/SizeUnit.html @@ -0,0 +1,289 @@ + + + + +SizeUnit (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Enum Class SizeUnit

    +
    +
    java.lang.Object +
    java.lang.Enum<SizeUnit> +
    org.apache.pulsar.client.api.SizeUnit
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable, Comparable<SizeUnit>, Constable
    +
    +
    +
    public enum SizeUnit +extends Enum<SizeUnit>
    +
    Size unit converter.
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Enum Constant Details

      +
        +
      • +
        +

        BYTES

        +
        public static final SizeUnit BYTES
        +
        +
        • +
      • +
        +

        KILO_BYTES

        +
        public static final SizeUnit KILO_BYTES
        +
        +
        • +
      • +
        +

        MEGA_BYTES

        +
        public static final SizeUnit MEGA_BYTES
        +
        +
        • +
      • +
        +

        GIGA_BYTES

        +
        public static final SizeUnit GIGA_BYTES
        +
        +
        • +
      +
      +
      • + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        values

        +
        public static SizeUnit[] values()
        +
        Returns an array containing the constants of this enum class, in +the order they are declared.
        +
        +
        Returns:
        +
        an array containing the constants of this enum class, in the order they are declared
        +
        +
        +
        • +
      • +
        +

        valueOf

        +
        public static SizeUnit valueOf(String name)
        +
        Returns the enum constant of this class with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this class. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        IllegalArgumentException - if this enum class has no constant with the specified name
        +
        NullPointerException - if the argument is null
        +
        +
        +
        • +
      • +
        +

        toBytes

        +
        public long toBytes(long value)
        +
        +
        • +
      • +
        +

        toKiloBytes

        +
        public long toKiloBytes(long value)
        +
        +
        • +
      • +
        +

        toMegaBytes

        +
        public long toMegaBytes(long value)
        +
        +
        • +
      • +
        +

        toGigaBytes

        +
        public long toGigaBytes(long value)
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/SubscriptionInitialPosition.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/SubscriptionInitialPosition.html new file mode 100644 index 000000000000..ffabaf4fadce --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/SubscriptionInitialPosition.html @@ -0,0 +1,261 @@ + + + + +SubscriptionInitialPosition (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Enum Class SubscriptionInitialPosition

    +
    +
    java.lang.Object +
    java.lang.Enum<SubscriptionInitialPosition> +
    org.apache.pulsar.client.api.SubscriptionInitialPosition
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable, Comparable<SubscriptionInitialPosition>, Constable
    +
    +
    +
    @Public +@Stable +public enum SubscriptionInitialPosition +extends Enum<SubscriptionInitialPosition>
    +
    When creating a consumer, if the subscription does not exist, a new subscription will be created. By default the + subscription will be created at the end of the topic. See + +
    +invalid reference +
    #subscriptionInitialPosition(SubscriptionInitialPosition)
    +
    + to configure the initial position behavior.
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Enum Constant Details

      +
        +
      • +
        +

        Latest

        +
        public static final SubscriptionInitialPosition Latest
        +
        The latest position which means the start consuming position will be the last message.
        +
        +
        • +
      • +
        +

        Earliest

        +
        public static final SubscriptionInitialPosition Earliest
        +
        The earliest position which means the start consuming position will be the first message.
        +
        +
        • +
      +
      +
      • + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        values

        +
        public static SubscriptionInitialPosition[] values()
        +
        Returns an array containing the constants of this enum class, in +the order they are declared.
        +
        +
        Returns:
        +
        an array containing the constants of this enum class, in the order they are declared
        +
        +
        +
        • +
      • +
        +

        valueOf

        +
        public static SubscriptionInitialPosition valueOf(String name)
        +
        Returns the enum constant of this class with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this class. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        IllegalArgumentException - if this enum class has no constant with the specified name
        +
        NullPointerException - if the argument is null
        +
        +
        +
        • +
      • +
        +

        getValue

        +
        public final int getValue()
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/SubscriptionMode.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/SubscriptionMode.html new file mode 100644 index 000000000000..75719269f59f --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/SubscriptionMode.html @@ -0,0 +1,239 @@ + + + + +SubscriptionMode (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Enum Class SubscriptionMode

    +
    +
    java.lang.Object +
    java.lang.Enum<SubscriptionMode> +
    org.apache.pulsar.client.api.SubscriptionMode
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable, Comparable<SubscriptionMode>, Constable
    +
    +
    +
    @Public +@Stable +public enum SubscriptionMode +extends Enum<SubscriptionMode>
    +
    Types of subscription mode supported by Pulsar.
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Enum Constant Details

      + +
      +
      • + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        values

        +
        public static SubscriptionMode[] values()
        +
        Returns an array containing the constants of this enum class, in +the order they are declared.
        +
        +
        Returns:
        +
        an array containing the constants of this enum class, in the order they are declared
        +
        +
        +
        • +
      • +
        +

        valueOf

        +
        public static SubscriptionMode valueOf(String name)
        +
        Returns the enum constant of this class with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this class. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        IllegalArgumentException - if this enum class has no constant with the specified name
        +
        NullPointerException - if the argument is null
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/SubscriptionType.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/SubscriptionType.html new file mode 100644 index 000000000000..ad850c42f748 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/SubscriptionType.html @@ -0,0 +1,282 @@ + + + + +SubscriptionType (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Enum Class SubscriptionType

    +
    +
    java.lang.Object +
    java.lang.Enum<SubscriptionType> +
    org.apache.pulsar.client.api.SubscriptionType
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable, Comparable<SubscriptionType>, Constable
    +
    +
    +
    @Public +@Stable +public enum SubscriptionType +extends Enum<SubscriptionType>
    +
    Types of subscription supported by Pulsar.
    +
    +
    +
      + +
    • +
      +

      Nested Class Summary

      +
      +

      Nested classes/interfaces inherited from class java.lang.Enum

      +Enum.EnumDesc<E extends Enum<E>>
      +
      +
      • + +
    • +
      +

      Enum Constant Summary

      +
      Enum Constants
      +
      +
      Enum Constant
      +
      Description
      +
      Exclusive
      +
      +
      There can be only 1 consumer on the same topic with the same subscription name.
      +
      +
      Failover
      +
      +
      Multiple consumer will be able to use the same subscription name but only 1 consumer will receive the messages.
      +
      +
      Key_Shared
      +
      +
      Multiple consumer will be able to use the same subscription and all messages with the same key + will be dispatched to only one consumer.
      +
      +
      Shared
      +
      +
      Multiple consumer will be able to use the same subscription name and the messages will be dispatched + according to a round-robin rotation between the connected consumers.
      +
      +
      +
      +
      • + +
    • +
      +

      Method Summary

      +
      +
      +
      +
      +
      Modifier and Type
      +
      Method
      +
      Description
      +
      static SubscriptionType
      +
      valueOf(String name)
      +
      +
      Returns the enum constant of this class with the specified name.
      +
      +
      static SubscriptionType[]
      +
      values()
      +
      +
      Returns an array containing the constants of this enum class, in +the order they are declared.
      +
      +
      +
      +
      +
      +

      Methods inherited from class java.lang.Enum

      +clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      +
      +

      Methods inherited from class java.lang.Object

      +getClass, notify, notifyAll, wait, wait, wait
      +
      +
      • +
    +
    +
    +
      + +
    • +
      +

      Enum Constant Details

      +
        +
      • +
        +

        Exclusive

        +
        public static final SubscriptionType Exclusive
        +
        There can be only 1 consumer on the same topic with the same subscription name.
        +
        +
        • +
      • +
        +

        Shared

        +
        public static final SubscriptionType Shared
        +
        Multiple consumer will be able to use the same subscription name and the messages will be dispatched + according to a round-robin rotation between the connected consumers. + +

        In this mode, the consumption order is not guaranteed.

        +
        +
        • +
      • +
        +

        Failover

        +
        public static final SubscriptionType Failover
        +
        Multiple consumer will be able to use the same subscription name but only 1 consumer will receive the messages. + If that consumer disconnects, one of the other connected consumers will start receiving messages. + +

        In failover mode, the consumption ordering is guaranteed. + +

        In case of partitioned topics, the ordering is guaranteed on a per-partition basis. + The partitions assignments will be split across the available consumers. On each partition, + at most one consumer will be active at a given point in time.

        +
        +
        • +
      • +
        +

        Key_Shared

        +
        public static final SubscriptionType Key_Shared
        +
        Multiple consumer will be able to use the same subscription and all messages with the same key + will be dispatched to only one consumer. + +

        Use ordering_key to overwrite the message key for message ordering.

        +
        +
        • +
      +
      +
      • + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        values

        +
        public static SubscriptionType[] values()
        +
        Returns an array containing the constants of this enum class, in +the order they are declared.
        +
        +
        Returns:
        +
        an array containing the constants of this enum class, in the order they are declared
        +
        +
        +
        • +
      • +
        +

        valueOf

        +
        public static SubscriptionType valueOf(String name)
        +
        Returns the enum constant of this class with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this class. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        IllegalArgumentException - if this enum class has no constant with the specified name
        +
        NullPointerException - if the argument is null
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/TableView.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/TableView.html new file mode 100644 index 000000000000..27e6c36391b0 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/TableView.html @@ -0,0 +1,385 @@ + + + + +TableView (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Interface TableView<T>

    +
    +
    +
    +
    All Superinterfaces:
    +
    AutoCloseable, Closeable
    +
    +
    +
    public interface TableView<T> +extends Closeable
    +
    +
    +
      + +
    • +
      +

      Method Summary

      +
      +
      +
      +
      +
      Modifier and Type
      +
      Method
      +
      Description
      +
      CompletableFuture<Void>
      +
      closeAsync()
      +
      +
      Close the table view and releases resources allocated.
      +
      +
      boolean
      +
      containsKey(String key)
      +
      +
      Returns true if this TableView contains a mapping for the specified + key.
      +
      +
      Set<Map.Entry<String,T>>
      +
      entrySet()
      +
      +
      Returns a Set view of the mappings contained in this map.
      +
      +
      void
      +
      forEach(BiConsumer<String,T> action)
      +
      +
      Performs the given action for each entry in this map until all entries + have been processed or the action throws an exception.
      +
      +
      void
      +
      forEachAndListen(BiConsumer<String,T> action)
      +
      +
      Performs the given action for each entry in this map until all entries + have been processed or the action throws an exception.
      +
      +
      T
      +
      get(String key)
      +
      +
      Returns the value to which the specified key is mapped, or null if this map contains + no mapping for the key.
      +
      +
      boolean
      +
      isEmpty()
      +
      +
      Returns true if this TableView contains no key-value mappings.
      +
      +
      Set<String>
      +
      keySet()
      +
      +
      Returns a Set view of the keys contained in this TableView.
      +
      +
      void
      +
      listen(BiConsumer<String,T> action)
      +
      +
      Performs the given action for each future entry in this map until all entries + have been processed or the action throws an exception.
      +
      +
      void
      +
      refresh()
      +
      +
      Refresh the table view with the latest data in the topic, ensuring that all subsequent reads are based on + the refreshed data.
      +
      +
      CompletableFuture<Void>
      +
      refreshAsync()
      +
      +
      Refresh the table view with the latest data in the topic, ensuring that all subsequent reads are based on + the refreshed data.
      +
      +
      int
      +
      size()
      +
      +
      Returns the number of key-value mappings in the TableView.
      +
      +
      Collection<T>
      +
      values()
      +
      +
      Returns a Collection view of the values contained in this TableView.
      +
      +
      +
      +
      +
      +

      Methods inherited from interface java.io.Closeable

      +close
      +
      +
      • +
    +
    +
    +
      + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        size

        +
        int size()
        +
        Returns the number of key-value mappings in the TableView.
        +
        +
        Returns:
        +
        the number of key-value mappings in this TableView
        +
        +
        +
        • +
      • +
        +

        isEmpty

        +
        boolean isEmpty()
        +
        Returns true if this TableView contains no key-value mappings.
        +
        +
        Returns:
        +
        true if this TableView contains no key-value mappings
        +
        +
        +
        • +
      • +
        +

        containsKey

        +
        boolean containsKey(String key)
        +
        Returns true if this TableView contains a mapping for the specified + key.
        +
        +
        Parameters:
        +
        key - key whose presence in this map is to be tested
        +
        Returns:
        +
        true if this map contains a mapping for the specified key
        +
        +
        +
        • +
      • +
        +

        get

        +
        T get(String key)
        +
        Returns the value to which the specified key is mapped, or null if this map contains + no mapping for the key.
        +
        +
        Parameters:
        +
        key - the key whose associated value is to be returned
        +
        Returns:
        +
        the value associated with the key or null if the keys was not found
        +
        +
        +
        • +
      • +
        +

        entrySet

        +
        Set<Map.Entry<String,T>> entrySet()
        +
        Returns a Set view of the mappings contained in this map.
        +
        +
        Returns:
        +
        a set view of the mappings contained in this map
        +
        +
        +
        • +
      • +
        +

        keySet

        +
        Set<String> keySet()
        +
        Returns a Set view of the keys contained in this TableView.
        +
        +
        Returns:
        +
        a set view of the keys contained in this map
        +
        +
        +
        • +
      • +
        +

        values

        +
        Collection<T> values()
        +
        Returns a Collection view of the values contained in this TableView.
        +
        +
        Returns:
        +
        a collection view of the values contained in this TableView
        +
        +
        +
        • +
      • +
        +

        forEach

        +
        void forEach(BiConsumer<String,T> action)
        +
        Performs the given action for each entry in this map until all entries + have been processed or the action throws an exception.
        +
        +
        Parameters:
        +
        action - The action to be performed for each entry
        +
        +
        +
        • +
      • +
        +

        listen

        +
        void listen(BiConsumer<String,T> action)
        +
        Performs the given action for each future entry in this map until all entries + have been processed or the action throws an exception.
        +
        +
        Parameters:
        +
        action - The action to be performed for each entry
        +
        +
        +
        • +
      • +
        +

        forEachAndListen

        +
        void forEachAndListen(BiConsumer<String,T> action)
        +
        Performs the given action for each entry in this map until all entries + have been processed or the action throws an exception.
        +
        +
        Parameters:
        +
        action - The action to be performed for each entry
        +
        +
        +
        • +
      • +
        +

        closeAsync

        +
        CompletableFuture<Void> closeAsync()
        +
        Close the table view and releases resources allocated.
        +
        +
        Returns:
        +
        a future that can used to track when the table view has been closed.
        +
        +
        +
        • +
      • +
        +

        refreshAsync

        +
        CompletableFuture<Void> refreshAsync()
        +
        Refresh the table view with the latest data in the topic, ensuring that all subsequent reads are based on + the refreshed data. + + Example usage: + + table.refreshAsync().thenApply(__ -> table.get(key)); + + This function retrieves the last written message in the topic and refreshes the table view accordingly. + Once the refresh is complete, all subsequent reads will be performed on the refreshed data or a combination of + the refreshed data and newly published data. The table view remains synchronized with any newly published data + after the refresh. + + |x:0|->|y:0|->|z:0|->|x:1|->|z:1|->|x:2|->|y:1|->|y:2| + + If a read occurs after the refresh (at the last published message |y:2|), it ensures that outdated data like x=1 + is not obtained. However, it does not guarantee that the values will always be x=2, y=2, z=1, + as the table view may receive updates with newly published data. + + |x:0|->|y:0|->|z:0|->|x:1|->|z:1|->|x:2|->|y:1|->|y:2| -> |y:3| + + Both y=2 or y=3 are possible. Therefore, different readers may receive different values, + but all values will be equal to or newer than the data refreshed from the last call to the refresh method.
        +
        +
        • +
      • +
        +

        refresh

        +
        void refresh() + throws PulsarClientException
        +
        Refresh the table view with the latest data in the topic, ensuring that all subsequent reads are based on + the refreshed data.
        +
        +
        Throws:
        +
        PulsarClientException - if there is any error refreshing the table view.
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/TableViewBuilder.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/TableViewBuilder.html new file mode 100644 index 000000000000..21d6a5f8f37f --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/TableViewBuilder.html @@ -0,0 +1,351 @@ + + + + +TableViewBuilder (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Interface TableViewBuilder<T>

    +
    +
    +
    +
    @Public +@Evolving +public interface TableViewBuilder<T>
    +
    TableViewBuilder is used to configure and create instances of TableView.
    +
    +
    Since:
    +
    2.10.0
    +
    See Also:
    +
    + +
    +
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        loadConf

        +
        TableViewBuilder<T> loadConf(Map<String,Object> config)
        +
        Load the configuration from provided config map. + +

        Example: + + 

        
+  Map<String, Object> config = new HashMap<>();
+  config.put("topicName", "test-topic");
+  config.put("autoUpdatePartitionsSeconds", "300");
+
+  TableViewBuilder<byte[]> builder = ...;
+  builder = builder.loadConf(config);
+
+  TableView<byte[]> tableView = builder.create();
+
        +
        +
        Parameters:
        +
        config - configuration to load
        +
        Returns:
        +
        the TableViewBuilder instance
        +
        +
        +
        • +
      • +
        +

        create

        +
        TableView<T> create() + throws PulsarClientException
        +
        Finalize the creation of the TableView instance. + +

        This method will block until the tableView is created successfully or an exception is thrown.

        +
        +
        Returns:
        +
        the TableView instance
        +
        Throws:
        +
        PulsarClientException - if the tableView creation fails
        +
        +
        +
        • +
      • +
        +

        createAsync

        +
        CompletableFuture<TableView<T>> createAsync()
        +
        Finalize the creation of the TableView instance in asynchronous mode. + +

        This method will return a CompletableFuture that can be used to access the instance when it's ready.

        +
        +
        Returns:
        +
        the TableView instance
        +
        +
        +
        • +
      • +
        +

        topic

        +
        TableViewBuilder<T> topic(String topic)
        +
        Set the topic name of the TableView.
        +
        +
        Parameters:
        +
        topic - the name of the topic to create the TableView
        +
        Returns:
        +
        the TableViewBuilder builder instance
        +
        +
        +
        • +
      • +
        +

        autoUpdatePartitionsInterval

        +
        TableViewBuilder<T> autoUpdatePartitionsInterval(int interval, + TimeUnit unit)
        +
        Set the interval of updating partitions (default: 1 minute).
        +
        +
        Parameters:
        +
        interval - the interval of updating partitions
        +
        unit - the time unit of the interval
        +
        Returns:
        +
        the TableViewBuilder builder instance
        +
        +
        +
        • +
      • +
        +

        subscriptionName

        +
        TableViewBuilder<T> subscriptionName(String subscriptionName)
        +
        Set the subscription name of the TableView.
        +
        +
        Parameters:
        +
        subscriptionName - the name of the subscription to the topic
        +
        Returns:
        +
        the TableViewBuilder builder instance
        +
        +
        +
        • +
      • +
        +

        cryptoKeyReader

        +
        TableViewBuilder<T> cryptoKeyReader(CryptoKeyReader cryptoKeyReader)
        +
        Set the CryptoKeyReader to decrypt the message payloads.
        +
        +
        Parameters:
        +
        cryptoKeyReader - CryptoKeyReader object
        +
        Returns:
        +
        the TableViewBuilder builder instance
        +
        +
        +
        • +
      • +
        +

        defaultCryptoKeyReader

        +
        TableViewBuilder<T> defaultCryptoKeyReader(String privateKey)
        +
        Set the default implementation of CryptoKeyReader. + +

        Configure the key reader to be used to decrypt message payloads.

        +
        +
        Parameters:
        +
        privateKey - the private key that is always used to decrypt message payloads.
        +
        Returns:
        +
        the TableViewBuilder builder instance
        +
        +
        +
        • +
      • +
        +

        defaultCryptoKeyReader

        +
        TableViewBuilder<T> defaultCryptoKeyReader(Map<String,String> privateKeys)
        +
        Set the default implementation of CryptoKeyReader. + +

        Configure the key reader to be used to decrypt message payloads.

        +
        +
        Parameters:
        +
        privateKeys - the map of private key names and their URIs + used to decrypt message payloads.
        +
        Returns:
        +
        the TableViewBuilder builder instance
        +
        +
        +
        • +
      • +
        +

        cryptoFailureAction

        +
        TableViewBuilder<T> cryptoFailureAction(ConsumerCryptoFailureAction action)
        +
        Set the ConsumerCryptoFailureAction to specify.
        +
        +
        Parameters:
        +
        action - the action to take when the decoding fails
        +
        Returns:
        +
        the TableViewBuilder builder instance
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/TopicConsumerBuilder.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/TopicConsumerBuilder.html new file mode 100644 index 000000000000..4c2698077eed --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/TopicConsumerBuilder.html @@ -0,0 +1,190 @@ + + + + +TopicConsumerBuilder (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Interface TopicConsumerBuilder<T>

    +
    +
    +
    +
    Type Parameters:
    +
    T - the type of the value in the ConsumerBuilder
    +
    +
    +
    public interface TopicConsumerBuilder<T>
    +
    TopicConsumerBuilder is used to configure topic specific options to override those set at the + ConsumerBuilder level.
    +
    +
    See Also:
    +
    + +
    +
    +
    +
    +
      + +
    • +
      +

      Method Summary

      +
      +
      +
      +
      +
      Modifier and Type
      +
      Method
      +
      Description
      +
      ConsumerBuilder<T>
      +
      build()
      +
      +
      Complete the configuration of the topic specific options and return control back to the + ConsumerBuilder instance.
      +
      +
      TopicConsumerBuilder<T>
      +
      priorityLevel(int priorityLevel)
      +
      +
      Configure the priority level of this topic.
      +
      +
      +
      +
      +
      +
      • +
    +
    +
    + +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/TopicMessageId.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/TopicMessageId.html new file mode 100644 index 000000000000..225dd9b5da72 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/TopicMessageId.html @@ -0,0 +1,191 @@ + + + + +TopicMessageId (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Interface TopicMessageId

    +
    +
    +
    +
    All Superinterfaces:
    +
    Comparable<MessageId>, MessageId, Serializable
    +
    +
    +
    public interface TopicMessageId +extends MessageId
    +
    The MessageId used for a consumer that subscribes multiple topics or partitioned topics. + +

    + It's guaranteed that Message.getMessageId() must return a TopicMessageId instance if the Message is received + from a consumer that subscribes multiple topics or partitioned topics. + The topic name used in APIs related to this class like `getOwnerTopic` and `create` must be the full topic name. For + example, "my-topic" is invalid while "persistent://public/default/my-topic" is valid. + If the topic is a partitioned topic, the topic name should be the name of the specific partition, e.g. + "persistent://public/default/my-topic-partition-0". +

    +
    +
    + +
    +
    +
      + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        getOwnerTopic

        +
        String getOwnerTopic()
        +
        Return the owner topic name of a message.
        +
        +
        Returns:
        +
        the owner topic
        +
        +
        +
        • +
      • +
        +

        create

        +
        static TopicMessageId create(String topic, + MessageId messageId)
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/TopicMetadata.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/TopicMetadata.html new file mode 100644 index 000000000000..10c89a88146c --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/TopicMetadata.html @@ -0,0 +1,153 @@ + + + + +TopicMetadata (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Interface TopicMetadata

    +
    +
    +
    +
    @Public +@Stable +public interface TopicMetadata
    +
    Metadata of a topic that can be used for message routing.
    +
    +
    +
      + +
    • +
      +

      Method Summary

      +
      +
      +
      +
      +
      Modifier and Type
      +
      Method
      +
      Description
      +
      int
      +
      numPartitions()
      +
      +
      Return the number of partitions per topic.
      +
      +
      +
      +
      +
      +
      • +
    +
    +
    +
      + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        numPartitions

        +
        int numPartitions()
        +
        Return the number of partitions per topic.
        +
        +
        Returns:
        +
        the number of partitions per topic.
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/TransactionIsolationLevel.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/TransactionIsolationLevel.html new file mode 100644 index 000000000000..8da64a440e49 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/TransactionIsolationLevel.html @@ -0,0 +1,238 @@ + + + + +TransactionIsolationLevel (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Enum Class TransactionIsolationLevel

    +
    +
    java.lang.Object +
    java.lang.Enum<TransactionIsolationLevel> +
    org.apache.pulsar.client.api.TransactionIsolationLevel
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable, Comparable<TransactionIsolationLevel>, Constable
    +
    +
    +
    @Public +@Stable +public enum TransactionIsolationLevel +extends Enum<TransactionIsolationLevel>
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Enum Constant Details

      + +
      +
      • + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        values

        +
        public static TransactionIsolationLevel[] values()
        +
        Returns an array containing the constants of this enum class, in +the order they are declared.
        +
        +
        Returns:
        +
        an array containing the constants of this enum class, in the order they are declared
        +
        +
        +
        • +
      • +
        +

        valueOf

        +
        public static TransactionIsolationLevel valueOf(String name)
        +
        Returns the enum constant of this class with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this class. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        IllegalArgumentException - if this enum class has no constant with the specified name
        +
        NullPointerException - if the argument is null
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/TypedMessageBuilder.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/TypedMessageBuilder.html new file mode 100644 index 000000000000..53514a31a919 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/TypedMessageBuilder.html @@ -0,0 +1,708 @@ + + + + +TypedMessageBuilder (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api
    +

    Interface TypedMessageBuilder<T>

    +
    +
    +
    +
    All Superinterfaces:
    +
    Serializable
    +
    +
    +
    @Public +@Stable +public interface TypedMessageBuilder<T> +extends Serializable
    +
    Message builder that constructs a message to be published through a producer. + +

    Usage example: + 

    
+ producer.newMessage().key(myKey).value(myValue).send();
+
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Field Details

      + +
      +
      • + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        send

        +
        MessageId send() + throws PulsarClientException
        +
        Send a message synchronously. + +

        This method will block until the message is successfully published and returns the + MessageId assigned by the broker to the published message. + +

        Example: + + 

        
+ MessageId msgId = producer.newMessage()
+                  .key(myKey)
+                  .value(myValue)
+                  .send();
+ System.out.println("Published message: " + msgId);
+
        +
        +
        Returns:
        +
        the MessageId assigned by the broker to the published message.
        +
        Throws:
        +
        PulsarClientException
        +
        +
        +
        • +
      • +
        +

        sendAsync

        +
        CompletableFuture<MessageId> sendAsync()
        +
        Send a message asynchronously + +

        This method returns a future that can be used to track the completion of the send operation and yields the + MessageId assigned by the broker to the published message. + +

        Example: + + 

        + producer.newMessage()
+                  .value(myValue)
+                  .sendAsync().thenAccept(messageId -> {
+    System.out.println("Published message: " + messageId);
+ }).exceptionally(e -> {
+    System.out.println("Failed to publish " + e);
+    return null;
+ });
+
        + +

        When the producer queue is full, by default this method will complete the future with an exception + PulsarClientException.ProducerQueueIsFullError + +

        See ProducerBuilder.maxPendingMessages(int) to configure the producer queue size and + ProducerBuilder.blockIfQueueFull(boolean) to change the blocking behavior.

        +
        +
        Returns:
        +
        a future that can be used to track when the message will have been safely persisted
        +
        +
        +
        • +
      • +
        +

        key

        +
        TypedMessageBuilder<T> key(String key)
        +
        Sets the key of the message for routing policy.
        +
        +
        Parameters:
        +
        key - the partitioning key for the message
        +
        Returns:
        +
        the message builder instance
        +
        +
        +
        • +
      • +
        +

        keyBytes

        +
        TypedMessageBuilder<T> keyBytes(byte[] key)
        +
        Sets the bytes of the key of the message for routing policy. + Internally the bytes will be base64 encoded.
        +
        +
        Parameters:
        +
        key - routing key for message, in byte array form
        +
        Returns:
        +
        the message builder instance
        +
        +
        +
        • +
      • +
        +

        orderingKey

        +
        TypedMessageBuilder<T> orderingKey(byte[] orderingKey)
        +
        Sets the ordering key of the message for message dispatch in SubscriptionType.Key_Shared mode. + Partition key Will be used if ordering key not specified.
        +
        +
        Parameters:
        +
        orderingKey - the ordering key for the message
        +
        Returns:
        +
        the message builder instance
        +
        +
        +
        • +
      • +
        +

        value

        +
        TypedMessageBuilder<T> value(T value)
        +
        Set a domain object on the message.
        +
        +
        Parameters:
        +
        value - the domain object
        +
        Returns:
        +
        the message builder instance
        +
        +
        +
        • +
      • +
        +

        property

        +
        TypedMessageBuilder<T> property(String name, + String value)
        +
        Sets a new property on a message.
        +
        +
        Parameters:
        +
        name - the name of the property
        +
        value - the associated value
        +
        Returns:
        +
        the message builder instance
        +
        +
        +
        • +
      • +
        +

        properties

        +
        TypedMessageBuilder<T> properties(Map<String,String> properties)
        +
        Add all the properties in the provided map.
        +
        +
        Returns:
        +
        the message builder instance
        +
        +
        +
        • +
      • +
        +

        eventTime

        +
        TypedMessageBuilder<T> eventTime(long timestamp)
        +
        Set the event time for a given message. + +

        Applications can retrieve the event time by calling Message.getEventTime(). + +

        Note: currently pulsar doesn't support event-time based index. so the subscribers + can't seek the messages by event time.

        +
        +
        Returns:
        +
        the message builder instance
        +
        +
        +
        • +
      • +
        +

        sequenceId

        +
        TypedMessageBuilder<T> sequenceId(long sequenceId)
        +
        Specify a custom sequence id for the message being published. + +

        The sequence id can be used for deduplication purposes and it needs to follow these rules: +

          +
        1. sequenceId >= 0 +
        2. Sequence id for a message needs to be greater than sequence id for earlier messages: + sequenceId(N+1) > sequenceId(N) +
        3. It's not necessary for sequence ids to be consecutive. There can be holes between messages. Eg. the + sequenceId could represent an offset or a cumulative size. +
        +
        +
        Parameters:
        +
        sequenceId - the sequence id to assign to the current message
        +
        Returns:
        +
        the message builder instance
        +
        +
        +
        • +
      • +
        +

        replicationClusters

        +
        TypedMessageBuilder<T> replicationClusters(List<String> clusters)
        +
        Override the geo-replication clusters for this message.
        +
        +
        Parameters:
        +
        clusters - the list of clusters.
        +
        Returns:
        +
        the message builder instance
        +
        +
        +
        • +
      • +
        +

        disableReplication

        +
        TypedMessageBuilder<T> disableReplication()
        +
        Disable geo-replication for this message.
        +
        +
        Returns:
        +
        the message builder instance
        +
        +
        +
        • +
      • +
        +

        deliverAt

        +
        TypedMessageBuilder<T> deliverAt(long timestamp)
        +
        Deliver the message only at or after the specified absolute timestamp. + +

        The timestamp is milliseconds and based on UTC (eg: System.currentTimeMillis(). + +

        Note: messages are only delivered with delay when a consumer is consuming + through a SubscriptionType.Shared subscription. With other subscription + types, the messages will still be delivered immediately.

        +
        +
        Parameters:
        +
        timestamp - absolute timestamp indicating when the message should be delivered to consumers
        +
        Returns:
        +
        the message builder instance
        +
        +
        +
        • +
      • +
        +

        deliverAfter

        +
        TypedMessageBuilder<T> deliverAfter(long delay, + TimeUnit unit)
        +
        Request to deliver the message only after the specified relative delay. + +

        Note: messages are only delivered with delay when a consumer is consuming + through a SubscriptionType.Shared subscription. With other subscription + types, the messages will still be delivered immediately.

        +
        +
        Parameters:
        +
        delay - the amount of delay before the message will be delivered
        +
        unit - the time unit for the delay
        +
        Returns:
        +
        the message builder instance
        +
        +
        +
        • +
      • +
        +

        loadConf

        +
        TypedMessageBuilder<T> loadConf(Map<String,Object> config)
        +
        Configure the TypedMessageBuilder from a config map, as an alternative compared + to call the individual builder methods. + +

        The "value" of the message itself cannot be set on the config map. + +

        Example: + + 

        
+ Map<String, Object> conf = new HashMap<>();
+ conf.put("key", "my-key");
+ conf.put("eventTime", System.currentTimeMillis());
+
+ producer.newMessage()
+             .value("my-message")
+             .loadConf(conf)
+             .send();
+
        + +

        The available options are: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        ConstantNameTypeDoc
        CONF_KEYkeyStringkey(String)
        CONF_PROPERTIESpropertiesMap<String,String>properties(Map)
        CONF_EVENT_TIMEeventTimelongeventTime(long)
        CONF_SEQUENCE_IDsequenceIdlongsequenceId(long)
        CONF_REPLICATION_CLUSTERSreplicationClustersList<String>replicationClusters(List)
        CONF_DISABLE_REPLICATIONdisableReplicationbooleandisableReplication()
        CONF_DELIVERY_AFTER_SECONDSdeliverAfterSecondslongdeliverAfter(long, TimeUnit)
        CONF_DELIVERY_ATdeliverAtlongdeliverAt(long)

        +
        +
        Parameters:
        +
        config - a map with the configuration options for the message
        +
        Returns:
        +
        the message builder instance
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/Authentication.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/Authentication.html new file mode 100644 index 000000000000..4ff8177d7090 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/Authentication.html @@ -0,0 +1,170 @@ + + + + +Uses of Interface org.apache.pulsar.client.api.Authentication (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    org.apache.pulsar.client.api.Authentication

    +
    +
    Packages that use Authentication
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    org.apache.pulsar.client.internal
    +
    +
    Helpers which provide useful functionality for the implementation of Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/AuthenticationDataProvider.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/AuthenticationDataProvider.html new file mode 100644 index 000000000000..823f9b2ca346 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/AuthenticationDataProvider.html @@ -0,0 +1,115 @@ + + + + +Uses of Interface org.apache.pulsar.client.api.AuthenticationDataProvider (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    org.apache.pulsar.client.api.AuthenticationDataProvider

    +
    +
    Packages that use AuthenticationDataProvider
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/AuthenticationFactory.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/AuthenticationFactory.html new file mode 100644 index 000000000000..449c6099e92e --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/AuthenticationFactory.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.client.api.AuthenticationFactory (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.apache.pulsar.client.api.AuthenticationFactory

    +
    +No usage of org.apache.pulsar.client.api.AuthenticationFactory
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/AutoClusterFailoverBuilder.FailoverPolicy.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/AutoClusterFailoverBuilder.FailoverPolicy.html new file mode 100644 index 000000000000..0e19bae4b2c3 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/AutoClusterFailoverBuilder.FailoverPolicy.html @@ -0,0 +1,108 @@ + + + + +Uses of Enum Class org.apache.pulsar.client.api.AutoClusterFailoverBuilder.FailoverPolicy (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Enum Class
    org.apache.pulsar.client.api.AutoClusterFailoverBuilder.FailoverPolicy

    +
    +
    Packages that use AutoClusterFailoverBuilder.FailoverPolicy
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/AutoClusterFailoverBuilder.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/AutoClusterFailoverBuilder.html new file mode 100644 index 000000000000..5dc3f9cd4890 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/AutoClusterFailoverBuilder.html @@ -0,0 +1,139 @@ + + + + +Uses of Interface org.apache.pulsar.client.api.AutoClusterFailoverBuilder (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    org.apache.pulsar.client.api.AutoClusterFailoverBuilder

    +
    +
    Packages that use AutoClusterFailoverBuilder
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/BatchMessageContainer.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/BatchMessageContainer.html new file mode 100644 index 000000000000..4dbca3ef7187 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/BatchMessageContainer.html @@ -0,0 +1,91 @@ + + + + +Uses of Interface org.apache.pulsar.client.api.BatchMessageContainer (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    org.apache.pulsar.client.api.BatchMessageContainer

    +
    +
    Packages that use BatchMessageContainer
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/BatchReceivePolicy.Builder.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/BatchReceivePolicy.Builder.html new file mode 100644 index 000000000000..678e2373c2bd --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/BatchReceivePolicy.Builder.html @@ -0,0 +1,102 @@ + + + + +Uses of Class org.apache.pulsar.client.api.BatchReceivePolicy.Builder (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.apache.pulsar.client.api.BatchReceivePolicy.Builder

    +
    +
    Packages that use BatchReceivePolicy.Builder
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/BatchReceivePolicy.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/BatchReceivePolicy.html new file mode 100644 index 000000000000..12216798a622 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/BatchReceivePolicy.html @@ -0,0 +1,114 @@ + + + + +Uses of Class org.apache.pulsar.client.api.BatchReceivePolicy (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.apache.pulsar.client.api.BatchReceivePolicy

    +
    +
    Packages that use BatchReceivePolicy
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/BatcherBuilder.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/BatcherBuilder.html new file mode 100644 index 000000000000..2bb8e5008047 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/BatcherBuilder.html @@ -0,0 +1,128 @@ + + + + +Uses of Interface org.apache.pulsar.client.api.BatcherBuilder (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    org.apache.pulsar.client.api.BatcherBuilder

    +
    +
    Packages that use BatcherBuilder
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    org.apache.pulsar.client.internal
    +
    +
    Helpers which provide useful functionality for the implementation of Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/ClientBuilder.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/ClientBuilder.html new file mode 100644 index 000000000000..dd1e34ca15c0 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/ClientBuilder.html @@ -0,0 +1,405 @@ + + + + +Uses of Interface org.apache.pulsar.client.api.ClientBuilder (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    org.apache.pulsar.client.api.ClientBuilder

    +
    +
    Packages that use ClientBuilder
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    org.apache.pulsar.client.internal
    +
    +
    Helpers which provide useful functionality for the implementation of Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/CompressionType.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/CompressionType.html new file mode 100644 index 000000000000..051b43eb0930 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/CompressionType.html @@ -0,0 +1,108 @@ + + + + +Uses of Enum Class org.apache.pulsar.client.api.CompressionType (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Enum Class
    org.apache.pulsar.client.api.CompressionType

    +
    +
    Packages that use CompressionType
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/Consumer.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/Consumer.html new file mode 100644 index 000000000000..fa04708151b3 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/Consumer.html @@ -0,0 +1,171 @@ + + + + +Uses of Interface org.apache.pulsar.client.api.Consumer (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    org.apache.pulsar.client.api.Consumer

    +
    +
    Packages that use Consumer
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/ConsumerBuilder.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/ConsumerBuilder.html new file mode 100644 index 000000000000..1903d02d601e --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/ConsumerBuilder.html @@ -0,0 +1,406 @@ + + + + +Uses of Interface org.apache.pulsar.client.api.ConsumerBuilder (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    org.apache.pulsar.client.api.ConsumerBuilder

    +
    +
    Packages that use ConsumerBuilder
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/ConsumerCryptoFailureAction.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/ConsumerCryptoFailureAction.html new file mode 100644 index 000000000000..eeb850ee5ce4 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/ConsumerCryptoFailureAction.html @@ -0,0 +1,118 @@ + + + + +Uses of Enum Class org.apache.pulsar.client.api.ConsumerCryptoFailureAction (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Enum Class
    org.apache.pulsar.client.api.ConsumerCryptoFailureAction

    +
    +
    Packages that use ConsumerCryptoFailureAction
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/ConsumerEventListener.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/ConsumerEventListener.html new file mode 100644 index 000000000000..01e531329312 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/ConsumerEventListener.html @@ -0,0 +1,91 @@ + + + + +Uses of Interface org.apache.pulsar.client.api.ConsumerEventListener (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    org.apache.pulsar.client.api.ConsumerEventListener

    +
    +
    Packages that use ConsumerEventListener
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/ConsumerInterceptor.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/ConsumerInterceptor.html new file mode 100644 index 000000000000..10ac54b3095f --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/ConsumerInterceptor.html @@ -0,0 +1,91 @@ + + + + +Uses of Interface org.apache.pulsar.client.api.ConsumerInterceptor (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    org.apache.pulsar.client.api.ConsumerInterceptor

    +
    +
    Packages that use ConsumerInterceptor
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/ConsumerStats.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/ConsumerStats.html new file mode 100644 index 000000000000..7ee35b68a51a --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/ConsumerStats.html @@ -0,0 +1,116 @@ + + + + +Uses of Interface org.apache.pulsar.client.api.ConsumerStats (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    org.apache.pulsar.client.api.ConsumerStats

    +
    +
    Packages that use ConsumerStats
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/ControlledClusterFailoverBuilder.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/ControlledClusterFailoverBuilder.html new file mode 100644 index 000000000000..cbf69db49ec3 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/ControlledClusterFailoverBuilder.html @@ -0,0 +1,107 @@ + + + + +Uses of Interface org.apache.pulsar.client.api.ControlledClusterFailoverBuilder (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    org.apache.pulsar.client.api.ControlledClusterFailoverBuilder

    +
    +
    Packages that use ControlledClusterFailoverBuilder
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/CryptoKeyReader.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/CryptoKeyReader.html new file mode 100644 index 000000000000..5df26e7e97b9 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/CryptoKeyReader.html @@ -0,0 +1,134 @@ + + + + +Uses of Interface org.apache.pulsar.client.api.CryptoKeyReader (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    org.apache.pulsar.client.api.CryptoKeyReader

    +
    +
    Packages that use CryptoKeyReader
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/DeadLetterPolicy.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/DeadLetterPolicy.html new file mode 100644 index 000000000000..f103b2439bbb --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/DeadLetterPolicy.html @@ -0,0 +1,91 @@ + + + + +Uses of Class org.apache.pulsar.client.api.DeadLetterPolicy (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.apache.pulsar.client.api.DeadLetterPolicy

    +
    +
    Packages that use DeadLetterPolicy
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/DummyCryptoKeyReaderImpl.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/DummyCryptoKeyReaderImpl.html new file mode 100644 index 000000000000..55dc6201d799 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/DummyCryptoKeyReaderImpl.html @@ -0,0 +1,89 @@ + + + + +Uses of Class org.apache.pulsar.client.api.DummyCryptoKeyReaderImpl (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.apache.pulsar.client.api.DummyCryptoKeyReaderImpl

    +
    +
    Packages that use DummyCryptoKeyReaderImpl
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/EncodedAuthenticationParameterSupport.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/EncodedAuthenticationParameterSupport.html new file mode 100644 index 000000000000..1c5a36c98ba4 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/EncodedAuthenticationParameterSupport.html @@ -0,0 +1,62 @@ + + + + +Uses of Interface org.apache.pulsar.client.api.EncodedAuthenticationParameterSupport (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    org.apache.pulsar.client.api.EncodedAuthenticationParameterSupport

    +
    +No usage of org.apache.pulsar.client.api.EncodedAuthenticationParameterSupport
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/EncryptionKeyInfo.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/EncryptionKeyInfo.html new file mode 100644 index 000000000000..ab2c5ffa4d13 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/EncryptionKeyInfo.html @@ -0,0 +1,104 @@ + + + + +Uses of Class org.apache.pulsar.client.api.EncryptionKeyInfo (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.apache.pulsar.client.api.EncryptionKeyInfo

    +
    +
    Packages that use EncryptionKeyInfo
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/HashingScheme.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/HashingScheme.html new file mode 100644 index 000000000000..2847c064e74a --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/HashingScheme.html @@ -0,0 +1,108 @@ + + + + +Uses of Enum Class org.apache.pulsar.client.api.HashingScheme (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Enum Class
    org.apache.pulsar.client.api.HashingScheme

    +
    +
    Packages that use HashingScheme
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/KeySharedMode.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/KeySharedMode.html new file mode 100644 index 000000000000..d39443414735 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/KeySharedMode.html @@ -0,0 +1,109 @@ + + + + +Uses of Enum Class org.apache.pulsar.client.api.KeySharedMode (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Enum Class
    org.apache.pulsar.client.api.KeySharedMode

    +
    +
    Packages that use KeySharedMode
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/KeySharedPolicy.KeySharedPolicyAutoSplit.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/KeySharedPolicy.KeySharedPolicyAutoSplit.html new file mode 100644 index 000000000000..779ee48ba7ae --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/KeySharedPolicy.KeySharedPolicyAutoSplit.html @@ -0,0 +1,89 @@ + + + + +Uses of Class org.apache.pulsar.client.api.KeySharedPolicy.KeySharedPolicyAutoSplit (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.apache.pulsar.client.api.KeySharedPolicy.KeySharedPolicyAutoSplit

    +
    +
    Packages that use KeySharedPolicy.KeySharedPolicyAutoSplit
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/KeySharedPolicy.KeySharedPolicySticky.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/KeySharedPolicy.KeySharedPolicySticky.html new file mode 100644 index 000000000000..e3a6de6c2320 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/KeySharedPolicy.KeySharedPolicySticky.html @@ -0,0 +1,95 @@ + + + + +Uses of Class org.apache.pulsar.client.api.KeySharedPolicy.KeySharedPolicySticky (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.apache.pulsar.client.api.KeySharedPolicy.KeySharedPolicySticky

    +
    +
    Packages that use KeySharedPolicy.KeySharedPolicySticky
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/KeySharedPolicy.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/KeySharedPolicy.html new file mode 100644 index 000000000000..c3ebc0c59a7b --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/KeySharedPolicy.html @@ -0,0 +1,119 @@ + + + + +Uses of Class org.apache.pulsar.client.api.KeySharedPolicy (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.apache.pulsar.client.api.KeySharedPolicy

    +
    +
    Packages that use KeySharedPolicy
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/KeyStoreParams.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/KeyStoreParams.html new file mode 100644 index 000000000000..46d25707b59b --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/KeyStoreParams.html @@ -0,0 +1,91 @@ + + + + +Uses of Class org.apache.pulsar.client.api.KeyStoreParams (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.apache.pulsar.client.api.KeyStoreParams

    +
    +
    Packages that use KeyStoreParams
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/Message.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/Message.html new file mode 100644 index 000000000000..616846f1b4b6 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/Message.html @@ -0,0 +1,403 @@ + + + + +Uses of Interface org.apache.pulsar.client.api.Message (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    org.apache.pulsar.client.api.Message

    +
    +
    Packages that use Message
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    org.apache.pulsar.client.api.interceptor
    +
    +
    Pulsar interceptors.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/MessageAcknowledger.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/MessageAcknowledger.html new file mode 100644 index 000000000000..4d9b96fcb256 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/MessageAcknowledger.html @@ -0,0 +1,91 @@ + + + + +Uses of Interface org.apache.pulsar.client.api.MessageAcknowledger (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    org.apache.pulsar.client.api.MessageAcknowledger

    +
    +
    Packages that use MessageAcknowledger
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/MessageCrypto.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/MessageCrypto.html new file mode 100644 index 000000000000..d67d9ecc8a16 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/MessageCrypto.html @@ -0,0 +1,101 @@ + + + + +Uses of Interface org.apache.pulsar.client.api.MessageCrypto (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    org.apache.pulsar.client.api.MessageCrypto

    +
    +
    Packages that use MessageCrypto
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/MessageId.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/MessageId.html new file mode 100644 index 000000000000..0ffd673f2a08 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/MessageId.html @@ -0,0 +1,367 @@ + + + + +Uses of Interface org.apache.pulsar.client.api.MessageId (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    org.apache.pulsar.client.api.MessageId

    +
    +
    Packages that use MessageId
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    org.apache.pulsar.client.api.interceptor
    +
    +
    Pulsar interceptors.
    +
    +
    org.apache.pulsar.client.internal
    +
    +
    Helpers which provide useful functionality for the implementation of Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/MessageListener.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/MessageListener.html new file mode 100644 index 000000000000..c9dab75dbf7a --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/MessageListener.html @@ -0,0 +1,91 @@ + + + + +Uses of Interface org.apache.pulsar.client.api.MessageListener (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    org.apache.pulsar.client.api.MessageListener

    +
    +
    Packages that use MessageListener
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/MessageListenerExecutor.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/MessageListenerExecutor.html new file mode 100644 index 000000000000..59d8980e3575 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/MessageListenerExecutor.html @@ -0,0 +1,91 @@ + + + + +Uses of Interface org.apache.pulsar.client.api.MessageListenerExecutor (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    org.apache.pulsar.client.api.MessageListenerExecutor

    +
    +
    Packages that use MessageListenerExecutor
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/MessagePayload.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/MessagePayload.html new file mode 100644 index 000000000000..90157a957241 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/MessagePayload.html @@ -0,0 +1,125 @@ + + + + +Uses of Interface org.apache.pulsar.client.api.MessagePayload (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    org.apache.pulsar.client.api.MessagePayload

    +
    +
    Packages that use MessagePayload
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/MessagePayloadContext.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/MessagePayloadContext.html new file mode 100644 index 000000000000..c35529c11498 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/MessagePayloadContext.html @@ -0,0 +1,94 @@ + + + + +Uses of Interface org.apache.pulsar.client.api.MessagePayloadContext (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    org.apache.pulsar.client.api.MessagePayloadContext

    +
    +
    Packages that use MessagePayloadContext
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/MessagePayloadFactory.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/MessagePayloadFactory.html new file mode 100644 index 000000000000..18ff88082c9b --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/MessagePayloadFactory.html @@ -0,0 +1,107 @@ + + + + +Uses of Interface org.apache.pulsar.client.api.MessagePayloadFactory (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    org.apache.pulsar.client.api.MessagePayloadFactory

    +
    +
    Packages that use MessagePayloadFactory
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    org.apache.pulsar.client.internal
    +
    +
    Helpers which provide useful functionality for the implementation of Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/MessagePayloadProcessor.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/MessagePayloadProcessor.html new file mode 100644 index 000000000000..6f829574df9c --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/MessagePayloadProcessor.html @@ -0,0 +1,101 @@ + + + + +Uses of Interface org.apache.pulsar.client.api.MessagePayloadProcessor (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    org.apache.pulsar.client.api.MessagePayloadProcessor

    +
    +
    Packages that use MessagePayloadProcessor
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/MessageRouter.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/MessageRouter.html new file mode 100644 index 000000000000..90d79844b1e8 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/MessageRouter.html @@ -0,0 +1,91 @@ + + + + +Uses of Interface org.apache.pulsar.client.api.MessageRouter (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    org.apache.pulsar.client.api.MessageRouter

    +
    +
    Packages that use MessageRouter
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/MessageRoutingMode.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/MessageRoutingMode.html new file mode 100644 index 000000000000..bcf2af7b70f9 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/MessageRoutingMode.html @@ -0,0 +1,108 @@ + + + + +Uses of Enum Class org.apache.pulsar.client.api.MessageRoutingMode (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Enum Class
    org.apache.pulsar.client.api.MessageRoutingMode

    +
    +
    Packages that use MessageRoutingMode
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/Messages.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/Messages.html new file mode 100644 index 000000000000..8b1ab7334d10 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/Messages.html @@ -0,0 +1,141 @@ + + + + +Uses of Interface org.apache.pulsar.client.api.Messages (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    org.apache.pulsar.client.api.Messages

    +
    +
    Packages that use Messages
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/MultiTopicConsumerStats.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/MultiTopicConsumerStats.html new file mode 100644 index 000000000000..ea15e3be74a3 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/MultiTopicConsumerStats.html @@ -0,0 +1,62 @@ + + + + +Uses of Interface org.apache.pulsar.client.api.MultiTopicConsumerStats (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    org.apache.pulsar.client.api.MultiTopicConsumerStats

    +
    +No usage of org.apache.pulsar.client.api.MultiTopicConsumerStats
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PartitionedTopicProducerStats.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PartitionedTopicProducerStats.html new file mode 100644 index 000000000000..6edf3b478100 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PartitionedTopicProducerStats.html @@ -0,0 +1,62 @@ + + + + +Uses of Interface org.apache.pulsar.client.api.PartitionedTopicProducerStats (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    org.apache.pulsar.client.api.PartitionedTopicProducerStats

    +
    +No usage of org.apache.pulsar.client.api.PartitionedTopicProducerStats
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/Producer.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/Producer.html new file mode 100644 index 000000000000..0d97fe6efd8b --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/Producer.html @@ -0,0 +1,167 @@ + + + + +Uses of Interface org.apache.pulsar.client.api.Producer (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    org.apache.pulsar.client.api.Producer

    +
    +
    Packages that use Producer
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    org.apache.pulsar.client.api.interceptor
    +
    +
    Pulsar interceptors.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/ProducerAccessMode.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/ProducerAccessMode.html new file mode 100644 index 000000000000..9c94e46b7109 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/ProducerAccessMode.html @@ -0,0 +1,108 @@ + + + + +Uses of Enum Class org.apache.pulsar.client.api.ProducerAccessMode (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Enum Class
    org.apache.pulsar.client.api.ProducerAccessMode

    +
    +
    Packages that use ProducerAccessMode
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/ProducerBuilder.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/ProducerBuilder.html new file mode 100644 index 000000000000..163f843a73b6 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/ProducerBuilder.html @@ -0,0 +1,286 @@ + + + + +Uses of Interface org.apache.pulsar.client.api.ProducerBuilder (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    org.apache.pulsar.client.api.ProducerBuilder

    +
    +
    Packages that use ProducerBuilder
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/ProducerCryptoFailureAction.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/ProducerCryptoFailureAction.html new file mode 100644 index 000000000000..13aec9570b0f --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/ProducerCryptoFailureAction.html @@ -0,0 +1,108 @@ + + + + +Uses of Enum Class org.apache.pulsar.client.api.ProducerCryptoFailureAction (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Enum Class
    org.apache.pulsar.client.api.ProducerCryptoFailureAction

    +
    +
    Packages that use ProducerCryptoFailureAction
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/ProducerInterceptor.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/ProducerInterceptor.html new file mode 100644 index 000000000000..fc814a93557d --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/ProducerInterceptor.html @@ -0,0 +1,109 @@ + + + + +Uses of Interface org.apache.pulsar.client.api.ProducerInterceptor (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    org.apache.pulsar.client.api.ProducerInterceptor

    +
    +
    Packages that use ProducerInterceptor
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    org.apache.pulsar.client.api.interceptor
    +
    +
    Pulsar interceptors.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/ProducerStats.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/ProducerStats.html new file mode 100644 index 000000000000..6415330cd6d5 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/ProducerStats.html @@ -0,0 +1,126 @@ + + + + +Uses of Interface org.apache.pulsar.client.api.ProducerStats (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    org.apache.pulsar.client.api.ProducerStats

    +
    +
    Packages that use ProducerStats
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/ProxyProtocol.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/ProxyProtocol.html new file mode 100644 index 000000000000..66a5eb3bad47 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/ProxyProtocol.html @@ -0,0 +1,109 @@ + + + + +Uses of Enum Class org.apache.pulsar.client.api.ProxyProtocol (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Enum Class
    org.apache.pulsar.client.api.ProxyProtocol

    +
    +
    Packages that use ProxyProtocol
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClient.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClient.html new file mode 100644 index 000000000000..5a9caa4805c2 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClient.html @@ -0,0 +1,102 @@ + + + + +Uses of Interface org.apache.pulsar.client.api.PulsarClient (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    org.apache.pulsar.client.api.PulsarClient

    +
    +
    Packages that use PulsarClient
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.AlreadyClosedException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.AlreadyClosedException.html new file mode 100644 index 000000000000..da11a6fdb52a --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.AlreadyClosedException.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.client.api.PulsarClientException.AlreadyClosedException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.apache.pulsar.client.api.PulsarClientException.AlreadyClosedException

    +
    +No usage of org.apache.pulsar.client.api.PulsarClientException.AlreadyClosedException
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.AuthenticationException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.AuthenticationException.html new file mode 100644 index 000000000000..77f76117cee7 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.AuthenticationException.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.client.api.PulsarClientException.AuthenticationException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.apache.pulsar.client.api.PulsarClientException.AuthenticationException

    +
    +No usage of org.apache.pulsar.client.api.PulsarClientException.AuthenticationException
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.AuthorizationException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.AuthorizationException.html new file mode 100644 index 000000000000..38fe3bf7798f --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.AuthorizationException.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.client.api.PulsarClientException.AuthorizationException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.apache.pulsar.client.api.PulsarClientException.AuthorizationException

    +
    +No usage of org.apache.pulsar.client.api.PulsarClientException.AuthorizationException
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.BrokerMetadataException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.BrokerMetadataException.html new file mode 100644 index 000000000000..1b161d9b45e9 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.BrokerMetadataException.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.client.api.PulsarClientException.BrokerMetadataException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.apache.pulsar.client.api.PulsarClientException.BrokerMetadataException

    +
    +No usage of org.apache.pulsar.client.api.PulsarClientException.BrokerMetadataException
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.BrokerPersistenceException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.BrokerPersistenceException.html new file mode 100644 index 000000000000..75f26e562943 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.BrokerPersistenceException.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.client.api.PulsarClientException.BrokerPersistenceException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.apache.pulsar.client.api.PulsarClientException.BrokerPersistenceException

    +
    +No usage of org.apache.pulsar.client.api.PulsarClientException.BrokerPersistenceException
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.ChecksumException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.ChecksumException.html new file mode 100644 index 000000000000..27247386959a --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.ChecksumException.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.client.api.PulsarClientException.ChecksumException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.apache.pulsar.client.api.PulsarClientException.ChecksumException

    +
    +No usage of org.apache.pulsar.client.api.PulsarClientException.ChecksumException
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.ConnectException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.ConnectException.html new file mode 100644 index 000000000000..43546ed502b2 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.ConnectException.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.client.api.PulsarClientException.ConnectException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.apache.pulsar.client.api.PulsarClientException.ConnectException

    +
    +No usage of org.apache.pulsar.client.api.PulsarClientException.ConnectException
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.ConsumerAssignException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.ConsumerAssignException.html new file mode 100644 index 000000000000..46216165cb9d --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.ConsumerAssignException.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.client.api.PulsarClientException.ConsumerAssignException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.apache.pulsar.client.api.PulsarClientException.ConsumerAssignException

    +
    +No usage of org.apache.pulsar.client.api.PulsarClientException.ConsumerAssignException
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.ConsumerBusyException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.ConsumerBusyException.html new file mode 100644 index 000000000000..ca8c31f3025c --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.ConsumerBusyException.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.client.api.PulsarClientException.ConsumerBusyException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.apache.pulsar.client.api.PulsarClientException.ConsumerBusyException

    +
    +No usage of org.apache.pulsar.client.api.PulsarClientException.ConsumerBusyException
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.CryptoException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.CryptoException.html new file mode 100644 index 000000000000..2cadd4b75b84 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.CryptoException.html @@ -0,0 +1,90 @@ + + + + +Uses of Class org.apache.pulsar.client.api.PulsarClientException.CryptoException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.apache.pulsar.client.api.PulsarClientException.CryptoException

    +
    +
    Packages that use PulsarClientException.CryptoException
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.FailedFeatureCheck.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.FailedFeatureCheck.html new file mode 100644 index 000000000000..a354c7df0e5e --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.FailedFeatureCheck.html @@ -0,0 +1,107 @@ + + + + +Uses of Enum Class org.apache.pulsar.client.api.PulsarClientException.FailedFeatureCheck (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Enum Class
    org.apache.pulsar.client.api.PulsarClientException.FailedFeatureCheck

    +
    +
    Packages that use PulsarClientException.FailedFeatureCheck
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.FeatureNotSupportedException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.FeatureNotSupportedException.html new file mode 100644 index 000000000000..ed60af8e8662 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.FeatureNotSupportedException.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.client.api.PulsarClientException.FeatureNotSupportedException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.apache.pulsar.client.api.PulsarClientException.FeatureNotSupportedException

    +
    +No usage of org.apache.pulsar.client.api.PulsarClientException.FeatureNotSupportedException
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.GettingAuthenticationDataException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.GettingAuthenticationDataException.html new file mode 100644 index 000000000000..3d679f829113 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.GettingAuthenticationDataException.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.client.api.PulsarClientException.GettingAuthenticationDataException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.apache.pulsar.client.api.PulsarClientException.GettingAuthenticationDataException

    +
    +No usage of org.apache.pulsar.client.api.PulsarClientException.GettingAuthenticationDataException
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.IncompatibleSchemaException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.IncompatibleSchemaException.html new file mode 100644 index 000000000000..33854b9f17e3 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.IncompatibleSchemaException.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.client.api.PulsarClientException.IncompatibleSchemaException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.apache.pulsar.client.api.PulsarClientException.IncompatibleSchemaException

    +
    +No usage of org.apache.pulsar.client.api.PulsarClientException.IncompatibleSchemaException
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.InvalidConfigurationException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.InvalidConfigurationException.html new file mode 100644 index 000000000000..b25f7d0f6958 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.InvalidConfigurationException.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.client.api.PulsarClientException.InvalidConfigurationException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.apache.pulsar.client.api.PulsarClientException.InvalidConfigurationException

    +
    +No usage of org.apache.pulsar.client.api.PulsarClientException.InvalidConfigurationException
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.InvalidMessageException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.InvalidMessageException.html new file mode 100644 index 000000000000..57cdede74394 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.InvalidMessageException.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.client.api.PulsarClientException.InvalidMessageException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.apache.pulsar.client.api.PulsarClientException.InvalidMessageException

    +
    +No usage of org.apache.pulsar.client.api.PulsarClientException.InvalidMessageException
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.InvalidServiceURL.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.InvalidServiceURL.html new file mode 100644 index 000000000000..cc873f60837e --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.InvalidServiceURL.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.client.api.PulsarClientException.InvalidServiceURL (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.apache.pulsar.client.api.PulsarClientException.InvalidServiceURL

    +
    +No usage of org.apache.pulsar.client.api.PulsarClientException.InvalidServiceURL
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.InvalidTopicNameException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.InvalidTopicNameException.html new file mode 100644 index 000000000000..e8fa73442757 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.InvalidTopicNameException.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.client.api.PulsarClientException.InvalidTopicNameException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.apache.pulsar.client.api.PulsarClientException.InvalidTopicNameException

    +
    +No usage of org.apache.pulsar.client.api.PulsarClientException.InvalidTopicNameException
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.LookupException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.LookupException.html new file mode 100644 index 000000000000..5f085da49739 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.LookupException.html @@ -0,0 +1,91 @@ + + + + +Uses of Class org.apache.pulsar.client.api.PulsarClientException.LookupException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.apache.pulsar.client.api.PulsarClientException.LookupException

    +
    +
    Packages that use PulsarClientException.LookupException
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.MemoryBufferIsFullError.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.MemoryBufferIsFullError.html new file mode 100644 index 000000000000..ca3924d83a38 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.MemoryBufferIsFullError.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.client.api.PulsarClientException.MemoryBufferIsFullError (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.apache.pulsar.client.api.PulsarClientException.MemoryBufferIsFullError

    +
    +No usage of org.apache.pulsar.client.api.PulsarClientException.MemoryBufferIsFullError
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.MessageAcknowledgeException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.MessageAcknowledgeException.html new file mode 100644 index 000000000000..0f9cfbbb7c0b --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.MessageAcknowledgeException.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.client.api.PulsarClientException.MessageAcknowledgeException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.apache.pulsar.client.api.PulsarClientException.MessageAcknowledgeException

    +
    +No usage of org.apache.pulsar.client.api.PulsarClientException.MessageAcknowledgeException
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.NotAllowedException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.NotAllowedException.html new file mode 100644 index 000000000000..cc009ce9fb6f --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.NotAllowedException.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.client.api.PulsarClientException.NotAllowedException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.apache.pulsar.client.api.PulsarClientException.NotAllowedException

    +
    +No usage of org.apache.pulsar.client.api.PulsarClientException.NotAllowedException
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.NotConnectedException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.NotConnectedException.html new file mode 100644 index 000000000000..70dba7e8c2c2 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.NotConnectedException.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.client.api.PulsarClientException.NotConnectedException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.apache.pulsar.client.api.PulsarClientException.NotConnectedException

    +
    +No usage of org.apache.pulsar.client.api.PulsarClientException.NotConnectedException
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.NotFoundException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.NotFoundException.html new file mode 100644 index 000000000000..359a9facd919 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.NotFoundException.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.client.api.PulsarClientException.NotFoundException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.apache.pulsar.client.api.PulsarClientException.NotFoundException

    +
    +No usage of org.apache.pulsar.client.api.PulsarClientException.NotFoundException
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.NotSupportedException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.NotSupportedException.html new file mode 100644 index 000000000000..9d894ac2f430 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.NotSupportedException.html @@ -0,0 +1,91 @@ + + + + +Uses of Class org.apache.pulsar.client.api.PulsarClientException.NotSupportedException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.apache.pulsar.client.api.PulsarClientException.NotSupportedException

    +
    +
    Packages that use PulsarClientException.NotSupportedException
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.ProducerBlockedQuotaExceededError.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.ProducerBlockedQuotaExceededError.html new file mode 100644 index 000000000000..8d59a4232205 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.ProducerBlockedQuotaExceededError.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.client.api.PulsarClientException.ProducerBlockedQuotaExceededError (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.apache.pulsar.client.api.PulsarClientException.ProducerBlockedQuotaExceededError

    +
    +No usage of org.apache.pulsar.client.api.PulsarClientException.ProducerBlockedQuotaExceededError
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.ProducerBlockedQuotaExceededException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.ProducerBlockedQuotaExceededException.html new file mode 100644 index 000000000000..33611153bfd8 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.ProducerBlockedQuotaExceededException.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.client.api.PulsarClientException.ProducerBlockedQuotaExceededException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.apache.pulsar.client.api.PulsarClientException.ProducerBlockedQuotaExceededException

    +
    +No usage of org.apache.pulsar.client.api.PulsarClientException.ProducerBlockedQuotaExceededException
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.ProducerBusyException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.ProducerBusyException.html new file mode 100644 index 000000000000..555653440ba5 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.ProducerBusyException.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.client.api.PulsarClientException.ProducerBusyException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.apache.pulsar.client.api.PulsarClientException.ProducerBusyException

    +
    +No usage of org.apache.pulsar.client.api.PulsarClientException.ProducerBusyException
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.ProducerFencedException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.ProducerFencedException.html new file mode 100644 index 000000000000..433149357eb7 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.ProducerFencedException.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.client.api.PulsarClientException.ProducerFencedException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.apache.pulsar.client.api.PulsarClientException.ProducerFencedException

    +
    +No usage of org.apache.pulsar.client.api.PulsarClientException.ProducerFencedException
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.ProducerQueueIsFullError.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.ProducerQueueIsFullError.html new file mode 100644 index 000000000000..c3f8a5acde2e --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.ProducerQueueIsFullError.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.client.api.PulsarClientException.ProducerQueueIsFullError (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.apache.pulsar.client.api.PulsarClientException.ProducerQueueIsFullError

    +
    +No usage of org.apache.pulsar.client.api.PulsarClientException.ProducerQueueIsFullError
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.SubscriptionNotFoundException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.SubscriptionNotFoundException.html new file mode 100644 index 000000000000..8f485a3e0e7a --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.SubscriptionNotFoundException.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.client.api.PulsarClientException.SubscriptionNotFoundException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.apache.pulsar.client.api.PulsarClientException.SubscriptionNotFoundException

    +
    +No usage of org.apache.pulsar.client.api.PulsarClientException.SubscriptionNotFoundException
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.TimeoutException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.TimeoutException.html new file mode 100644 index 000000000000..c1279273d149 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.TimeoutException.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.client.api.PulsarClientException.TimeoutException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.apache.pulsar.client.api.PulsarClientException.TimeoutException

    +
    +No usage of org.apache.pulsar.client.api.PulsarClientException.TimeoutException
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.TooManyRequestsException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.TooManyRequestsException.html new file mode 100644 index 000000000000..9cc4c4c17909 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.TooManyRequestsException.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.client.api.PulsarClientException.TooManyRequestsException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.apache.pulsar.client.api.PulsarClientException.TooManyRequestsException

    +
    +No usage of org.apache.pulsar.client.api.PulsarClientException.TooManyRequestsException
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.TopicDoesNotExistException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.TopicDoesNotExistException.html new file mode 100644 index 000000000000..8f394af97798 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.TopicDoesNotExistException.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.client.api.PulsarClientException.TopicDoesNotExistException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.apache.pulsar.client.api.PulsarClientException.TopicDoesNotExistException

    +
    +No usage of org.apache.pulsar.client.api.PulsarClientException.TopicDoesNotExistException
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.TopicMigrationException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.TopicMigrationException.html new file mode 100644 index 000000000000..0a0a6d766bb7 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.TopicMigrationException.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.client.api.PulsarClientException.TopicMigrationException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.apache.pulsar.client.api.PulsarClientException.TopicMigrationException

    +
    +No usage of org.apache.pulsar.client.api.PulsarClientException.TopicMigrationException
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.TopicTerminatedException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.TopicTerminatedException.html new file mode 100644 index 000000000000..2a8b334a5ae9 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.TopicTerminatedException.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.client.api.PulsarClientException.TopicTerminatedException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.apache.pulsar.client.api.PulsarClientException.TopicTerminatedException

    +
    +No usage of org.apache.pulsar.client.api.PulsarClientException.TopicTerminatedException
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.TransactionConflictException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.TransactionConflictException.html new file mode 100644 index 000000000000..9bc98d633959 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.TransactionConflictException.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.client.api.PulsarClientException.TransactionConflictException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.apache.pulsar.client.api.PulsarClientException.TransactionConflictException

    +
    +No usage of org.apache.pulsar.client.api.PulsarClientException.TransactionConflictException
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.TransactionHasOperationFailedException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.TransactionHasOperationFailedException.html new file mode 100644 index 000000000000..0d30acfeb102 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.TransactionHasOperationFailedException.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.client.api.PulsarClientException.TransactionHasOperationFailedException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.apache.pulsar.client.api.PulsarClientException.TransactionHasOperationFailedException

    +
    +No usage of org.apache.pulsar.client.api.PulsarClientException.TransactionHasOperationFailedException
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.UnsupportedAuthenticationException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.UnsupportedAuthenticationException.html new file mode 100644 index 000000000000..9c4f7ae906b1 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.UnsupportedAuthenticationException.html @@ -0,0 +1,135 @@ + + + + +Uses of Class org.apache.pulsar.client.api.PulsarClientException.UnsupportedAuthenticationException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.apache.pulsar.client.api.PulsarClientException.UnsupportedAuthenticationException

    +
    +
    Packages that use PulsarClientException.UnsupportedAuthenticationException
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    org.apache.pulsar.client.internal
    +
    +
    Helpers which provide useful functionality for the implementation of Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.html new file mode 100644 index 000000000000..c78138ed7dfb --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/PulsarClientException.html @@ -0,0 +1,522 @@ + + + + +Uses of Class org.apache.pulsar.client.api.PulsarClientException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.apache.pulsar.client.api.PulsarClientException

    +
    +
    Packages that use PulsarClientException
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/Range.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/Range.html new file mode 100644 index 000000000000..15ecf15bce51 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/Range.html @@ -0,0 +1,146 @@ + + + + +Uses of Class org.apache.pulsar.client.api.Range (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.apache.pulsar.client.api.Range

    +
    +
    Packages that use Range
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/Reader.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/Reader.html new file mode 100644 index 000000000000..6b81a17dc09a --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/Reader.html @@ -0,0 +1,128 @@ + + + + +Uses of Interface org.apache.pulsar.client.api.Reader (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    org.apache.pulsar.client.api.Reader

    +
    +
    Packages that use Reader
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/ReaderBuilder.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/ReaderBuilder.html new file mode 100644 index 000000000000..d13ea9c66b13 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/ReaderBuilder.html @@ -0,0 +1,233 @@ + + + + +Uses of Interface org.apache.pulsar.client.api.ReaderBuilder (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    org.apache.pulsar.client.api.ReaderBuilder

    +
    +
    Packages that use ReaderBuilder
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/ReaderInterceptor.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/ReaderInterceptor.html new file mode 100644 index 000000000000..64cc18757562 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/ReaderInterceptor.html @@ -0,0 +1,91 @@ + + + + +Uses of Interface org.apache.pulsar.client.api.ReaderInterceptor (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    org.apache.pulsar.client.api.ReaderInterceptor

    +
    +
    Packages that use ReaderInterceptor
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/ReaderListener.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/ReaderListener.html new file mode 100644 index 000000000000..1885b1626806 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/ReaderListener.html @@ -0,0 +1,91 @@ + + + + +Uses of Interface org.apache.pulsar.client.api.ReaderListener (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    org.apache.pulsar.client.api.ReaderListener

    +
    +
    Packages that use ReaderListener
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/RedeliveryBackoff.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/RedeliveryBackoff.html new file mode 100644 index 000000000000..247a290d2319 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/RedeliveryBackoff.html @@ -0,0 +1,99 @@ + + + + +Uses of Interface org.apache.pulsar.client.api.RedeliveryBackoff (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    org.apache.pulsar.client.api.RedeliveryBackoff

    +
    +
    Packages that use RedeliveryBackoff
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/RegexSubscriptionMode.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/RegexSubscriptionMode.html new file mode 100644 index 000000000000..ec838a81c632 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/RegexSubscriptionMode.html @@ -0,0 +1,108 @@ + + + + +Uses of Enum Class org.apache.pulsar.client.api.RegexSubscriptionMode (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Enum Class
    org.apache.pulsar.client.api.RegexSubscriptionMode

    +
    +
    Packages that use RegexSubscriptionMode
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/Schema.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/Schema.html new file mode 100644 index 000000000000..a487b99763d8 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/Schema.html @@ -0,0 +1,592 @@ + + + + +Uses of Interface org.apache.pulsar.client.api.Schema (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    org.apache.pulsar.client.api.Schema

    +
    +
    Packages that use Schema
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    org.apache.pulsar.client.api.schema
    +
    +
    Schema definitions for Pulsar Client API.
    +
    +
    org.apache.pulsar.client.internal
    +
    +
    Helpers which provide useful functionality for the implementation of Pulsar Client API.
    +
    +
    org.apache.pulsar.common.schema
    +
    +
    This package contains data structures for schema definitions used in the Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/SchemaSerializationException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/SchemaSerializationException.html new file mode 100644 index 000000000000..16c066ba4b25 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/SchemaSerializationException.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.client.api.SchemaSerializationException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.apache.pulsar.client.api.SchemaSerializationException

    +
    +No usage of org.apache.pulsar.client.api.SchemaSerializationException
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/ServiceUrlProvider.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/ServiceUrlProvider.html new file mode 100644 index 000000000000..22bc3cc31cc2 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/ServiceUrlProvider.html @@ -0,0 +1,107 @@ + + + + +Uses of Interface org.apache.pulsar.client.api.ServiceUrlProvider (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    org.apache.pulsar.client.api.ServiceUrlProvider

    +
    +
    Packages that use ServiceUrlProvider
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/SizeUnit.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/SizeUnit.html new file mode 100644 index 000000000000..f21809ded7b7 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/SizeUnit.html @@ -0,0 +1,109 @@ + + + + +Uses of Enum Class org.apache.pulsar.client.api.SizeUnit (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Enum Class
    org.apache.pulsar.client.api.SizeUnit

    +
    +
    Packages that use SizeUnit
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/SubscriptionInitialPosition.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/SubscriptionInitialPosition.html new file mode 100644 index 000000000000..a391f5ffa95f --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/SubscriptionInitialPosition.html @@ -0,0 +1,108 @@ + + + + +Uses of Enum Class org.apache.pulsar.client.api.SubscriptionInitialPosition (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Enum Class
    org.apache.pulsar.client.api.SubscriptionInitialPosition

    +
    +
    Packages that use SubscriptionInitialPosition
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/SubscriptionMode.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/SubscriptionMode.html new file mode 100644 index 000000000000..f2f347fa3ccd --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/SubscriptionMode.html @@ -0,0 +1,108 @@ + + + + +Uses of Enum Class org.apache.pulsar.client.api.SubscriptionMode (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Enum Class
    org.apache.pulsar.client.api.SubscriptionMode

    +
    +
    Packages that use SubscriptionMode
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/SubscriptionType.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/SubscriptionType.html new file mode 100644 index 000000000000..2952a6854fe8 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/SubscriptionType.html @@ -0,0 +1,108 @@ + + + + +Uses of Enum Class org.apache.pulsar.client.api.SubscriptionType (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Enum Class
    org.apache.pulsar.client.api.SubscriptionType

    +
    +
    Packages that use SubscriptionType
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/TableView.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/TableView.html new file mode 100644 index 000000000000..f4612d7fc14b --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/TableView.html @@ -0,0 +1,102 @@ + + + + +Uses of Interface org.apache.pulsar.client.api.TableView (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    org.apache.pulsar.client.api.TableView

    +
    +
    Packages that use TableView
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/TableViewBuilder.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/TableViewBuilder.html new file mode 100644 index 000000000000..e932fffe3872 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/TableViewBuilder.html @@ -0,0 +1,145 @@ + + + + +Uses of Interface org.apache.pulsar.client.api.TableViewBuilder (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    org.apache.pulsar.client.api.TableViewBuilder

    +
    +
    Packages that use TableViewBuilder
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/TopicConsumerBuilder.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/TopicConsumerBuilder.html new file mode 100644 index 000000000000..e45ff4f7ef01 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/TopicConsumerBuilder.html @@ -0,0 +1,119 @@ + + + + +Uses of Interface org.apache.pulsar.client.api.TopicConsumerBuilder (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    org.apache.pulsar.client.api.TopicConsumerBuilder

    +
    +
    Packages that use TopicConsumerBuilder
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/TopicMessageId.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/TopicMessageId.html new file mode 100644 index 000000000000..55c7de4edd4c --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/TopicMessageId.html @@ -0,0 +1,135 @@ + + + + +Uses of Interface org.apache.pulsar.client.api.TopicMessageId (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    org.apache.pulsar.client.api.TopicMessageId

    +
    +
    Packages that use TopicMessageId
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    org.apache.pulsar.client.internal
    +
    +
    Helpers which provide useful functionality for the implementation of Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/TopicMetadata.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/TopicMetadata.html new file mode 100644 index 000000000000..50021cbfc23f --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/TopicMetadata.html @@ -0,0 +1,92 @@ + + + + +Uses of Interface org.apache.pulsar.client.api.TopicMetadata (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    org.apache.pulsar.client.api.TopicMetadata

    +
    +
    Packages that use TopicMetadata
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/TransactionIsolationLevel.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/TransactionIsolationLevel.html new file mode 100644 index 000000000000..e3584a775aca --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/TransactionIsolationLevel.html @@ -0,0 +1,97 @@ + + + + +Uses of Enum Class org.apache.pulsar.client.api.TransactionIsolationLevel (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Enum Class
    org.apache.pulsar.client.api.TransactionIsolationLevel

    +
    +
    Packages that use TransactionIsolationLevel
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/TypedMessageBuilder.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/TypedMessageBuilder.html new file mode 100644 index 000000000000..2a905f8a9ac7 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/class-use/TypedMessageBuilder.html @@ -0,0 +1,169 @@ + + + + +Uses of Interface org.apache.pulsar.client.api.TypedMessageBuilder (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    org.apache.pulsar.client.api.TypedMessageBuilder

    +
    +
    Packages that use TypedMessageBuilder
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/interceptor/ProducerInterceptor.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/interceptor/ProducerInterceptor.html new file mode 100644 index 000000000000..3ae5618112aa --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/interceptor/ProducerInterceptor.html @@ -0,0 +1,283 @@ + + + + +ProducerInterceptor (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api.interceptor
    +

    Interface ProducerInterceptor

    +
    +
    +
    +
    All Superinterfaces:
    +
    AutoCloseable
    +
    +
    +
    All Known Implementing Classes:
    +
    ProducerInterceptorWrapper
    +
    +
    +
    @Public +@Stable +public interface ProducerInterceptor +extends AutoCloseable
    +
    A plugin interface that allows you to intercept (and possibly mutate) the + messages received by the producer before they are published to the Pulsar + brokers. + +

    Exceptions thrown by ProducerInterceptor methods will be caught, logged, but + not propagated further. + +

    ProducerInterceptor callbacks may be called from multiple threads. Interceptor + implementation must ensure thread-safety, if needed. + +

    Since the producer may run multiple interceptors, a particular + interceptor will be called in the order specified by + ProducerBuilder.intercept(ProducerInterceptor...).

    +
    +
    + +
    +
    +
      + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        close

        +
        void close()
        +
        Close the interceptor.
        +
        +
        Specified by:
        +
        close in interface AutoCloseable
        +
        +
        +
        • +
      • +
        +

        eligible

        +
        boolean eligible(Message message)
        +
        Check whether the interceptor is eligible for this message.
        +
        +
        Parameters:
        +
        message - message to send
        +
        Returns:
        +
        whether the interceptor can be applied to this particular message.
        +
        +
        +
        • +
      • +
        +

        beforeSend

        +
        Message beforeSend(Producer producer, + Message message)
        +
        This is called from Producer.send(Object) and Producer.sendAsync(Object) methods, before + send the message to the brokers. This method is allowed to modify the + record, in which case, the new record + will be returned. + +

        Any exception thrown by this method will be caught by the caller and + logged, but not propagated further. + +

        Each interceptor will be passed the message returned by the + last successful executed interceptor or the original message if it is the first one. + Since interceptors are allowed to modify messages, + interceptors may potentially get the message already modified by other interceptors. + However, building a pipeline of mutable interceptors + that depend on the output of the previous interceptor is discouraged, + because of potential side-effects caused by interceptors potentially + failing to modify the message and throwing an exception.

        +
        +
        Parameters:
        +
        producer - the producer which contains the interceptor.
        +
        message - message to send
        +
        Returns:
        +
        the intercepted message
        +
        +
        +
        • +
      • +
        +

        onSendAcknowledgement

        +
        void onSendAcknowledgement(Producer producer, + Message message, + MessageId msgId, + Throwable exception)
        +
        This method is called when the message sent to the broker has been + acknowledged, or when sending the message fails. + This method is generally called just before the user callback is + called, and in additional cases when an exception on the producer side. + +

        Any exception thrown by this method will be ignored by the caller. + +

        This method will generally execute in the background I/O thread, so the + implementation should be reasonably fast. Otherwise, sending of messages + from other threads could be delayed.

        +
        +
        Parameters:
        +
        producer - the producer which contains the interceptor.
        +
        message - the message that application sends
        +
        msgId - the message id that assigned by the broker; null if send failed.
        +
        exception - the exception on sending messages, null indicates send has succeed.
        +
        +
        +
        • +
      • +
        +

        onPartitionsChange

        +
        default void onPartitionsChange(String topicName, + int partitions)
        +
        This method is called when partitions of the topic (partitioned-topic) changes.
        +
        +
        Parameters:
        +
        topicName - topic name
        +
        partitions - new updated partitions
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/interceptor/ProducerInterceptorWrapper.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/interceptor/ProducerInterceptorWrapper.html new file mode 100644 index 000000000000..08cbf24e6621 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/interceptor/ProducerInterceptorWrapper.html @@ -0,0 +1,316 @@ + + + + +ProducerInterceptorWrapper (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api.interceptor
    +

    Class ProducerInterceptorWrapper

    +
    +
    java.lang.Object +
    org.apache.pulsar.client.api.interceptor.ProducerInterceptorWrapper
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    AutoCloseable, ProducerInterceptor
    +
    +
    +
    @Private +@Stable +public class ProducerInterceptorWrapper +extends Object +implements ProducerInterceptor
    +
    A wrapper for old style producer interceptor.
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        ProducerInterceptorWrapper

        +
        public ProducerInterceptorWrapper(ProducerInterceptor<?> innerInterceptor)
        +
        +
        • +
      +
      +
      • + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        close

        +
        public void close()
        +
        Description copied from interface: ProducerInterceptor
        +
        Close the interceptor.
        +
        +
        Specified by:
        +
        close in interface AutoCloseable
        +
        Specified by:
        +
        close in interface ProducerInterceptor
        +
        +
        +
        • +
      • +
        +

        eligible

        +
        public boolean eligible(Message message)
        +
        Description copied from interface: ProducerInterceptor
        +
        Check whether the interceptor is eligible for this message.
        +
        +
        Specified by:
        +
        eligible in interface ProducerInterceptor
        +
        Parameters:
        +
        message - message to send
        +
        Returns:
        +
        whether the interceptor can be applied to this particular message.
        +
        +
        +
        • +
      • +
        +

        beforeSend

        +
        public Message beforeSend(Producer producer, + Message message)
        +
        Description copied from interface: ProducerInterceptor
        +
        This is called from Producer.send(Object) and Producer.sendAsync(Object) methods, before + send the message to the brokers. This method is allowed to modify the + record, in which case, the new record + will be returned. + +

        Any exception thrown by this method will be caught by the caller and + logged, but not propagated further. + +

        Each interceptor will be passed the message returned by the + last successful executed interceptor or the original message if it is the first one. + Since interceptors are allowed to modify messages, + interceptors may potentially get the message already modified by other interceptors. + However, building a pipeline of mutable interceptors + that depend on the output of the previous interceptor is discouraged, + because of potential side-effects caused by interceptors potentially + failing to modify the message and throwing an exception.

        +
        +
        Specified by:
        +
        beforeSend in interface ProducerInterceptor
        +
        Parameters:
        +
        producer - the producer which contains the interceptor.
        +
        message - message to send
        +
        Returns:
        +
        the intercepted message
        +
        +
        +
        • +
      • +
        +

        onSendAcknowledgement

        +
        public void onSendAcknowledgement(Producer producer, + Message message, + MessageId msgId, + Throwable exception)
        +
        Description copied from interface: ProducerInterceptor
        +
        This method is called when the message sent to the broker has been + acknowledged, or when sending the message fails. + This method is generally called just before the user callback is + called, and in additional cases when an exception on the producer side. + +

        Any exception thrown by this method will be ignored by the caller. + +

        This method will generally execute in the background I/O thread, so the + implementation should be reasonably fast. Otherwise, sending of messages + from other threads could be delayed.

        +
        +
        Specified by:
        +
        onSendAcknowledgement in interface ProducerInterceptor
        +
        Parameters:
        +
        producer - the producer which contains the interceptor.
        +
        message - the message that application sends
        +
        msgId - the message id that assigned by the broker; null if send failed.
        +
        exception - the exception on sending messages, null indicates send has succeed.
        +
        +
        +
        • +
      • +
        +

        onPartitionsChange

        +
        public void onPartitionsChange(String topicName, + int partitions)
        +
        Description copied from interface: ProducerInterceptor
        +
        This method is called when partitions of the topic (partitioned-topic) changes.
        +
        +
        Specified by:
        +
        onPartitionsChange in interface ProducerInterceptor
        +
        Parameters:
        +
        topicName - topic name
        +
        partitions - new updated partitions
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/interceptor/class-use/ProducerInterceptor.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/interceptor/class-use/ProducerInterceptor.html new file mode 100644 index 000000000000..96d627259984 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/interceptor/class-use/ProducerInterceptor.html @@ -0,0 +1,111 @@ + + + + +Uses of Interface org.apache.pulsar.client.api.interceptor.ProducerInterceptor (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    org.apache.pulsar.client.api.interceptor.ProducerInterceptor

    +
    +
    Packages that use ProducerInterceptor
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    org.apache.pulsar.client.api.interceptor
    +
    +
    Pulsar interceptors.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/interceptor/class-use/ProducerInterceptorWrapper.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/interceptor/class-use/ProducerInterceptorWrapper.html new file mode 100644 index 000000000000..dfe9e81691aa --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/interceptor/class-use/ProducerInterceptorWrapper.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.client.api.interceptor.ProducerInterceptorWrapper (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.apache.pulsar.client.api.interceptor.ProducerInterceptorWrapper

    +
    +No usage of org.apache.pulsar.client.api.interceptor.ProducerInterceptorWrapper
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/interceptor/package-summary.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/interceptor/package-summary.html new file mode 100644 index 000000000000..43b9106b9948 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/interceptor/package-summary.html @@ -0,0 +1,130 @@ + + + + +org.apache.pulsar.client.api.interceptor (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package org.apache.pulsar.client.api.interceptor

    +
    +
    +
    package org.apache.pulsar.client.api.interceptor
    +
    +
    Pulsar interceptors.
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/interceptor/package-tree.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/interceptor/package-tree.html new file mode 100644 index 000000000000..db3342c6efc2 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/interceptor/package-tree.html @@ -0,0 +1,86 @@ + + + + +org.apache.pulsar.client.api.interceptor Class Hierarchy (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package org.apache.pulsar.client.api.interceptor

    +
    +Package Hierarchies: + +
    +

    Class Hierarchy

    + +
    +
    +

    Interface Hierarchy

    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/interceptor/package-use.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/interceptor/package-use.html new file mode 100644 index 000000000000..1ec7700199ee --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/interceptor/package-use.html @@ -0,0 +1,109 @@ + + + + +Uses of Package org.apache.pulsar.client.api.interceptor (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Package
    org.apache.pulsar.client.api.interceptor

    +
    +
    Packages that use org.apache.pulsar.client.api.interceptor
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    org.apache.pulsar.client.api.interceptor
    +
    +
    Pulsar interceptors.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/package-summary.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/package-summary.html new file mode 100644 index 000000000000..76390d26d81c --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/package-summary.html @@ -0,0 +1,577 @@ + + + + +org.apache.pulsar.client.api (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package org.apache.pulsar.client.api

    +
    +
    +
    package org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/package-tree.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/package-tree.html new file mode 100644 index 000000000000..a8da232e821f --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/package-tree.html @@ -0,0 +1,278 @@ + + + + +org.apache.pulsar.client.api Class Hierarchy (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package org.apache.pulsar.client.api

    +
    +Package Hierarchies: + +
    +

    Class Hierarchy

    + +
    +
    +

    Interface Hierarchy

    + +
    +
    +

    Enum Class Hierarchy

    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/package-use.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/package-use.html new file mode 100644 index 000000000000..be3141209aad --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/package-use.html @@ -0,0 +1,500 @@ + + + + +Uses of Package org.apache.pulsar.client.api (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Package
    org.apache.pulsar.client.api

    +
    +
    Packages that use org.apache.pulsar.client.api
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    org.apache.pulsar.client.api.interceptor
    +
    +
    Pulsar interceptors.
    +
    +
    org.apache.pulsar.client.api.schema
    +
    +
    Schema definitions for Pulsar Client API.
    +
    +
    org.apache.pulsar.client.internal
    +
    +
    Helpers which provide useful functionality for the implementation of Pulsar Client API.
    +
    +
    org.apache.pulsar.common.schema
    +
    +
    This package contains data structures for schema definitions used in the Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/Field.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/Field.html new file mode 100644 index 000000000000..f826e465cacb --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/Field.html @@ -0,0 +1,154 @@ + + + + +Field (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api.schema
    +

    Class Field

    +
    +
    java.lang.Object +
    org.apache.pulsar.client.api.schema.Field
    +
    +
    +
    +
    @Public +@Stable +public class Field +extends Object
    +
    A field in a record, consisting of a field name, index, and + Schema for the field value.
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        Field

        +
        public Field()
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/FieldSchemaBuilder.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/FieldSchemaBuilder.html new file mode 100644 index 000000000000..6d711e19caca --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/FieldSchemaBuilder.html @@ -0,0 +1,264 @@ + + + + +FieldSchemaBuilder (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api.schema
    +

    Interface FieldSchemaBuilder<T extends FieldSchemaBuilder<T>>

    +
    +
    +
    +
    @Public +@Stable +public interface FieldSchemaBuilder<T extends FieldSchemaBuilder<T>>
    +
    Build a field for a record.
    +
    +
    +
      + +
    • +
      +

      Method Summary

      +
      +
      +
      +
      +
      Modifier and Type
      +
      Method
      +
      Description
      +
      T
      +
      aliases(String... aliases)
      +
      +
      The optional name aliases of this field.
      +
      +
      T
      +
      defaultValue(Object value)
      +
      +
      Set the default value of this field.
      +
      +
      T
      +
      doc(String doc)
      +
      +
      The documentation of this field.
      +
      +
      T
      +
      optional()
      +
      +
      Make this field optional.
      +
      +
      T
      +
      property(String name, + String val)
      +
      +
      Set name-value pair properties for this field.
      +
      +
      T
      +
      required()
      +
      +
      Make this field required.
      +
      +
      T
      +
      type(SchemaType type)
      +
      +
      The type of this field.
      +
      +
      +
      +
      +
      +
      • +
    +
    +
    +
      + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        property

        +
        T property(String name, + String val)
        +
        Set name-value pair properties for this field.
        +
        +
        Parameters:
        +
        name - name of the property
        +
        val - value of the property
        +
        Returns:
        +
        field schema builder
        +
        +
        +
        • +
      • +
        +

        doc

        +
        T doc(String doc)
        +
        The documentation of this field.
        +
        +
        Parameters:
        +
        doc - documentation
        +
        Returns:
        +
        field schema builder
        +
        +
        +
        • +
      • +
        +

        aliases

        +
        T aliases(String... aliases)
        +
        The optional name aliases of this field.
        +
        +
        Parameters:
        +
        aliases - the name aliases of this field
        +
        Returns:
        +
        field schema builder
        +
        +
        +
        • +
      • +
        +

        type

        +
        T type(SchemaType type)
        +
        The type of this field. + +

        Currently only primitive types are supported.

        +
        +
        Parameters:
        +
        type - schema type of this field
        +
        Returns:
        +
        field schema builder
        +
        +
        +
        • +
      • +
        +

        optional

        +
        T optional()
        +
        Make this field optional.
        +
        +
        Returns:
        +
        field schema builder
        +
        +
        +
        • +
      • +
        +

        required

        +
        T required()
        +
        Make this field required.
        +
        +
        Returns:
        +
        field schema builder
        +
        +
        +
        • +
      • +
        +

        defaultValue

        +
        T defaultValue(Object value)
        +
        Set the default value of this field. + +

        The value is validated against the schema type.

        +
        +
        Returns:
        +
        value
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/GenericObject.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/GenericObject.html new file mode 100644 index 000000000000..c240714b6228 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/GenericObject.html @@ -0,0 +1,188 @@ + + + + +GenericObject (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api.schema
    +

    Interface GenericObject

    +
    +
    +
    +
    All Known Subinterfaces:
    +
    GenericRecord
    +
    +
    +
    public interface GenericObject
    +
    This is an abstraction over the logical value that is store into a Message. + Pulsar decodes the payload of the Message using the Schema that is configured for the topic.
    +
    +
    +
      + +
    • +
      +

      Method Summary

      +
      +
      +
      +
      +
      Modifier and Type
      +
      Method
      +
      Description
      +
      Object
      +
      getNativeObject()
      +
      +
      Return the internal native representation of the Object, + like a AVRO GenericRecord, a String or a byte[].
      +
      +
      SchemaType
      +
      getSchemaType()
      +
      +
      Return the schema tyoe.
      +
      +
      +
      +
      +
      +
      • +
    +
    +
    + +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/GenericRecord.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/GenericRecord.html new file mode 100644 index 000000000000..ec944a50f924 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/GenericRecord.html @@ -0,0 +1,260 @@ + + + + +GenericRecord (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api.schema
    +

    Interface GenericRecord

    +
    +
    +
    +
    All Superinterfaces:
    +
    GenericObject
    +
    +
    +
    @Public +@Stable +public interface GenericRecord +extends GenericObject
    +
    An interface represents a message with schema.
    +
    +
    +
      + +
    • +
      +

      Method Summary

      +
      +
      +
      +
      +
      Modifier and Type
      +
      Method
      +
      Description
      +
      Object
      +
      getField(String fieldName)
      +
      +
      Retrieve the value of the provided fieldName.
      +
      +
      default Object
      +
      getField(Field field)
      +
      +
      Retrieve the value of the provided field.
      +
      +
      List<Field>
      +
      getFields()
      +
      +
      Returns the list of fields associated with the record.
      +
      +
      default Object
      +
      getNativeObject()
      +
      +
      Return the internal native representation of the Record, + like a AVRO GenericRecord.
      +
      +
      default SchemaType
      +
      getSchemaType()
      +
      +
      Return the schema tyoe.
      +
      +
      byte[]
      +
      getSchemaVersion()
      +
      +
      Return schema version.
      +
      +
      +
      +
      +
      +
      • +
    +
    +
    +
      + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        getSchemaVersion

        +
        byte[] getSchemaVersion()
        +
        Return schema version.
        +
        +
        Returns:
        +
        schema version, or null if the information is not available.
        +
        +
        +
        • +
      • +
        +

        getFields

        +
        List<Field> getFields()
        +
        Returns the list of fields associated with the record.
        +
        +
        Returns:
        +
        the list of fields associated with the record.
        +
        +
        +
        • +
      • +
        +

        getField

        +
        default Object getField(Field field)
        +
        Retrieve the value of the provided field.
        +
        +
        Parameters:
        +
        field - the field to retrieve the value
        +
        Returns:
        +
        the value object
        +
        +
        +
        • +
      • +
        +

        getField

        +
        Object getField(String fieldName)
        +
        Retrieve the value of the provided fieldName.
        +
        +
        Parameters:
        +
        fieldName - the field name
        +
        Returns:
        +
        the value object, or null if field doesn't exist
        +
        +
        +
        • +
      • +
        +

        getSchemaType

        +
        default SchemaType getSchemaType()
        +
        Return the schema tyoe.
        +
        +
        Specified by:
        +
        getSchemaType in interface GenericObject
        +
        Returns:
        +
        the schema type
        +
        Throws:
        +
        UnsupportedOperationException - if this feature is not implemented
        +
        See Also:
        +
        + +
        +
        +
        +
        • +
      • +
        +

        getNativeObject

        +
        default Object getNativeObject()
        +
        Return the internal native representation of the Record, + like a AVRO GenericRecord.
        +
        +
        Specified by:
        +
        getNativeObject in interface GenericObject
        +
        Returns:
        +
        the internal representation of the record
        +
        Throws:
        +
        UnsupportedOperationException - if the operation is not supported
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/GenericRecordBuilder.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/GenericRecordBuilder.html new file mode 100644 index 000000000000..21f5f2a4095b --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/GenericRecordBuilder.html @@ -0,0 +1,231 @@ + + + + +GenericRecordBuilder (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api.schema
    +

    Interface GenericRecordBuilder

    +
    +
    +
    +
    @Public +@Stable +public interface GenericRecordBuilder
    +
    Generic Record Builder to build a GenericRecord.
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        set

        +
        GenericRecordBuilder set(String fieldName, + Object value)
        +
        Sets the value of a field.
        +
        +
        Parameters:
        +
        fieldName - the name of the field to set.
        +
        value - the value to set.
        +
        Returns:
        +
        a reference to the RecordBuilder.
        +
        +
        +
        • +
      • +
        +

        set

        +
        GenericRecordBuilder set(Field field, + Object value)
        +
        Sets the value of a field.
        +
        +
        Parameters:
        +
        field - the field to set.
        +
        value - the value to set.
        +
        Returns:
        +
        a reference to the RecordBuilder.
        +
        +
        +
        • +
      • +
        +

        clear

        +
        GenericRecordBuilder clear(String fieldName)
        +
        Clears the value of the given field.
        +
        +
        Parameters:
        +
        fieldName - the name of the field to clear.
        +
        Returns:
        +
        a reference to the RecordBuilder.
        +
        +
        +
        • +
      • +
        +

        clear

        +
        GenericRecordBuilder clear(Field field)
        +
        Clears the value of the given field.
        +
        +
        Parameters:
        +
        field - the field to clear.
        +
        Returns:
        +
        a reference to the RecordBuilder.
        +
        +
        +
        • +
      • +
        +

        build

        +
        GenericRecord build()
        +
        Build a generic record.
        +
        +
        Returns:
        +
        a generic record.
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/GenericSchema.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/GenericSchema.html new file mode 100644 index 000000000000..1374660f4b35 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/GenericSchema.html @@ -0,0 +1,206 @@ + + + + +GenericSchema (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api.schema
    +

    Interface GenericSchema<T extends GenericRecord>

    +
    +
    +
    +
    All Superinterfaces:
    +
    Cloneable, Schema<T>
    +
    +
    +
    @Public +@Stable +public interface GenericSchema<T extends GenericRecord> +extends Schema<T>
    +
    A schema that serializes and deserializes between GenericRecord and bytes.
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        getFields

        +
        List<Field> getFields()
        +
        Returns the list of fields.
        +
        +
        Returns:
        +
        the list of fields of generic record.
        +
        +
        +
        • +
      • +
        +

        newRecordBuilder

        +
        GenericRecordBuilder newRecordBuilder()
        +
        Create a builder to build GenericRecord.
        +
        +
        Returns:
        +
        generic record builder
        +
        +
        +
        • +
      • +
        +

        of

        +
        static GenericSchema of(SchemaInfo schemaInfo)
        +
        +
        • +
      • +
        +

        of

        +
        static GenericSchema of(SchemaInfo schemaInfo, + boolean useProvidedSchemaAsReaderSchema)
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/KeyValueSchema.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/KeyValueSchema.html new file mode 100644 index 000000000000..13c6ed43d3d4 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/KeyValueSchema.html @@ -0,0 +1,213 @@ + + + + +KeyValueSchema (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api.schema
    +

    Interface KeyValueSchema<K,V>

    +
    +
    +
    +
    Type Parameters:
    +
    K - the type of the Key
    +
    V - the type of the Value.
    +
    +
    +
    All Superinterfaces:
    +
    Cloneable, Schema<KeyValue<K,V>>
    +
    +
    +
    public interface KeyValueSchema<K,V> +extends Schema<KeyValue<K,V>>
    +
    This interface models a Schema that is composed of two parts. + A Key and a Value.
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        getKeySchema

        +
        Schema<K> getKeySchema()
        +
        Get the Schema of the Key.
        +
        +
        Returns:
        +
        the Schema of the Key
        +
        +
        +
        • +
      • +
        +

        getValueSchema

        +
        Schema<V> getValueSchema()
        +
        Get the Schema of the Value.
        +
        +
        Returns:
        +
        the Schema of the Value
        +
        +
        +
        • +
      • +
        +

        getKeyValueEncodingType

        +
        KeyValueEncodingType getKeyValueEncodingType()
        +
        Get the KeyValueEncodingType.
        +
        +
        Returns:
        +
        the KeyValueEncodingType
        +
        See Also:
        +
        + +
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/RecordSchemaBuilder.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/RecordSchemaBuilder.html new file mode 100644 index 000000000000..e994fd20d866 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/RecordSchemaBuilder.html @@ -0,0 +1,231 @@ + + + + +RecordSchemaBuilder (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api.schema
    +

    Interface RecordSchemaBuilder

    +
    +
    +
    +
    @Public +@Stable +public interface RecordSchemaBuilder
    +
    Building the schema for a GenericRecord.
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        property

        +
        RecordSchemaBuilder property(String name, + String val)
        +
        Attach val-name property pair to the record schema.
        +
        +
        Parameters:
        +
        name - property name
        +
        val - property value
        +
        Returns:
        +
        record schema builder
        +
        +
        +
        • +
      • +
        +

        field

        +
        FieldSchemaBuilder field(String fieldName)
        +
        Add a field with the given name to the record.
        +
        +
        Parameters:
        +
        fieldName - name of the field
        +
        Returns:
        +
        field schema builder to build the field.
        +
        +
        +
        • +
      • +
        +

        field

        +
        FieldSchemaBuilder field(String fieldName, + GenericSchema genericSchema)
        +
        Add a field with the given name and genericSchema to the record.
        +
        +
        Parameters:
        +
        fieldName - name of the field
        +
        genericSchema - schema of the field
        +
        Returns:
        +
        field schema builder to build the field.
        +
        +
        +
        • +
      • +
        +

        doc

        +
        RecordSchemaBuilder doc(String doc)
        +
        Add doc to the record schema.
        +
        +
        Parameters:
        +
        doc - documentation
        +
        Returns:
        +
        field schema builder
        +
        +
        +
        • +
      • +
        +

        build

        +
        SchemaInfo build(SchemaType schemaType)
        +
        Build the schema info.
        +
        +
        Returns:
        +
        the schema info.
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/SchemaBuilder.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/SchemaBuilder.html new file mode 100644 index 000000000000..9f1fbb2c0e21 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/SchemaBuilder.html @@ -0,0 +1,153 @@ + + + + +SchemaBuilder (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api.schema
    +

    Interface SchemaBuilder

    +
    +
    +
    +
    @Public +@Stable +public interface SchemaBuilder
    +
    Builder to build schema.
    +
    +
    +
      + +
    • +
      +

      Method Summary

      +
      +
      Static Methods
      +
      +
      Modifier and Type
      +
      Method
      +
      Description
      +
      static RecordSchemaBuilder
      +
      record(String name)
      +
      +
      Build the schema for a record.
      +
      +
      +
      +
      +
      • +
    +
    +
    +
      + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        record

        +
        static RecordSchemaBuilder record(String name)
        +
        Build the schema for a record.
        +
        +
        Parameters:
        +
        name - name of the record.
        +
        Returns:
        +
        builder to build the schema for a record.
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/SchemaDefinition.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/SchemaDefinition.html new file mode 100644 index 000000000000..8db88efc4900 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/SchemaDefinition.html @@ -0,0 +1,297 @@ + + + + +SchemaDefinition (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api.schema
    +

    Interface SchemaDefinition<T>

    +
    +
    +
    +
    @Public +@Stable +public interface SchemaDefinition<T>
    +
    Interface for schema definition.
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        builder

        +
        static <T> SchemaDefinitionBuilder<T> builder()
        +
        Get a new builder instance that can used to configure and build a SchemaDefinition instance.
        +
        +
        Returns:
        +
        the SchemaDefinition
        +
        +
        +
        • +
      • +
        +

        getAlwaysAllowNull

        +
        boolean getAlwaysAllowNull()
        +
        Get schema whether always allow null or not.
        +
        +
        Returns:
        +
        schema always null or not
        +
        +
        +
        • +
      • +
        +

        isJsr310ConversionEnabled

        +
        boolean isJsr310ConversionEnabled()
        +
        Get JSR310 conversion enabled.
        +
        +
        Returns:
        +
        return true if enable JSR310 conversion. false means use Joda time conversion.
        +
        +
        +
        • +
      • +
        +

        getProperties

        +
        Map<String,String> getProperties()
        +
        Get schema class.
        +
        +
        Returns:
        +
        schema class
        +
        +
        +
        • +
      • +
        +

        getJsonDef

        +
        String getJsonDef()
        +
        Get json schema definition.
        +
        +
        Returns:
        +
        schema class
        +
        +
        +
        • +
      • +
        +

        getPojo

        +
        Class<T> getPojo()
        +
        Get pojo schema definition.
        +
        +
        Returns:
        +
        pojo schema
        +
        +
        +
        • +
      • +
        +

        getClassLoader

        +
        ClassLoader getClassLoader()
        +
        Get pojo classLoader.
        +
        +
        Returns:
        +
        pojo schema
        +
        +
        +
        • +
      • +
        +

        getSupportSchemaVersioning

        +
        boolean getSupportSchemaVersioning()
        +
        Get supportSchemaVersioning schema definition.
        +
        +
        Returns:
        +
        the flag of supportSchemaVersioning
        +
        +
        +
        • +
      • +
        +

        getSchemaReaderOpt

        +
        Optional<SchemaReader<T>> getSchemaReaderOpt()
        +
        Get a configured schema reader.
        +
        +
        Returns:
        +
        optional containing configured schema reader or empty optional if none is configure
        +
        +
        +
        • +
      • +
        +

        getSchemaWriterOpt

        +
        Optional<SchemaWriter<T>> getSchemaWriterOpt()
        +
        Get a configured schema writer.
        +
        +
        Returns:
        +
        optional containing configured schema writer or empty optional if none is configure
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/SchemaDefinitionBuilder.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/SchemaDefinitionBuilder.html new file mode 100644 index 000000000000..e21fd890d95e --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/SchemaDefinitionBuilder.html @@ -0,0 +1,344 @@ + + + + +SchemaDefinitionBuilder (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api.schema
    +

    Interface SchemaDefinitionBuilder<T>

    +
    +
    +
    +
    @Public +@Stable +public interface SchemaDefinitionBuilder<T>
    +
    Builder to build schema definition SchemaDefinition.
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        withAlwaysAllowNull

        +
        SchemaDefinitionBuilder<T> withAlwaysAllowNull(boolean alwaysAllowNull)
        +
        Set schema whether always allow null or not.
        +
        +
        Parameters:
        +
        alwaysAllowNull - definition null or not
        +
        Returns:
        +
        schema definition builder
        +
        +
        +
        • +
      • +
        +

        withJSR310ConversionEnabled

        +
        SchemaDefinitionBuilder<T> withJSR310ConversionEnabled(boolean jsr310ConversionEnabled)
        +
        Set schema use JRS310 conversion or not. + +

        Before Avro 1.9 the Joda time library was used for handling the logical date(time) values. + But since the introduction of Java8 the Java Specification Request (JSR) 310 has been included, + which greatly improves the handling of date and time natively. To keep forwarding compatibility, + default is use Joda time conversion. + +

        JSR310 conversion is recommended here. Joda time conversion is has been marked deprecated. + In future versions, joda time conversion may be removed

        +
        +
        Parameters:
        +
        jsr310ConversionEnabled - use JRS310 conversion or not, default is false for keep forwarding compatibility
        +
        Returns:
        +
        schema definition builder
        +
        +
        +
        • +
      • +
        +

        withProperties

        +
        SchemaDefinitionBuilder<T> withProperties(Map<String,String> properties)
        +
        Set schema info properties.
        +
        +
        Parameters:
        +
        properties - schema info properties
        +
        Returns:
        +
        schema definition builder
        +
        +
        +
        • +
      • +
        +

        addProperty

        +
        SchemaDefinitionBuilder<T> addProperty(String key, + String value)
        +
        Set schema info properties.
        +
        +
        Parameters:
        +
        key - property key
        +
        value - property value
        +
        Returns:
        +
        schema definition builder
        +
        +
        +
        • +
      • +
        +

        withPojo

        +
        SchemaDefinitionBuilder<T> withPojo(Class pojo)
        +
        Set schema of pojo definition.
        +
        +
        Parameters:
        +
        pojo - pojo schema definition
        +
        Returns:
        +
        schema definition builder
        +
        +
        +
        • +
      • +
        +

        withClassLoader

        +
        SchemaDefinitionBuilder<T> withClassLoader(ClassLoader classLoader)
        +
        Set schema of pojo classLoader.
        +
        +
        Parameters:
        +
        classLoader - pojo classLoader
        +
        Returns:
        +
        schema definition builder
        +
        +
        +
        • +
      • +
        +

        withJsonDef

        +
        SchemaDefinitionBuilder<T> withJsonDef(String jsonDefinition)
        +
        Set schema of json definition.
        +
        +
        Parameters:
        +
        jsonDefinition - json schema definition
        +
        Returns:
        +
        schema definition builder
        +
        +
        +
        • +
      • +
        +

        withSupportSchemaVersioning

        +
        SchemaDefinitionBuilder<T> withSupportSchemaVersioning(boolean supportSchemaVersioning)
        +
        Set schema whether decode by schema version.
        +
        +
        Parameters:
        +
        supportSchemaVersioning - decode by version
        +
        Returns:
        +
        schema definition builder
        +
        +
        +
        • +
      • +
        +

        withSchemaReader

        +
        SchemaDefinitionBuilder<T> withSchemaReader(SchemaReader<T> reader)
        +
        Set schema reader for deserialization of object data.
        +
        +
        Parameters:
        +
        reader - reader for object data
        +
        Returns:
        +
        schema definition builder
        +
        +
        +
        • +
      • +
        +

        withSchemaWriter

        +
        SchemaDefinitionBuilder<T> withSchemaWriter(SchemaWriter<T> writer)
        +
        Set schema writer for serialization of objects.
        +
        +
        Parameters:
        +
        writer - writer for objects
        +
        Returns:
        +
        schema definition builder
        +
        +
        +
        • +
      • +
        +

        build

        +
        SchemaDefinition<T> build()
        +
        Build the schema definition.
        +
        +
        Returns:
        +
        the schema definition.
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/SchemaInfoProvider.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/SchemaInfoProvider.html new file mode 100644 index 000000000000..3cb715c45ff9 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/SchemaInfoProvider.html @@ -0,0 +1,187 @@ + + + + +SchemaInfoProvider (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api.schema
    +

    Interface SchemaInfoProvider

    +
    +
    +
    +
    @Private +@Stable +public interface SchemaInfoProvider
    +
    Schema Provider.
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        getSchemaByVersion

        +
        CompletableFuture<SchemaInfo> getSchemaByVersion(byte[] schemaVersion)
        +
        Retrieve the schema info of a given schemaVersion.
        +
        +
        Parameters:
        +
        schemaVersion - schema version
        +
        Returns:
        +
        schema info of the provided schemaVersion
        +
        +
        +
        • +
      • +
        +

        getLatestSchema

        +
        CompletableFuture<SchemaInfo> getLatestSchema()
        +
        Retrieve the latest schema info.
        +
        +
        Returns:
        +
        the latest schema
        +
        +
        +
        • +
      • +
        +

        getTopicName

        +
        String getTopicName()
        +
        Retrieve the topic name.
        +
        +
        Returns:
        +
        the topic name
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/SchemaReader.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/SchemaReader.html new file mode 100644 index 000000000000..fa21fcdc959b --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/SchemaReader.html @@ -0,0 +1,271 @@ + + + + +SchemaReader (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api.schema
    +

    Interface SchemaReader<T>

    +
    +
    +
    +
    @Public +@Stable +public interface SchemaReader<T>
    +
    Deserialize messages from bytes.
    +
    +
    +
      + +
    • +
      +

      Method Summary

      +
      +
      +
      +
      +
      Modifier and Type
      +
      Method
      +
      Description
      +
      default Optional<Object>
      +
      getNativeSchema()
      +
      +
      Returns the underling Schema if possible.
      +
      +
      default T
      +
      read(byte[] bytes)
      +
      +
      Serialize bytes convert pojo.
      +
      +
      default T
      +
      read(byte[] bytes, + byte[] schemaVersion)
      +
      +
      Serialize bytes convert pojo.
      +
      +
      T
      +
      read(byte[] bytes, + int offset, + int length)
      +
      +
      serialize bytes convert pojo.
      +
      +
      T
      +
      read(InputStream inputStream)
      +
      +
      serialize bytes convert pojo.
      +
      +
      default T
      +
      read(InputStream inputStream, + byte[] schemaVersion)
      +
      +
      serialize bytes convert pojo.
      +
      +
      default void
      +
      setSchemaInfoProvider(SchemaInfoProvider schemaInfoProvider)
      +
      +
      Set schema info provider, this method support multi version reader.
      +
      +
      +
      +
      +
      +
      • +
    +
    +
    +
      + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        read

        +
        default T read(byte[] bytes)
        +
        Serialize bytes convert pojo.
        +
        +
        Parameters:
        +
        bytes - the data
        +
        Returns:
        +
        the serialized object
        +
        +
        +
        • +
      • +
        +

        read

        +
        T read(byte[] bytes, + int offset, + int length)
        +
        serialize bytes convert pojo.
        +
        +
        Parameters:
        +
        bytes - the data
        +
        offset - the byte[] initial position
        +
        length - the byte[] read length
        +
        Returns:
        +
        the serialized object
        +
        +
        +
        • +
      • +
        +

        read

        +
        T read(InputStream inputStream)
        +
        serialize bytes convert pojo.
        +
        +
        Parameters:
        +
        inputStream - the stream of message
        +
        Returns:
        +
        the serialized object
        +
        +
        +
        • +
      • +
        +

        read

        +
        default T read(byte[] bytes, + byte[] schemaVersion)
        +
        Serialize bytes convert pojo.
        +
        +
        Parameters:
        +
        bytes - the data
        +
        schemaVersion - the schema version of message
        +
        Returns:
        +
        the serialized object
        +
        +
        +
        • +
      • +
        +

        read

        +
        default T read(InputStream inputStream, + byte[] schemaVersion)
        +
        serialize bytes convert pojo.
        +
        +
        Parameters:
        +
        inputStream - the stream of message
        +
        schemaVersion - the schema version of message
        +
        Returns:
        +
        the serialized object
        +
        +
        +
        • +
      • +
        +

        setSchemaInfoProvider

        +
        default void setSchemaInfoProvider(SchemaInfoProvider schemaInfoProvider)
        +
        Set schema info provider, this method support multi version reader.
        +
        +
        Parameters:
        +
        schemaInfoProvider - the stream of message
        +
        +
        +
        • +
      • +
        +

        getNativeSchema

        +
        default Optional<Object> getNativeSchema()
        +
        Returns the underling Schema if possible.
        +
        +
        Returns:
        +
        the schema, or an empty Optional if it is not possible to access it
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/SchemaWriter.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/SchemaWriter.html new file mode 100644 index 000000000000..9dc369cca829 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/SchemaWriter.html @@ -0,0 +1,160 @@ + + + + +SchemaWriter (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api.schema
    +

    Interface SchemaWriter<T>

    +
    +
    +
    +
    Functional Interface:
    +
    This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
    +
    +
    +
    @Public +@Stable +@FunctionalInterface +public interface SchemaWriter<T>
    +
    Serialize messages into bytes.
    +
    +
    +
      + +
    • +
      +

      Method Summary

      +
      +
      +
      +
      +
      Modifier and Type
      +
      Method
      +
      Description
      +
      byte[]
      +
      write(T message)
      +
      +
      Serialize the message into bytes.
      +
      +
      +
      +
      +
      +
      • +
    +
    +
    +
      + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        write

        +
        byte[] write(T message)
        +
        Serialize the message into bytes.
        +
        +
        Parameters:
        +
        message - the message for encode
        +
        Returns:
        +
        the serialized bytes
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/class-use/Field.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/class-use/Field.html new file mode 100644 index 000000000000..874131f015a7 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/class-use/Field.html @@ -0,0 +1,118 @@ + + + + +Uses of Class org.apache.pulsar.client.api.schema.Field (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.apache.pulsar.client.api.schema.Field

    +
    +
    Packages that use Field
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api.schema
    +
    +
    Schema definitions for Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/class-use/FieldSchemaBuilder.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/class-use/FieldSchemaBuilder.html new file mode 100644 index 000000000000..ff932dc79d7c --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/class-use/FieldSchemaBuilder.html @@ -0,0 +1,108 @@ + + + + +Uses of Interface org.apache.pulsar.client.api.schema.FieldSchemaBuilder (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    org.apache.pulsar.client.api.schema.FieldSchemaBuilder

    +
    +
    Packages that use FieldSchemaBuilder
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api.schema
    +
    +
    Schema definitions for Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/class-use/GenericObject.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/class-use/GenericObject.html new file mode 100644 index 000000000000..23b3de901868 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/class-use/GenericObject.html @@ -0,0 +1,91 @@ + + + + +Uses of Interface org.apache.pulsar.client.api.schema.GenericObject (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    org.apache.pulsar.client.api.schema.GenericObject

    +
    +
    Packages that use GenericObject
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api.schema
    +
    +
    Schema definitions for Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/class-use/GenericRecord.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/class-use/GenericRecord.html new file mode 100644 index 000000000000..1e98fa577863 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/class-use/GenericRecord.html @@ -0,0 +1,154 @@ + + + + +Uses of Interface org.apache.pulsar.client.api.schema.GenericRecord (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    org.apache.pulsar.client.api.schema.GenericRecord

    +
    +
    Packages that use GenericRecord
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    org.apache.pulsar.client.api.schema
    +
    +
    Schema definitions for Pulsar Client API.
    +
    +
    org.apache.pulsar.client.internal
    +
    +
    Helpers which provide useful functionality for the implementation of Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/class-use/GenericRecordBuilder.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/class-use/GenericRecordBuilder.html new file mode 100644 index 000000000000..b0bc3328dde9 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/class-use/GenericRecordBuilder.html @@ -0,0 +1,113 @@ + + + + +Uses of Interface org.apache.pulsar.client.api.schema.GenericRecordBuilder (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    org.apache.pulsar.client.api.schema.GenericRecordBuilder

    +
    +
    Packages that use GenericRecordBuilder
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api.schema
    +
    +
    Schema definitions for Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/class-use/GenericSchema.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/class-use/GenericSchema.html new file mode 100644 index 000000000000..cdaf990484cb --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/class-use/GenericSchema.html @@ -0,0 +1,143 @@ + + + + +Uses of Interface org.apache.pulsar.client.api.schema.GenericSchema (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    org.apache.pulsar.client.api.schema.GenericSchema

    +
    +
    Packages that use GenericSchema
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    org.apache.pulsar.client.api.schema
    +
    +
    Schema definitions for Pulsar Client API.
    +
    +
    org.apache.pulsar.client.internal
    +
    +
    Helpers which provide useful functionality for the implementation of Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/class-use/KeyValueSchema.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/class-use/KeyValueSchema.html new file mode 100644 index 000000000000..9aab4996d9ee --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/class-use/KeyValueSchema.html @@ -0,0 +1,62 @@ + + + + +Uses of Interface org.apache.pulsar.client.api.schema.KeyValueSchema (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    org.apache.pulsar.client.api.schema.KeyValueSchema

    +
    +No usage of org.apache.pulsar.client.api.schema.KeyValueSchema
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/class-use/RecordSchemaBuilder.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/class-use/RecordSchemaBuilder.html new file mode 100644 index 000000000000..07d592e5cd9e --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/class-use/RecordSchemaBuilder.html @@ -0,0 +1,120 @@ + + + + +Uses of Interface org.apache.pulsar.client.api.schema.RecordSchemaBuilder (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    org.apache.pulsar.client.api.schema.RecordSchemaBuilder

    +
    +
    Packages that use RecordSchemaBuilder
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api.schema
    +
    +
    Schema definitions for Pulsar Client API.
    +
    +
    org.apache.pulsar.client.internal
    +
    +
    Helpers which provide useful functionality for the implementation of Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/class-use/SchemaBuilder.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/class-use/SchemaBuilder.html new file mode 100644 index 000000000000..bed93995f513 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/class-use/SchemaBuilder.html @@ -0,0 +1,62 @@ + + + + +Uses of Interface org.apache.pulsar.client.api.schema.SchemaBuilder (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    org.apache.pulsar.client.api.schema.SchemaBuilder

    +
    +No usage of org.apache.pulsar.client.api.schema.SchemaBuilder
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/class-use/SchemaDefinition.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/class-use/SchemaDefinition.html new file mode 100644 index 000000000000..aa8a2edbaf79 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/class-use/SchemaDefinition.html @@ -0,0 +1,153 @@ + + + + +Uses of Interface org.apache.pulsar.client.api.schema.SchemaDefinition (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    org.apache.pulsar.client.api.schema.SchemaDefinition

    +
    +
    Packages that use SchemaDefinition
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    org.apache.pulsar.client.api.schema
    +
    +
    Schema definitions for Pulsar Client API.
    +
    +
    org.apache.pulsar.client.internal
    +
    +
    Helpers which provide useful functionality for the implementation of Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/class-use/SchemaDefinitionBuilder.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/class-use/SchemaDefinitionBuilder.html new file mode 100644 index 000000000000..605ac1653c24 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/class-use/SchemaDefinitionBuilder.html @@ -0,0 +1,160 @@ + + + + +Uses of Interface org.apache.pulsar.client.api.schema.SchemaDefinitionBuilder (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    org.apache.pulsar.client.api.schema.SchemaDefinitionBuilder

    +
    +
    Packages that use SchemaDefinitionBuilder
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api.schema
    +
    +
    Schema definitions for Pulsar Client API.
    +
    +
    org.apache.pulsar.client.internal
    +
    +
    Helpers which provide useful functionality for the implementation of Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/class-use/SchemaInfoProvider.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/class-use/SchemaInfoProvider.html new file mode 100644 index 000000000000..275b228d926f --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/class-use/SchemaInfoProvider.html @@ -0,0 +1,109 @@ + + + + +Uses of Interface org.apache.pulsar.client.api.schema.SchemaInfoProvider (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    org.apache.pulsar.client.api.schema.SchemaInfoProvider

    +
    +
    Packages that use SchemaInfoProvider
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    org.apache.pulsar.client.api.schema
    +
    +
    Schema definitions for Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/class-use/SchemaReader.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/class-use/SchemaReader.html new file mode 100644 index 000000000000..babe13573ab7 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/class-use/SchemaReader.html @@ -0,0 +1,102 @@ + + + + +Uses of Interface org.apache.pulsar.client.api.schema.SchemaReader (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    org.apache.pulsar.client.api.schema.SchemaReader

    +
    +
    Packages that use SchemaReader
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api.schema
    +
    +
    Schema definitions for Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/class-use/SchemaWriter.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/class-use/SchemaWriter.html new file mode 100644 index 000000000000..4980ec4e55f8 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/class-use/SchemaWriter.html @@ -0,0 +1,102 @@ + + + + +Uses of Interface org.apache.pulsar.client.api.schema.SchemaWriter (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    org.apache.pulsar.client.api.schema.SchemaWriter

    +
    +
    Packages that use SchemaWriter
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api.schema
    +
    +
    Schema definitions for Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/package-summary.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/package-summary.html new file mode 100644 index 000000000000..23d64502252a --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/package-summary.html @@ -0,0 +1,177 @@ + + + + +org.apache.pulsar.client.api.schema (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package org.apache.pulsar.client.api.schema

    +
    +
    +
    package org.apache.pulsar.client.api.schema
    +
    +
    Schema definitions for Pulsar Client API.
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/package-tree.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/package-tree.html new file mode 100644 index 000000000000..84af7b3a99e1 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/package-tree.html @@ -0,0 +1,105 @@ + + + + +org.apache.pulsar.client.api.schema Class Hierarchy (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package org.apache.pulsar.client.api.schema

    +
    +Package Hierarchies: + +
    +

    Class Hierarchy

    +
      +
    • java.lang.Object +
        +
      • org.apache.pulsar.client.api.schema.Field
        • +
      +
      • +
    +
    +
    +

    Interface Hierarchy

    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/package-use.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/package-use.html new file mode 100644 index 000000000000..5741c774d249 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/schema/package-use.html @@ -0,0 +1,195 @@ + + + + +Uses of Package org.apache.pulsar.client.api.schema (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Package
    org.apache.pulsar.client.api.schema

    +
    +
    Packages that use org.apache.pulsar.client.api.schema
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    org.apache.pulsar.client.api.schema
    +
    +
    Schema definitions for Pulsar Client API.
    +
    +
    org.apache.pulsar.client.internal
    +
    +
    Helpers which provide useful functionality for the implementation of Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/Transaction.State.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/Transaction.State.html new file mode 100644 index 000000000000..43c8be617230 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/Transaction.State.html @@ -0,0 +1,315 @@ + + + + +Transaction.State (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api.transaction
    +

    Enum Class Transaction.State

    +
    +
    java.lang.Object +
    java.lang.Enum<Transaction.State> +
    org.apache.pulsar.client.api.transaction.Transaction.State
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable, Comparable<Transaction.State>, Constable
    +
    +
    +
    Enclosing interface:
    +
    Transaction
    +
    +
    +
    public static enum Transaction.State +extends Enum<Transaction.State>
    +
    +
    +
      + +
    • +
      +

      Nested Class Summary

      +
      +

      Nested classes/interfaces inherited from class java.lang.Enum

      +Enum.EnumDesc<E extends Enum<E>>
      +
      +
      • + +
    • +
      +

      Enum Constant Summary

      +
      Enum Constants
      +
      +
      Enum Constant
      +
      Description
      +
      ABORTED
      +
      +
      When a client receives a response to an abort, the transaction state is changed from `ABORTING` to `ABORTED`.
      +
      +
      ABORTING
      +
      +
      When a client invokes an abort, the transaction state is changed from `OPEN` to `ABORTING`.
      +
      +
      COMMITTED
      +
      +
      When a client receives a response to a commit, the transaction state is changed from + `COMMITTING` to `COMMITTED`.
      +
      +
      COMMITTING
      +
      +
      When a client invokes a commit, the transaction state is changed from `OPEN` to `COMMITTING`.
      +
      +
      ERROR
      +
      +
      When a client invokes a commit or an abort, but a transaction does not exist in a coordinator, + then the state is changed to `ERROR`.
      +
      +
      OPEN
      +
      +
      When a transaction is in the `OPEN` state, messages can be produced and acked with this transaction.
      +
      +
      TIME_OUT
      +
      +
      When a transaction is timed out and the transaction state is `OPEN`, + then the transaction state is changed from `OPEN` to `TIME_OUT`.
      +
      +
      +
      +
      • + +
    • +
      +

      Method Summary

      +
      +
      +
      +
      +
      Modifier and Type
      +
      Method
      +
      Description
      +
      static Transaction.State
      +
      valueOf(String name)
      +
      +
      Returns the enum constant of this class with the specified name.
      +
      +
      static Transaction.State[]
      +
      values()
      +
      +
      Returns an array containing the constants of this enum class, in +the order they are declared.
      +
      +
      +
      +
      +
      +

      Methods inherited from class java.lang.Enum

      +clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      +
      +

      Methods inherited from class java.lang.Object

      +getClass, notify, notifyAll, wait, wait, wait
      +
      +
      • +
    +
    +
    +
      + +
    • +
      +

      Enum Constant Details

      +
        +
      • +
        +

        OPEN

        +
        public static final Transaction.State OPEN
        +
        When a transaction is in the `OPEN` state, messages can be produced and acked with this transaction. + + When a transaction is in the `OPEN` state, it can commit or abort.
        +
        +
        • +
      • +
        +

        COMMITTING

        +
        public static final Transaction.State COMMITTING
        +
        When a client invokes a commit, the transaction state is changed from `OPEN` to `COMMITTING`.
        +
        +
        • +
      • +
        +

        ABORTING

        +
        public static final Transaction.State ABORTING
        +
        When a client invokes an abort, the transaction state is changed from `OPEN` to `ABORTING`.
        +
        +
        • +
      • +
        +

        COMMITTED

        +
        public static final Transaction.State COMMITTED
        +
        When a client receives a response to a commit, the transaction state is changed from + `COMMITTING` to `COMMITTED`.
        +
        +
        • +
      • +
        +

        ABORTED

        +
        public static final Transaction.State ABORTED
        +
        When a client receives a response to an abort, the transaction state is changed from `ABORTING` to `ABORTED`.
        +
        +
        • +
      • +
        +

        ERROR

        +
        public static final Transaction.State ERROR
        +
        When a client invokes a commit or an abort, but a transaction does not exist in a coordinator, + then the state is changed to `ERROR`. + + When a client invokes a commit, but the transaction state in a coordinator is `ABORTED` or `ABORTING`, + then the state is changed to `ERROR`. + + When a client invokes an abort, but the transaction state in a coordinator is `COMMITTED` or `COMMITTING`, + then the state is changed to `ERROR`.
        +
        +
        • +
      • +
        +

        TIME_OUT

        +
        public static final Transaction.State TIME_OUT
        +
        When a transaction is timed out and the transaction state is `OPEN`, + then the transaction state is changed from `OPEN` to `TIME_OUT`.
        +
        +
        • +
      +
      +
      • + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        values

        +
        public static Transaction.State[] values()
        +
        Returns an array containing the constants of this enum class, in +the order they are declared.
        +
        +
        Returns:
        +
        an array containing the constants of this enum class, in the order they are declared
        +
        +
        +
        • +
      • +
        +

        valueOf

        +
        public static Transaction.State valueOf(String name)
        +
        Returns the enum constant of this class with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this class. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        IllegalArgumentException - if this enum class has no constant with the specified name
        +
        NullPointerException - if the argument is null
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/Transaction.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/Transaction.html new file mode 100644 index 000000000000..5931e35a3907 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/Transaction.html @@ -0,0 +1,216 @@ + + + + +Transaction (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api.transaction
    +

    Interface Transaction

    +
    +
    +
    +
    @Public +@Evolving +public interface Transaction
    +
    The class represents a transaction within Pulsar.
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        commit

        +
        CompletableFuture<Void> commit()
        +
        Commit the transaction.
        +
        +
        Returns:
        +
        the future represents the commit result.
        +
        +
        +
        • +
      • +
        +

        abort

        +
        CompletableFuture<Void> abort()
        +
        Abort the transaction.
        +
        +
        Returns:
        +
        the future represents the abort result.
        +
        +
        +
        • +
      • +
        +

        getTxnID

        +
        TxnID getTxnID()
        +
        Get TxnID of the transaction.
        +
        +
        Returns:
        +
        TxnID the txnID.
        +
        +
        +
        • +
      • +
        +

        getState

        +
        Transaction.State getState()
        +
        Get transaction state.
        +
        +
        Returns:
        +
        Transaction.State the state of the transaction.
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/TransactionBufferClient.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/TransactionBufferClient.html new file mode 100644 index 000000000000..1a9a2eb9c08a --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/TransactionBufferClient.html @@ -0,0 +1,279 @@ + + + + +TransactionBufferClient (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api.transaction
    +

    Interface TransactionBufferClient

    +
    +
    +
    +
    @Private +@Evolving +public interface TransactionBufferClient
    +
    The transaction buffer client to commit and abort transactions on topics or subscription. + The transaction buffer client is used by transaction coordinator to end transactions.
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        commitTxnOnTopic

        +
        CompletableFuture<TxnID> commitTxnOnTopic(String topic, + long txnIdMostBits, + long txnIdLeastBits, + long lowWaterMark)
        +
        Commit the transaction associated with the topic.
        +
        +
        Parameters:
        +
        topic - topic name
        +
        txnIdMostBits - the most bits of txn id
        +
        txnIdLeastBits - the least bits of txn id
        +
        lowWaterMark - the low water mark of this txn;
        +
        Returns:
        +
        the future represents the commit result
        +
        +
        +
        • +
      • +
        +

        abortTxnOnTopic

        +
        CompletableFuture<TxnID> abortTxnOnTopic(String topic, + long txnIdMostBits, + long txnIdLeastBits, + long lowWaterMark)
        +
        Abort the transaction associated with the topic.
        +
        +
        Parameters:
        +
        topic - topic name
        +
        txnIdMostBits - the most bits of txn id
        +
        txnIdLeastBits - the least bits of txn id
        +
        lowWaterMark - the low water mark of this txn
        +
        Returns:
        +
        the future represents the abort result
        +
        +
        +
        • +
      • +
        +

        commitTxnOnSubscription

        +
        CompletableFuture<TxnID> commitTxnOnSubscription(String topic, + String subscription, + long txnIdMostBits, + long txnIdLeastBits, + long lowWaterMark)
        +
        Commit the transaction associated with the topic subscription.
        +
        +
        Parameters:
        +
        topic - topic name
        +
        subscription - subscription name
        +
        txnIdMostBits - the most bits of txn id
        +
        txnIdLeastBits - the least bits of txn id
        +
        lowWaterMark - the low water mark of this txn
        +
        Returns:
        +
        the future represents the commit result
        +
        +
        +
        • +
      • +
        +

        abortTxnOnSubscription

        +
        CompletableFuture<TxnID> abortTxnOnSubscription(String topic, + String subscription, + long txnIdMostBits, + long txnIdLeastBits, + long lowWaterMark)
        +
        Abort the transaction associated with the topic subscription.
        +
        +
        Parameters:
        +
        topic - topic name
        +
        subscription - subscription name
        +
        txnIdMostBits - the most bits of txn id
        +
        txnIdLeastBits - the least bits of txn id
        +
        lowWaterMark - the low water mark of this txn
        +
        Returns:
        +
        the future represents the abort result
        +
        +
        +
        • +
      • +
        +

        close

        +
        void close()
        +
        +
        • +
      • +
        +

        getAvailableRequestCredits

        +
        int getAvailableRequestCredits()
        +
        +
        • +
      • +
        +

        getPendingRequestsCount

        +
        int getPendingRequestsCount()
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/TransactionBufferClientException.ReachMaxPendingOpsException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/TransactionBufferClientException.ReachMaxPendingOpsException.html new file mode 100644 index 000000000000..055ee0b79632 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/TransactionBufferClientException.ReachMaxPendingOpsException.html @@ -0,0 +1,198 @@ + + + + +TransactionBufferClientException.ReachMaxPendingOpsException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api.transaction
    +

    Class TransactionBufferClientException.ReachMaxPendingOpsException

    +
    +
    java.lang.Object +
    java.lang.Throwable +
    java.lang.Exception +
    java.io.IOException +
    org.apache.pulsar.client.api.transaction.TransactionBufferClientException +
    org.apache.pulsar.client.api.transaction.TransactionBufferClientException.ReachMaxPendingOpsException
    +
    +
    +
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable
    +
    +
    +
    Enclosing class:
    +
    TransactionBufferClientException
    +
    +
    +
    public static class TransactionBufferClientException.ReachMaxPendingOpsException +extends TransactionBufferClientException
    +
    Thrown when transaction buffer op over max pending numbers.
    +
    +
    See Also:
    +
    + +
    +
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        ReachMaxPendingOpsException

        +
        public ReachMaxPendingOpsException()
        +
        +
        • +
      • +
        +

        ReachMaxPendingOpsException

        +
        public ReachMaxPendingOpsException(String message)
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/TransactionBufferClientException.RequestTimeoutException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/TransactionBufferClientException.RequestTimeoutException.html new file mode 100644 index 000000000000..44c76a906eb8 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/TransactionBufferClientException.RequestTimeoutException.html @@ -0,0 +1,198 @@ + + + + +TransactionBufferClientException.RequestTimeoutException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api.transaction
    +

    Class TransactionBufferClientException.RequestTimeoutException

    +
    +
    java.lang.Object +
    java.lang.Throwable +
    java.lang.Exception +
    java.io.IOException +
    org.apache.pulsar.client.api.transaction.TransactionBufferClientException +
    org.apache.pulsar.client.api.transaction.TransactionBufferClientException.RequestTimeoutException
    +
    +
    +
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable
    +
    +
    +
    Enclosing class:
    +
    TransactionBufferClientException
    +
    +
    +
    public static class TransactionBufferClientException.RequestTimeoutException +extends TransactionBufferClientException
    +
    Thrown when operation timeout.
    +
    +
    See Also:
    +
    + +
    +
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        RequestTimeoutException

        +
        public RequestTimeoutException()
        +
        +
        • +
      • +
        +

        RequestTimeoutException

        +
        public RequestTimeoutException(String message)
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/TransactionBufferClientException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/TransactionBufferClientException.html new file mode 100644 index 000000000000..66f137ce25af --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/TransactionBufferClientException.html @@ -0,0 +1,235 @@ + + + + +TransactionBufferClientException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api.transaction
    +

    Class TransactionBufferClientException

    +
    +
    java.lang.Object +
    java.lang.Throwable +
    java.lang.Exception +
    java.io.IOException +
    org.apache.pulsar.client.api.transaction.TransactionBufferClientException
    +
    +
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable
    +
    +
    +
    Direct Known Subclasses:
    +
    TransactionBufferClientException.ReachMaxPendingOpsException, TransactionBufferClientException.RequestTimeoutException
    +
    +
    +
    @Private +@Evolving +public class TransactionBufferClientException +extends IOException
    +
    Exceptions for transaction buffer client.
    +
    +
    See Also:
    +
    + +
    +
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        TransactionBufferClientException

        +
        public TransactionBufferClientException(Throwable t)
        +
        +
        • +
      • +
        +

        TransactionBufferClientException

        +
        public TransactionBufferClientException(String message)
        +
        +
        • +
      +
      +
      • + +
    • +
      +

      Method Details

      + +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/TransactionBuilder.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/TransactionBuilder.html new file mode 100644 index 000000000000..7d5212080eb7 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/TransactionBuilder.html @@ -0,0 +1,181 @@ + + + + +TransactionBuilder (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api.transaction
    +

    Interface TransactionBuilder

    +
    +
    +
    +
    @Public +@Evolving +public interface TransactionBuilder
    +
    The builder to build a transaction for Pulsar.
    +
    +
    +
      + +
    • +
      +

      Method Summary

      +
      +
      +
      +
      +
      Modifier and Type
      +
      Method
      +
      Description
      +
      CompletableFuture<Transaction>
      +
      build()
      +
      +
      Build the transaction with the configured settings.
      +
      +
      TransactionBuilder
      +
      withTransactionTimeout(long timeout, + TimeUnit timeoutUnit)
      +
      +
      Configure the maximum amount of time that the transaction + coordinator will for a transaction to be completed by the + client before proactively aborting the ongoing transaction.
      +
      +
      +
      +
      +
      +
      • +
    +
    +
    +
      + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        withTransactionTimeout

        +
        TransactionBuilder withTransactionTimeout(long timeout, + TimeUnit timeoutUnit)
        +
        Configure the maximum amount of time that the transaction + coordinator will for a transaction to be completed by the + client before proactively aborting the ongoing transaction. + +

        The config value will be sent to the transaction coordinator + along with the CommandNewTxn. Default is 60 seconds.

        +
        +
        Parameters:
        +
        timeout - the transaction timeout value
        +
        timeoutUnit - the transaction timeout unit
        +
        Returns:
        +
        the transaction builder itself
        +
        +
        +
        • +
      • +
        +

        build

        +
        CompletableFuture<Transaction> build()
        +
        Build the transaction with the configured settings.
        +
        +
        Returns:
        +
        a future represents the result of starting a new transaction
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/TransactionCoordinatorClient.State.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/TransactionCoordinatorClient.State.html new file mode 100644 index 000000000000..058de8378ea4 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/TransactionCoordinatorClient.State.html @@ -0,0 +1,265 @@ + + + + +TransactionCoordinatorClient.State (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api.transaction
    +

    Enum Class TransactionCoordinatorClient.State

    +
    +
    java.lang.Object +
    java.lang.Enum<TransactionCoordinatorClient.State> +
    org.apache.pulsar.client.api.transaction.TransactionCoordinatorClient.State
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable, Comparable<TransactionCoordinatorClient.State>, Constable
    +
    +
    +
    Enclosing interface:
    +
    TransactionCoordinatorClient
    +
    +
    +
    public static enum TransactionCoordinatorClient.State +extends Enum<TransactionCoordinatorClient.State>
    +
    State of the transaction coordinator client.
    +
    +
    + +
    +
    + +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/TransactionCoordinatorClient.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/TransactionCoordinatorClient.html new file mode 100644 index 000000000000..e48f4595da5e --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/TransactionCoordinatorClient.html @@ -0,0 +1,521 @@ + + + + +TransactionCoordinatorClient (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api.transaction
    +

    Interface TransactionCoordinatorClient

    +
    +
    +
    +
    All Superinterfaces:
    +
    AutoCloseable, Closeable
    +
    +
    +
    @Private +@Evolving +public interface TransactionCoordinatorClient +extends Closeable
    +
    Transaction coordinator client.
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Field Details

      +
        +
      • +
        +

        DEFAULT_TXN_TTL_MS

        +
        static final long DEFAULT_TXN_TTL_MS
        +
        Default transaction ttl in mills.
        +
        +
        See Also:
        +
        + +
        +
        +
        +
        • +
      +
      +
      • + +
    • +
      +

      Method Details

      + +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/TransactionCoordinatorClientException.CoordinatorClientStateException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/TransactionCoordinatorClientException.CoordinatorClientStateException.html new file mode 100644 index 000000000000..998cb8c5d04a --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/TransactionCoordinatorClientException.CoordinatorClientStateException.html @@ -0,0 +1,198 @@ + + + + +TransactionCoordinatorClientException.CoordinatorClientStateException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api.transaction
    +

    Class TransactionCoordinatorClientException.CoordinatorClientStateException

    +
    +
    java.lang.Object +
    java.lang.Throwable +
    java.lang.Exception +
    java.io.IOException +
    org.apache.pulsar.client.api.transaction.TransactionCoordinatorClientException +
    org.apache.pulsar.client.api.transaction.TransactionCoordinatorClientException.CoordinatorClientStateException
    +
    +
    +
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable
    +
    +
    +
    Enclosing class:
    +
    TransactionCoordinatorClientException
    +
    +
    +
    public static class TransactionCoordinatorClientException.CoordinatorClientStateException +extends TransactionCoordinatorClientException
    +
    Thrown when transaction coordinator with unexpected state.
    +
    +
    See Also:
    +
    + +
    +
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        CoordinatorClientStateException

        +
        public CoordinatorClientStateException()
        +
        +
        • +
      • +
        +

        CoordinatorClientStateException

        +
        public CoordinatorClientStateException(String message)
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/TransactionCoordinatorClientException.CoordinatorNotFoundException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/TransactionCoordinatorClientException.CoordinatorNotFoundException.html new file mode 100644 index 000000000000..0cd0b9163e63 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/TransactionCoordinatorClientException.CoordinatorNotFoundException.html @@ -0,0 +1,190 @@ + + + + +TransactionCoordinatorClientException.CoordinatorNotFoundException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api.transaction
    +

    Class TransactionCoordinatorClientException.CoordinatorNotFoundException

    +
    +
    java.lang.Object +
    java.lang.Throwable +
    java.lang.Exception +
    java.io.IOException +
    org.apache.pulsar.client.api.transaction.TransactionCoordinatorClientException +
    org.apache.pulsar.client.api.transaction.TransactionCoordinatorClientException.CoordinatorNotFoundException
    +
    +
    +
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable
    +
    +
    +
    Enclosing class:
    +
    TransactionCoordinatorClientException
    +
    +
    +
    public static class TransactionCoordinatorClientException.CoordinatorNotFoundException +extends TransactionCoordinatorClientException
    +
    Thrown when transaction coordinator not found in broker side.
    +
    +
    See Also:
    +
    + +
    +
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        CoordinatorNotFoundException

        +
        public CoordinatorNotFoundException(String message)
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/TransactionCoordinatorClientException.InvalidTxnStatusException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/TransactionCoordinatorClientException.InvalidTxnStatusException.html new file mode 100644 index 000000000000..02e318f85515 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/TransactionCoordinatorClientException.InvalidTxnStatusException.html @@ -0,0 +1,202 @@ + + + + +TransactionCoordinatorClientException.InvalidTxnStatusException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api.transaction
    +

    Class TransactionCoordinatorClientException.InvalidTxnStatusException

    +
    +
    java.lang.Object +
    java.lang.Throwable +
    java.lang.Exception +
    java.io.IOException +
    org.apache.pulsar.client.api.transaction.TransactionCoordinatorClientException +
    org.apache.pulsar.client.api.transaction.TransactionCoordinatorClientException.InvalidTxnStatusException
    +
    +
    +
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable
    +
    +
    +
    Enclosing class:
    +
    TransactionCoordinatorClientException
    +
    +
    +
    public static class TransactionCoordinatorClientException.InvalidTxnStatusException +extends TransactionCoordinatorClientException
    +
    Thrown when transaction switch to a invalid status.
    +
    +
    See Also:
    +
    + +
    +
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        InvalidTxnStatusException

        +
        public InvalidTxnStatusException(String message)
        +
        +
        • +
      • +
        +

        InvalidTxnStatusException

        +
        public InvalidTxnStatusException(String txnId, + String actualState, + String expectState)
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/TransactionCoordinatorClientException.MetaStoreHandlerNotExistsException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/TransactionCoordinatorClientException.MetaStoreHandlerNotExistsException.html new file mode 100644 index 000000000000..b75b2098c1e6 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/TransactionCoordinatorClientException.MetaStoreHandlerNotExistsException.html @@ -0,0 +1,198 @@ + + + + +TransactionCoordinatorClientException.MetaStoreHandlerNotExistsException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api.transaction
    +

    Class TransactionCoordinatorClientException.MetaStoreHandlerNotExistsException

    +
    +
    java.lang.Object +
    java.lang.Throwable +
    java.lang.Exception +
    java.io.IOException +
    org.apache.pulsar.client.api.transaction.TransactionCoordinatorClientException +
    org.apache.pulsar.client.api.transaction.TransactionCoordinatorClientException.MetaStoreHandlerNotExistsException
    +
    +
    +
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable
    +
    +
    +
    Enclosing class:
    +
    TransactionCoordinatorClientException
    +
    +
    +
    public static class TransactionCoordinatorClientException.MetaStoreHandlerNotExistsException +extends TransactionCoordinatorClientException
    +
    Thrown when transaction meta store handler not exists.
    +
    +
    See Also:
    +
    + +
    +
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        MetaStoreHandlerNotExistsException

        +
        public MetaStoreHandlerNotExistsException(long tcId)
        +
        +
        • +
      • +
        +

        MetaStoreHandlerNotExistsException

        +
        public MetaStoreHandlerNotExistsException(String message)
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/TransactionCoordinatorClientException.MetaStoreHandlerNotReadyException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/TransactionCoordinatorClientException.MetaStoreHandlerNotReadyException.html new file mode 100644 index 000000000000..1e24ca23ebe3 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/TransactionCoordinatorClientException.MetaStoreHandlerNotReadyException.html @@ -0,0 +1,198 @@ + + + + +TransactionCoordinatorClientException.MetaStoreHandlerNotReadyException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api.transaction
    +

    Class TransactionCoordinatorClientException.MetaStoreHandlerNotReadyException

    +
    +
    java.lang.Object +
    java.lang.Throwable +
    java.lang.Exception +
    java.io.IOException +
    org.apache.pulsar.client.api.transaction.TransactionCoordinatorClientException +
    org.apache.pulsar.client.api.transaction.TransactionCoordinatorClientException.MetaStoreHandlerNotReadyException
    +
    +
    +
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable
    +
    +
    +
    Enclosing class:
    +
    TransactionCoordinatorClientException
    +
    +
    +
    public static class TransactionCoordinatorClientException.MetaStoreHandlerNotReadyException +extends TransactionCoordinatorClientException
    +
    Thrown when send request to transaction meta store but the transaction meta store handler not ready.
    +
    +
    See Also:
    +
    + +
    +
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        MetaStoreHandlerNotReadyException

        +
        public MetaStoreHandlerNotReadyException(long tcId)
        +
        +
        • +
      • +
        +

        MetaStoreHandlerNotReadyException

        +
        public MetaStoreHandlerNotReadyException(String message)
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/TransactionCoordinatorClientException.TransactionNotFoundException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/TransactionCoordinatorClientException.TransactionNotFoundException.html new file mode 100644 index 000000000000..a5bfc6dd7c37 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/TransactionCoordinatorClientException.TransactionNotFoundException.html @@ -0,0 +1,190 @@ + + + + +TransactionCoordinatorClientException.TransactionNotFoundException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api.transaction
    +

    Class TransactionCoordinatorClientException.TransactionNotFoundException

    +
    +
    java.lang.Object +
    java.lang.Throwable +
    java.lang.Exception +
    java.io.IOException +
    org.apache.pulsar.client.api.transaction.TransactionCoordinatorClientException +
    org.apache.pulsar.client.api.transaction.TransactionCoordinatorClientException.TransactionNotFoundException
    +
    +
    +
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable
    +
    +
    +
    Enclosing class:
    +
    TransactionCoordinatorClientException
    +
    +
    +
    public static class TransactionCoordinatorClientException.TransactionNotFoundException +extends TransactionCoordinatorClientException
    +
    Thrown when transaction not found in transaction coordinator.
    +
    +
    See Also:
    +
    + +
    +
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        TransactionNotFoundException

        +
        public TransactionNotFoundException(String message)
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/TransactionCoordinatorClientException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/TransactionCoordinatorClientException.html new file mode 100644 index 000000000000..6dec4666811e --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/TransactionCoordinatorClientException.html @@ -0,0 +1,255 @@ + + + + +TransactionCoordinatorClientException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api.transaction
    +

    Class TransactionCoordinatorClientException

    +
    +
    java.lang.Object +
    java.lang.Throwable +
    java.lang.Exception +
    java.io.IOException +
    org.apache.pulsar.client.api.transaction.TransactionCoordinatorClientException
    +
    +
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable
    +
    +
    +
    Direct Known Subclasses:
    +
    TransactionCoordinatorClientException.CoordinatorClientStateException, TransactionCoordinatorClientException.CoordinatorNotFoundException, TransactionCoordinatorClientException.InvalidTxnStatusException, TransactionCoordinatorClientException.MetaStoreHandlerNotExistsException, TransactionCoordinatorClientException.MetaStoreHandlerNotReadyException, TransactionCoordinatorClientException.TransactionNotFoundException
    +
    +
    +
    @Private +@Evolving +public class TransactionCoordinatorClientException +extends IOException
    +
    Exceptions for transaction coordinator client.
    +
    +
    See Also:
    +
    + +
    +
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        TransactionCoordinatorClientException

        +
        public TransactionCoordinatorClientException(Throwable t)
        +
        +
        • +
      • +
        +

        TransactionCoordinatorClientException

        +
        public TransactionCoordinatorClientException(String message)
        +
        +
        • +
      +
      +
      • + +
    • +
      +

      Method Details

      + +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/TxnID.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/TxnID.html new file mode 100644 index 000000000000..ab724f4361b3 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/TxnID.html @@ -0,0 +1,225 @@ + + + + +TxnID (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.api.transaction
    +

    Class TxnID

    +
    +
    java.lang.Object +
    org.apache.pulsar.client.api.transaction.TxnID
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable
    +
    +
    +
    @Public +@Evolving +public class TxnID +extends Object +implements Serializable
    +
    An identifier for representing a transaction.
    +
    +
    See Also:
    +
    + +
    +
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        TxnID

        +
        public TxnID(long mostSigBits, + long leastSigBits)
        +
        +
        • +
      +
      +
      • + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        toString

        +
        public String toString()
        +
        +
        Overrides:
        +
        toString in class Object
        +
        +
        +
        • +
      • +
        +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class Object
        +
        +
        +
        • +
      • +
        +

        equals

        +
        public boolean equals(Object obj)
        +
        +
        Overrides:
        +
        equals in class Object
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/class-use/Transaction.State.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/class-use/Transaction.State.html new file mode 100644 index 000000000000..c3b232dedc88 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/class-use/Transaction.State.html @@ -0,0 +1,102 @@ + + + + +Uses of Enum Class org.apache.pulsar.client.api.transaction.Transaction.State (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Enum Class
    org.apache.pulsar.client.api.transaction.Transaction.State

    +
    +
    Packages that use Transaction.State
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api.transaction
    +
    +
    Pulsar transaction related API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/class-use/Transaction.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/class-use/Transaction.html new file mode 100644 index 000000000000..a24953b38d86 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/class-use/Transaction.html @@ -0,0 +1,135 @@ + + + + +Uses of Interface org.apache.pulsar.client.api.transaction.Transaction (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    org.apache.pulsar.client.api.transaction.Transaction

    +
    +
    Packages that use Transaction
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    org.apache.pulsar.client.api.transaction
    +
    +
    Pulsar transaction related API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/class-use/TransactionBufferClient.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/class-use/TransactionBufferClient.html new file mode 100644 index 000000000000..63aa5d9e5123 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/class-use/TransactionBufferClient.html @@ -0,0 +1,62 @@ + + + + +Uses of Interface org.apache.pulsar.client.api.transaction.TransactionBufferClient (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    org.apache.pulsar.client.api.transaction.TransactionBufferClient

    +
    +No usage of org.apache.pulsar.client.api.transaction.TransactionBufferClient
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/class-use/TransactionBufferClientException.ReachMaxPendingOpsException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/class-use/TransactionBufferClientException.ReachMaxPendingOpsException.html new file mode 100644 index 000000000000..0bdf403a9e36 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/class-use/TransactionBufferClientException.ReachMaxPendingOpsException.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.client.api.transaction.TransactionBufferClientException.ReachMaxPendingOpsException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.apache.pulsar.client.api.transaction.TransactionBufferClientException.ReachMaxPendingOpsException

    +
    +No usage of org.apache.pulsar.client.api.transaction.TransactionBufferClientException.ReachMaxPendingOpsException
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/class-use/TransactionBufferClientException.RequestTimeoutException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/class-use/TransactionBufferClientException.RequestTimeoutException.html new file mode 100644 index 000000000000..b07cc9886373 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/class-use/TransactionBufferClientException.RequestTimeoutException.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.client.api.transaction.TransactionBufferClientException.RequestTimeoutException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.apache.pulsar.client.api.transaction.TransactionBufferClientException.RequestTimeoutException

    +
    +No usage of org.apache.pulsar.client.api.transaction.TransactionBufferClientException.RequestTimeoutException
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/class-use/TransactionBufferClientException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/class-use/TransactionBufferClientException.html new file mode 100644 index 000000000000..9f782ba27e19 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/class-use/TransactionBufferClientException.html @@ -0,0 +1,105 @@ + + + + +Uses of Class org.apache.pulsar.client.api.transaction.TransactionBufferClientException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.apache.pulsar.client.api.transaction.TransactionBufferClientException

    +
    +
    Packages that use TransactionBufferClientException
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api.transaction
    +
    +
    Pulsar transaction related API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/class-use/TransactionBuilder.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/class-use/TransactionBuilder.html new file mode 100644 index 000000000000..51e4f02c1afc --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/class-use/TransactionBuilder.html @@ -0,0 +1,115 @@ + + + + +Uses of Interface org.apache.pulsar.client.api.transaction.TransactionBuilder (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    org.apache.pulsar.client.api.transaction.TransactionBuilder

    +
    +
    Packages that use TransactionBuilder
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    org.apache.pulsar.client.api.transaction
    +
    +
    Pulsar transaction related API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/class-use/TransactionCoordinatorClient.State.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/class-use/TransactionCoordinatorClient.State.html new file mode 100644 index 000000000000..ce33d5d9df65 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/class-use/TransactionCoordinatorClient.State.html @@ -0,0 +1,102 @@ + + + + +Uses of Enum Class org.apache.pulsar.client.api.transaction.TransactionCoordinatorClient.State (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Enum Class
    org.apache.pulsar.client.api.transaction.TransactionCoordinatorClient.State

    +
    +
    Packages that use TransactionCoordinatorClient.State
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api.transaction
    +
    +
    Pulsar transaction related API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/class-use/TransactionCoordinatorClient.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/class-use/TransactionCoordinatorClient.html new file mode 100644 index 000000000000..4010fcc97274 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/class-use/TransactionCoordinatorClient.html @@ -0,0 +1,62 @@ + + + + +Uses of Interface org.apache.pulsar.client.api.transaction.TransactionCoordinatorClient (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    org.apache.pulsar.client.api.transaction.TransactionCoordinatorClient

    +
    +No usage of org.apache.pulsar.client.api.transaction.TransactionCoordinatorClient
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/class-use/TransactionCoordinatorClientException.CoordinatorClientStateException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/class-use/TransactionCoordinatorClientException.CoordinatorClientStateException.html new file mode 100644 index 000000000000..f1f07a6ab24c --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/class-use/TransactionCoordinatorClientException.CoordinatorClientStateException.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.client.api.transaction.TransactionCoordinatorClientException.CoordinatorClientStateException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.apache.pulsar.client.api.transaction.TransactionCoordinatorClientException.CoordinatorClientStateException

    +
    +No usage of org.apache.pulsar.client.api.transaction.TransactionCoordinatorClientException.CoordinatorClientStateException
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/class-use/TransactionCoordinatorClientException.CoordinatorNotFoundException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/class-use/TransactionCoordinatorClientException.CoordinatorNotFoundException.html new file mode 100644 index 000000000000..3601817b430a --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/class-use/TransactionCoordinatorClientException.CoordinatorNotFoundException.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.client.api.transaction.TransactionCoordinatorClientException.CoordinatorNotFoundException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.apache.pulsar.client.api.transaction.TransactionCoordinatorClientException.CoordinatorNotFoundException

    +
    +No usage of org.apache.pulsar.client.api.transaction.TransactionCoordinatorClientException.CoordinatorNotFoundException
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/class-use/TransactionCoordinatorClientException.InvalidTxnStatusException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/class-use/TransactionCoordinatorClientException.InvalidTxnStatusException.html new file mode 100644 index 000000000000..81872daa1cf2 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/class-use/TransactionCoordinatorClientException.InvalidTxnStatusException.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.client.api.transaction.TransactionCoordinatorClientException.InvalidTxnStatusException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.apache.pulsar.client.api.transaction.TransactionCoordinatorClientException.InvalidTxnStatusException

    +
    +No usage of org.apache.pulsar.client.api.transaction.TransactionCoordinatorClientException.InvalidTxnStatusException
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/class-use/TransactionCoordinatorClientException.MetaStoreHandlerNotExistsException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/class-use/TransactionCoordinatorClientException.MetaStoreHandlerNotExistsException.html new file mode 100644 index 000000000000..5b507a86a45d --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/class-use/TransactionCoordinatorClientException.MetaStoreHandlerNotExistsException.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.client.api.transaction.TransactionCoordinatorClientException.MetaStoreHandlerNotExistsException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.apache.pulsar.client.api.transaction.TransactionCoordinatorClientException.MetaStoreHandlerNotExistsException

    +
    +No usage of org.apache.pulsar.client.api.transaction.TransactionCoordinatorClientException.MetaStoreHandlerNotExistsException
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/class-use/TransactionCoordinatorClientException.MetaStoreHandlerNotReadyException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/class-use/TransactionCoordinatorClientException.MetaStoreHandlerNotReadyException.html new file mode 100644 index 000000000000..8b797b145867 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/class-use/TransactionCoordinatorClientException.MetaStoreHandlerNotReadyException.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.client.api.transaction.TransactionCoordinatorClientException.MetaStoreHandlerNotReadyException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.apache.pulsar.client.api.transaction.TransactionCoordinatorClientException.MetaStoreHandlerNotReadyException

    +
    +No usage of org.apache.pulsar.client.api.transaction.TransactionCoordinatorClientException.MetaStoreHandlerNotReadyException
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/class-use/TransactionCoordinatorClientException.TransactionNotFoundException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/class-use/TransactionCoordinatorClientException.TransactionNotFoundException.html new file mode 100644 index 000000000000..56d874ec6697 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/class-use/TransactionCoordinatorClientException.TransactionNotFoundException.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.client.api.transaction.TransactionCoordinatorClientException.TransactionNotFoundException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.apache.pulsar.client.api.transaction.TransactionCoordinatorClientException.TransactionNotFoundException

    +
    +No usage of org.apache.pulsar.client.api.transaction.TransactionCoordinatorClientException.TransactionNotFoundException
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/class-use/TransactionCoordinatorClientException.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/class-use/TransactionCoordinatorClientException.html new file mode 100644 index 000000000000..4fb2a3344bdb --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/class-use/TransactionCoordinatorClientException.html @@ -0,0 +1,170 @@ + + + + +Uses of Class org.apache.pulsar.client.api.transaction.TransactionCoordinatorClientException (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.apache.pulsar.client.api.transaction.TransactionCoordinatorClientException

    +
    +
    Packages that use TransactionCoordinatorClientException
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api.transaction
    +
    +
    Pulsar transaction related API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/class-use/TxnID.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/class-use/TxnID.html new file mode 100644 index 000000000000..132947aa54f8 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/class-use/TxnID.html @@ -0,0 +1,205 @@ + + + + +Uses of Class org.apache.pulsar.client.api.transaction.TxnID (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.apache.pulsar.client.api.transaction.TxnID

    +
    +
    Packages that use TxnID
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api.transaction
    +
    +
    Pulsar transaction related API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/package-summary.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/package-summary.html new file mode 100644 index 000000000000..93b6eb4a93a8 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/package-summary.html @@ -0,0 +1,186 @@ + + + + +org.apache.pulsar.client.api.transaction (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package org.apache.pulsar.client.api.transaction

    +
    +
    +
    package org.apache.pulsar.client.api.transaction
    +
    +
    Pulsar transaction related API.
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/package-tree.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/package-tree.html new file mode 100644 index 000000000000..68db31369a57 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/package-tree.html @@ -0,0 +1,136 @@ + + + + +org.apache.pulsar.client.api.transaction Class Hierarchy (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package org.apache.pulsar.client.api.transaction

    +
    +Package Hierarchies: + +
    +

    Class Hierarchy

    + +
    +
    +

    Interface Hierarchy

    + +
    +
    +

    Enum Class Hierarchy

    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/package-use.html b/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/package-use.html new file mode 100644 index 000000000000..c11d5423ed8f --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/api/transaction/package-use.html @@ -0,0 +1,131 @@ + + + + +Uses of Package org.apache.pulsar.client.api.transaction (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Package
    org.apache.pulsar.client.api.transaction

    +
    +
    Packages that use org.apache.pulsar.client.api.transaction
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    org.apache.pulsar.client.api.transaction
    +
    +
    Pulsar transaction related API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/internal/DefaultImplementation.html b/static/api/client/4.0.x/org/apache/pulsar/client/internal/DefaultImplementation.html new file mode 100644 index 000000000000..858eb8da3462 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/internal/DefaultImplementation.html @@ -0,0 +1,188 @@ + + + + +DefaultImplementation (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.internal
    +

    Class DefaultImplementation

    +
    +
    java.lang.Object +
    org.apache.pulsar.client.internal.DefaultImplementation
    +
    +
    +
    +
    public class DefaultImplementation +extends Object
    +
    This class loads the implementation for PulsarClientImplementationBinding + and allows you to decouple the API from the actual implementation. + This class is internal to the Pulsar API implementation, and it is not part of the public API + it is not meant to be used by client applications.
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        DefaultImplementation

        +
        public DefaultImplementation()
        +
        +
        • +
      +
      +
      • + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        getDefaultImplementation

        +
        public static PulsarClientImplementationBinding getDefaultImplementation()
        +
        Access the actual implementation of the Pulsar Client API.
        +
        +
        Returns:
        +
        the loaded implementation.
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/internal/PropertiesUtils.html b/static/api/client/4.0.x/org/apache/pulsar/client/internal/PropertiesUtils.html new file mode 100644 index 000000000000..f1c3f3722ef5 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/internal/PropertiesUtils.html @@ -0,0 +1,218 @@ + + + + +PropertiesUtils (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.internal
    +

    Class PropertiesUtils

    +
    +
    java.lang.Object +
    org.apache.pulsar.client.internal.PropertiesUtils
    +
    +
    +
    +
    public class PropertiesUtils +extends Object
    +
    Internal utility methods for filtering and mapping Properties objects.
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        PropertiesUtils

        +
        public PropertiesUtils()
        +
        +
        • +
      +
      +
      • + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        filterAndMapProperties

        +
        public static Map<String,Object> filterAndMapProperties(Properties props, + String prefix)
        +
        Filters the Properties object so that only properties with the configured prefix are retained, + and then removes that prefix and puts the key value pairs into the result map.
        +
        +
        Parameters:
        +
        props - - the properties object to filter
        +
        prefix - - the prefix to filter against and then remove for keys in the resulting map
        +
        Returns:
        +
        a map of properties
        +
        +
        +
        • +
      • +
        +

        filterAndMapProperties

        +
        public static Map<String,Object> filterAndMapProperties(Properties props, + String srcPrefix, + String targetPrefix)
        +
        Filters the Properties object so that only properties with the configured prefix are retained, + and then replaces the srcPrefix with the targetPrefix when putting the key value pairs in the resulting map.
        +
        +
        Parameters:
        +
        props - - the properties object to filter
        +
        srcPrefix - - the prefix to filter against and then remove for keys in the resulting map
        +
        targetPrefix - - the prefix to add to keys in the result map
        +
        Returns:
        +
        a map of properties
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/internal/PulsarClientImplementationBinding.html b/static/api/client/4.0.x/org/apache/pulsar/client/internal/PulsarClientImplementationBinding.html new file mode 100644 index 000000000000..160978d4c0a4 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/internal/PulsarClientImplementationBinding.html @@ -0,0 +1,820 @@ + + + + +PulsarClientImplementationBinding (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.client.internal
    +

    Interface PulsarClientImplementationBinding

    +
    +
    +
    +
    public interface PulsarClientImplementationBinding
    +
    Helper class for class instantiations and it also contains methods to work with schemas. + This interface allows you to not depend on the Implementation classes directly. + The actual implementation of this class is loaded from DefaultImplementation.
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        newSchemaDefinitionBuilder

        +
        <T> SchemaDefinitionBuilder<T> newSchemaDefinitionBuilder()
        +
        +
        • +
      • +
        +

        newClientBuilder

        +
        ClientBuilder newClientBuilder()
        +
        +
        • +
      • +
        +

        newMessageId

        +
        MessageId newMessageId(long ledgerId, + long entryId, + int partitionIndex)
        +
        +
        • +
      • +
        +

        newMessageIdFromByteArray

        +
        MessageId newMessageIdFromByteArray(byte[] data) + throws IOException
        +
        +
        Throws:
        +
        IOException
        +
        +
        +
        • +
      • +
        +

        newMessageIdFromByteArrayWithTopic

        +
        MessageId newMessageIdFromByteArrayWithTopic(byte[] data, + String topicName) + throws IOException
        +
        +
        Throws:
        +
        IOException
        +
        +
        +
        • +
      • +
        +

        newAuthenticationToken

        +
        Authentication newAuthenticationToken(String token)
        +
        +
        • +
      • +
        +

        newAuthenticationToken

        +
        Authentication newAuthenticationToken(Supplier<String> supplier)
        +
        +
        • +
      • +
        +

        newAuthenticationTLS

        +
        Authentication newAuthenticationTLS(String certFilePath, + String keyFilePath)
        +
        +
        • +
      • +
        +

        createAuthentication

        +
        Authentication createAuthentication(String authPluginClassName, + String authParamsString) + throws PulsarClientException.UnsupportedAuthenticationException
        +
        +
        Throws:
        +
        PulsarClientException.UnsupportedAuthenticationException
        +
        +
        +
        • +
      • +
        +

        createAuthentication

        +
        Authentication createAuthentication(String authPluginClassName, + Map<String,String> authParams) + throws PulsarClientException.UnsupportedAuthenticationException
        +
        +
        Throws:
        +
        PulsarClientException.UnsupportedAuthenticationException
        +
        +
        +
        • +
      • +
        +

        newBytesSchema

        +
        Schema<byte[]> newBytesSchema()
        +
        +
        • +
      • +
        +

        newStringSchema

        +
        Schema<String> newStringSchema()
        +
        +
        • +
      • +
        +

        newStringSchema

        +
        Schema<String> newStringSchema(Charset charset)
        +
        +
        • +
      • +
        +

        newByteSchema

        +
        Schema<Byte> newByteSchema()
        +
        +
        • +
      • +
        +

        newShortSchema

        +
        Schema<Short> newShortSchema()
        +
        +
        • +
      • +
        +

        newIntSchema

        +
        Schema<Integer> newIntSchema()
        +
        +
        • +
      • +
        +

        newLongSchema

        +
        Schema<Long> newLongSchema()
        +
        +
        • +
      • +
        +

        newBooleanSchema

        +
        Schema<Boolean> newBooleanSchema()
        +
        +
        • +
      • +
        +

        newByteBufferSchema

        +
        Schema<ByteBuffer> newByteBufferSchema()
        +
        +
        • +
      • +
        +

        newFloatSchema

        +
        Schema<Float> newFloatSchema()
        +
        +
        • +
      • +
        +

        newDoubleSchema

        +
        Schema<Double> newDoubleSchema()
        +
        +
        • +
      • +
        +

        newDateSchema

        +
        Schema<Date> newDateSchema()
        +
        +
        • +
      • +
        +

        newTimeSchema

        +
        Schema<Time> newTimeSchema()
        +
        +
        • +
      • +
        +

        newTimestampSchema

        +
        Schema<Timestamp> newTimestampSchema()
        +
        +
        • +
      • +
        +

        newInstantSchema

        +
        Schema<Instant> newInstantSchema()
        +
        +
        • +
      • +
        +

        newLocalDateSchema

        +
        Schema<LocalDate> newLocalDateSchema()
        +
        +
        • +
      • +
        +

        newLocalTimeSchema

        +
        Schema<LocalTime> newLocalTimeSchema()
        +
        +
        • +
      • +
        +

        newLocalDateTimeSchema

        +
        Schema<LocalDateTime> newLocalDateTimeSchema()
        +
        +
        • +
      • +
        +

        newAvroSchema

        +
        <T> Schema<T> newAvroSchema(SchemaDefinition schemaDefinition)
        +
        +
        • +
      • +
        +

        newProtobufSchema

        +
        <T extends com.google.protobuf.GeneratedMessageV3> +Schema<T> newProtobufSchema(SchemaDefinition schemaDefinition)
        +
        +
        • +
      • +
        +

        newProtobufNativeSchema

        +
        <T extends com.google.protobuf.GeneratedMessageV3> +Schema<T> newProtobufNativeSchema(SchemaDefinition schemaDefinition)
        +
        +
        • +
      • +
        +

        newJSONSchema

        +
        <T> Schema<T> newJSONSchema(SchemaDefinition schemaDefinition)
        +
        +
        • +
      • +
        +

        newAutoConsumeSchema

        +
        Schema<GenericRecord> newAutoConsumeSchema()
        +
        +
        • +
      • +
        +

        newAutoProduceSchema

        +
        Schema<byte[]> newAutoProduceSchema()
        +
        +
        • +
      • +
        +

        newAutoProduceSchema

        +
        Schema<byte[]> newAutoProduceSchema(Schema<?> schema)
        +
        +
        • +
      • +
        +

        newAutoProduceValidatedAvroSchema

        +
        Schema<byte[]> newAutoProduceValidatedAvroSchema(Object schema)
        +
        +
        • +
      • +
        +

        newKeyValueBytesSchema

        +
        Schema<KeyValue<byte[],byte[]>> newKeyValueBytesSchema()
        +
        +
        • +
      • +
        +

        newKeyValueSchema

        +
        <K, +V> Schema<KeyValue<K,V>> newKeyValueSchema(Schema<K> keySchema, + Schema<V> valueSchema, + KeyValueEncodingType keyValueEncodingType)
        +
        +
        • +
      • +
        +

        newKeyValueSchema

        +
        <K, +V> Schema<KeyValue<K,V>> newKeyValueSchema(Class<K> key, + Class<V> value, + SchemaType type)
        +
        +
        • +
      • +
        +

        getSchema

        +
        Schema<?> getSchema(SchemaInfo schemaInfo)
        +
        +
        • +
      • +
        +

        getGenericSchema

        +
        GenericSchema<GenericRecord> getGenericSchema(SchemaInfo schemaInfo)
        +
        +
        • +
      • +
        +

        newRecordSchemaBuilder

        +
        RecordSchemaBuilder newRecordSchemaBuilder(String name)
        +
        +
        • +
      • +
        +

        decodeKeyValueEncodingType

        +
        KeyValueEncodingType decodeKeyValueEncodingType(SchemaInfo schemaInfo)
        +
        Decode the kv encoding type from the schema info.
        +
        +
        Parameters:
        +
        schemaInfo - the schema info
        +
        Returns:
        +
        the kv encoding type
        +
        +
        +
        • +
      • +
        +

        encodeKeyValueSchemaInfo

        +
        <K, +V> SchemaInfo encodeKeyValueSchemaInfo(Schema<K> keySchema, + Schema<V> valueSchema, + KeyValueEncodingType keyValueEncodingType)
        +
        Encode key invalid input: '&' value into schema into a KeyValue schema.
        +
        +
        Parameters:
        +
        keySchema - the key schema
        +
        valueSchema - the value schema
        +
        keyValueEncodingType - the encoding type to encode and decode key value pair
        +
        Returns:
        +
        the final schema info
        +
        +
        +
        • +
      • +
        +

        encodeKeyValueSchemaInfo

        +
        <K, +V> SchemaInfo encodeKeyValueSchemaInfo(String schemaName, + Schema<K> keySchema, + Schema<V> valueSchema, + KeyValueEncodingType keyValueEncodingType)
        +
        Encode key invalid input: '&' value into schema into a KeyValue schema.
        +
        +
        Parameters:
        +
        schemaName - the final schema name
        +
        keySchema - the key schema
        +
        valueSchema - the value schema
        +
        keyValueEncodingType - the encoding type to encode and decode key value pair
        +
        Returns:
        +
        the final schema info
        +
        +
        +
        • +
      • +
        +

        decodeKeyValueSchemaInfo

        +
        KeyValue<SchemaInfo,SchemaInfo> decodeKeyValueSchemaInfo(SchemaInfo schemaInfo)
        +
        Decode the key/value schema info to get key schema info and value schema info.
        +
        +
        Parameters:
        +
        schemaInfo - key/value schema info.
        +
        Returns:
        +
        the pair of key schema info and value schema info
        +
        +
        +
        • +
      • +
        +

        jsonifySchemaInfo

        +
        String jsonifySchemaInfo(SchemaInfo schemaInfo)
        +
        Jsonify the schema info.
        +
        +
        Parameters:
        +
        schemaInfo - the schema info
        +
        Returns:
        +
        the jsonified schema info
        +
        +
        +
        • +
      • +
        +

        jsonifySchemaInfoWithVersion

        +
        String jsonifySchemaInfoWithVersion(SchemaInfoWithVersion schemaInfoWithVersion)
        +
        Jsonify the schema info with version.
        +
        +
        Parameters:
        +
        schemaInfoWithVersion - the schema info with version
        +
        Returns:
        +
        the jsonified schema info with version
        +
        +
        +
        • +
      • +
        +

        jsonifyKeyValueSchemaInfo

        +
        String jsonifyKeyValueSchemaInfo(KeyValue<SchemaInfo,SchemaInfo> kvSchemaInfo)
        +
        Jsonify the key/value schema info.
        +
        +
        Parameters:
        +
        kvSchemaInfo - the key/value schema info
        +
        Returns:
        +
        the jsonified schema info
        +
        +
        +
        • +
      • +
        +

        convertKeyValueSchemaInfoDataToString

        +
        String convertKeyValueSchemaInfoDataToString(KeyValue<SchemaInfo,SchemaInfo> kvSchemaInfo) + throws IOException
        +
        Convert the key/value schema data.
        +
        +
        Parameters:
        +
        kvSchemaInfo - the key/value schema info
        +
        Returns:
        +
        the convert key/value schema data string
        +
        Throws:
        +
        IOException
        +
        +
        +
        • +
      • +
        +

        convertKeyValueDataStringToSchemaInfoSchema

        +
        byte[] convertKeyValueDataStringToSchemaInfoSchema(byte[] keyValueSchemaInfoDataJsonBytes) + throws IOException
        +
        Convert the key/value schema info data json bytes to key/value schema info data bytes.
        +
        +
        Parameters:
        +
        keyValueSchemaInfoDataJsonBytes - the key/value schema info data json bytes
        +
        Returns:
        +
        the key/value schema info data bytes
        +
        Throws:
        +
        IOException
        +
        +
        +
        • +
      • +
        +

        newDefaultBatcherBuilder

        +
        BatcherBuilder newDefaultBatcherBuilder()
        +
        +
        • +
      • +
        +

        newKeyBasedBatcherBuilder

        +
        BatcherBuilder newKeyBasedBatcherBuilder()
        +
        +
        • +
      • +
        +

        newDefaultMessagePayloadFactory

        +
        MessagePayloadFactory newDefaultMessagePayloadFactory()
        +
        +
        • +
      • +
        +

        getBytes

        +
        static byte[] getBytes(ByteBuffer byteBuffer)
        +
        Retrieves ByteBuffer data into byte[].
        +
        +
        Parameters:
        +
        byteBuffer -
        +
        Returns:
        +
        +
        +
        • +
      • +
        +

        newSchemaInfoImpl

        +
        SchemaInfo newSchemaInfoImpl(String name, + byte[] schema, + SchemaType type, + long timestamp, + Map<String,String> propertiesValue)
        +
        +
        • +
      • +
        +

        newTopicMessageId

        +
        TopicMessageId newTopicMessageId(String topic, + MessageId messageId)
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/internal/class-use/DefaultImplementation.html b/static/api/client/4.0.x/org/apache/pulsar/client/internal/class-use/DefaultImplementation.html new file mode 100644 index 000000000000..bf528a7fc621 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/internal/class-use/DefaultImplementation.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.client.internal.DefaultImplementation (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.apache.pulsar.client.internal.DefaultImplementation

    +
    +No usage of org.apache.pulsar.client.internal.DefaultImplementation
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/internal/class-use/PropertiesUtils.html b/static/api/client/4.0.x/org/apache/pulsar/client/internal/class-use/PropertiesUtils.html new file mode 100644 index 000000000000..790c6fdcb38b --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/internal/class-use/PropertiesUtils.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.client.internal.PropertiesUtils (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.apache.pulsar.client.internal.PropertiesUtils

    +
    +No usage of org.apache.pulsar.client.internal.PropertiesUtils
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/internal/class-use/PulsarClientImplementationBinding.html b/static/api/client/4.0.x/org/apache/pulsar/client/internal/class-use/PulsarClientImplementationBinding.html new file mode 100644 index 000000000000..803bc6ff731b --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/internal/class-use/PulsarClientImplementationBinding.html @@ -0,0 +1,91 @@ + + + + +Uses of Interface org.apache.pulsar.client.internal.PulsarClientImplementationBinding (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    org.apache.pulsar.client.internal.PulsarClientImplementationBinding

    +
    +
    Packages that use PulsarClientImplementationBinding
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.internal
    +
    +
    Helpers which provide useful functionality for the implementation of Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/internal/package-summary.html b/static/api/client/4.0.x/org/apache/pulsar/client/internal/package-summary.html new file mode 100644 index 000000000000..322d31cf572e --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/internal/package-summary.html @@ -0,0 +1,112 @@ + + + + +org.apache.pulsar.client.internal (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package org.apache.pulsar.client.internal

    +
    +
    +
    package org.apache.pulsar.client.internal
    +
    +
    Helpers which provide useful functionality for the implementation of Pulsar Client API.
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/internal/package-tree.html b/static/api/client/4.0.x/org/apache/pulsar/client/internal/package-tree.html new file mode 100644 index 000000000000..f5ff677c73e3 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/internal/package-tree.html @@ -0,0 +1,83 @@ + + + + +org.apache.pulsar.client.internal Class Hierarchy (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package org.apache.pulsar.client.internal

    +
    +Package Hierarchies: + +
    +

    Class Hierarchy

    + +
    +
    +

    Interface Hierarchy

    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/client/internal/package-use.html b/static/api/client/4.0.x/org/apache/pulsar/client/internal/package-use.html new file mode 100644 index 000000000000..aca9d989fab4 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/client/internal/package-use.html @@ -0,0 +1,88 @@ + + + + +Uses of Package org.apache.pulsar.client.internal (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Package
    org.apache.pulsar.client.internal

    +
    +
    Packages that use org.apache.pulsar.client.internal
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.internal
    +
    +
    Helpers which provide useful functionality for the implementation of Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/common/api/AuthData.html b/static/api/client/4.0.x/org/apache/pulsar/common/api/AuthData.html new file mode 100644 index 000000000000..4e0978e66180 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/common/api/AuthData.html @@ -0,0 +1,234 @@ + + + + +AuthData (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.common.api
    +

    Class AuthData

    +
    +
    java.lang.Object +
    org.apache.pulsar.common.api.AuthData
    +
    +
    +
    +
    public final class AuthData +extends Object
    +
    Authentication data.
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Field Details

      +
        +
      • +
        +

        INIT_AUTH_DATA_BYTES

        +
        public static byte[] INIT_AUTH_DATA_BYTES
        +
        +
        • +
      • +
        +

        REFRESH_AUTH_DATA_BYTES

        +
        public static byte[] REFRESH_AUTH_DATA_BYTES
        +
        +
        • +
      • +
        +

        INIT_AUTH_DATA

        +
        public static AuthData INIT_AUTH_DATA
        +
        +
        • +
      • +
        +

        REFRESH_AUTH_DATA

        +
        public static AuthData REFRESH_AUTH_DATA
        +
        +
        • +
      +
      +
      • + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        AuthData

        +
        public AuthData()
        +
        +
        • +
      +
      +
      • + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        isComplete

        +
        public boolean isComplete()
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/common/api/EncryptionContext.EncryptionKey.html b/static/api/client/4.0.x/org/apache/pulsar/common/api/EncryptionContext.EncryptionKey.html new file mode 100644 index 000000000000..1e5fcae16b36 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/common/api/EncryptionContext.EncryptionKey.html @@ -0,0 +1,155 @@ + + + + +EncryptionContext.EncryptionKey (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.common.api
    +

    Class EncryptionContext.EncryptionKey

    +
    +
    java.lang.Object +
    org.apache.pulsar.common.api.EncryptionContext.EncryptionKey
    +
    +
    +
    +
    Enclosing class:
    +
    EncryptionContext
    +
    +
    +
    public static class EncryptionContext.EncryptionKey +extends Object
    +
    Encryption key with metadata.
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        EncryptionKey

        +
        public EncryptionKey()
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/common/api/EncryptionContext.html b/static/api/client/4.0.x/org/apache/pulsar/common/api/EncryptionContext.html new file mode 100644 index 000000000000..803319657aef --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/common/api/EncryptionContext.html @@ -0,0 +1,168 @@ + + + + +EncryptionContext (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.common.api
    +

    Class EncryptionContext

    +
    +
    java.lang.Object +
    org.apache.pulsar.common.api.EncryptionContext
    +
    +
    +
    +
    public class EncryptionContext +extends Object
    +
    Class representing an encryption context.
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        EncryptionContext

        +
        public EncryptionContext()
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/common/api/class-use/AuthData.html b/static/api/client/4.0.x/org/apache/pulsar/common/api/class-use/AuthData.html new file mode 100644 index 000000000000..c0377e44d3aa --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/common/api/class-use/AuthData.html @@ -0,0 +1,127 @@ + + + + +Uses of Class org.apache.pulsar.common.api.AuthData (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.apache.pulsar.common.api.AuthData

    +
    +
    Packages that use AuthData
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    org.apache.pulsar.common.api
    +
    +
    Common data classes used in the Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/common/api/class-use/EncryptionContext.EncryptionKey.html b/static/api/client/4.0.x/org/apache/pulsar/common/api/class-use/EncryptionContext.EncryptionKey.html new file mode 100644 index 000000000000..8d21ec0cef38 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/common/api/class-use/EncryptionContext.EncryptionKey.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.common.api.EncryptionContext.EncryptionKey (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.apache.pulsar.common.api.EncryptionContext.EncryptionKey

    +
    +No usage of org.apache.pulsar.common.api.EncryptionContext.EncryptionKey
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/common/api/class-use/EncryptionContext.html b/static/api/client/4.0.x/org/apache/pulsar/common/api/class-use/EncryptionContext.html new file mode 100644 index 000000000000..38af1dc8e9f2 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/common/api/class-use/EncryptionContext.html @@ -0,0 +1,92 @@ + + + + +Uses of Class org.apache.pulsar.common.api.EncryptionContext (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.apache.pulsar.common.api.EncryptionContext

    +
    +
    Packages that use EncryptionContext
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/common/api/package-summary.html b/static/api/client/4.0.x/org/apache/pulsar/common/api/package-summary.html new file mode 100644 index 000000000000..c2bf80de7375 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/common/api/package-summary.html @@ -0,0 +1,109 @@ + + + + +org.apache.pulsar.common.api (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package org.apache.pulsar.common.api

    +
    +
    +
    package org.apache.pulsar.common.api
    +
    +
    Common data classes used in the Pulsar Client API.
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/common/api/package-tree.html b/static/api/client/4.0.x/org/apache/pulsar/common/api/package-tree.html new file mode 100644 index 000000000000..4edc9382f39a --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/common/api/package-tree.html @@ -0,0 +1,78 @@ + + + + +org.apache.pulsar.common.api Class Hierarchy (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package org.apache.pulsar.common.api

    +
    +Package Hierarchies: + +
    +

    Class Hierarchy

    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/common/api/package-use.html b/static/api/client/4.0.x/org/apache/pulsar/common/api/package-use.html new file mode 100644 index 000000000000..4d484a85061d --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/common/api/package-use.html @@ -0,0 +1,109 @@ + + + + +Uses of Package org.apache.pulsar.common.api (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Package
    org.apache.pulsar.common.api

    +
    +
    Packages that use org.apache.pulsar.common.api
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    org.apache.pulsar.common.api
    +
    +
    Common data classes used in the Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/common/classification/InterfaceAudience.LimitedPrivate.html b/static/api/client/4.0.x/org/apache/pulsar/common/classification/InterfaceAudience.LimitedPrivate.html new file mode 100644 index 000000000000..7e8dae1f63a2 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/common/classification/InterfaceAudience.LimitedPrivate.html @@ -0,0 +1,107 @@ + + + + +InterfaceAudience.LimitedPrivate (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.common.classification
    +

    Annotation Interface InterfaceAudience.LimitedPrivate

    +
    +
    +
    +
    Enclosing class:
    +
    InterfaceAudience
    +
    +
    +
    @Documented +@Retention(RUNTIME) +public static @interface InterfaceAudience.LimitedPrivate
    +
    Intended for use only within the project(s) specified in the annotation. + For example, "functions", "SQL".
    +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/common/classification/InterfaceAudience.Private.html b/static/api/client/4.0.x/org/apache/pulsar/common/classification/InterfaceAudience.Private.html new file mode 100644 index 000000000000..4ed490398673 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/common/classification/InterfaceAudience.Private.html @@ -0,0 +1,106 @@ + + + + +InterfaceAudience.Private (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.common.classification
    +

    Annotation Interface InterfaceAudience.Private

    +
    +
    +
    +
    Enclosing class:
    +
    InterfaceAudience
    +
    +
    +
    @Documented +@Retention(RUNTIME) +public static @interface InterfaceAudience.Private
    +
    Intended for use only within the project itself.
    +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/common/classification/InterfaceAudience.Public.html b/static/api/client/4.0.x/org/apache/pulsar/common/classification/InterfaceAudience.Public.html new file mode 100644 index 000000000000..6996506b2d4e --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/common/classification/InterfaceAudience.Public.html @@ -0,0 +1,106 @@ + + + + +InterfaceAudience.Public (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.common.classification
    +

    Annotation Interface InterfaceAudience.Public

    +
    +
    +
    +
    Enclosing class:
    +
    InterfaceAudience
    +
    +
    +
    @Documented +@Retention(RUNTIME) +public static @interface InterfaceAudience.Public
    +
    Intended for use by any project or application.
    +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/common/classification/InterfaceAudience.html b/static/api/client/4.0.x/org/apache/pulsar/common/classification/InterfaceAudience.html new file mode 100644 index 000000000000..42c4f8eddaa0 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/common/classification/InterfaceAudience.html @@ -0,0 +1,149 @@ + + + + +InterfaceAudience (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.common.classification
    +

    Class InterfaceAudience

    +
    +
    java.lang.Object +
    org.apache.pulsar.common.classification.InterfaceAudience
    +
    +
    +
    +
    @Public +@Stable +public class InterfaceAudience +extends Object
    +
    Annotation to inform users of a package, class or method's intended audience.
    +
    +
    + +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/common/classification/InterfaceStability.Evolving.html b/static/api/client/4.0.x/org/apache/pulsar/common/classification/InterfaceStability.Evolving.html new file mode 100644 index 000000000000..dc450b425cb1 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/common/classification/InterfaceStability.Evolving.html @@ -0,0 +1,105 @@ + + + + +InterfaceStability.Evolving (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.common.classification
    +

    Annotation Interface InterfaceStability.Evolving

    +
    +
    +
    +
    Enclosing class:
    +
    InterfaceStability
    +
    +
    +
    @Documented +public static @interface InterfaceStability.Evolving
    +
    Evolving, but can break compatibility at minor release (i.e. m.x)
    +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/common/classification/InterfaceStability.Stable.html b/static/api/client/4.0.x/org/apache/pulsar/common/classification/InterfaceStability.Stable.html new file mode 100644 index 000000000000..bebc80d29933 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/common/classification/InterfaceStability.Stable.html @@ -0,0 +1,106 @@ + + + + +InterfaceStability.Stable (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.common.classification
    +

    Annotation Interface InterfaceStability.Stable

    +
    +
    +
    +
    Enclosing class:
    +
    InterfaceStability
    +
    +
    +
    @Documented +public static @interface InterfaceStability.Stable
    +
    Can evolve while retaining compatibility for minor release boundaries.; + can break compatibility only at major release (ie. at m.0).
    +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/common/classification/InterfaceStability.Unstable.html b/static/api/client/4.0.x/org/apache/pulsar/common/classification/InterfaceStability.Unstable.html new file mode 100644 index 000000000000..a3f5fc5a163a --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/common/classification/InterfaceStability.Unstable.html @@ -0,0 +1,106 @@ + + + + +InterfaceStability.Unstable (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.common.classification
    +

    Annotation Interface InterfaceStability.Unstable

    +
    +
    +
    +
    Enclosing class:
    +
    InterfaceStability
    +
    +
    +
    @Documented +public static @interface InterfaceStability.Unstable
    +
    No guarantee is provided as to reliability or stability across any + level of release granularity.
    +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/common/classification/InterfaceStability.html b/static/api/client/4.0.x/org/apache/pulsar/common/classification/InterfaceStability.html new file mode 100644 index 000000000000..d2763e1aa880 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/common/classification/InterfaceStability.html @@ -0,0 +1,152 @@ + + + + +InterfaceStability (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.common.classification
    +

    Class InterfaceStability

    +
    +
    java.lang.Object +
    org.apache.pulsar.common.classification.InterfaceStability
    +
    +
    +
    +
    @Public +@Stable +public class InterfaceStability +extends Object
    +
    Annotation to inform users of how much to rely on a particular package, + class or method not changing over time.
    +
    +
    + +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/common/classification/class-use/InterfaceAudience.LimitedPrivate.html b/static/api/client/4.0.x/org/apache/pulsar/common/classification/class-use/InterfaceAudience.LimitedPrivate.html new file mode 100644 index 000000000000..c65d7a7f9c0b --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/common/classification/class-use/InterfaceAudience.LimitedPrivate.html @@ -0,0 +1,102 @@ + + + + +Uses of Annotation Interface org.apache.pulsar.common.classification.InterfaceAudience.LimitedPrivate (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Annotation Interface
    org.apache.pulsar.common.classification.InterfaceAudience.LimitedPrivate

    +
    +
    Packages that use InterfaceAudience.LimitedPrivate
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/common/classification/class-use/InterfaceAudience.Private.html b/static/api/client/4.0.x/org/apache/pulsar/common/classification/class-use/InterfaceAudience.Private.html new file mode 100644 index 000000000000..1c89fde97bf8 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/common/classification/class-use/InterfaceAudience.Private.html @@ -0,0 +1,172 @@ + + + + +Uses of Annotation Interface org.apache.pulsar.common.classification.InterfaceAudience.Private (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Annotation Interface
    org.apache.pulsar.common.classification.InterfaceAudience.Private

    +
    +
    Packages that use InterfaceAudience.Private
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    org.apache.pulsar.client.api.interceptor
    +
    +
    Pulsar interceptors.
    +
    +
    org.apache.pulsar.client.api.schema
    +
    +
    Schema definitions for Pulsar Client API.
    +
    +
    org.apache.pulsar.client.api.transaction
    +
    +
    Pulsar transaction related API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/common/classification/class-use/InterfaceAudience.Public.html b/static/api/client/4.0.x/org/apache/pulsar/common/classification/class-use/InterfaceAudience.Public.html new file mode 100644 index 000000000000..a95343fce367 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/common/classification/class-use/InterfaceAudience.Public.html @@ -0,0 +1,554 @@ + + + + +Uses of Annotation Interface org.apache.pulsar.common.classification.InterfaceAudience.Public (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Annotation Interface
    org.apache.pulsar.common.classification.InterfaceAudience.Public

    +
    +
    Packages that use InterfaceAudience.Public
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    org.apache.pulsar.client.api.interceptor
    +
    +
    Pulsar interceptors.
    +
    +
    org.apache.pulsar.client.api.schema
    +
    +
    Schema definitions for Pulsar Client API.
    +
    +
    org.apache.pulsar.client.api.transaction
    +
    +
    Pulsar transaction related API.
    +
    +
    org.apache.pulsar.common.classification
    +
    +
    Annotations used across the whole project.
    +
    +
    org.apache.pulsar.common.schema
    +
    +
    This package contains data structures for schema definitions used in the Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/common/classification/class-use/InterfaceAudience.html b/static/api/client/4.0.x/org/apache/pulsar/common/classification/class-use/InterfaceAudience.html new file mode 100644 index 000000000000..b6012ec0a3b1 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/common/classification/class-use/InterfaceAudience.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.common.classification.InterfaceAudience (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.apache.pulsar.common.classification.InterfaceAudience

    +
    +No usage of org.apache.pulsar.common.classification.InterfaceAudience
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/common/classification/class-use/InterfaceStability.Evolving.html b/static/api/client/4.0.x/org/apache/pulsar/common/classification/class-use/InterfaceStability.Evolving.html new file mode 100644 index 000000000000..0eae2f36ce82 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/common/classification/class-use/InterfaceStability.Evolving.html @@ -0,0 +1,165 @@ + + + + +Uses of Annotation Interface org.apache.pulsar.common.classification.InterfaceStability.Evolving (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Annotation Interface
    org.apache.pulsar.common.classification.InterfaceStability.Evolving

    +
    +
    Packages that use InterfaceStability.Evolving
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    org.apache.pulsar.client.api.transaction
    +
    +
    Pulsar transaction related API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/common/classification/class-use/InterfaceStability.Stable.html b/static/api/client/4.0.x/org/apache/pulsar/common/classification/class-use/InterfaceStability.Stable.html new file mode 100644 index 000000000000..498bd8ca0a41 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/common/classification/class-use/InterfaceStability.Stable.html @@ -0,0 +1,532 @@ + + + + +Uses of Annotation Interface org.apache.pulsar.common.classification.InterfaceStability.Stable (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Annotation Interface
    org.apache.pulsar.common.classification.InterfaceStability.Stable

    +
    +
    Packages that use InterfaceStability.Stable
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    org.apache.pulsar.client.api.interceptor
    +
    +
    Pulsar interceptors.
    +
    +
    org.apache.pulsar.client.api.schema
    +
    +
    Schema definitions for Pulsar Client API.
    +
    +
    org.apache.pulsar.common.classification
    +
    +
    Annotations used across the whole project.
    +
    +
    org.apache.pulsar.common.schema
    +
    +
    This package contains data structures for schema definitions used in the Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/common/classification/class-use/InterfaceStability.Unstable.html b/static/api/client/4.0.x/org/apache/pulsar/common/classification/class-use/InterfaceStability.Unstable.html new file mode 100644 index 000000000000..880dbd725eca --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/common/classification/class-use/InterfaceStability.Unstable.html @@ -0,0 +1,62 @@ + + + + +Uses of Annotation Interface org.apache.pulsar.common.classification.InterfaceStability.Unstable (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Annotation Interface
    org.apache.pulsar.common.classification.InterfaceStability.Unstable

    +
    +No usage of org.apache.pulsar.common.classification.InterfaceStability.Unstable
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/common/classification/class-use/InterfaceStability.html b/static/api/client/4.0.x/org/apache/pulsar/common/classification/class-use/InterfaceStability.html new file mode 100644 index 000000000000..16f5cc2a629c --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/common/classification/class-use/InterfaceStability.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.common.classification.InterfaceStability (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.apache.pulsar.common.classification.InterfaceStability

    +
    +No usage of org.apache.pulsar.common.classification.InterfaceStability
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/common/classification/package-summary.html b/static/api/client/4.0.x/org/apache/pulsar/common/classification/package-summary.html new file mode 100644 index 000000000000..dc72c79f36c5 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/common/classification/package-summary.html @@ -0,0 +1,134 @@ + + + + +org.apache.pulsar.common.classification (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package org.apache.pulsar.common.classification

    +
    +
    +
    package org.apache.pulsar.common.classification
    +
    +
    Annotations used across the whole project.
    +
    +
    +
      +
    • +
      +
      +
      +
      +
      Class
      +
      Description
      +
      InterfaceAudience
      +
      +
      Annotation to inform users of a package, class or method's intended audience.
      +
      +
      InterfaceAudience.LimitedPrivate
      +
      +
      Intended for use only within the project(s) specified in the annotation.
      +
      +
      InterfaceAudience.Private
      +
      +
      Intended for use only within the project itself.
      +
      +
      InterfaceAudience.Public
      +
      +
      Intended for use by any project or application.
      +
      +
      InterfaceStability
      +
      +
      Annotation to inform users of how much to rely on a particular package, + class or method not changing over time.
      +
      +
      InterfaceStability.Evolving
      +
      +
      Evolving, but can break compatibility at minor release (i.e.
      +
      +
      InterfaceStability.Stable
      +
      +
      Can evolve while retaining compatibility for minor release boundaries.; + can break compatibility only at major release (ie.
      +
      +
      InterfaceStability.Unstable
      +
      +
      No guarantee is provided as to reliability or stability across any + level of release granularity.
      +
      +
      +
      +
      +
      • +
    +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/common/classification/package-tree.html b/static/api/client/4.0.x/org/apache/pulsar/common/classification/package-tree.html new file mode 100644 index 000000000000..ce7e52fbf5d4 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/common/classification/package-tree.html @@ -0,0 +1,88 @@ + + + + +org.apache.pulsar.common.classification Class Hierarchy (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package org.apache.pulsar.common.classification

    +
    +Package Hierarchies: + +
    +

    Class Hierarchy

    + +
    +
    +

    Annotation Interface Hierarchy

    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/common/classification/package-use.html b/static/api/client/4.0.x/org/apache/pulsar/common/classification/package-use.html new file mode 100644 index 000000000000..5e9794c8a612 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/common/classification/package-use.html @@ -0,0 +1,226 @@ + + + + +Uses of Package org.apache.pulsar.common.classification (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Package
    org.apache.pulsar.common.classification

    +
    +
    Packages that use org.apache.pulsar.common.classification
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    org.apache.pulsar.client.api.interceptor
    +
    +
    Pulsar interceptors.
    +
    +
    org.apache.pulsar.client.api.schema
    +
    +
    Schema definitions for Pulsar Client API.
    +
    +
    org.apache.pulsar.client.api.transaction
    +
    +
    Pulsar transaction related API.
    +
    +
    org.apache.pulsar.common.classification
    +
    +
    Annotations used across the whole project.
    +
    +
    org.apache.pulsar.common.schema
    +
    +
    This package contains data structures for schema definitions used in the Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/common/schema/KeyValue.KeyValueDecoder.html b/static/api/client/4.0.x/org/apache/pulsar/common/schema/KeyValue.KeyValueDecoder.html new file mode 100644 index 000000000000..40e17d1b6505 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/common/schema/KeyValue.KeyValueDecoder.html @@ -0,0 +1,165 @@ + + + + +KeyValue.KeyValueDecoder (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.common.schema
    +

    Interface KeyValue.KeyValueDecoder<K,V>

    +
    +
    +
    +
    Enclosing class:
    +
    KeyValue<K,V>
    +
    +
    +
    Functional Interface:
    +
    This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
    +
    +
    +
    @FunctionalInterface +public static interface KeyValue.KeyValueDecoder<K,V>
    +
    Decoder to decode key/value bytes.
    +
    +
    +
      + +
    • +
      +

      Method Summary

      +
      +
      +
      +
      +
      Modifier and Type
      +
      Method
      +
      Description
      +
      KeyValue<K,V>
      +
      decode(byte[] keyData, + byte[] valueData)
      +
      +
      Decode key and value bytes into a KeyValue pair.
      +
      +
      +
      +
      +
      +
      • +
    +
    +
    +
      + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        decode

        +
        KeyValue<K,V> decode(byte[] keyData, + byte[] valueData)
        +
        Decode key and value bytes into a KeyValue pair.
        +
        +
        Parameters:
        +
        keyData - key data
        +
        valueData - value data
        +
        Returns:
        +
        the decoded KeyValue pair
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/common/schema/KeyValue.html b/static/api/client/4.0.x/org/apache/pulsar/common/schema/KeyValue.html new file mode 100644 index 000000000000..f4dbee92f241 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/common/schema/KeyValue.html @@ -0,0 +1,299 @@ + + + + +KeyValue (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.common.schema
    +

    Class KeyValue<K,V>

    +
    +
    java.lang.Object +
    org.apache.pulsar.common.schema.KeyValue<K,V>
    +
    +
    +
    +
    @Public +@Stable +public class KeyValue<K,V> +extends Object
    +
    A simple KeyValue class.
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        KeyValue

        +
        public KeyValue(K key, + V value)
        +
        +
        • +
      +
      +
      • + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        getKey

        +
        public K getKey()
        +
        +
        • +
      • +
        +

        getValue

        +
        public V getValue()
        +
        +
        • +
      • +
        +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class Object
        +
        +
        +
        • +
      • +
        +

        equals

        +
        public boolean equals(Object obj)
        +
        +
        Overrides:
        +
        equals in class Object
        +
        +
        +
        • +
      • +
        +

        toString

        +
        public String toString()
        +
        +
        Overrides:
        +
        toString in class Object
        +
        +
        +
        • +
      • +
        +

        encode

        +
        public static <K, +V> byte[] encode(K key, + Schema<K> keyWriter, + V value, + Schema<V> valueWriter)
        +
        Encode a key and value pair into a bytes array.
        +
        +
        Parameters:
        +
        key - key object to encode
        +
        keyWriter - a writer to encode key object
        +
        value - value object to encode
        +
        valueWriter - a writer to encode value object
        +
        Returns:
        +
        the encoded bytes array
        +
        +
        +
        • +
      • +
        +

        decode

        +
        public static <K, +V> KeyValue<K,V> decode(byte[] data, + KeyValue.KeyValueDecoder<K,V> decoder)
        +
        Decode the value into a key/value pair.
        +
        +
        Parameters:
        +
        data - the encoded bytes
        +
        decoder - the decoder to decode encoded key/value bytes
        +
        Returns:
        +
        the decoded key/value pair
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/common/schema/KeyValueEncodingType.html b/static/api/client/4.0.x/org/apache/pulsar/common/schema/KeyValueEncodingType.html new file mode 100644 index 000000000000..b7c3890a100f --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/common/schema/KeyValueEncodingType.html @@ -0,0 +1,245 @@ + + + + +KeyValueEncodingType (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.common.schema
    +

    Enum Class KeyValueEncodingType

    +
    +
    java.lang.Object +
    java.lang.Enum<KeyValueEncodingType> +
    org.apache.pulsar.common.schema.KeyValueEncodingType
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable, Comparable<KeyValueEncodingType>, Constable
    +
    +
    +
    @Public +@Stable +public enum KeyValueEncodingType +extends Enum<KeyValueEncodingType>
    +
    Encoding types of supported KeyValueSchema for Pulsar messages.
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Enum Constant Details

      +
        +
      • +
        +

        SEPARATED

        +
        public static final KeyValueEncodingType SEPARATED
        +
        Key is stored as message key, while value is stored as message payload.
        +
        +
        • +
      • +
        +

        INLINE

        +
        public static final KeyValueEncodingType INLINE
        +
        Key and value are stored as message payload.
        +
        +
        • +
      +
      +
      • + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        values

        +
        public static KeyValueEncodingType[] values()
        +
        Returns an array containing the constants of this enum class, in +the order they are declared.
        +
        +
        Returns:
        +
        an array containing the constants of this enum class, in the order they are declared
        +
        +
        +
        • +
      • +
        +

        valueOf

        +
        public static KeyValueEncodingType valueOf(String name)
        +
        Returns the enum constant of this class with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this class. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        IllegalArgumentException - if this enum class has no constant with the specified name
        +
        NullPointerException - if the argument is null
        +
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/common/schema/SchemaInfo.SchemaInfoBuilder.html b/static/api/client/4.0.x/org/apache/pulsar/common/schema/SchemaInfo.SchemaInfoBuilder.html new file mode 100644 index 000000000000..a01645042725 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/common/schema/SchemaInfo.SchemaInfoBuilder.html @@ -0,0 +1,199 @@ + + + + +SchemaInfo.SchemaInfoBuilder (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.common.schema
    +

    Class SchemaInfo.SchemaInfoBuilder

    +
    +
    java.lang.Object +
    org.apache.pulsar.common.schema.SchemaInfo.SchemaInfoBuilder
    +
    +
    +
    +
    Enclosing interface:
    +
    SchemaInfo
    +
    +
    +
    public static class SchemaInfo.SchemaInfoBuilder +extends Object
    +
    +
    + +
    +
    + +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/common/schema/SchemaInfo.html b/static/api/client/4.0.x/org/apache/pulsar/common/schema/SchemaInfo.html new file mode 100644 index 000000000000..cc82f1bc519b --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/common/schema/SchemaInfo.html @@ -0,0 +1,227 @@ + + + + +SchemaInfo (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.common.schema
    +

    Interface SchemaInfo

    +
    +
    +
    +
    @Public +@Stable +public interface SchemaInfo
    +
    Information about the schema.
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        getName

        +
        String getName()
        +
        +
        • +
      • +
        +

        getSchema

        +
        byte[] getSchema()
        +
        The schema data in AVRO JSON format.
        +
        +
        • +
      • +
        +

        getType

        +
        SchemaType getType()
        +
        The type of schema (AVRO, JSON, PROTOBUF, etc..).
        +
        +
        • +
      • +
        +

        getProperties

        +
        Map<String,String> getProperties()
        +
        Additional properties of the schema definition (implementation defined).
        +
        +
        • +
      • +
        +

        getTimestamp

        +
        long getTimestamp()
        +
        The created time of schema.
        +
        +
        • +
      • +
        +

        getSchemaDefinition

        +
        String getSchemaDefinition()
        +
        +
        • +
      • +
        +

        builder

        +
        static SchemaInfo.SchemaInfoBuilder builder()
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/common/schema/SchemaInfoWithVersion.html b/static/api/client/4.0.x/org/apache/pulsar/common/schema/SchemaInfoWithVersion.html new file mode 100644 index 000000000000..b7376d96ae76 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/common/schema/SchemaInfoWithVersion.html @@ -0,0 +1,184 @@ + + + + +SchemaInfoWithVersion (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.common.schema
    +

    Class SchemaInfoWithVersion

    +
    +
    java.lang.Object +
    org.apache.pulsar.common.schema.SchemaInfoWithVersion
    +
    +
    +
    +
    @Public +@Stable +public class SchemaInfoWithVersion +extends Object
    +
    Data structure representing a schema information including its version.
    +
    +
    + +
    +
    +
      + +
    • +
      +

      Constructor Details

      +
        +
      • +
        +

        SchemaInfoWithVersion

        +
        public SchemaInfoWithVersion()
        +
        +
        • +
      +
      +
      • + +
    • +
      +

      Method Details

      + +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/common/schema/SchemaType.html b/static/api/client/4.0.x/org/apache/pulsar/common/schema/SchemaType.html new file mode 100644 index 000000000000..a92fac7d92a9 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/common/schema/SchemaType.html @@ -0,0 +1,593 @@ + + + + +SchemaType (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    + +
    +
    Package org.apache.pulsar.common.schema
    +

    Enum Class SchemaType

    +
    +
    java.lang.Object +
    java.lang.Enum<SchemaType> +
    org.apache.pulsar.common.schema.SchemaType
    +
    +
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable, Comparable<SchemaType>, Constable
    +
    +
    +
    @Public +@Stable +public enum SchemaType +extends Enum<SchemaType>
    +
    Types of supported schema for Pulsar messages. + +

    Ideally we should have just one single set of enum definitions + for schema type. but we have 3 locations of defining schema types. + +

    when you are adding a new schema type that whose + schema info is required to be recorded in schema registry, + add corresponding schema type into `pulsar-common/src/main/proto/PulsarApi.proto` + and `pulsar-broker/src/main/proto/SchemaRegistryFormat.proto`.

    +
    +
    + +
    +
    +
      + +
    • +
      +

      Enum Constant Details

      +
        +
      • +
        +

        NONE

        +
        public static final SchemaType NONE
        +
        No schema defined.
        +
        +
        • +
      • +
        +

        STRING

        +
        public static final SchemaType STRING
        +
        Simple String encoding with UTF-8.
        +
        +
        • +
      • +
        +

        JSON

        +
        public static final SchemaType JSON
        +
        JSON object encoding and validation.
        +
        +
        • +
      • +
        +

        PROTOBUF

        +
        public static final SchemaType PROTOBUF
        +
        Protobuf message encoding and decoding.
        +
        +
        • +
      • +
        +

        AVRO

        +
        public static final SchemaType AVRO
        +
        Serialize and deserialize via avro.
        +
        +
        • +
      • +
        +

        BOOLEAN

        +
        public static final SchemaType BOOLEAN
        +
        boolean schema defined.
        +
        +
        Since:
        +
        2.3.0
        +
        +
        +
        • +
      • +
        +

        INT8

        +
        public static final SchemaType INT8
        +
        A 8-byte integer.
        +
        +
        • +
      • +
        +

        INT16

        +
        public static final SchemaType INT16
        +
        A 16-byte integer.
        +
        +
        • +
      • +
        +

        INT32

        +
        public static final SchemaType INT32
        +
        A 32-byte integer.
        +
        +
        • +
      • +
        +

        INT64

        +
        public static final SchemaType INT64
        +
        A 64-byte integer.
        +
        +
        • +
      • +
        +

        FLOAT

        +
        public static final SchemaType FLOAT
        +
        A float number.
        +
        +
        • +
      • +
        +

        DOUBLE

        +
        public static final SchemaType DOUBLE
        +
        A double number.
        +
        +
        • +
      • +
        +

        DATE

        +
        public static final SchemaType DATE
        +
        Date.
        +
        +
        Since:
        +
        2.4.0
        +
        +
        +
        • +
      • +
        +

        TIME

        +
        public static final SchemaType TIME
        +
        Time.
        +
        +
        Since:
        +
        2.4.0
        +
        +
        +
        • +
      • +
        +

        TIMESTAMP

        +
        public static final SchemaType TIMESTAMP
        +
        Timestamp.
        +
        +
        Since:
        +
        2.4.0
        +
        +
        +
        • +
      • +
        +

        KEY_VALUE

        +
        public static final SchemaType KEY_VALUE
        +
        A Schema that contains Key Schema and Value Schema.
        +
        +
        • +
      • +
        +

        INSTANT

        +
        public static final SchemaType INSTANT
        +
        Instant.
        +
        +
        • +
      • +
        +

        LOCAL_DATE

        +
        public static final SchemaType LOCAL_DATE
        +
        LocalDate.
        +
        +
        • +
      • +
        +

        LOCAL_TIME

        +
        public static final SchemaType LOCAL_TIME
        +
        LocalTime.
        +
        +
        • +
      • +
        +

        LOCAL_DATE_TIME

        +
        public static final SchemaType LOCAL_DATE_TIME
        +
        LocalDateTime.
        +
        +
        • +
      • +
        +

        PROTOBUF_NATIVE

        +
        public static final SchemaType PROTOBUF_NATIVE
        +
        Protobuf native schema base on Descriptor.
        +
        +
        • +
      • +
        +

        BYTES

        +
        public static final SchemaType BYTES
        +
        A bytes array.
        +
        +
        • +
      • +
        +

        AUTO

        +
        @Deprecated +public static final SchemaType AUTO
        +
        Deprecated.
        +
        Auto Detect Schema Type.
        +
        +
        • +
      • +
        +

        AUTO_CONSUME

        +
        public static final SchemaType AUTO_CONSUME
        +
        Auto Consume Type.
        +
        +
        • +
      • +
        +

        AUTO_PUBLISH

        +
        public static final SchemaType AUTO_PUBLISH
        +
        Auto Publish Type.
        +
        +
        • +
      +
      +
      • + +
    • +
      +

      Method Details

      +
        +
      • +
        +

        values

        +
        public static SchemaType[] values()
        +
        Returns an array containing the constants of this enum class, in +the order they are declared.
        +
        +
        Returns:
        +
        an array containing the constants of this enum class, in the order they are declared
        +
        +
        +
        • +
      • +
        +

        valueOf

        +
        public static SchemaType valueOf(String name)
        +
        Returns the enum constant of this class with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this class. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        IllegalArgumentException - if this enum class has no constant with the specified name
        +
        NullPointerException - if the argument is null
        +
        +
        +
        • +
      • +
        +

        getValue

        +
        public int getValue()
        +
        +
        • +
      • +
        +

        valueOf

        +
        public static SchemaType valueOf(int value)
        +
        Returns the enum constant of this class with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this class. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        value - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        IllegalArgumentException - if this enum class has no constant with the specified name
        +
        NullPointerException - if the argument is null
        +
        +
        +
        • +
      • +
        +

        isPrimitive

        +
        public boolean isPrimitive()
        +
        +
        • +
      • +
        +

        isStruct

        +
        public boolean isStruct()
        +
        +
        • +
      • +
        +

        isPrimitiveType

        +
        public static boolean isPrimitiveType(SchemaType type)
        +
        +
        • +
      • +
        +

        isStructType

        +
        public static boolean isStructType(SchemaType type)
        +
        +
        • +
      +
      +
      • +
    +
    + +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/common/schema/class-use/KeyValue.KeyValueDecoder.html b/static/api/client/4.0.x/org/apache/pulsar/common/schema/class-use/KeyValue.KeyValueDecoder.html new file mode 100644 index 000000000000..e2bcccbb3c05 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/common/schema/class-use/KeyValue.KeyValueDecoder.html @@ -0,0 +1,93 @@ + + + + +Uses of Interface org.apache.pulsar.common.schema.KeyValue.KeyValueDecoder (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    org.apache.pulsar.common.schema.KeyValue.KeyValueDecoder

    +
    +
    Packages that use KeyValue.KeyValueDecoder
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.common.schema
    +
    +
    This package contains data structures for schema definitions used in the Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/common/schema/class-use/KeyValue.html b/static/api/client/4.0.x/org/apache/pulsar/common/schema/class-use/KeyValue.html new file mode 100644 index 000000000000..7797d336ba27 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/common/schema/class-use/KeyValue.html @@ -0,0 +1,206 @@ + + + + +Uses of Class org.apache.pulsar.common.schema.KeyValue (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.apache.pulsar.common.schema.KeyValue

    +
    +
    Packages that use KeyValue
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    org.apache.pulsar.client.internal
    +
    +
    Helpers which provide useful functionality for the implementation of Pulsar Client API.
    +
    +
    org.apache.pulsar.common.schema
    +
    +
    This package contains data structures for schema definitions used in the Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/common/schema/class-use/KeyValueEncodingType.html b/static/api/client/4.0.x/org/apache/pulsar/common/schema/class-use/KeyValueEncodingType.html new file mode 100644 index 000000000000..0270f7112575 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/common/schema/class-use/KeyValueEncodingType.html @@ -0,0 +1,189 @@ + + + + +Uses of Enum Class org.apache.pulsar.common.schema.KeyValueEncodingType (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Enum Class
    org.apache.pulsar.common.schema.KeyValueEncodingType

    +
    +
    Packages that use KeyValueEncodingType
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    org.apache.pulsar.client.api.schema
    +
    +
    Schema definitions for Pulsar Client API.
    +
    +
    org.apache.pulsar.client.internal
    +
    +
    Helpers which provide useful functionality for the implementation of Pulsar Client API.
    +
    +
    org.apache.pulsar.common.schema
    +
    +
    This package contains data structures for schema definitions used in the Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/common/schema/class-use/SchemaInfo.SchemaInfoBuilder.html b/static/api/client/4.0.x/org/apache/pulsar/common/schema/class-use/SchemaInfo.SchemaInfoBuilder.html new file mode 100644 index 000000000000..9fa7829825c9 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/common/schema/class-use/SchemaInfo.SchemaInfoBuilder.html @@ -0,0 +1,104 @@ + + + + +Uses of Class org.apache.pulsar.common.schema.SchemaInfo.SchemaInfoBuilder (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.apache.pulsar.common.schema.SchemaInfo.SchemaInfoBuilder

    +
    +
    Packages that use SchemaInfo.SchemaInfoBuilder
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.common.schema
    +
    +
    This package contains data structures for schema definitions used in the Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/common/schema/class-use/SchemaInfo.html b/static/api/client/4.0.x/org/apache/pulsar/common/schema/class-use/SchemaInfo.html new file mode 100644 index 000000000000..46e31a1bb834 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/common/schema/class-use/SchemaInfo.html @@ -0,0 +1,285 @@ + + + + +Uses of Interface org.apache.pulsar.common.schema.SchemaInfo (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    org.apache.pulsar.common.schema.SchemaInfo

    +
    +
    Packages that use SchemaInfo
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    org.apache.pulsar.client.api.schema
    +
    +
    Schema definitions for Pulsar Client API.
    +
    +
    org.apache.pulsar.client.internal
    +
    +
    Helpers which provide useful functionality for the implementation of Pulsar Client API.
    +
    +
    org.apache.pulsar.common.schema
    +
    +
    This package contains data structures for schema definitions used in the Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/common/schema/class-use/SchemaInfoWithVersion.html b/static/api/client/4.0.x/org/apache/pulsar/common/schema/class-use/SchemaInfoWithVersion.html new file mode 100644 index 000000000000..4708bee90f6f --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/common/schema/class-use/SchemaInfoWithVersion.html @@ -0,0 +1,91 @@ + + + + +Uses of Class org.apache.pulsar.common.schema.SchemaInfoWithVersion (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.apache.pulsar.common.schema.SchemaInfoWithVersion

    +
    +
    Packages that use SchemaInfoWithVersion
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.internal
    +
    +
    Helpers which provide useful functionality for the implementation of Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/common/schema/class-use/SchemaType.html b/static/api/client/4.0.x/org/apache/pulsar/common/schema/class-use/SchemaType.html new file mode 100644 index 000000000000..02dac5261fa9 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/common/schema/class-use/SchemaType.html @@ -0,0 +1,214 @@ + + + + +Uses of Enum Class org.apache.pulsar.common.schema.SchemaType (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Enum Class
    org.apache.pulsar.common.schema.SchemaType

    +
    +
    Packages that use SchemaType
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    org.apache.pulsar.client.api.schema
    +
    +
    Schema definitions for Pulsar Client API.
    +
    +
    org.apache.pulsar.client.internal
    +
    +
    Helpers which provide useful functionality for the implementation of Pulsar Client API.
    +
    +
    org.apache.pulsar.common.schema
    +
    +
    This package contains data structures for schema definitions used in the Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/common/schema/package-summary.html b/static/api/client/4.0.x/org/apache/pulsar/common/schema/package-summary.html new file mode 100644 index 000000000000..c2a628eba379 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/common/schema/package-summary.html @@ -0,0 +1,125 @@ + + + + +org.apache.pulsar.common.schema (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package org.apache.pulsar.common.schema

    +
    +
    +
    package org.apache.pulsar.common.schema
    +
    +
    This package contains data structures for schema definitions used in the Pulsar Client API.
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/common/schema/package-tree.html b/static/api/client/4.0.x/org/apache/pulsar/common/schema/package-tree.html new file mode 100644 index 000000000000..0891701c65f2 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/common/schema/package-tree.html @@ -0,0 +1,100 @@ + + + + +org.apache.pulsar.common.schema Class Hierarchy (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package org.apache.pulsar.common.schema

    +
    +Package Hierarchies: + +
    +

    Class Hierarchy

    + +
    +
    +

    Interface Hierarchy

    + +
    +
    +

    Enum Class Hierarchy

    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/org/apache/pulsar/common/schema/package-use.html b/static/api/client/4.0.x/org/apache/pulsar/common/schema/package-use.html new file mode 100644 index 000000000000..fc813fbd1034 --- /dev/null +++ b/static/api/client/4.0.x/org/apache/pulsar/common/schema/package-use.html @@ -0,0 +1,193 @@ + + + + +Uses of Package org.apache.pulsar.common.schema (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Package
    org.apache.pulsar.common.schema

    +
    +
    Packages that use org.apache.pulsar.common.schema
    +
    +
    Package
    +
    Description
    +
    org.apache.pulsar.client.api
    +
    +
    Pulsar Client API.
    +
    +
    org.apache.pulsar.client.api.schema
    +
    +
    Schema definitions for Pulsar Client API.
    +
    +
    org.apache.pulsar.client.internal
    +
    +
    Helpers which provide useful functionality for the implementation of Pulsar Client API.
    +
    +
    org.apache.pulsar.common.schema
    +
    +
    This package contains data structures for schema definitions used in the Pulsar Client API.
    +
    +
    +
    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/overview-summary.html b/static/api/client/4.0.x/overview-summary.html new file mode 100644 index 000000000000..1e851feb4a4e --- /dev/null +++ b/static/api/client/4.0.x/overview-summary.html @@ -0,0 +1,25 @@ + + + + +Pulsar Client :: API 4.0.0 API + + + + + + + + + + +
    + +

    index.html

    +
    + + diff --git a/static/api/client/4.0.x/overview-tree.html b/static/api/client/4.0.x/overview-tree.html new file mode 100644 index 000000000000..56161f68f7b4 --- /dev/null +++ b/static/api/client/4.0.x/overview-tree.html @@ -0,0 +1,356 @@ + + + + +Class Hierarchy (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For All Packages

    +
    +Package Hierarchies: + +
    +

    Class Hierarchy

    + +
    +
    +

    Interface Hierarchy

    + +
    +
    +

    Annotation Interface Hierarchy

    + +
    +
    +

    Enum Class Hierarchy

    + +
    +
    + +
    +
    + + diff --git a/static/api/client/4.0.x/package-search-index.js b/static/api/client/4.0.x/package-search-index.js new file mode 100644 index 000000000000..153a0fc6d77e --- /dev/null +++ b/static/api/client/4.0.x/package-search-index.js @@ -0,0 +1 @@ +packageSearchIndex = [{"l":"All Packages","u":"allpackages-index.html"},{"l":"org.apache.pulsar.client.api"},{"l":"org.apache.pulsar.client.api.interceptor"},{"l":"org.apache.pulsar.client.api.schema"},{"l":"org.apache.pulsar.client.api.transaction"},{"l":"org.apache.pulsar.client.internal"},{"l":"org.apache.pulsar.common.api"},{"l":"org.apache.pulsar.common.classification"},{"l":"org.apache.pulsar.common.schema"}];updateSearchResults(); \ No newline at end of file diff --git a/static/api/client/4.0.x/resources/glass.png b/static/api/client/4.0.x/resources/glass.png new file mode 100644 index 0000000000000000000000000000000000000000..a7f591f467a1c0c949bbc510156a0c1afb860a6e GIT binary patch literal 499 zcmVJoRsvExf%rEN>jUL}qZ_~k#FbE+Q;{`;0FZwVNX2n-^JoI; zP;4#$8DIy*Yk-P>VN(DUKmPse7mx+ExD4O|;?E5D0Z5($mjO3`*anwQU^s{ZDK#Lz zj>~{qyaIx5K!t%=G&2IJNzg!ChRpyLkO7}Ry!QaotAHAMpbB3AF(}|_f!G-oI|uK6 z`id_dumai5K%C3Y$;tKS_iqMPHg<*|-@e`liWLAggVM!zAP#@l;=c>S03;{#04Z~5 zN_+ss=Yg6*hTr59mzMwZ@+l~q!+?ft!fF66AXT#wWavHt30bZWFCK%!BNk}LN?0Hg z1VF_nfs`Lm^DjYZ1(1uD0u4CSIr)XAaqW6IT{!St5~1{i=i}zAy76p%_|w8rh@@c0Axr!ns=D-X+|*sY6!@wacG9%)Qn*O zl0sa739kT-&_?#oVxXF6tOnqTD)cZ}2vi$`ZU8RLAlo8=_z#*P3xI~i!lEh+Pdu-L zx{d*wgjtXbnGX_Yf@Tc7Q3YhLhPvc8noGJs2DA~1DySiA&6V{5JzFt ojAY1KXm~va;tU{v7C?Xj0BHw!K;2aXV*mgE07*qoM6N<$f;4TDA^-pY literal 0 HcmV?d00001 diff --git a/static/api/client/4.0.x/script-dir/jquery-3.6.1.min.js b/static/api/client/4.0.x/script-dir/jquery-3.6.1.min.js new file mode 100644 index 000000000000..2c69bc908b10 --- /dev/null +++ b/static/api/client/4.0.x/script-dir/jquery-3.6.1.min.js @@ -0,0 +1,2 @@ +/*! jQuery v3.6.1 | (c) OpenJS Foundation and other contributors | jquery.org/license */ +!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(C,e){"use strict";var t=[],r=Object.getPrototypeOf,s=t.slice,g=t.flat?function(e){return t.flat.call(e)}:function(e){return t.concat.apply([],e)},u=t.push,i=t.indexOf,n={},o=n.toString,y=n.hasOwnProperty,a=y.toString,l=a.call(Object),v={},m=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType&&"function"!=typeof e.item},x=function(e){return null!=e&&e===e.window},E=C.document,c={type:!0,src:!0,nonce:!0,noModule:!0};function b(e,t,n){var r,i,o=(n=n||E).createElement("script");if(o.text=e,t)for(r in c)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function w(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[o.call(e)]||"object":typeof e}var f="3.6.1",S=function(e,t){return new S.fn.init(e,t)};function p(e){var t=!!e&&"length"in e&&e.length,n=w(e);return!m(e)&&!x(e)&&("array"===n||0===t||"number"==typeof t&&0+~]|"+M+")"+M+"*"),U=new RegExp(M+"|>"),X=new RegExp(F),V=new RegExp("^"+I+"$"),G={ID:new RegExp("^#("+I+")"),CLASS:new RegExp("^\\.("+I+")"),TAG:new RegExp("^("+I+"|[*])"),ATTR:new RegExp("^"+W),PSEUDO:new RegExp("^"+F),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+R+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,Q=/^(?:input|select|textarea|button)$/i,J=/^h\d$/i,K=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\[\\da-fA-F]{1,6}"+M+"?|\\\\([^\\r\\n\\f])","g"),ne=function(e,t){var n="0x"+e.slice(1)-65536;return t||(n<0?String.fromCharCode(n+65536):String.fromCharCode(n>>10|55296,1023&n|56320))},re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},oe=function(){T()},ae=be(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{H.apply(t=O.call(p.childNodes),p.childNodes),t[p.childNodes.length].nodeType}catch(e){H={apply:t.length?function(e,t){L.apply(e,O.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&(T(e),e=e||C,E)){if(11!==p&&(u=Z.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&v(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return H.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&d.getElementsByClassName&&e.getElementsByClassName)return H.apply(n,e.getElementsByClassName(i)),n}if(d.qsa&&!N[t+" "]&&(!y||!y.test(t))&&(1!==p||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===p&&(U.test(t)||z.test(t))){(f=ee.test(t)&&ve(e.parentNode)||e)===e&&d.scope||((s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=S)),o=(l=h(t)).length;while(o--)l[o]=(s?"#"+s:":scope")+" "+xe(l[o]);c=l.join(",")}try{return H.apply(n,f.querySelectorAll(c)),n}catch(e){N(t,!0)}finally{s===S&&e.removeAttribute("id")}}}return g(t.replace(B,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[S]=!0,e}function ce(e){var t=C.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){var n=e.split("|"),r=n.length;while(r--)b.attrHandle[n[r]]=t}function pe(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function de(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ye(a){return le(function(o){return o=+o,le(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ve(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}for(e in d=se.support={},i=se.isXML=function(e){var t=e&&e.namespaceURI,n=e&&(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},T=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:p;return r!=C&&9===r.nodeType&&r.documentElement&&(a=(C=r).documentElement,E=!i(C),p!=C&&(n=C.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),d.scope=ce(function(e){return a.appendChild(e).appendChild(C.createElement("div")),"undefined"!=typeof e.querySelectorAll&&!e.querySelectorAll(":scope fieldset div").length}),d.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),d.getElementsByTagName=ce(function(e){return e.appendChild(C.createComment("")),!e.getElementsByTagName("*").length}),d.getElementsByClassName=K.test(C.getElementsByClassName),d.getById=ce(function(e){return a.appendChild(e).id=S,!C.getElementsByName||!C.getElementsByName(S).length}),d.getById?(b.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=d.getElementsByTagName?function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):d.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},b.find.CLASS=d.getElementsByClassName&&function(e,t){if("undefined"!=typeof t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],y=[],(d.qsa=K.test(C.querySelectorAll))&&(ce(function(e){var t;a.appendChild(e).innerHTML="",e.querySelectorAll("[msallowcapture^='']").length&&y.push("[*^$]="+M+"*(?:''|\"\")"),e.querySelectorAll("[selected]").length||y.push("\\["+M+"*(?:value|"+R+")"),e.querySelectorAll("[id~="+S+"-]").length||y.push("~="),(t=C.createElement("input")).setAttribute("name",""),e.appendChild(t),e.querySelectorAll("[name='']").length||y.push("\\["+M+"*name"+M+"*="+M+"*(?:''|\"\")"),e.querySelectorAll(":checked").length||y.push(":checked"),e.querySelectorAll("a#"+S+"+*").length||y.push(".#.+[+~]"),e.querySelectorAll("\\\f"),y.push("[\\r\\n\\f]")}),ce(function(e){e.innerHTML="";var t=C.createElement("input");t.setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),e.querySelectorAll("[name=d]").length&&y.push("name"+M+"*[*^$|!~]?="),2!==e.querySelectorAll(":enabled").length&&y.push(":enabled",":disabled"),a.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&y.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),y.push(",.*:")})),(d.matchesSelector=K.test(c=a.matches||a.webkitMatchesSelector||a.mozMatchesSelector||a.oMatchesSelector||a.msMatchesSelector))&&ce(function(e){d.disconnectedMatch=c.call(e,"*"),c.call(e,"[s!='']:x"),s.push("!=",F)}),y=y.length&&new RegExp(y.join("|")),s=s.length&&new RegExp(s.join("|")),t=K.test(a.compareDocumentPosition),v=t||K.test(a.contains)?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)while(t=t.parentNode)if(t===e)return!0;return!1},j=t?function(e,t){if(e===t)return l=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)==(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!d.sortDetached&&t.compareDocumentPosition(e)===n?e==C||e.ownerDocument==p&&v(p,e)?-1:t==C||t.ownerDocument==p&&v(p,t)?1:u?P(u,e)-P(u,t):0:4&n?-1:1)}:function(e,t){if(e===t)return l=!0,0;var n,r=0,i=e.parentNode,o=t.parentNode,a=[e],s=[t];if(!i||!o)return e==C?-1:t==C?1:i?-1:o?1:u?P(u,e)-P(u,t):0;if(i===o)return pe(e,t);n=e;while(n=n.parentNode)a.unshift(n);n=t;while(n=n.parentNode)s.unshift(n);while(a[r]===s[r])r++;return r?pe(a[r],s[r]):a[r]==p?-1:s[r]==p?1:0}),C},se.matches=function(e,t){return se(e,null,null,t)},se.matchesSelector=function(e,t){if(T(e),d.matchesSelector&&E&&!N[t+" "]&&(!s||!s.test(t))&&(!y||!y.test(t)))try{var n=c.call(e,t);if(n||d.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){N(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return G.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&X.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=m[e+" "];return t||(t=new RegExp("(^|"+M+")"+e+"("+M+"|$)"))&&m(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function j(e,n,r){return m(n)?S.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?S.grep(e,function(e){return e===n!==r}):"string"!=typeof n?S.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(S.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||D,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:q.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof S?t[0]:t,S.merge(this,S.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:E,!0)),N.test(r[1])&&S.isPlainObject(t))for(r in t)m(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=E.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):m(e)?void 0!==n.ready?n.ready(e):e(S):S.makeArray(e,this)}).prototype=S.fn,D=S(E);var L=/^(?:parents|prev(?:Until|All))/,H={children:!0,contents:!0,next:!0,prev:!0};function O(e,t){while((e=e[t])&&1!==e.nodeType);return e}S.fn.extend({has:function(e){var t=S(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,he=/^$|^module$|\/(?:java|ecma)script/i;ce=E.createDocumentFragment().appendChild(E.createElement("div")),(fe=E.createElement("input")).setAttribute("type","radio"),fe.setAttribute("checked","checked"),fe.setAttribute("name","t"),ce.appendChild(fe),v.checkClone=ce.cloneNode(!0).cloneNode(!0).lastChild.checked,ce.innerHTML="",v.noCloneChecked=!!ce.cloneNode(!0).lastChild.defaultValue,ce.innerHTML="",v.option=!!ce.lastChild;var ge={thead:[1,"","
    "],col:[2,"","
    "],tr:[2,"","
    "],td:[3,"","
    "],_default:[0,"",""]};function ye(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&A(e,t)?S.merge([e],n):n}function ve(e,t){for(var n=0,r=e.length;n",""]);var me=/<|&#?\w+;/;function xe(e,t,n,r,i){for(var o,a,s,u,l,c,f=t.createDocumentFragment(),p=[],d=0,h=e.length;d\s*$/g;function je(e,t){return A(e,"table")&&A(11!==t.nodeType?t:t.firstChild,"tr")&&S(e).children("tbody")[0]||e}function De(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function qe(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Le(e,t){var n,r,i,o,a,s;if(1===t.nodeType){if(Y.hasData(e)&&(s=Y.get(e).events))for(i in Y.remove(t,"handle events"),s)for(n=0,r=s[i].length;n").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),E.head.appendChild(r[0])},abort:function(){i&&i()}}});var Ut,Xt=[],Vt=/(=)\?(?=&|$)|\?\?/;S.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=Xt.pop()||S.expando+"_"+Ct.guid++;return this[e]=!0,e}}),S.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Vt.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Vt.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=m(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Vt,"$1"+r):!1!==e.jsonp&&(e.url+=(Et.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||S.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=C[r],C[r]=function(){o=arguments},n.always(function(){void 0===i?S(C).removeProp(r):C[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,Xt.push(r)),o&&m(i)&&i(o[0]),o=i=void 0}),"script"}),v.createHTMLDocument=((Ut=E.implementation.createHTMLDocument("").body).innerHTML="
    ",2===Ut.childNodes.length),S.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(v.createHTMLDocument?((r=(t=E.implementation.createHTMLDocument("")).createElement("base")).href=E.location.href,t.head.appendChild(r)):t=E),o=!n&&[],(i=N.exec(e))?[t.createElement(i[1])]:(i=xe([e],t,o),o&&o.length&&S(o).remove(),S.merge([],i.childNodes)));var r,i,o},S.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(S.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},S.expr.pseudos.animated=function(t){return S.grep(S.timers,function(e){return t===e.elem}).length},S.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=S.css(e,"position"),c=S(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=S.css(e,"top"),u=S.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),m(t)&&(t=t.call(e,n,S.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):c.css(f)}},S.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){S.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===S.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===S.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=S(e).offset()).top+=S.css(e,"borderTopWidth",!0),i.left+=S.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-S.css(r,"marginTop",!0),left:t.left-i.left-S.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===S.css(e,"position"))e=e.offsetParent;return e||re})}}),S.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;S.fn[t]=function(e){return B(this,function(e,t,n){var r;if(x(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),S.each(["top","left"],function(e,n){S.cssHooks[n]=_e(v.pixelPosition,function(e,t){if(t)return t=Be(e,n),Pe.test(t)?S(e).position()[n]+"px":t})}),S.each({Height:"height",Width:"width"},function(a,s){S.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){S.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return B(this,function(e,t,n){var r;return x(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?S.css(e,t,i):S.style(e,t,n,i)},s,n?e:void 0,n)}})}),S.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){S.fn[t]=function(e){return this.on(t,e)}}),S.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)},hover:function(e,t){return this.mouseenter(e).mouseleave(t||e)}}),S.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){S.fn[n]=function(e,t){return 0",options:{classes:{},disabled:!1,create:null},_createWidget:function(t,e){e=x(e||this.defaultElement||this)[0],this.element=x(e),this.uuid=i++,this.eventNamespace="."+this.widgetName+this.uuid,this.bindings=x(),this.hoverable=x(),this.focusable=x(),this.classesElementLookup={},e!==this&&(x.data(e,this.widgetFullName,this),this._on(!0,this.element,{remove:function(t){t.target===e&&this.destroy()}}),this.document=x(e.style?e.ownerDocument:e.document||e),this.window=x(this.document[0].defaultView||this.document[0].parentWindow)),this.options=x.widget.extend({},this.options,this._getCreateOptions(),t),this._create(),this.options.disabled&&this._setOptionDisabled(this.options.disabled),this._trigger("create",null,this._getCreateEventData()),this._init()},_getCreateOptions:function(){return{}},_getCreateEventData:x.noop,_create:x.noop,_init:x.noop,destroy:function(){var i=this;this._destroy(),x.each(this.classesElementLookup,function(t,e){i._removeClass(e,t)}),this.element.off(this.eventNamespace).removeData(this.widgetFullName),this.widget().off(this.eventNamespace).removeAttr("aria-disabled"),this.bindings.off(this.eventNamespace)},_destroy:x.noop,widget:function(){return this.element},option:function(t,e){var i,s,n,o=t;if(0===arguments.length)return x.widget.extend({},this.options);if("string"==typeof t)if(o={},t=(i=t.split(".")).shift(),i.length){for(s=o[t]=x.widget.extend({},this.options[t]),n=0;n
    "),i=e.children()[0];return x("body").append(e),t=i.offsetWidth,e.css("overflow","scroll"),t===(i=i.offsetWidth)&&(i=e[0].clientWidth),e.remove(),s=t-i},getScrollInfo:function(t){var e=t.isWindow||t.isDocument?"":t.element.css("overflow-x"),i=t.isWindow||t.isDocument?"":t.element.css("overflow-y"),e="scroll"===e||"auto"===e&&t.widthC(E(s),E(n))?o.important="horizontal":o.important="vertical",c.using.call(this,t,o)}),l.offset(x.extend(u,{using:t}))})},x.ui.position={fit:{left:function(t,e){var i=e.within,s=i.isWindow?i.scrollLeft:i.offset.left,n=i.width,o=t.left-e.collisionPosition.marginLeft,l=s-o,a=o+e.collisionWidth-n-s;e.collisionWidth>n?0n?0",delay:300,options:{icons:{submenu:"ui-icon-caret-1-e"},items:"> *",menus:"ul",position:{my:"left top",at:"right top"},role:"menu",blur:null,focus:null,select:null},_create:function(){this.activeMenu=this.element,this.mouseHandled=!1,this.lastMousePosition={x:null,y:null},this.element.uniqueId().attr({role:this.options.role,tabIndex:0}),this._addClass("ui-menu","ui-widget ui-widget-content"),this._on({"mousedown .ui-menu-item":function(t){t.preventDefault(),this._activateItem(t)},"click .ui-menu-item":function(t){var e=x(t.target),i=x(x.ui.safeActiveElement(this.document[0]));!this.mouseHandled&&e.not(".ui-state-disabled").length&&(this.select(t),t.isPropagationStopped()||(this.mouseHandled=!0),e.has(".ui-menu").length?this.expand(t):!this.element.is(":focus")&&i.closest(".ui-menu").length&&(this.element.trigger("focus",[!0]),this.active&&1===this.active.parents(".ui-menu").length&&clearTimeout(this.timer)))},"mouseenter .ui-menu-item":"_activateItem","mousemove .ui-menu-item":"_activateItem",mouseleave:"collapseAll","mouseleave .ui-menu":"collapseAll",focus:function(t,e){var i=this.active||this._menuItems().first();e||this.focus(t,i)},blur:function(t){this._delay(function(){x.contains(this.element[0],x.ui.safeActiveElement(this.document[0]))||this.collapseAll(t)})},keydown:"_keydown"}),this.refresh(),this._on(this.document,{click:function(t){this._closeOnDocumentClick(t)&&this.collapseAll(t,!0),this.mouseHandled=!1}})},_activateItem:function(t){var e,i;this.previousFilter||t.clientX===this.lastMousePosition.x&&t.clientY===this.lastMousePosition.y||(this.lastMousePosition={x:t.clientX,y:t.clientY},e=x(t.target).closest(".ui-menu-item"),i=x(t.currentTarget),e[0]===i[0]&&(i.is(".ui-state-active")||(this._removeClass(i.siblings().children(".ui-state-active"),null,"ui-state-active"),this.focus(t,i))))},_destroy:function(){var t=this.element.find(".ui-menu-item").removeAttr("role aria-disabled").children(".ui-menu-item-wrapper").removeUniqueId().removeAttr("tabIndex role aria-haspopup");this.element.removeAttr("aria-activedescendant").find(".ui-menu").addBack().removeAttr("role aria-labelledby aria-expanded aria-hidden aria-disabled tabIndex").removeUniqueId().show(),t.children().each(function(){var t=x(this);t.data("ui-menu-submenu-caret")&&t.remove()})},_keydown:function(t){var e,i,s,n=!0;switch(t.keyCode){case x.ui.keyCode.PAGE_UP:this.previousPage(t);break;case x.ui.keyCode.PAGE_DOWN:this.nextPage(t);break;case x.ui.keyCode.HOME:this._move("first","first",t);break;case x.ui.keyCode.END:this._move("last","last",t);break;case x.ui.keyCode.UP:this.previous(t);break;case x.ui.keyCode.DOWN:this.next(t);break;case x.ui.keyCode.LEFT:this.collapse(t);break;case x.ui.keyCode.RIGHT:this.active&&!this.active.is(".ui-state-disabled")&&this.expand(t);break;case x.ui.keyCode.ENTER:case x.ui.keyCode.SPACE:this._activate(t);break;case x.ui.keyCode.ESCAPE:this.collapse(t);break;default:e=this.previousFilter||"",s=n=!1,i=96<=t.keyCode&&t.keyCode<=105?(t.keyCode-96).toString():String.fromCharCode(t.keyCode),clearTimeout(this.filterTimer),i===e?s=!0:i=e+i,e=this._filterMenuItems(i),(e=s&&-1!==e.index(this.active.next())?this.active.nextAll(".ui-menu-item"):e).length||(i=String.fromCharCode(t.keyCode),e=this._filterMenuItems(i)),e.length?(this.focus(t,e),this.previousFilter=i,this.filterTimer=this._delay(function(){delete this.previousFilter},1e3)):delete this.previousFilter}n&&t.preventDefault()},_activate:function(t){this.active&&!this.active.is(".ui-state-disabled")&&(this.active.children("[aria-haspopup='true']").length?this.expand(t):this.select(t))},refresh:function(){var t,e,s=this,n=this.options.icons.submenu,i=this.element.find(this.options.menus);this._toggleClass("ui-menu-icons",null,!!this.element.find(".ui-icon").length),e=i.filter(":not(.ui-menu)").hide().attr({role:this.options.role,"aria-hidden":"true","aria-expanded":"false"}).each(function(){var t=x(this),e=t.prev(),i=x("").data("ui-menu-submenu-caret",!0);s._addClass(i,"ui-menu-icon","ui-icon "+n),e.attr("aria-haspopup","true").prepend(i),t.attr("aria-labelledby",e.attr("id"))}),this._addClass(e,"ui-menu","ui-widget ui-widget-content ui-front"),(t=i.add(this.element).find(this.options.items)).not(".ui-menu-item").each(function(){var t=x(this);s._isDivider(t)&&s._addClass(t,"ui-menu-divider","ui-widget-content")}),i=(e=t.not(".ui-menu-item, .ui-menu-divider")).children().not(".ui-menu").uniqueId().attr({tabIndex:-1,role:this._itemRole()}),this._addClass(e,"ui-menu-item")._addClass(i,"ui-menu-item-wrapper"),t.filter(".ui-state-disabled").attr("aria-disabled","true"),this.active&&!x.contains(this.element[0],this.active[0])&&this.blur()},_itemRole:function(){return{menu:"menuitem",listbox:"option"}[this.options.role]},_setOption:function(t,e){var i;"icons"===t&&(i=this.element.find(".ui-menu-icon"),this._removeClass(i,null,this.options.icons.submenu)._addClass(i,null,e.submenu)),this._super(t,e)},_setOptionDisabled:function(t){this._super(t),this.element.attr("aria-disabled",String(t)),this._toggleClass(null,"ui-state-disabled",!!t)},focus:function(t,e){var i;this.blur(t,t&&"focus"===t.type),this._scrollIntoView(e),this.active=e.first(),i=this.active.children(".ui-menu-item-wrapper"),this._addClass(i,null,"ui-state-active"),this.options.role&&this.element.attr("aria-activedescendant",i.attr("id")),i=this.active.parent().closest(".ui-menu-item").children(".ui-menu-item-wrapper"),this._addClass(i,null,"ui-state-active"),t&&"keydown"===t.type?this._close():this.timer=this._delay(function(){this._close()},this.delay),(i=e.children(".ui-menu")).length&&t&&/^mouse/.test(t.type)&&this._startOpening(i),this.activeMenu=e.parent(),this._trigger("focus",t,{item:e})},_scrollIntoView:function(t){var e,i,s;this._hasScroll()&&(i=parseFloat(x.css(this.activeMenu[0],"borderTopWidth"))||0,s=parseFloat(x.css(this.activeMenu[0],"paddingTop"))||0,e=t.offset().top-this.activeMenu.offset().top-i-s,i=this.activeMenu.scrollTop(),s=this.activeMenu.height(),t=t.outerHeight(),e<0?this.activeMenu.scrollTop(i+e):s",options:{appendTo:null,autoFocus:!1,delay:300,minLength:1,position:{my:"left top",at:"left bottom",collision:"none"},source:null,change:null,close:null,focus:null,open:null,response:null,search:null,select:null},requestIndex:0,pending:0,liveRegionTimer:null,_create:function(){var i,s,n,t=this.element[0].nodeName.toLowerCase(),e="textarea"===t,t="input"===t;this.isMultiLine=e||!t&&this._isContentEditable(this.element),this.valueMethod=this.element[e||t?"val":"text"],this.isNewMenu=!0,this._addClass("ui-autocomplete-input"),this.element.attr("autocomplete","off"),this._on(this.element,{keydown:function(t){if(this.element.prop("readOnly"))s=n=i=!0;else{s=n=i=!1;var e=x.ui.keyCode;switch(t.keyCode){case e.PAGE_UP:i=!0,this._move("previousPage",t);break;case e.PAGE_DOWN:i=!0,this._move("nextPage",t);break;case e.UP:i=!0,this._keyEvent("previous",t);break;case e.DOWN:i=!0,this._keyEvent("next",t);break;case e.ENTER:this.menu.active&&(i=!0,t.preventDefault(),this.menu.select(t));break;case e.TAB:this.menu.active&&this.menu.select(t);break;case e.ESCAPE:this.menu.element.is(":visible")&&(this.isMultiLine||this._value(this.term),this.close(t),t.preventDefault());break;default:s=!0,this._searchTimeout(t)}}},keypress:function(t){if(i)return i=!1,void(this.isMultiLine&&!this.menu.element.is(":visible")||t.preventDefault());if(!s){var e=x.ui.keyCode;switch(t.keyCode){case e.PAGE_UP:this._move("previousPage",t);break;case e.PAGE_DOWN:this._move("nextPage",t);break;case e.UP:this._keyEvent("previous",t);break;case e.DOWN:this._keyEvent("next",t)}}},input:function(t){if(n)return n=!1,void t.preventDefault();this._searchTimeout(t)},focus:function(){this.selectedItem=null,this.previous=this._value()},blur:function(t){clearTimeout(this.searching),this.close(t),this._change(t)}}),this._initSource(),this.menu=x("
      ").appendTo(this._appendTo()).menu({role:null}).hide().attr({unselectable:"on"}).menu("instance"),this._addClass(this.menu.element,"ui-autocomplete","ui-front"),this._on(this.menu.element,{mousedown:function(t){t.preventDefault()},menufocus:function(t,e){var i,s;if(this.isNewMenu&&(this.isNewMenu=!1,t.originalEvent&&/^mouse/.test(t.originalEvent.type)))return this.menu.blur(),void this.document.one("mousemove",function(){x(t.target).trigger(t.originalEvent)});s=e.item.data("ui-autocomplete-item"),!1!==this._trigger("focus",t,{item:s})&&t.originalEvent&&/^key/.test(t.originalEvent.type)&&this._value(s.value),(i=e.item.attr("aria-label")||s.value)&&String.prototype.trim.call(i).length&&(clearTimeout(this.liveRegionTimer),this.liveRegionTimer=this._delay(function(){this.liveRegion.html(x("
      ").text(i))},100))},menuselect:function(t,e){var i=e.item.data("ui-autocomplete-item"),s=this.previous;this.element[0]!==x.ui.safeActiveElement(this.document[0])&&(this.element.trigger("focus"),this.previous=s,this._delay(function(){this.previous=s,this.selectedItem=i})),!1!==this._trigger("select",t,{item:i})&&this._value(i.value),this.term=this._value(),this.close(t),this.selectedItem=i}}),this.liveRegion=x("
      ",{role:"status","aria-live":"assertive","aria-relevant":"additions"}).appendTo(this.document[0].body),this._addClass(this.liveRegion,null,"ui-helper-hidden-accessible"),this._on(this.window,{beforeunload:function(){this.element.removeAttr("autocomplete")}})},_destroy:function(){clearTimeout(this.searching),this.element.removeAttr("autocomplete"),this.menu.element.remove(),this.liveRegion.remove()},_setOption:function(t,e){this._super(t,e),"source"===t&&this._initSource(),"appendTo"===t&&this.menu.element.appendTo(this._appendTo()),"disabled"===t&&e&&this.xhr&&this.xhr.abort()},_isEventTargetInWidget:function(t){var e=this.menu.element[0];return t.target===this.element[0]||t.target===e||x.contains(e,t.target)},_closeOnClickOutside:function(t){this._isEventTargetInWidget(t)||this.close()},_appendTo:function(){var t=this.options.appendTo;return t=!(t=!(t=t&&(t.jquery||t.nodeType?x(t):this.document.find(t).eq(0)))||!t[0]?this.element.closest(".ui-front, dialog"):t).length?this.document[0].body:t},_initSource:function(){var i,s,n=this;Array.isArray(this.options.source)?(i=this.options.source,this.source=function(t,e){e(x.ui.autocomplete.filter(i,t.term))}):"string"==typeof this.options.source?(s=this.options.source,this.source=function(t,e){n.xhr&&n.xhr.abort(),n.xhr=x.ajax({url:s,data:t,dataType:"json",success:function(t){e(t)},error:function(){e([])}})}):this.source=this.options.source},_searchTimeout:function(s){clearTimeout(this.searching),this.searching=this._delay(function(){var t=this.term===this._value(),e=this.menu.element.is(":visible"),i=s.altKey||s.ctrlKey||s.metaKey||s.shiftKey;t&&(e||i)||(this.selectedItem=null,this.search(null,s))},this.options.delay)},search:function(t,e){return t=null!=t?t:this._value(),this.term=this._value(),t.length").append(x("
      ").text(e.label)).appendTo(t)},_move:function(t,e){if(this.menu.element.is(":visible"))return this.menu.isFirstItem()&&/^previous/.test(t)||this.menu.isLastItem()&&/^next/.test(t)?(this.isMultiLine||this._value(this.term),void this.menu.blur()):void this.menu[t](e);this.search(null,e)},widget:function(){return this.menu.element},_value:function(){return this.valueMethod.apply(this.element,arguments)},_keyEvent:function(t,e){this.isMultiLine&&!this.menu.element.is(":visible")||(this._move(t,e),e.preventDefault())},_isContentEditable:function(t){if(!t.length)return!1;var e=t.prop("contentEditable");return"inherit"===e?this._isContentEditable(t.parent()):"true"===e}}),x.extend(x.ui.autocomplete,{escapeRegex:function(t){return t.replace(/[\-\[\]{}()*+?.,\\\^$|#\s]/g,"\\$&")},filter:function(t,e){var i=new RegExp(x.ui.autocomplete.escapeRegex(e),"i");return x.grep(t,function(t){return i.test(t.label||t.value||t)})}}),x.widget("ui.autocomplete",x.ui.autocomplete,{options:{messages:{noResults:"No search results.",results:function(t){return t+(1").text(e))},100))}});x.ui.autocomplete}); \ No newline at end of file diff --git a/static/api/client/4.0.x/script.js b/static/api/client/4.0.x/script.js new file mode 100644 index 000000000000..bb9c8a2415d3 --- /dev/null +++ b/static/api/client/4.0.x/script.js @@ -0,0 +1,253 @@ +/* + * Copyright (c) 2013, 2023, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the LICENSE file that accompanied this code. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +var moduleSearchIndex; +var packageSearchIndex; +var typeSearchIndex; +var memberSearchIndex; +var tagSearchIndex; + +var oddRowColor = "odd-row-color"; +var evenRowColor = "even-row-color"; +var sortAsc = "sort-asc"; +var sortDesc = "sort-desc"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; + +function loadScripts(doc, tag) { + createElem(doc, tag, 'search.js'); + + createElem(doc, tag, 'module-search-index.js'); + createElem(doc, tag, 'package-search-index.js'); + createElem(doc, tag, 'type-search-index.js'); + createElem(doc, tag, 'member-search-index.js'); + createElem(doc, tag, 'tag-search-index.js'); +} + +function createElem(doc, tag, path) { + var script = doc.createElement(tag); + var scriptElement = doc.getElementsByTagName(tag)[0]; + script.src = pathtoroot + path; + scriptElement.parentNode.insertBefore(script, scriptElement); +} + +// Helper for making content containing release names comparable lexicographically +function makeComparable(s) { + return s.toLowerCase().replace(/(\d+)/g, + function(n, m) { + return ("000" + m).slice(-4); + }); +} + +// Switches between two styles depending on a condition +function toggleStyle(classList, condition, trueStyle, falseStyle) { + if (condition) { + classList.remove(falseStyle); + classList.add(trueStyle); + } else { + classList.remove(trueStyle); + classList.add(falseStyle); + } +} + +// Sorts the rows in a table lexicographically by the content of a specific column +function sortTable(header, columnIndex, columns) { + var container = header.parentElement; + var descending = header.classList.contains(sortAsc); + container.querySelectorAll("div.table-header").forEach( + function(header) { + header.classList.remove(sortAsc); + header.classList.remove(sortDesc); + } + ) + var cells = container.children; + var rows = []; + for (var i = columns; i < cells.length; i += columns) { + rows.push(Array.prototype.slice.call(cells, i, i + columns)); + } + var comparator = function(a, b) { + var ka = makeComparable(a[columnIndex].textContent); + var kb = makeComparable(b[columnIndex].textContent); + if (ka < kb) + return descending ? 1 : -1; + if (ka > kb) + return descending ? -1 : 1; + return 0; + }; + var sorted = rows.sort(comparator); + var visible = 0; + sorted.forEach(function(row) { + if (row[0].style.display !== 'none') { + var isEvenRow = visible++ % 2 === 0; + } + row.forEach(function(cell) { + toggleStyle(cell.classList, isEvenRow, evenRowColor, oddRowColor); + container.appendChild(cell); + }) + }); + toggleStyle(header.classList, descending, sortDesc, sortAsc); +} + +// Toggles the visibility of a table category in all tables in a page +function toggleGlobal(checkbox, selected, columns) { + var display = checkbox.checked ? '' : 'none'; + document.querySelectorAll("div.table-tabs").forEach(function(t) { + var id = t.parentElement.getAttribute("id"); + var selectedClass = id + "-tab" + selected; + // if selected is empty string it selects all uncategorized entries + var selectUncategorized = !Boolean(selected); + var visible = 0; + document.querySelectorAll('div.' + id) + .forEach(function(elem) { + if (selectUncategorized) { + if (elem.className.indexOf(selectedClass) === -1) { + elem.style.display = display; + } + } else if (elem.classList.contains(selectedClass)) { + elem.style.display = display; + } + if (elem.style.display === '') { + var isEvenRow = visible++ % (columns * 2) < columns; + toggleStyle(elem.classList, isEvenRow, evenRowColor, oddRowColor); + } + }); + var displaySection = visible === 0 ? 'none' : ''; + t.parentElement.style.display = displaySection; + document.querySelector("li#contents-" + id).style.display = displaySection; + }) +} + +// Shows the elements of a table belonging to a specific category +function show(tableId, selected, columns) { + if (tableId !== selected) { + document.querySelectorAll('div.' + tableId + ':not(.' + selected + ')') + .forEach(function(elem) { + elem.style.display = 'none'; + }); + } + document.querySelectorAll('div.' + selected) + .forEach(function(elem, index) { + elem.style.display = ''; + var isEvenRow = index % (columns * 2) < columns; + toggleStyle(elem.classList, isEvenRow, evenRowColor, oddRowColor); + }); + updateTabs(tableId, selected); +} + +function updateTabs(tableId, selected) { + document.getElementById(tableId + '.tabpanel') + .setAttribute('aria-labelledby', selected); + document.querySelectorAll('button[id^="' + tableId + '"]') + .forEach(function(tab, index) { + if (selected === tab.id || (tableId === selected && index === 0)) { + tab.className = activeTableTab; + tab.setAttribute('aria-selected', true); + tab.setAttribute('tabindex',0); + } else { + tab.className = tableTab; + tab.setAttribute('aria-selected', false); + tab.setAttribute('tabindex',-1); + } + }); +} + +function switchTab(e) { + var selected = document.querySelector('[aria-selected=true]'); + if (selected) { + if ((e.keyCode === 37 || e.keyCode === 38) && selected.previousSibling) { + // left or up arrow key pressed: move focus to previous tab + selected.previousSibling.click(); + selected.previousSibling.focus(); + e.preventDefault(); + } else if ((e.keyCode === 39 || e.keyCode === 40) && selected.nextSibling) { + // right or down arrow key pressed: move focus to next tab + selected.nextSibling.click(); + selected.nextSibling.focus(); + e.preventDefault(); + } + } +} + +var updateSearchResults = function() {}; + +function indexFilesLoaded() { + return moduleSearchIndex + && packageSearchIndex + && typeSearchIndex + && memberSearchIndex + && tagSearchIndex; +} +// Copy the contents of the local snippet to the clipboard +function copySnippet(button) { + copyToClipboard(button.nextElementSibling.innerText); + switchCopyLabel(button, button.firstElementChild); +} +function copyToClipboard(content) { + var textarea = document.createElement("textarea"); + textarea.style.height = 0; + document.body.appendChild(textarea); + textarea.value = content; + textarea.select(); + document.execCommand("copy"); + document.body.removeChild(textarea); +} +function switchCopyLabel(button, span) { + var copied = span.getAttribute("data-copied"); + button.classList.add("visible"); + var initialLabel = span.innerHTML; + span.innerHTML = copied; + setTimeout(function() { + button.classList.remove("visible"); + setTimeout(function() { + if (initialLabel !== copied) { + span.innerHTML = initialLabel; + } + }, 100); + }, 1900); +} +// Workaround for scroll position not being included in browser history (8249133) +document.addEventListener("DOMContentLoaded", function(e) { + var contentDiv = document.querySelector("div.flex-content"); + window.addEventListener("popstate", function(e) { + if (e.state !== null) { + contentDiv.scrollTop = e.state; + } + }); + window.addEventListener("hashchange", function(e) { + history.replaceState(contentDiv.scrollTop, document.title); + }); + var timeoutId; + contentDiv.addEventListener("scroll", function(e) { + if (timeoutId) { + clearTimeout(timeoutId); + } + timeoutId = setTimeout(function() { + history.replaceState(contentDiv.scrollTop, document.title); + }, 100); + }); + if (!location.hash) { + history.replaceState(contentDiv.scrollTop, document.title); + } +}); diff --git a/static/api/client/4.0.x/search-page.js b/static/api/client/4.0.x/search-page.js new file mode 100644 index 000000000000..540c90f57c52 --- /dev/null +++ b/static/api/client/4.0.x/search-page.js @@ -0,0 +1,284 @@ +/* + * Copyright (c) 2022, 2023, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the LICENSE file that accompanied this code. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +"use strict"; +$(function() { + var copy = $("#page-search-copy"); + var expand = $("#page-search-expand"); + var searchLink = $("span#page-search-link"); + var redirect = $("input#search-redirect"); + function setSearchUrlTemplate() { + var href = document.location.href.split(/[#?]/)[0]; + href += "?q=" + "%s"; + if (redirect.is(":checked")) { + href += "&r=1"; + } + searchLink.html(href); + copy[0].onmouseenter(); + } + function copyLink(e) { + copyToClipboard(this.previousSibling.innerText); + switchCopyLabel(this, this.lastElementChild); + } + copy.click(copyLink); + copy[0].onmouseenter = function() {}; + redirect.click(setSearchUrlTemplate); + setSearchUrlTemplate(); + copy.prop("disabled", false); + redirect.prop("disabled", false); + expand.click(function (e) { + var searchInfo = $("div.page-search-info"); + if(this.parentElement.hasAttribute("open")) { + searchInfo.attr("style", "border-width: 0;"); + } else { + searchInfo.attr("style", "border-width: 1px;").height(searchInfo.prop("scrollHeight")); + } + }); +}); +$(window).on("load", function() { + var input = $("#page-search-input"); + var reset = $("#page-search-reset"); + var notify = $("#page-search-notify"); + var resultSection = $("div#result-section"); + var resultContainer = $("div#result-container"); + var searchTerm = ""; + var activeTab = ""; + var fixedTab = false; + var visibleTabs = []; + var feelingLucky = false; + function renderResults(result) { + if (!result.length) { + notify.html(messages.noResult); + } else if (result.length === 1) { + notify.html(messages.oneResult); + } else { + notify.html(messages.manyResults.replace("{0}", result.length)); + } + resultContainer.empty(); + var r = { + "types": [], + "members": [], + "packages": [], + "modules": [], + "searchTags": [] + }; + for (var i in result) { + var item = result[i]; + var arr = r[item.category]; + arr.push(item); + } + if (!activeTab || r[activeTab].length === 0 || !fixedTab) { + Object.keys(r).reduce(function(prev, curr) { + if (r[curr].length > 0 && r[curr][0].score > prev) { + activeTab = curr; + return r[curr][0].score; + } + return prev; + }, 0); + } + if (feelingLucky && activeTab) { + notify.html(messages.redirecting) + var firstItem = r[activeTab][0]; + window.location = getURL(firstItem.indexItem, firstItem.category); + return; + } + if (result.length > 20) { + if (searchTerm[searchTerm.length - 1] === ".") { + if (activeTab === "types" && r["members"].length > r["types"].length) { + activeTab = "members"; + } else if (activeTab === "packages" && r["types"].length > r["packages"].length) { + activeTab = "types"; + } + } + } + var categoryCount = Object.keys(r).reduce(function(prev, curr) { + return prev + (r[curr].length > 0 ? 1 : 0); + }, 0); + visibleTabs = []; + var tabContainer = $("
      ").appendTo(resultContainer); + for (var key in r) { + var id = "#result-tab-" + key.replace("searchTags", "search_tags"); + if (r[key].length) { + var count = r[key].length >= 1000 ? "999+" : r[key].length; + if (result.length > 20 && categoryCount > 1) { + var button = $("").appendTo(tabContainer); + button.click(key, function(e) { + fixedTab = true; + renderResult(e.data, $(this)); + }); + visibleTabs.push(key); + } else { + $("" + categories[key] + + " (" + count + ")").appendTo(tabContainer); + renderTable(key, r[key]).appendTo(resultContainer); + tabContainer = $("
      ").appendTo(resultContainer); + + } + } + } + if (activeTab && result.length > 20 && categoryCount > 1) { + $("button#result-tab-" + activeTab).addClass("active-table-tab"); + renderTable(activeTab, r[activeTab]).appendTo(resultContainer); + } + resultSection.show(); + function renderResult(category, button) { + activeTab = category; + setSearchUrl(); + resultContainer.find("div.summary-table").remove(); + renderTable(activeTab, r[activeTab]).appendTo(resultContainer); + button.siblings().removeClass("active-table-tab"); + button.addClass("active-table-tab"); + } + } + function selectTab(category) { + $("button#result-tab-" + category).click(); + } + function renderTable(category, items) { + var table = $("
      ") + .addClass(category === "modules" + ? "one-column-search-results" + : "two-column-search-results"); + var col1, col2; + if (category === "modules") { + col1 = "Module"; + } else if (category === "packages") { + col1 = "Module"; + col2 = "Package"; + } else if (category === "types") { + col1 = "Package"; + col2 = "Class" + } else if (category === "members") { + col1 = "Class"; + col2 = "Member"; + } else if (category === "searchTags") { + col1 = "Location"; + col2 = "Name"; + } + $("
      " + col1 + "
      ").appendTo(table); + if (category !== "modules") { + $("
      " + col2 + "
      ").appendTo(table); + } + $.each(items, function(index, item) { + var rowColor = index % 2 ? "odd-row-color" : "even-row-color"; + renderItem(item, table, rowColor); + }); + return table; + } + function renderItem(item, table, rowColor) { + var label = getHighlightedText(item.input, item.boundaries, item.prefix.length, item.input.length); + var link = $("") + .attr("href", getURL(item.indexItem, item.category)) + .attr("tabindex", "0") + .addClass("search-result-link") + .html(label); + var container = getHighlightedText(item.input, item.boundaries, 0, item.prefix.length - 1); + if (item.category === "searchTags") { + container = item.indexItem.h || ""; + } + if (item.category !== "modules") { + $("
      ").html(container).addClass("col-plain").addClass(rowColor).appendTo(table); + } + $("
      ").html(link).addClass("col-last").addClass(rowColor).appendTo(table); + } + var timeout; + function schedulePageSearch() { + if (timeout) { + clearTimeout(timeout); + } + timeout = setTimeout(function () { + doPageSearch() + }, 100); + } + function doPageSearch() { + setSearchUrl(); + var term = searchTerm = input.val().trim(); + if (term === "") { + notify.html(messages.enterTerm); + activeTab = ""; + fixedTab = false; + resultContainer.empty(); + resultSection.hide(); + } else { + notify.html(messages.searching); + doSearch({ term: term, maxResults: 1200 }, renderResults); + } + } + function setSearchUrl() { + var query = input.val().trim(); + var url = document.location.pathname; + if (query) { + url += "?q=" + encodeURI(query); + if (activeTab && fixedTab) { + url += "&c=" + activeTab; + } + } + history.replaceState({query: query}, "", url); + } + input.on("input", function(e) { + feelingLucky = false; + schedulePageSearch(); + }); + $(document).keydown(function(e) { + if ((e.ctrlKey || e.metaKey) && (e.key === "ArrowLeft" || e.key === "ArrowRight")) { + if (activeTab && visibleTabs.length > 1) { + var idx = visibleTabs.indexOf(activeTab); + idx += e.key === "ArrowLeft" ? visibleTabs.length - 1 : 1; + selectTab(visibleTabs[idx % visibleTabs.length]); + return false; + } + } + }); + reset.click(function() { + notify.html(messages.enterTerm); + resultSection.hide(); + activeTab = ""; + fixedTab = false; + resultContainer.empty(); + input.val('').focus(); + setSearchUrl(); + }); + input.prop("disabled", false); + reset.prop("disabled", false); + + var urlParams = new URLSearchParams(window.location.search); + if (urlParams.has("q")) { + input.val(urlParams.get("q")) + } + if (urlParams.has("c")) { + activeTab = urlParams.get("c"); + fixedTab = true; + } + if (urlParams.get("r")) { + feelingLucky = true; + } + if (input.val()) { + doPageSearch(); + } else { + notify.html(messages.enterTerm); + } + input.select().focus(); +}); diff --git a/static/api/client/4.0.x/search.html b/static/api/client/4.0.x/search.html new file mode 100644 index 000000000000..b502a34e0681 --- /dev/null +++ b/static/api/client/4.0.x/search.html @@ -0,0 +1,77 @@ + + + + +Search (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
      + +
      +
      +

      Search

      +
      + + +
      +Additional resources +
      +
      +
      +

      The help page provides an introduction to the scope and syntax of JavaDoc search.

      +

      You can use the <ctrl> or <cmd> keys in combination with the left and right arrow keys to switch between result tabs in this page.

      +

      The URL template below may be used to configure this page as a search engine in browsers that support this feature. It has been tested to work in Google Chrome and Mozilla Firefox. Note that other browsers may not support this feature or require a different URL format.

      +link +

      + +

      +
      +

      Loading search index...

      + +
      + +
      +
      + + diff --git a/static/api/client/4.0.x/search.js b/static/api/client/4.0.x/search.js new file mode 100644 index 000000000000..d3986705ef22 --- /dev/null +++ b/static/api/client/4.0.x/search.js @@ -0,0 +1,458 @@ +/* + * Copyright (c) 2015, 2023, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the LICENSE file that accompanied this code. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ +"use strict"; +const messages = { + enterTerm: "Enter a search term", + noResult: "No results found", + oneResult: "Found one result", + manyResults: "Found {0} results", + loading: "Loading search index...", + searching: "Searching...", + redirecting: "Redirecting to first result...", + linkIcon: "Link icon", + linkToSection: "Link to this section" +} +const categories = { + modules: "Modules", + packages: "Packages", + types: "Classes and Interfaces", + members: "Members", + searchTags: "Search Tags" +}; +const highlight = "$&"; +const NO_MATCH = {}; +const MAX_RESULTS = 300; +function checkUnnamed(name, separator) { + return name === "" || !name ? "" : name + separator; +} +function escapeHtml(str) { + return str.replace(//g, ">"); +} +function getHighlightedText(str, boundaries, from, to) { + var start = from; + var text = ""; + for (var i = 0; i < boundaries.length; i += 2) { + var b0 = boundaries[i]; + var b1 = boundaries[i + 1]; + if (b0 >= to || b1 <= from) { + continue; + } + text += escapeHtml(str.slice(start, Math.max(start, b0))); + text += ""; + text += escapeHtml(str.slice(Math.max(start, b0), Math.min(to, b1))); + text += ""; + start = Math.min(to, b1); + } + text += escapeHtml(str.slice(start, to)); + return text; +} +function getURLPrefix(item, category) { + var urlPrefix = ""; + var slash = "/"; + if (category === "modules") { + return item.l + slash; + } else if (category === "packages" && item.m) { + return item.m + slash; + } else if (category === "types" || category === "members") { + if (item.m) { + urlPrefix = item.m + slash; + } else { + $.each(packageSearchIndex, function(index, it) { + if (it.m && item.p === it.l) { + urlPrefix = it.m + slash; + } + }); + } + } + return urlPrefix; +} +function getURL(item, category) { + if (item.url) { + return item.url; + } + var url = getURLPrefix(item, category); + if (category === "modules") { + url += "module-summary.html"; + } else if (category === "packages") { + if (item.u) { + url = item.u; + } else { + url += item.l.replace(/\./g, '/') + "/package-summary.html"; + } + } else if (category === "types") { + if (item.u) { + url = item.u; + } else { + url += checkUnnamed(item.p, "/").replace(/\./g, '/') + item.l + ".html"; + } + } else if (category === "members") { + url += checkUnnamed(item.p, "/").replace(/\./g, '/') + item.c + ".html" + "#"; + if (item.u) { + url += item.u; + } else { + url += item.l; + } + } else if (category === "searchTags") { + url += item.u; + } + item.url = url; + return url; +} +function createMatcher(term, camelCase) { + if (camelCase && !isUpperCase(term)) { + return null; // no need for camel-case matcher for lower case query + } + var pattern = ""; + var upperCase = []; + term.trim().split(/\s+/).forEach(function(w, index, array) { + var tokens = w.split(/(?=[A-Z,.()<>?[\/])/); + for (var i = 0; i < tokens.length; i++) { + var s = tokens[i]; + // ',' and '?' are the only delimiters commonly followed by space in java signatures + pattern += "(" + $.ui.autocomplete.escapeRegex(s).replace(/[,?]/g, "$&\\s*?") + ")"; + upperCase.push(false); + var isWordToken = /\w$/.test(s); + if (isWordToken) { + if (i === tokens.length - 1 && index < array.length - 1) { + // space in query string matches all delimiters + pattern += "(.*?)"; + upperCase.push(isUpperCase(s[0])); + } else { + if (!camelCase && isUpperCase(s) && s.length === 1) { + pattern += "()"; + } else { + pattern += "([a-z0-9$<>?[\\]]*?)"; + } + upperCase.push(isUpperCase(s[0])); + } + } else { + pattern += "()"; + upperCase.push(false); + } + } + }); + var re = new RegExp(pattern, "gi"); + re.upperCase = upperCase; + return re; +} +function findMatch(matcher, input, startOfName, endOfName) { + var from = startOfName; + matcher.lastIndex = from; + var match = matcher.exec(input); + // Expand search area until we get a valid result or reach the beginning of the string + while (!match || match.index + match[0].length < startOfName || endOfName < match.index) { + if (from === 0) { + return NO_MATCH; + } + from = input.lastIndexOf(".", from - 2) + 1; + matcher.lastIndex = from; + match = matcher.exec(input); + } + var boundaries = []; + var matchEnd = match.index + match[0].length; + var score = 5; + var start = match.index; + var prevEnd = -1; + for (var i = 1; i < match.length; i += 2) { + var isUpper = isUpperCase(input[start]); + var isMatcherUpper = matcher.upperCase[i]; + // capturing groups come in pairs, match and non-match + boundaries.push(start, start + match[i].length); + // make sure groups are anchored on a left word boundary + var prevChar = input[start - 1] || ""; + var nextChar = input[start + 1] || ""; + if (start !== 0 && !/[\W_]/.test(prevChar) && !/[\W_]/.test(input[start])) { + if (isUpper && (isLowerCase(prevChar) || isLowerCase(nextChar))) { + score -= 0.1; + } else if (isMatcherUpper && start === prevEnd) { + score -= isUpper ? 0.1 : 1.0; + } else { + return NO_MATCH; + } + } + prevEnd = start + match[i].length; + start += match[i].length + match[i + 1].length; + + // lower score for parts of the name that are missing + if (match[i + 1] && prevEnd < endOfName) { + score -= rateNoise(match[i + 1]); + } + } + // lower score if a type name contains unmatched camel-case parts + if (input[matchEnd - 1] !== "." && endOfName > matchEnd) + score -= rateNoise(input.slice(matchEnd, endOfName)); + score -= rateNoise(input.slice(0, Math.max(startOfName, match.index))); + + if (score <= 0) { + return NO_MATCH; + } + return { + input: input, + score: score, + boundaries: boundaries + }; +} +function isUpperCase(s) { + return s !== s.toLowerCase(); +} +function isLowerCase(s) { + return s !== s.toUpperCase(); +} +function rateNoise(str) { + return (str.match(/([.(])/g) || []).length / 5 + + (str.match(/([A-Z]+)/g) || []).length / 10 + + str.length / 20; +} +function doSearch(request, response) { + var term = request.term.trim(); + var maxResults = request.maxResults || MAX_RESULTS; + if (term.length === 0) { + return this.close(); + } + var matcher = { + plainMatcher: createMatcher(term, false), + camelCaseMatcher: createMatcher(term, true) + } + var indexLoaded = indexFilesLoaded(); + + function getPrefix(item, category) { + switch (category) { + case "packages": + return checkUnnamed(item.m, "/"); + case "types": + return checkUnnamed(item.p, "."); + case "members": + return checkUnnamed(item.p, ".") + item.c + "."; + default: + return ""; + } + } + function useQualifiedName(category) { + switch (category) { + case "packages": + return /[\s/]/.test(term); + case "types": + case "members": + return /[\s.]/.test(term); + default: + return false; + } + } + function searchIndex(indexArray, category) { + var matches = []; + if (!indexArray) { + if (!indexLoaded) { + matches.push({ l: messages.loading, category: category }); + } + return matches; + } + $.each(indexArray, function (i, item) { + var prefix = getPrefix(item, category); + var simpleName = item.l; + var qualifiedName = prefix + simpleName; + var useQualified = useQualifiedName(category); + var input = useQualified ? qualifiedName : simpleName; + var startOfName = useQualified ? prefix.length : 0; + var endOfName = category === "members" && input.indexOf("(", startOfName) > -1 + ? input.indexOf("(", startOfName) : input.length; + var m = findMatch(matcher.plainMatcher, input, startOfName, endOfName); + if (m === NO_MATCH && matcher.camelCaseMatcher) { + m = findMatch(matcher.camelCaseMatcher, input, startOfName, endOfName); + } + if (m !== NO_MATCH) { + m.indexItem = item; + m.prefix = prefix; + m.category = category; + if (!useQualified) { + m.input = qualifiedName; + m.boundaries = m.boundaries.map(function(b) { + return b + prefix.length; + }); + } + matches.push(m); + } + return true; + }); + return matches.sort(function(e1, e2) { + return e2.score - e1.score; + }).slice(0, maxResults); + } + + var result = searchIndex(moduleSearchIndex, "modules") + .concat(searchIndex(packageSearchIndex, "packages")) + .concat(searchIndex(typeSearchIndex, "types")) + .concat(searchIndex(memberSearchIndex, "members")) + .concat(searchIndex(tagSearchIndex, "searchTags")); + + if (!indexLoaded) { + updateSearchResults = function() { + doSearch(request, response); + } + } else { + updateSearchResults = function() {}; + } + response(result); +} +// JQuery search menu implementation +$.widget("custom.catcomplete", $.ui.autocomplete, { + _create: function() { + this._super(); + this.widget().menu("option", "items", "> .result-item"); + // workaround for search result scrolling + this.menu._scrollIntoView = function _scrollIntoView( item ) { + var borderTop, paddingTop, offset, scroll, elementHeight, itemHeight; + if ( this._hasScroll() ) { + borderTop = parseFloat( $.css( this.activeMenu[ 0 ], "borderTopWidth" ) ) || 0; + paddingTop = parseFloat( $.css( this.activeMenu[ 0 ], "paddingTop" ) ) || 0; + offset = item.offset().top - this.activeMenu.offset().top - borderTop - paddingTop; + scroll = this.activeMenu.scrollTop(); + elementHeight = this.activeMenu.height() - 26; + itemHeight = item.outerHeight(); + + if ( offset < 0 ) { + this.activeMenu.scrollTop( scroll + offset ); + } else if ( offset + itemHeight > elementHeight ) { + this.activeMenu.scrollTop( scroll + offset - elementHeight + itemHeight ); + } + } + }; + }, + _renderMenu: function(ul, items) { + var currentCategory = ""; + var widget = this; + widget.menu.bindings = $(); + $.each(items, function(index, item) { + if (item.category && item.category !== currentCategory) { + ul.append("
    • " + categories[item.category] + "
      • "); + currentCategory = item.category; + } + var li = widget._renderItemData(ul, item); + if (item.category) { + li.attr("aria-label", categories[item.category] + " : " + item.l); + } else { + li.attr("aria-label", item.l); + } + li.attr("class", "result-item"); + }); + ul.append("
    • Go to search page
      • "); + }, + _renderItem: function(ul, item) { + var li = $("
    • ").appendTo(ul); + var div = $("
      ").appendTo(li); + var label = item.l + ? item.l + : getHighlightedText(item.input, item.boundaries, 0, item.input.length); + var idx = item.indexItem; + if (item.category === "searchTags" && idx && idx.h) { + if (idx.d) { + div.html(label + " (" + idx.h + ")
      " + + idx.d + "
      "); + } else { + div.html(label + " (" + idx.h + ")"); + } + } else { + div.html(label); + } + return li; + } +}); +$(function() { + var expanded = false; + var windowWidth; + function collapse() { + if (expanded) { + $("div#navbar-top").removeAttr("style"); + $("button#navbar-toggle-button") + .removeClass("expanded") + .attr("aria-expanded", "false"); + expanded = false; + } + } + $("button#navbar-toggle-button").click(function (e) { + if (expanded) { + collapse(); + } else { + var navbar = $("div#navbar-top"); + navbar.height(navbar.prop("scrollHeight")); + $("button#navbar-toggle-button") + .addClass("expanded") + .attr("aria-expanded", "true"); + expanded = true; + windowWidth = window.innerWidth; + } + }); + $("ul.sub-nav-list-small li a").click(collapse); + $("input#search-input").focus(collapse); + $("main").click(collapse); + $("section[id] > :header, :header[id], :header:has(a[id])").each(function(idx, el) { + // Create anchor links for headers with an associated id attribute + var hdr = $(el); + var id = hdr.attr("id") || hdr.parent("section").attr("id") || hdr.children("a").attr("id"); + if (id) { + hdr.append(" " + messages.linkIcon +""); + } + }); + $(window).on("orientationchange", collapse).on("resize", function(e) { + if (expanded && windowWidth !== window.innerWidth) collapse(); + }); + var search = $("#search-input"); + var reset = $("#reset-button"); + search.catcomplete({ + minLength: 1, + delay: 200, + source: doSearch, + response: function(event, ui) { + if (!ui.content.length) { + ui.content.push({ l: messages.noResult }); + } else { + $("#search-input").empty(); + } + }, + autoFocus: true, + focus: function(event, ui) { + return false; + }, + position: { + collision: "flip" + }, + select: function(event, ui) { + if (ui.item.indexItem) { + var url = getURL(ui.item.indexItem, ui.item.category); + window.location.href = pathtoroot + url; + $("#search-input").focus(); + } + } + }); + search.val(''); + search.prop("disabled", false); + reset.prop("disabled", false); + reset.click(function() { + search.val('').focus(); + }); + search.focus(); +}); diff --git a/static/api/client/4.0.x/serialized-form.html b/static/api/client/4.0.x/serialized-form.html new file mode 100644 index 000000000000..25e1fd3bc8d3 --- /dev/null +++ b/static/api/client/4.0.x/serialized-form.html @@ -0,0 +1,485 @@ + + + + +Serialized Form (Pulsar Client :: API 4.0.0 API) + + + + + + + + + + + + + +
      + +
      +
      +
      +

      Serialized Form

      +
      + +
      + +
      +
      + + diff --git a/static/api/client/4.0.x/stylesheet.css b/static/api/client/4.0.x/stylesheet.css new file mode 100644 index 000000000000..f71489f86ccd --- /dev/null +++ b/static/api/client/4.0.x/stylesheet.css @@ -0,0 +1,1272 @@ +/* + * Javadoc style sheet + */ + +@import url('resources/fonts/dejavu.css'); + +/* + * These CSS custom properties (variables) define the core color and font + * properties used in this stylesheet. + */ +:root { + /* body, block and code fonts */ + --body-font-family: 'DejaVu Sans', Arial, Helvetica, sans-serif; + --block-font-family: 'DejaVu Serif', Georgia, "Times New Roman", Times, serif; + --code-font-family: 'DejaVu Sans Mono', monospace; + /* Base font sizes for body and code elements */ + --body-font-size: 14px; + --code-font-size: 14px; + /* Text colors for body and block elements */ + --body-text-color: #353833; + --block-text-color: #474747; + /* Background colors for various structural elements */ + --body-background-color: #ffffff; + --section-background-color: #f8f8f8; + --detail-background-color: #ffffff; + /* Colors for navigation bar and table captions */ + --navbar-background-color: #4D7A97; + --navbar-text-color: #ffffff; + /* Background color for subnavigation and various headers */ + --subnav-background-color: #dee3e9; + /* Background and text colors for selected tabs and navigation items */ + --selected-background-color: #f8981d; + --selected-text-color: #253441; + --selected-link-color: #1f389c; + /* Background colors for generated tables */ + --even-row-color: #ffffff; + --odd-row-color: #eeeeef; + /* Text color for page title */ + --title-color: #2c4557; + /* Text colors for links */ + --link-color: #4A6782; + --link-color-active: #bb7a2a; + /* Snippet colors */ + --snippet-background-color: #ebecee; + --snippet-text-color: var(--block-text-color); + --snippet-highlight-color: #f7c590; + /* Border colors for structural elements and user defined tables */ + --border-color: #ededed; + --table-border-color: #000000; + /* Search input colors */ + --search-input-background-color: #ffffff; + --search-input-text-color: #000000; + --search-input-placeholder-color: #909090; + /* Highlight color for active search tag target */ + --search-tag-highlight-color: #ffff00; + /* Adjustments for icon and active background colors of copy-to-clipboard buttons */ + --copy-icon-brightness: 100%; + --copy-button-background-color-active: rgba(168, 168, 176, 0.3); + /* Colors for invalid tag notifications */ + --invalid-tag-background-color: #ffe6e6; + --invalid-tag-text-color: #000000; +} +/* + * Styles for individual HTML elements. + * + * These are styles that are specific to individual HTML elements. Changing them affects the style of a particular + * HTML element throughout the page. + */ +body { + background-color:var(--body-background-color); + color:var(--body-text-color); + font-family:var(--body-font-family); + font-size:var(--body-font-size); + margin:0; + padding:0; + height:100%; + width:100%; +} +iframe { + margin:0; + padding:0; + height:100%; + width:100%; + overflow-y:scroll; + border:none; +} +a:link, a:visited { + text-decoration:none; + color:var(--link-color); +} +a[href]:hover, a[href]:focus { + text-decoration:none; + color:var(--link-color-active); +} +pre { + font-family:var(--code-font-family); + font-size:1em; +} +h1 { + font-size:1.428em; +} +h2 { + font-size:1.285em; +} +h3 { + font-size:1.14em; +} +h4 { + font-size:1.072em; +} +h5 { + font-size:1.001em; +} +h6 { + font-size:0.93em; +} +/* Disable font boosting for selected elements */ +h1, h2, h3, h4, h5, h6, div.member-signature { + max-height: 1000em; +} +ul { + list-style-type:disc; +} +code, tt { + font-family:var(--code-font-family); +} +:not(h1, h2, h3, h4, h5, h6) > code, +:not(h1, h2, h3, h4, h5, h6) > tt { + font-size:var(--code-font-size); + padding-top:4px; + margin-top:8px; + line-height:1.4em; +} +dt code { + font-family:var(--code-font-family); + font-size:1em; + padding-top:4px; +} +.summary-table dt code { + font-family:var(--code-font-family); + font-size:1em; + vertical-align:top; + padding-top:4px; +} +sup { + font-size:8px; +} +button { + font-family: var(--body-font-family); + font-size: 1em; +} +/* + * Styles for HTML generated by javadoc. + * + * These are style classes that are used by the standard doclet to generate HTML documentation. + */ + +/* + * Styles for document title and copyright. + */ +.about-language { + float:right; + padding:0 21px 8px 8px; + font-size:0.915em; + margin-top:-9px; + height:2.9em; +} +.legal-copy { + margin-left:.5em; +} +/* + * Styles for navigation bar. + */ +@media screen { + div.flex-box { + position:fixed; + display:flex; + flex-direction:column; + height: 100%; + width: 100%; + } + header.flex-header { + flex: 0 0 auto; + } + div.flex-content { + flex: 1 1 auto; + overflow-y: auto; + } +} +.top-nav { + background-color:var(--navbar-background-color); + color:var(--navbar-text-color); + float:left; + width:100%; + clear:right; + min-height:2.8em; + padding:10px 0 0 0; + overflow:hidden; + font-size:0.857em; +} +button#navbar-toggle-button { + display:none; +} +ul.sub-nav-list-small { + display: none; +} +.sub-nav { + background-color:var(--subnav-background-color); + float:left; + width:100%; + overflow:hidden; + font-size:0.857em; +} +.sub-nav div { + clear:left; + float:left; + padding:6px; + text-transform:uppercase; +} +.sub-nav .sub-nav-list { + padding-top:4px; +} +ul.nav-list { + display:block; + margin:0 25px 0 0; + padding:0; +} +ul.sub-nav-list { + float:left; + margin:0 25px 0 0; + padding:0; +} +ul.nav-list li { + list-style:none; + float:left; + padding: 5px 6px; + text-transform:uppercase; +} +.sub-nav .nav-list-search { + float:right; + margin:0; + padding:6px; + clear:none; + text-align:right; + position:relative; +} +ul.sub-nav-list li { + list-style:none; + float:left; +} +.top-nav a:link, .top-nav a:active, .top-nav a:visited { + color:var(--navbar-text-color); + text-decoration:none; + text-transform:uppercase; +} +.top-nav a:hover { + color:var(--link-color-active); +} +.nav-bar-cell1-rev { + background-color:var(--selected-background-color); + color:var(--selected-text-color); + margin: auto 5px; +} +.skip-nav { + position:absolute; + top:auto; + left:-9999px; + overflow:hidden; +} +/* + * Hide navigation links and search box in print layout + */ +@media print { + ul.nav-list, div.sub-nav { + display:none; + } +} +/* + * Styles for page header. + */ +.title { + color:var(--title-color); + margin:10px 0; +} +.sub-title { + margin:5px 0 0 0; +} +ul.contents-list { + margin: 0 0 15px 0; + padding: 0; + list-style: none; +} +ul.contents-list li { + font-size:0.93em; +} +/* + * Styles for headings. + */ +body.class-declaration-page .summary h2, +body.class-declaration-page .details h2, +body.class-use-page h2, +body.module-declaration-page .block-list h2 { + font-style: italic; + padding:0; + margin:15px 0; +} +body.class-declaration-page .summary h3, +body.class-declaration-page .details h3, +body.class-declaration-page .summary .inherited-list h2 { + background-color:var(--subnav-background-color); + border:1px solid var(--border-color); + margin:0 0 6px -8px; + padding:7px 5px; +} +/* + * Styles for page layout containers. + */ +main { + clear:both; + padding:10px 20px; + position:relative; +} +dl.notes > dt { + font-family: var(--body-font-family); + font-size:0.856em; + font-weight:bold; + margin:10px 0 0 0; + color:var(--body-text-color); +} +dl.notes > dd { + margin:5px 10px 10px 0; + font-size:1em; + font-family:var(--block-font-family) +} +dl.name-value > dt { + margin-left:1px; + font-size:1.1em; + display:inline; + font-weight:bold; +} +dl.name-value > dd { + margin:0 0 0 1px; + font-size:1.1em; + display:inline; +} +/* + * Styles for lists. + */ +li.circle { + list-style:circle; +} +ul.horizontal li { + display:inline; + font-size:0.9em; +} +div.inheritance { + margin:0; + padding:0; +} +div.inheritance div.inheritance { + margin-left:2em; +} +ul.block-list, +ul.details-list, +ul.member-list, +ul.summary-list { + margin:10px 0 10px 0; + padding:0; +} +ul.block-list > li, +ul.details-list > li, +ul.member-list > li, +ul.summary-list > li { + list-style:none; + margin-bottom:15px; + line-height:1.4; +} +ul.ref-list { + padding:0; + margin:0; +} +ul.ref-list > li { + list-style:none; +} +.summary-table dl, .summary-table dl dt, .summary-table dl dd { + margin-top:0; + margin-bottom:1px; +} +ul.tag-list, ul.tag-list-long { + padding-left: 0; + list-style: none; +} +ul.tag-list li { + display: inline; +} +ul.tag-list li:not(:last-child):after, +ul.tag-list-long li:not(:last-child):after +{ + content: ", "; + white-space: pre-wrap; +} +ul.preview-feature-list { + list-style: none; + margin:0; + padding:0.1em; + line-height: 1.6em; +} +/* + * Styles for tables. + */ +.summary-table, .details-table { + width:100%; + border-spacing:0; + border:1px solid var(--border-color); + border-top:0; + padding:0; +} +.caption { + position:relative; + text-align:left; + background-repeat:no-repeat; + color:var(--selected-text-color); + clear:none; + overflow:hidden; + padding: 10px 0 0 1px; + margin:0; +} +.caption a:link, .caption a:visited { + color:var(--selected-link-color); +} +.caption a:hover, +.caption a:active { + color:var(--navbar-text-color); +} +.caption span { + font-weight:bold; + white-space:nowrap; + padding:5px 12px 7px 12px; + display:inline-block; + float:left; + background-color:var(--selected-background-color); + border: none; + height:16px; +} +div.table-tabs { + padding:10px 0 0 1px; + margin:10px 0 0 0; +} +div.table-tabs > button { + border: none; + cursor: pointer; + padding: 5px 12px 7px 12px; + font-weight: bold; + margin-right: 8px; +} +div.table-tabs > .active-table-tab { + background: var(--selected-background-color); + color: var(--selected-text-color); +} +div.table-tabs > button.table-tab { + background: var(--navbar-background-color); + color: var(--navbar-text-color); +} +.two-column-search-results { + display: grid; + grid-template-columns: minmax(400px, max-content) minmax(400px, auto); +} +div.checkboxes { + line-height: 2em; +} +div.checkboxes > span { + margin-left: 10px; +} +div.checkboxes > label { + margin-left: 8px; + white-space: nowrap; +} +div.checkboxes > label > input { + margin: 0 2px; +} +.two-column-summary { + display: grid; + grid-template-columns: minmax(25%, max-content) minmax(25%, auto); +} +.three-column-summary { + display: grid; + grid-template-columns: minmax(15%, max-content) minmax(20%, max-content) minmax(20%, auto); +} +.three-column-release-summary { + display: grid; + grid-template-columns: minmax(40%, max-content) minmax(10%, max-content) minmax(40%, auto); +} +.four-column-summary { + display: grid; + grid-template-columns: minmax(10%, max-content) minmax(15%, max-content) minmax(15%, max-content) minmax(15%, auto); +} +@media screen and (max-width: 1000px) { + .four-column-summary { + display: grid; + grid-template-columns: minmax(15%, max-content) minmax(15%, auto); + } +} +@media screen and (max-width: 800px) { + .two-column-search-results { + display: grid; + grid-template-columns: minmax(40%, max-content) minmax(40%, auto); + } + .three-column-summary { + display: grid; + grid-template-columns: minmax(10%, max-content) minmax(25%, auto); + } + .three-column-release-summary { + display: grid; + grid-template-columns: minmax(70%, max-content) minmax(30%, max-content) + } + .three-column-summary .col-last, + .three-column-release-summary .col-last{ + grid-column-end: span 2; + } +} +@media screen and (max-width: 600px) { + .two-column-summary { + display: grid; + grid-template-columns: 1fr; + } +} +.summary-table > div, .details-table > div { + text-align:left; + padding: 8px 3px 3px 7px; + overflow-x: auto; + scrollbar-width: thin; +} +.col-first, .col-second, .col-last, .col-constructor-name, .col-summary-item-name { + vertical-align:top; + padding-right:0; + padding-top:8px; + padding-bottom:3px; +} +.table-header { + background:var(--subnav-background-color); + font-weight: bold; +} +/* Sortable table columns */ +.table-header[onclick] { + cursor: pointer; +} +.table-header[onclick]::after { + content:""; + display:inline-block; + background-image:url('data:image/svg+xml; utf8, \ + \ + '); + background-size:100% 100%; + width:9px; + height:14px; + margin-left:4px; + margin-bottom:-3px; +} +.table-header[onclick].sort-asc::after { + background-image:url('data:image/svg+xml; utf8, \ + \ + \ + '); + +} +.table-header[onclick].sort-desc::after { + background-image:url('data:image/svg+xml; utf8, \ + \ + \ + '); +} +.col-first, .col-first { + font-size:0.93em; +} +.col-second, .col-second, .col-last, .col-constructor-name, .col-summary-item-name, .col-last { + font-size:0.93em; +} +.col-first, .col-second, .col-constructor-name { + vertical-align:top; + overflow: auto; +} +.col-last { + white-space:normal; +} +.col-first a:link, .col-first a:visited, +.col-second a:link, .col-second a:visited, +.col-first a:link, .col-first a:visited, +.col-second a:link, .col-second a:visited, +.col-constructor-name a:link, .col-constructor-name a:visited, +.col-summary-item-name a:link, .col-summary-item-name a:visited { + font-weight:bold; +} +.even-row-color, .even-row-color .table-header { + background-color:var(--even-row-color); +} +.odd-row-color, .odd-row-color .table-header { + background-color:var(--odd-row-color); +} +/* + * Styles for contents. + */ +div.block { + font-size:var(--body-font-size); + font-family:var(--block-font-family); +} +.col-last div { + padding-top:0; +} +.col-last a { + padding-bottom:3px; +} +.module-signature, +.package-signature, +.type-signature, +.member-signature { + font-family:var(--code-font-family); + font-size:1em; + margin:14px 0; + white-space: pre-wrap; +} +.module-signature, +.package-signature, +.type-signature { + margin-top: 0; +} +.member-signature .type-parameters-long, +.member-signature .parameters, +.member-signature .exceptions { + display: inline-block; + vertical-align: top; + white-space: pre; +} +.member-signature .type-parameters { + white-space: normal; +} +/* + * Styles for formatting effect. + */ +.source-line-no { + /* Color of line numbers in source pages can be set via custom property below */ + color:var(--source-linenumber-color, green); + padding:0 30px 0 0; +} +.block { + display:block; + margin:0 10px 5px 0; + color:var(--block-text-color); +} +.deprecated-label, .description-from-type-label, .implementation-label, .member-name-link, +.module-label-in-package, .module-label-in-type, .package-label-in-type, +.package-hierarchy-label, .type-name-label, .type-name-link, .search-tag-link, .preview-label { + font-weight:bold; +} +.deprecation-comment, .help-footnote, .preview-comment { + font-style:italic; +} +.deprecation-block { + font-size:1em; + font-family:var(--block-font-family); + border-style:solid; + border-width:thin; + border-radius:10px; + padding:10px; + margin-bottom:10px; + margin-right:10px; + display:inline-block; +} +.preview-block { + font-size:1em; + font-family:var(--block-font-family); + border-style:solid; + border-width:thin; + border-radius:10px; + padding:10px; + margin-bottom:10px; + margin-right:10px; + display:inline-block; +} +div.block div.deprecation-comment { + font-style:normal; +} +details.invalid-tag, span.invalid-tag { + font-size:1em; + font-family:var(--block-font-family); + color: var(--invalid-tag-text-color); + background: var(--invalid-tag-background-color); + border: thin solid var(--table-border-color); + border-radius:2px; + padding: 2px 4px; + display:inline-block; +} +details summary { + cursor: pointer; +} +/* + * Styles specific to HTML5 elements. + */ +main, nav, header, footer, section { + display:block; +} +/* + * Styles for javadoc search. + */ +.ui-state-active { + /* Overrides the color of selection used in jQuery UI */ + background: var(--selected-background-color); + border: 1px solid var(--selected-background-color); + color: var(--selected-text-color); +} +.ui-autocomplete-category { + font-weight:bold; + font-size:15px; + padding:7px 0 7px 3px; + background-color:var(--navbar-background-color); + color:var(--navbar-text-color); +} +.ui-autocomplete { + max-height:85%; + max-width:65%; + overflow-y:auto; + overflow-x:auto; + scrollbar-width: thin; + white-space:nowrap; + box-shadow: 0 3px 6px rgba(0,0,0,0.16), 0 3px 6px rgba(0,0,0,0.23); +} +ul.ui-autocomplete { + position:fixed; + z-index:1; + background-color: var(--body-background-color); +} +ul.ui-autocomplete li { + float:left; + clear:both; + min-width:100%; +} +ul.ui-autocomplete li.ui-static-link { + position:sticky; + bottom:0; + left:0; + background: var(--subnav-background-color); + padding: 5px 0; + font-family: var(--body-font-family); + font-size: 0.93em; + font-weight: bolder; + z-index: 2; +} +li.ui-static-link a, li.ui-static-link a:visited { + text-decoration:none; + color:var(--link-color); + float:right; + margin-right:20px; +} +.ui-autocomplete .result-item { + font-size: inherit; +} +.ui-autocomplete .result-highlight { + font-weight:bold; +} +#search-input, #page-search-input { + background-image:url('resources/glass.png'); + background-size:13px; + background-repeat:no-repeat; + background-position:2px 3px; + background-color: var(--search-input-background-color); + color: var(--search-input-text-color); + border-color: var(--border-color); + padding-left:20px; + width: 250px; + margin: 0; +} +#search-input { + margin-left: 4px; +} +#reset-button { + background-color: transparent; + background-image:url('resources/x.png'); + background-repeat:no-repeat; + background-size:contain; + border:0; + border-radius:0; + width:12px; + height:12px; + position:absolute; + right:12px; + top:10px; + font-size:0; +} +::placeholder { + color:var(--search-input-placeholder-color); + opacity: 1; +} +.search-tag-desc-result { + font-style:italic; + font-size:11px; +} +.search-tag-holder-result { + font-style:italic; + font-size:12px; +} +.search-tag-result:target { + background-color:var(--search-tag-highlight-color); +} +details.page-search-details { + display: inline-block; +} +div#result-container { + font-size: 1em; +} +div#result-container a.search-result-link { + padding: 0; + margin: 4px 0; + width: 100%; +} +#result-container .result-highlight { + font-weight:bolder; +} +.page-search-info { + background-color: var(--subnav-background-color); + border-radius: 3px; + border: 0 solid var(--border-color); + padding: 0 8px; + overflow: hidden; + height: 0; + transition: all 0.2s ease; +} +div.table-tabs > button.table-tab { + background: var(--navbar-background-color); + color: var(--navbar-text-color); +} +.page-search-header { + padding: 5px 12px 7px 12px; + font-weight: bold; + margin-right: 3px; + background-color:var(--navbar-background-color); + color:var(--navbar-text-color); + display: inline-block; +} +button.page-search-header { + border: none; + cursor: pointer; +} +span#page-search-link { + text-decoration: underline; +} +.module-graph span, .sealed-graph span { + display:none; + position:absolute; +} +.module-graph:hover span, .sealed-graph:hover span { + display:block; + margin: -100px 0 0 100px; + z-index: 1; +} +.inherited-list { + margin: 10px 0 10px 0; +} +section.class-description { + line-height: 1.4; +} +.summary section[class$="-summary"], .details section[class$="-details"], +.class-uses .detail, .serialized-class-details { + padding: 0 20px 5px 10px; + border: 1px solid var(--border-color); + background-color: var(--section-background-color); +} +.inherited-list, section[class$="-details"] .detail { + padding:0 0 5px 8px; + background-color:var(--detail-background-color); + border:none; +} +.vertical-separator { + padding: 0 5px; +} +ul.help-section-list { + margin: 0; +} +ul.help-subtoc > li { + display: inline-block; + padding-right: 5px; + font-size: smaller; +} +ul.help-subtoc > li::before { + content: "\2022" ; + padding-right:2px; +} +.help-note { + font-style: italic; +} +/* + * Indicator icon for external links. + */ +main a[href*="://"]::after { + content:""; + display:inline-block; + background-image:url('data:image/svg+xml; utf8, \ + \ + \ + '); + background-size:100% 100%; + width:7px; + height:7px; + margin-left:2px; + margin-bottom:4px; +} +main a[href*="://"]:hover::after, +main a[href*="://"]:focus::after { + background-image:url('data:image/svg+xml; utf8, \ + \ + \ + '); +} +/* + * Styles for header/section anchor links + */ +a.anchor-link { + opacity: 0; + transition: opacity 0.1s; +} +:hover > a.anchor-link { + opacity: 80%; +} +a.anchor-link:hover, +a.anchor-link:focus-visible, +a.anchor-link.visible { + opacity: 100%; +} +a.anchor-link > img { + width: 0.9em; + height: 0.9em; +} +/* + * Styles for copy-to-clipboard buttons + */ +button.copy { + opacity: 70%; + border: none; + border-radius: 3px; + position: relative; + background:none; + transition: opacity 0.3s; + cursor: pointer; +} +:hover > button.copy { + opacity: 80%; +} +button.copy:hover, +button.copy:active, +button.copy:focus-visible, +button.copy.visible { + opacity: 100%; +} +button.copy img { + position: relative; + background: none; + filter: brightness(var(--copy-icon-brightness)); +} +button.copy:active { + background-color: var(--copy-button-background-color-active); +} +button.copy span { + color: var(--body-text-color); + position: relative; + top: -0.1em; + transition: all 0.1s; + font-size: 0.76rem; + line-height: 1.2em; + opacity: 0; +} +button.copy:hover span, +button.copy:focus-visible span, +button.copy.visible span { + opacity: 100%; +} +/* search page copy button */ +button#page-search-copy { + margin-left: 0.4em; + padding:0.3em; + top:0.13em; +} +button#page-search-copy img { + width: 1.2em; + height: 1.2em; + padding: 0.01em 0; + top: 0.15em; +} +button#page-search-copy span { + color: var(--body-text-color); + line-height: 1.2em; + padding: 0.2em; + top: -0.18em; +} +div.page-search-info:hover button#page-search-copy span { + opacity: 100%; +} +/* snippet copy button */ +button.snippet-copy { + position: absolute; + top: 6px; + right: 6px; + height: 1.7em; + padding: 2px; +} +button.snippet-copy img { + width: 18px; + height: 18px; + padding: 0.05em 0; +} +button.snippet-copy span { + line-height: 1.2em; + padding: 0.2em; + position: relative; + top: -0.5em; +} +div.snippet-container:hover button.snippet-copy span { + opacity: 100%; +} +/* + * Styles for user-provided tables. + * + * borderless: + * No borders, vertical margins, styled caption. + * This style is provided for use with existing doc comments. + * In general, borderless tables should not be used for layout purposes. + * + * plain: + * Plain borders around table and cells, vertical margins, styled caption. + * Best for small tables or for complex tables for tables with cells that span + * rows and columns, when the "striped" style does not work well. + * + * striped: + * Borders around the table and vertical borders between cells, striped rows, + * vertical margins, styled caption. + * Best for tables that have a header row, and a body containing a series of simple rows. + */ + +table.borderless, +table.plain, +table.striped { + margin-top: 10px; + margin-bottom: 10px; +} +table.borderless > caption, +table.plain > caption, +table.striped > caption { + font-weight: bold; + font-size: smaller; +} +table.borderless th, table.borderless td, +table.plain th, table.plain td, +table.striped th, table.striped td { + padding: 2px 5px; +} +table.borderless, +table.borderless > thead > tr > th, table.borderless > tbody > tr > th, table.borderless > tr > th, +table.borderless > thead > tr > td, table.borderless > tbody > tr > td, table.borderless > tr > td { + border: none; +} +table.borderless > thead > tr, table.borderless > tbody > tr, table.borderless > tr { + background-color: transparent; +} +table.plain { + border-collapse: collapse; + border: 1px solid var(--table-border-color); +} +table.plain > thead > tr, table.plain > tbody tr, table.plain > tr { + background-color: transparent; +} +table.plain > thead > tr > th, table.plain > tbody > tr > th, table.plain > tr > th, +table.plain > thead > tr > td, table.plain > tbody > tr > td, table.plain > tr > td { + border: 1px solid var(--table-border-color); +} +table.striped { + border-collapse: collapse; + border: 1px solid var(--table-border-color); +} +table.striped > thead { + background-color: var(--subnav-background-color); +} +table.striped > thead > tr > th, table.striped > thead > tr > td { + border: 1px solid var(--table-border-color); +} +table.striped > tbody > tr:nth-child(even) { + background-color: var(--odd-row-color) +} +table.striped > tbody > tr:nth-child(odd) { + background-color: var(--even-row-color) +} +table.striped > tbody > tr > th, table.striped > tbody > tr > td { + border-left: 1px solid var(--table-border-color); + border-right: 1px solid var(--table-border-color); +} +table.striped > tbody > tr > th { + font-weight: normal; +} +/** + * Tweak style for small screens. + */ +@media screen and (max-width: 920px) { + header.flex-header { + max-height: 100vh; + overflow-y: auto; + } + div#navbar-top { + height: 2.8em; + transition: height 0.35s ease; + } + ul.nav-list { + display: block; + width: 40%; + float:left; + clear: left; + margin: 10px 0 0 0; + padding: 0; + } + ul.nav-list li { + float: none; + padding: 6px; + margin-left: 10px; + margin-top: 2px; + } + ul.sub-nav-list-small { + display:block; + height: 100%; + width: 50%; + float: right; + clear: right; + background-color: var(--subnav-background-color); + color: var(--body-text-color); + margin: 6px 0 0 0; + padding: 0; + } + ul.sub-nav-list-small ul { + padding-left: 20px; + } + ul.sub-nav-list-small a:link, ul.sub-nav-list-small a:visited { + color:var(--link-color); + } + ul.sub-nav-list-small a:hover { + color:var(--link-color-active); + } + ul.sub-nav-list-small li { + list-style:none; + float:none; + padding: 6px; + margin-top: 1px; + text-transform:uppercase; + } + ul.sub-nav-list-small > li { + margin-left: 10px; + } + ul.sub-nav-list-small li p { + margin: 5px 0; + } + div#navbar-sub-list { + display: none; + } + .top-nav a:link, .top-nav a:active, .top-nav a:visited { + display: block; + } + button#navbar-toggle-button { + width: 3.4em; + height: 2.8em; + background-color: transparent; + display: block; + float: left; + border: 0; + margin: 0 10px; + cursor: pointer; + font-size: 10px; + } + button#navbar-toggle-button .nav-bar-toggle-icon { + display: block; + width: 24px; + height: 3px; + margin: 1px 0 4px 0; + border-radius: 2px; + transition: all 0.1s; + background-color: var(--navbar-text-color); + } + button#navbar-toggle-button.expanded span.nav-bar-toggle-icon:nth-child(1) { + transform: rotate(45deg); + transform-origin: 10% 10%; + width: 26px; + } + button#navbar-toggle-button.expanded span.nav-bar-toggle-icon:nth-child(2) { + opacity: 0; + } + button#navbar-toggle-button.expanded span.nav-bar-toggle-icon:nth-child(3) { + transform: rotate(-45deg); + transform-origin: 10% 90%; + width: 26px; + } +} +@media screen and (max-width: 800px) { + .about-language { + padding-right: 16px; + } + ul.nav-list li { + margin-left: 5px; + } + ul.sub-nav-list-small > li { + margin-left: 5px; + } + main { + padding: 10px; + } + .summary section[class$="-summary"], .details section[class$="-details"], + .class-uses .detail, .serialized-class-details { + padding: 0 8px 5px 8px; + } + body { + -webkit-text-size-adjust: none; + } +} +@media screen and (max-width: 400px) { + .about-language { + font-size: 10px; + padding-right: 12px; + } +} +@media screen and (max-width: 400px) { + .nav-list-search { + width: 94%; + } + #search-input, #page-search-input { + width: 70%; + } +} +@media screen and (max-width: 320px) { + .nav-list-search > label { + display: none; + } + .nav-list-search { + width: 90%; + } + #search-input, #page-search-input { + width: 80%; + } +} + +pre.snippet { + background-color: var(--snippet-background-color); + color: var(--snippet-text-color); + padding: 10px; + margin: 12px 0; + overflow: auto; + white-space: pre; +} +div.snippet-container { + position: relative; +} +@media screen and (max-width: 800px) { + pre.snippet { + padding-top: 26px; + } + button.snippet-copy { + top: 4px; + right: 4px; + } +} +pre.snippet .italic { + font-style: italic; +} +pre.snippet .bold { + font-weight: bold; +} +pre.snippet .highlighted { + background-color: var(--snippet-highlight-color); + border-radius: 10%; +} diff --git a/static/api/client/4.0.x/tag-search-index.js b/static/api/client/4.0.x/tag-search-index.js new file mode 100644 index 000000000000..bf10aaf6d137 --- /dev/null +++ b/static/api/client/4.0.x/tag-search-index.js @@ -0,0 +1 @@ +tagSearchIndex = [{"l":"Constant Field Values","h":"","u":"constant-values.html"},{"l":"Serialized Form","h":"","u":"serialized-form.html"}];updateSearchResults(); \ No newline at end of file diff --git a/static/api/client/4.0.x/type-search-index.js b/static/api/client/4.0.x/type-search-index.js new file mode 100644 index 000000000000..22e5e2b8cfca --- /dev/null +++ b/static/api/client/4.0.x/type-search-index.js @@ -0,0 +1 @@ +typeSearchIndex = [{"l":"All Classes and Interfaces","u":"allclasses-index.html"},{"p":"org.apache.pulsar.client.api","l":"PulsarClientException.AlreadyClosedException"},{"p":"org.apache.pulsar.common.api","l":"AuthData"},{"p":"org.apache.pulsar.client.api","l":"Authentication"},{"p":"org.apache.pulsar.client.api","l":"AuthenticationDataProvider"},{"p":"org.apache.pulsar.client.api","l":"PulsarClientException.AuthenticationException"},{"p":"org.apache.pulsar.client.api","l":"AuthenticationFactory"},{"p":"org.apache.pulsar.client.api","l":"PulsarClientException.AuthorizationException"},{"p":"org.apache.pulsar.client.api","l":"AutoClusterFailoverBuilder"},{"p":"org.apache.pulsar.client.api","l":"BatcherBuilder"},{"p":"org.apache.pulsar.client.api","l":"BatchMessageContainer"},{"p":"org.apache.pulsar.client.api","l":"BatchReceivePolicy"},{"p":"org.apache.pulsar.client.api","l":"PulsarClientException.BrokerMetadataException"},{"p":"org.apache.pulsar.client.api","l":"PulsarClientException.BrokerPersistenceException"},{"p":"org.apache.pulsar.client.api","l":"BatchReceivePolicy.Builder"},{"p":"org.apache.pulsar.client.api","l":"PulsarClientException.ChecksumException"},{"p":"org.apache.pulsar.client.api","l":"ClientBuilder"},{"p":"org.apache.pulsar.client.api","l":"CompressionType"},{"p":"org.apache.pulsar.client.api","l":"PulsarClientException.ConnectException"},{"p":"org.apache.pulsar.client.api","l":"Consumer"},{"p":"org.apache.pulsar.client.api","l":"PulsarClientException.ConsumerAssignException"},{"p":"org.apache.pulsar.client.api","l":"ConsumerBuilder"},{"p":"org.apache.pulsar.client.api","l":"PulsarClientException.ConsumerBusyException"},{"p":"org.apache.pulsar.client.api","l":"ConsumerCryptoFailureAction"},{"p":"org.apache.pulsar.client.api","l":"ConsumerEventListener"},{"p":"org.apache.pulsar.client.api","l":"ConsumerInterceptor"},{"p":"org.apache.pulsar.client.api","l":"ConsumerStats"},{"p":"org.apache.pulsar.client.api","l":"ControlledClusterFailoverBuilder"},{"p":"org.apache.pulsar.client.api.transaction","l":"TransactionCoordinatorClientException.CoordinatorClientStateException"},{"p":"org.apache.pulsar.client.api.transaction","l":"TransactionCoordinatorClientException.CoordinatorNotFoundException"},{"p":"org.apache.pulsar.client.api","l":"PulsarClientException.CryptoException"},{"p":"org.apache.pulsar.client.api","l":"CryptoKeyReader"},{"p":"org.apache.pulsar.client.api","l":"DeadLetterPolicy"},{"p":"org.apache.pulsar.client.internal","l":"DefaultImplementation"},{"p":"org.apache.pulsar.client.api","l":"DummyCryptoKeyReaderImpl"},{"p":"org.apache.pulsar.client.api","l":"EncodedAuthenticationParameterSupport"},{"p":"org.apache.pulsar.common.api","l":"EncryptionContext"},{"p":"org.apache.pulsar.common.api","l":"EncryptionContext.EncryptionKey"},{"p":"org.apache.pulsar.client.api","l":"EncryptionKeyInfo"},{"p":"org.apache.pulsar.common.classification","l":"InterfaceStability.Evolving"},{"p":"org.apache.pulsar.client.api","l":"PulsarClientException.FailedFeatureCheck"},{"p":"org.apache.pulsar.client.api","l":"AutoClusterFailoverBuilder.FailoverPolicy"},{"p":"org.apache.pulsar.client.api","l":"PulsarClientException.FeatureNotSupportedException"},{"p":"org.apache.pulsar.client.api.schema","l":"Field"},{"p":"org.apache.pulsar.client.api.schema","l":"FieldSchemaBuilder"},{"p":"org.apache.pulsar.client.api.schema","l":"GenericObject"},{"p":"org.apache.pulsar.client.api.schema","l":"GenericRecord"},{"p":"org.apache.pulsar.client.api.schema","l":"GenericRecordBuilder"},{"p":"org.apache.pulsar.client.api.schema","l":"GenericSchema"},{"p":"org.apache.pulsar.client.api","l":"PulsarClientException.GettingAuthenticationDataException"},{"p":"org.apache.pulsar.client.api","l":"HashingScheme"},{"p":"org.apache.pulsar.client.api","l":"PulsarClientException.IncompatibleSchemaException"},{"p":"org.apache.pulsar.common.classification","l":"InterfaceAudience"},{"p":"org.apache.pulsar.common.classification","l":"InterfaceStability"},{"p":"org.apache.pulsar.client.api","l":"PulsarClientException.InvalidConfigurationException"},{"p":"org.apache.pulsar.client.api","l":"PulsarClientException.InvalidMessageException"},{"p":"org.apache.pulsar.client.api","l":"PulsarClientException.InvalidServiceURL"},{"p":"org.apache.pulsar.client.api","l":"PulsarClientException.InvalidTopicNameException"},{"p":"org.apache.pulsar.client.api.transaction","l":"TransactionCoordinatorClientException.InvalidTxnStatusException"},{"p":"org.apache.pulsar.client.api","l":"KeySharedMode"},{"p":"org.apache.pulsar.client.api","l":"KeySharedPolicy"},{"p":"org.apache.pulsar.client.api","l":"KeySharedPolicy.KeySharedPolicyAutoSplit"},{"p":"org.apache.pulsar.client.api","l":"KeySharedPolicy.KeySharedPolicySticky"},{"p":"org.apache.pulsar.client.api","l":"KeyStoreParams"},{"p":"org.apache.pulsar.common.schema","l":"KeyValue"},{"p":"org.apache.pulsar.common.schema","l":"KeyValue.KeyValueDecoder"},{"p":"org.apache.pulsar.common.schema","l":"KeyValueEncodingType"},{"p":"org.apache.pulsar.client.api.schema","l":"KeyValueSchema"},{"p":"org.apache.pulsar.common.classification","l":"InterfaceAudience.LimitedPrivate"},{"p":"org.apache.pulsar.client.api","l":"PulsarClientException.LookupException"},{"p":"org.apache.pulsar.client.api","l":"PulsarClientException.MemoryBufferIsFullError"},{"p":"org.apache.pulsar.client.api","l":"Message"},{"p":"org.apache.pulsar.client.api","l":"PulsarClientException.MessageAcknowledgeException"},{"p":"org.apache.pulsar.client.api","l":"MessageAcknowledger"},{"p":"org.apache.pulsar.client.api","l":"MessageCrypto"},{"p":"org.apache.pulsar.client.api","l":"MessageId"},{"p":"org.apache.pulsar.client.api","l":"MessageListener"},{"p":"org.apache.pulsar.client.api","l":"MessageListenerExecutor"},{"p":"org.apache.pulsar.client.api","l":"MessagePayload"},{"p":"org.apache.pulsar.client.api","l":"MessagePayloadContext"},{"p":"org.apache.pulsar.client.api","l":"MessagePayloadFactory"},{"p":"org.apache.pulsar.client.api","l":"MessagePayloadProcessor"},{"p":"org.apache.pulsar.client.api","l":"MessageRouter"},{"p":"org.apache.pulsar.client.api","l":"MessageRoutingMode"},{"p":"org.apache.pulsar.client.api","l":"Messages"},{"p":"org.apache.pulsar.client.api.transaction","l":"TransactionCoordinatorClientException.MetaStoreHandlerNotExistsException"},{"p":"org.apache.pulsar.client.api.transaction","l":"TransactionCoordinatorClientException.MetaStoreHandlerNotReadyException"},{"p":"org.apache.pulsar.client.api","l":"MultiTopicConsumerStats"},{"p":"org.apache.pulsar.client.api","l":"PulsarClientException.NotAllowedException"},{"p":"org.apache.pulsar.client.api","l":"PulsarClientException.NotConnectedException"},{"p":"org.apache.pulsar.client.api","l":"PulsarClientException.NotFoundException"},{"p":"org.apache.pulsar.client.api","l":"PulsarClientException.NotSupportedException"},{"p":"org.apache.pulsar.client.api","l":"PartitionedTopicProducerStats"},{"p":"org.apache.pulsar.common.classification","l":"InterfaceAudience.Private"},{"p":"org.apache.pulsar.client.api","l":"Producer"},{"p":"org.apache.pulsar.client.api","l":"ProducerAccessMode"},{"p":"org.apache.pulsar.client.api","l":"PulsarClientException.ProducerBlockedQuotaExceededError"},{"p":"org.apache.pulsar.client.api","l":"PulsarClientException.ProducerBlockedQuotaExceededException"},{"p":"org.apache.pulsar.client.api","l":"ProducerBuilder"},{"p":"org.apache.pulsar.client.api","l":"PulsarClientException.ProducerBusyException"},{"p":"org.apache.pulsar.client.api","l":"ProducerCryptoFailureAction"},{"p":"org.apache.pulsar.client.api","l":"PulsarClientException.ProducerFencedException"},{"p":"org.apache.pulsar.client.api.interceptor","l":"ProducerInterceptor"},{"p":"org.apache.pulsar.client.api","l":"ProducerInterceptor"},{"p":"org.apache.pulsar.client.api.interceptor","l":"ProducerInterceptorWrapper"},{"p":"org.apache.pulsar.client.api","l":"PulsarClientException.ProducerQueueIsFullError"},{"p":"org.apache.pulsar.client.api","l":"ProducerStats"},{"p":"org.apache.pulsar.client.internal","l":"PropertiesUtils"},{"p":"org.apache.pulsar.client.api","l":"ProxyProtocol"},{"p":"org.apache.pulsar.common.classification","l":"InterfaceAudience.Public"},{"p":"org.apache.pulsar.client.api","l":"PulsarClient"},{"p":"org.apache.pulsar.client.api","l":"PulsarClientException"},{"p":"org.apache.pulsar.client.internal","l":"PulsarClientImplementationBinding"},{"p":"org.apache.pulsar.client.api","l":"Range"},{"p":"org.apache.pulsar.client.api.transaction","l":"TransactionBufferClientException.ReachMaxPendingOpsException"},{"p":"org.apache.pulsar.client.api","l":"Reader"},{"p":"org.apache.pulsar.client.api","l":"ReaderBuilder"},{"p":"org.apache.pulsar.client.api","l":"ReaderInterceptor"},{"p":"org.apache.pulsar.client.api","l":"ReaderListener"},{"p":"org.apache.pulsar.client.api.schema","l":"RecordSchemaBuilder"},{"p":"org.apache.pulsar.client.api","l":"RedeliveryBackoff"},{"p":"org.apache.pulsar.client.api","l":"RegexSubscriptionMode"},{"p":"org.apache.pulsar.client.api.transaction","l":"TransactionBufferClientException.RequestTimeoutException"},{"p":"org.apache.pulsar.client.api","l":"Schema"},{"p":"org.apache.pulsar.client.api.schema","l":"SchemaBuilder"},{"p":"org.apache.pulsar.client.api.schema","l":"SchemaDefinition"},{"p":"org.apache.pulsar.client.api.schema","l":"SchemaDefinitionBuilder"},{"p":"org.apache.pulsar.common.schema","l":"SchemaInfo"},{"p":"org.apache.pulsar.common.schema","l":"SchemaInfo.SchemaInfoBuilder"},{"p":"org.apache.pulsar.client.api.schema","l":"SchemaInfoProvider"},{"p":"org.apache.pulsar.common.schema","l":"SchemaInfoWithVersion"},{"p":"org.apache.pulsar.client.api.schema","l":"SchemaReader"},{"p":"org.apache.pulsar.client.api","l":"SchemaSerializationException"},{"p":"org.apache.pulsar.common.schema","l":"SchemaType"},{"p":"org.apache.pulsar.client.api.schema","l":"SchemaWriter"},{"p":"org.apache.pulsar.client.api","l":"ServiceUrlProvider"},{"p":"org.apache.pulsar.client.api","l":"SizeUnit"},{"p":"org.apache.pulsar.common.classification","l":"InterfaceStability.Stable"},{"p":"org.apache.pulsar.client.api.transaction","l":"Transaction.State"},{"p":"org.apache.pulsar.client.api.transaction","l":"TransactionCoordinatorClient.State"},{"p":"org.apache.pulsar.client.api","l":"SubscriptionInitialPosition"},{"p":"org.apache.pulsar.client.api","l":"SubscriptionMode"},{"p":"org.apache.pulsar.client.api","l":"PulsarClientException.SubscriptionNotFoundException"},{"p":"org.apache.pulsar.client.api","l":"SubscriptionType"},{"p":"org.apache.pulsar.client.api","l":"TableView"},{"p":"org.apache.pulsar.client.api","l":"TableViewBuilder"},{"p":"org.apache.pulsar.client.api","l":"PulsarClientException.TimeoutException"},{"p":"org.apache.pulsar.client.api","l":"PulsarClientException.TooManyRequestsException"},{"p":"org.apache.pulsar.client.api","l":"TopicConsumerBuilder"},{"p":"org.apache.pulsar.client.api","l":"PulsarClientException.TopicDoesNotExistException"},{"p":"org.apache.pulsar.client.api","l":"TopicMessageId"},{"p":"org.apache.pulsar.client.api","l":"TopicMetadata"},{"p":"org.apache.pulsar.client.api","l":"PulsarClientException.TopicMigrationException"},{"p":"org.apache.pulsar.client.api","l":"PulsarClientException.TopicTerminatedException"},{"p":"org.apache.pulsar.client.api.transaction","l":"Transaction"},{"p":"org.apache.pulsar.client.api.transaction","l":"TransactionBufferClient"},{"p":"org.apache.pulsar.client.api.transaction","l":"TransactionBufferClientException"},{"p":"org.apache.pulsar.client.api.transaction","l":"TransactionBuilder"},{"p":"org.apache.pulsar.client.api","l":"PulsarClientException.TransactionConflictException"},{"p":"org.apache.pulsar.client.api.transaction","l":"TransactionCoordinatorClient"},{"p":"org.apache.pulsar.client.api.transaction","l":"TransactionCoordinatorClientException"},{"p":"org.apache.pulsar.client.api","l":"PulsarClientException.TransactionHasOperationFailedException"},{"p":"org.apache.pulsar.client.api","l":"TransactionIsolationLevel"},{"p":"org.apache.pulsar.client.api.transaction","l":"TransactionCoordinatorClientException.TransactionNotFoundException"},{"p":"org.apache.pulsar.client.api.transaction","l":"TxnID"},{"p":"org.apache.pulsar.client.api","l":"TypedMessageBuilder"},{"p":"org.apache.pulsar.common.classification","l":"InterfaceStability.Unstable"},{"p":"org.apache.pulsar.client.api","l":"PulsarClientException.UnsupportedAuthenticationException"}];updateSearchResults(); \ No newline at end of file diff --git a/static/api/pulsar-functions/4.0.x/allclasses-index.html b/static/api/pulsar-functions/4.0.x/allclasses-index.html new file mode 100644 index 000000000000..ebc4dc0c523c --- /dev/null +++ b/static/api/pulsar-functions/4.0.x/allclasses-index.html @@ -0,0 +1,123 @@ + + + + +All Classes and Interfaces (Pulsar Functions :: API 4.0.0 API) + + + + + + + + + + + + + +
      + +
      +
      +
      +

      All Classes and Interfaces

      +
      +
      +
      +
      +
      +
      Class
      +
      Description
      +
      BaseContext
      +
      +
      BaseContext provides base contextual information to the executing function/source/sink.
      +
      +
      ByteBufferStateStore
      +
      +
      A key-value state store that stores values in ByteBuffer.
      +
      +
      Context
      +
      +
      Context provides contextual information to the executing function.
      +
      +
      CounterStateStore
      +
      +
      The state store supports counters.
      +
      +
      Function<X,T>
      +
      +
      This is the core interface of the function api.
      +
      +
      FunctionRecord<T>
      +
       
      +
      FunctionRecord.FunctionRecordBuilder<T>
      +
       
      +
      IdentityFunction
      +
       
      +
      KVRecord<K,V>
      +
      +
      key value schema record.
      +
      +
      Record<T>
      +
      +
      Pulsar IO's Record interface.
      +
      +
      SerDe<T>
      +
      +
      An interface for serializer/deserializer.
      +
      +
      StateStore
      +
       
      +
      StateStoreContext
      +
      +
      State Store Context Interface.
      +
      +
      StateValue
      +
       
      +
      WindowContext
      +
       
      +
      WindowFunction<X,T>
      +
      +
      This is the interface of the windowed function api.
      +
      +
      +
      +
      +
      + +
      +
      + + diff --git a/static/api/pulsar-functions/4.0.x/allpackages-index.html b/static/api/pulsar-functions/4.0.x/allpackages-index.html new file mode 100644 index 000000000000..a9aa0e1b11b6 --- /dev/null +++ b/static/api/pulsar-functions/4.0.x/allpackages-index.html @@ -0,0 +1,79 @@ + + + + +All Packages (Pulsar Functions :: API 4.0.0 API) + + + + + + + + + + + + + +
      + +
      +
      +
      +

      All Packages

      +
      +
      Package Summary
      +
      +
      Package
      +
      Description
      +
      org.apache.pulsar.functions.api
      +
      +
      Provides a simple model for enabling lightweight computation on Apache Pulsar.
      +
      +
      org.apache.pulsar.functions.api.state
      +
      +
      State Store API.
      +
      +
      org.apache.pulsar.functions.api.utils
      +
      +
      State Store API.
      +
      +
      +
      + +
      +
      + + diff --git a/static/api/pulsar-functions/4.0.x/copy.svg b/static/api/pulsar-functions/4.0.x/copy.svg new file mode 100644 index 000000000000..7c46ab15feaf --- /dev/null +++ b/static/api/pulsar-functions/4.0.x/copy.svg @@ -0,0 +1,33 @@ + + + + + + + + diff --git a/static/api/pulsar-functions/4.0.x/deprecated-list.html b/static/api/pulsar-functions/4.0.x/deprecated-list.html new file mode 100644 index 000000000000..ef503a33b327 --- /dev/null +++ b/static/api/pulsar-functions/4.0.x/deprecated-list.html @@ -0,0 +1,99 @@ + + + + +Deprecated List (Pulsar Functions :: API 4.0.0 API) + + + + + + + + + + + + + +
      + +
      +
      +
      +

      Deprecated API

      +
      +

      Contents

      + + + +
      + +
      +
      + + diff --git a/static/api/pulsar-functions/4.0.x/element-list b/static/api/pulsar-functions/4.0.x/element-list new file mode 100644 index 000000000000..fc3ca9923670 --- /dev/null +++ b/static/api/pulsar-functions/4.0.x/element-list @@ -0,0 +1,3 @@ +org.apache.pulsar.functions.api +org.apache.pulsar.functions.api.state +org.apache.pulsar.functions.api.utils diff --git a/static/api/pulsar-functions/4.0.x/help-doc.html b/static/api/pulsar-functions/4.0.x/help-doc.html new file mode 100644 index 000000000000..5bd3b7ce809c --- /dev/null +++ b/static/api/pulsar-functions/4.0.x/help-doc.html @@ -0,0 +1,198 @@ + + + + +API Help (Pulsar Functions :: API 4.0.0 API) + + + + + + + + + + + + + +
      + +
      +
      +

      JavaDoc Help

      + +
      +
      +

      Navigation

      +Starting from the Overview page, you can browse the documentation using the links in each page, and in the navigation bar at the top of each page. The Index and Search box allow you to navigate to specific declarations and summary pages, including: All Packages, All Classes and Interfaces + +
      +
      +
      +

      Kinds of Pages

      +The following sections describe the different kinds of pages in this collection. +
      +

      Overview

      +

      The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.

      +
      +
      +

      Package

      +

      Each package has a page that contains a list of its classes and interfaces, with a summary for each. These pages may contain the following categories:

      +
        +
      • Interfaces
        • +
      • Classes
        • +
      • Enum Classes
        • +
      • Exception Classes
        • +
      • Annotation Interfaces
        • +
      +
      +
      +

      Class or Interface

      +

      Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a declaration and description, member summary tables, and detailed member descriptions. Entries in each of these sections are omitted if they are empty or not applicable.

      +
        +
      • Class Inheritance Diagram
        • +
      • Direct Subclasses
        • +
      • All Known Subinterfaces
        • +
      • All Known Implementing Classes
        • +
      • Class or Interface Declaration
        • +
      • Class or Interface Description
        • +
      +
      +
        +
      • Nested Class Summary
        • +
      • Enum Constant Summary
        • +
      • Field Summary
        • +
      • Property Summary
        • +
      • Constructor Summary
        • +
      • Method Summary
        • +
      • Required Element Summary
        • +
      • Optional Element Summary
        • +
      +
      +
        +
      • Enum Constant Details
        • +
      • Field Details
        • +
      • Property Details
        • +
      • Constructor Details
        • +
      • Method Details
        • +
      • Element Details
        • +
      +

      Note: Annotation interfaces have required and optional elements, but not methods. Only enum classes have enum constants. The components of a record class are displayed as part of the declaration of the record class. Properties are a feature of JavaFX.

      +

      The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.

      +
      +
      +

      Other Files

      +

      Packages and modules may contain pages with additional information related to the declarations nearby.

      +
      +
      +

      Use

      +

      Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the USE link in the navigation bar.

      +
      +
      +

      Tree (Class Hierarchy)

      +

      There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. Classes are organized by inheritance structure starting with java.lang.Object. Interfaces do not inherit from java.lang.Object.

      +
        +
      • When viewing the Overview page, clicking on TREE displays the hierarchy for all packages.
        • +
      • When viewing a particular package, class or interface page, clicking on TREE displays the hierarchy for only that package.
        • +
      +
      +
      +

      Deprecated API

      +

      The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to shortcomings, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.

      +
      +
      +

      All Packages

      +

      The All Packages page contains an alphabetic index of all packages contained in the documentation.

      +
      +
      +

      All Classes and Interfaces

      +

      The All Classes and Interfaces page contains an alphabetic index of all classes and interfaces contained in the documentation, including annotation interfaces, enum classes, and record classes.

      +
      +
      +

      Index

      +

      The Index contains an alphabetic index of all classes, interfaces, constructors, methods, and fields in the documentation, as well as summary pages such as All Packages, All Classes and Interfaces.

      +
      +
      +
      +This help file applies to API documentation generated by the standard doclet.
      + +
      +
      + + diff --git a/static/api/pulsar-functions/4.0.x/index-all.html b/static/api/pulsar-functions/4.0.x/index-all.html new file mode 100644 index 000000000000..c961e38751be --- /dev/null +++ b/static/api/pulsar-functions/4.0.x/index-all.html @@ -0,0 +1,592 @@ + + + + +Index (Pulsar Functions :: API 4.0.0 API) + + + + + + + + + + + + + +
      + +
      +
      +
      +

      Index

      +
      +A B C D F G I K N O P R S T W 
      All Classes and Interfaces|All Packages +

      A

      +
      +
      ack() - Method in interface org.apache.pulsar.functions.api.Record
      +
      +
      Acknowledge that this record is fully processed.
      +
      +
      apply(Object) - Method in class org.apache.pulsar.functions.api.utils.IdentityFunction
      +
       
      +
      +

      B

      +
      +
      BaseContext - Interface in org.apache.pulsar.functions.api
      +
      +
      BaseContext provides base contextual information to the executing function/source/sink.
      +
      +
      ByteBufferStateStore - Interface in org.apache.pulsar.functions.api.state
      +
      +
      A key-value state store that stores values in ByteBuffer.
      +
      +
      +

      C

      +
      +
      close() - Method in interface org.apache.pulsar.functions.api.Function
      +
      +
      Called once to properly close resources when function instance is stopped.
      +
      +
      close() - Method in interface org.apache.pulsar.functions.api.StateStore
      +
       
      +
      Context - Interface in org.apache.pulsar.functions.api
      +
      +
      Context provides contextual information to the executing function.
      +
      +
      CounterStateStore - Interface in org.apache.pulsar.functions.api.state
      +
      +
      The state store supports counters.
      +
      +
      +

      D

      +
      +
      delete(String) - Method in interface org.apache.pulsar.functions.api.state.ByteBufferStateStore
      +
      +
      Delete the state value for the key.
      +
      +
      deleteAsync(String) - Method in interface org.apache.pulsar.functions.api.state.ByteBufferStateStore
      +
      +
      Delete the state value for the key, but don't wait for the operation to be completed.
      +
      +
      deleteState(String) - Method in interface org.apache.pulsar.functions.api.BaseContext
      +
      +
      Delete the state value for the key.
      +
      +
      deleteStateAsync(String) - Method in interface org.apache.pulsar.functions.api.BaseContext
      +
      +
      Delete the state value for the key, but don't wait for the operation to be completed.
      +
      +
      deserialize(byte[]) - Method in interface org.apache.pulsar.functions.api.SerDe
      +
       
      +
      +

      F

      +
      +
      fail() - Method in interface org.apache.pulsar.functions.api.Record
      +
      +
      To indicate that this record has failed to be processed.
      +
      +
      fatal(Throwable) - Method in interface org.apache.pulsar.functions.api.BaseContext
      +
      +
      Terminate the function instance with a fatal exception.
      +
      +
      fqsn() - Method in interface org.apache.pulsar.functions.api.StateStore
      +
      +
      The fully qualified state store name.
      +
      +
      from(Context, Schema<T>) - Static method in class org.apache.pulsar.functions.api.utils.FunctionRecord
      +
      +
      Creates a builder for a Record from a Function Context.
      +
      +
      Function<X,T> - Interface in org.apache.pulsar.functions.api
      +
      +
      This is the core interface of the function api.
      +
      +
      FunctionRecord<T> - Class in org.apache.pulsar.functions.api.utils
      +
       
      +
      FunctionRecord() - Constructor for class org.apache.pulsar.functions.api.utils.FunctionRecord
      +
       
      +
      FunctionRecord.FunctionRecordBuilder<T> - Class in org.apache.pulsar.functions.api.utils
      +
       
      +
      +

      G

      +
      +
      get(String) - Method in interface org.apache.pulsar.functions.api.state.ByteBufferStateStore
      +
      +
      Retrieve the state value for the key.
      +
      +
      getAsync(String) - Method in interface org.apache.pulsar.functions.api.state.ByteBufferStateStore
      +
      +
      Retrieve the state value for the key, but don't wait for the operation to be completed.
      +
      +
      getCounter(String) - Method in interface org.apache.pulsar.functions.api.BaseContext
      +
      +
      Retrieve the counter value for the key.
      +
      +
      getCounter(String) - Method in interface org.apache.pulsar.functions.api.state.CounterStateStore
      +
      +
      Retrieve the counter value for the key.
      +
      +
      getCounter(String) - Method in interface org.apache.pulsar.functions.api.WindowContext
      +
      +
      Retrieve the counter value for the key.
      +
      +
      getCounterAsync(String) - Method in interface org.apache.pulsar.functions.api.BaseContext
      +
      +
      Retrieve the counter value for the key, but don't wait + for the operation to be completed.
      +
      +
      getCounterAsync(String) - Method in interface org.apache.pulsar.functions.api.state.CounterStateStore
      +
      +
      Retrieve the counter value for the key, but don't wait + for the operation to be completed.
      +
      +
      getCurrentRecord() - Method in interface org.apache.pulsar.functions.api.Context
      +
      +
      Access the record associated with the current input value.
      +
      +
      getDestinationTopic() - Method in interface org.apache.pulsar.functions.api.Record
      +
      +
      To support message routing on a per message basis.
      +
      +
      getDestinationTopic() - Method in class org.apache.pulsar.functions.api.utils.FunctionRecord
      +
       
      +
      getEventTime() - Method in interface org.apache.pulsar.functions.api.Record
      +
      +
      Retrieves the event time of the record from the source.
      +
      +
      getEventTime() - Method in class org.apache.pulsar.functions.api.utils.FunctionRecord
      +
       
      +
      getFunctionId() - Method in interface org.apache.pulsar.functions.api.Context
      +
      +
      The id of the function that we are executing.
      +
      +
      getFunctionId() - Method in interface org.apache.pulsar.functions.api.WindowContext
      +
      +
      The id of the function that we are executing.
      +
      +
      getFunctionName() - Method in interface org.apache.pulsar.functions.api.Context
      +
      +
      The name of the function that we are executing.
      +
      +
      getFunctionName() - Method in interface org.apache.pulsar.functions.api.WindowContext
      +
      +
      The name of the function that we are executing.
      +
      +
      getFunctionVersion() - Method in interface org.apache.pulsar.functions.api.Context
      +
      +
      The version of the function that we are executing.
      +
      +
      getFunctionVersion() - Method in interface org.apache.pulsar.functions.api.WindowContext
      +
      +
      The version of the function that we are executing.
      +
      +
      getInputTopics() - Method in interface org.apache.pulsar.functions.api.Context
      +
      +
      Get a list of all input topics.
      +
      +
      getInputTopics() - Method in interface org.apache.pulsar.functions.api.WindowContext
      +
      +
      Get a list of all input topics.
      +
      +
      getInstanceId() - Method in interface org.apache.pulsar.functions.api.BaseContext
      +
      +
      The id of the instance that invokes this component.
      +
      +
      getInstanceId() - Method in interface org.apache.pulsar.functions.api.WindowContext
      +
      +
      The id of the instance that invokes this function.
      +
      +
      getKey() - Method in interface org.apache.pulsar.functions.api.Record
      +
      +
      Return a key if the key has one associated.
      +
      +
      getKey() - Method in class org.apache.pulsar.functions.api.utils.FunctionRecord
      +
       
      +
      getKeySchema() - Method in interface org.apache.pulsar.functions.api.KVRecord
      +
       
      +
      getKeyValueEncodingType() - Method in interface org.apache.pulsar.functions.api.KVRecord
      +
       
      +
      getLogger() - Method in interface org.apache.pulsar.functions.api.BaseContext
      +
      +
      The logger object that can be used to log in a component.
      +
      +
      getLogger() - Method in interface org.apache.pulsar.functions.api.WindowContext
      +
      +
      The logger object that can be used to log in a function.
      +
      +
      getMessage() - Method in interface org.apache.pulsar.functions.api.Record
      +
       
      +
      getNamespace() - Method in interface org.apache.pulsar.functions.api.BaseContext
      +
      +
      The namespace this component belongs to.
      +
      +
      getNamespace() - Method in interface org.apache.pulsar.functions.api.WindowContext
      +
      +
      The namespace this function belongs to.
      +
      +
      getNumInstances() - Method in interface org.apache.pulsar.functions.api.BaseContext
      +
      +
      Get the number of instances that invoke this component.
      +
      +
      getNumInstances() - Method in interface org.apache.pulsar.functions.api.WindowContext
      +
      +
      Get the number of instances that invoke this function.
      +
      +
      getOutputSchemaType() - Method in interface org.apache.pulsar.functions.api.Context
      +
      +
      Get output schema builtin type or custom class name.
      +
      +
      getOutputSchemaType() - Method in interface org.apache.pulsar.functions.api.WindowContext
      +
      +
      Get output schema builtin type or custom class name.
      +
      +
      getOutputTopic() - Method in interface org.apache.pulsar.functions.api.Context
      +
      +
      Get the output topic of the source.
      +
      +
      getOutputTopic() - Method in interface org.apache.pulsar.functions.api.WindowContext
      +
      +
      Get the output topic of the function.
      +
      +
      getPartitionId() - Method in interface org.apache.pulsar.functions.api.Record
      +
      +
      Retrieves the partition information if any of the record.
      +
      +
      getPartitionId() - Method in class org.apache.pulsar.functions.api.utils.FunctionRecord
      +
       
      +
      getPartitionIndex() - Method in interface org.apache.pulsar.functions.api.Record
      +
      +
      Retrieves the partition index if any of the record.
      +
      +
      getPartitionIndex() - Method in class org.apache.pulsar.functions.api.utils.FunctionRecord
      +
       
      +
      getProperties() - Method in interface org.apache.pulsar.functions.api.Record
      +
      +
      Retrieves user-defined properties attached to record.
      +
      +
      getProperties() - Method in class org.apache.pulsar.functions.api.utils.FunctionRecord
      +
       
      +
      getPulsarAdmin() - Method in interface org.apache.pulsar.functions.api.Context
      +
      +
      Get the pulsar admin client.
      +
      +
      getPulsarClient() - Method in interface org.apache.pulsar.functions.api.BaseContext
      +
      +
      Get the pre-configured pulsar client.
      +
      +
      getPulsarClientBuilder() - Method in interface org.apache.pulsar.functions.api.BaseContext
      +
      +
      Get the pre-configured pulsar client builder.
      +
      +
      getRecordSequence() - Method in interface org.apache.pulsar.functions.api.Record
      +
      +
      Retrieves the sequence of the record from a source partition.
      +
      +
      getRecordSequence() - Method in class org.apache.pulsar.functions.api.utils.FunctionRecord
      +
       
      +
      getSchema() - Method in interface org.apache.pulsar.functions.api.Record
      +
       
      +
      getSchema() - Method in class org.apache.pulsar.functions.api.utils.FunctionRecord
      +
       
      +
      getSecret(String) - Method in interface org.apache.pulsar.functions.api.BaseContext
      +
      +
      Get the secret associated with this key.
      +
      +
      getState(String) - Method in interface org.apache.pulsar.functions.api.BaseContext
      +
      +
      Retrieve the state value for the key.
      +
      +
      getState(String) - Method in interface org.apache.pulsar.functions.api.WindowContext
      +
      +
      Retrieve the state value for the key.
      +
      +
      getStateAsync(String) - Method in interface org.apache.pulsar.functions.api.BaseContext
      +
      +
      Retrieve the state value for the key, but don't wait for the operation to be completed.
      +
      +
      getStateStore(String) - Method in interface org.apache.pulsar.functions.api.BaseContext
      +
      +
      Get the state store with the provided store name in the tenant invalid input: '&' namespace.
      +
      +
      getStateStore(String, String, String) - Method in interface org.apache.pulsar.functions.api.BaseContext
      +
      +
      Get the state store with the provided store name.
      +
      +
      getStateValue(String) - Method in interface org.apache.pulsar.functions.api.state.ByteBufferStateStore
      +
      +
      Retrieve the StateValue for the key.
      +
      +
      getStateValueAsync(String) - Method in interface org.apache.pulsar.functions.api.state.ByteBufferStateStore
      +
      +
      Retrieve the StateValue for the key, but don't wait for the operation to be completed.
      +
      +
      getTenant() - Method in interface org.apache.pulsar.functions.api.BaseContext
      +
      +
      The tenant this component belongs to.
      +
      +
      getTenant() - Method in interface org.apache.pulsar.functions.api.WindowContext
      +
      +
      The tenant this function belongs to.
      +
      +
      getTopicName() - Method in interface org.apache.pulsar.functions.api.Record
      +
      +
      If the record originated from a topic, report the topic name.
      +
      +
      getTopicName() - Method in class org.apache.pulsar.functions.api.utils.FunctionRecord
      +
       
      +
      getUserConfigMap() - Method in interface org.apache.pulsar.functions.api.Context
      +
      +
      Get a map of all user-defined key/value configs for the function.
      +
      +
      getUserConfigMap() - Method in interface org.apache.pulsar.functions.api.WindowContext
      +
      +
      Get a map of all user-defined key/value configs for the function.
      +
      +
      getUserConfigValue(String) - Method in interface org.apache.pulsar.functions.api.Context
      +
      +
      Get any user-defined key/value.
      +
      +
      getUserConfigValue(String) - Method in interface org.apache.pulsar.functions.api.WindowContext
      +
      +
      Get any user-defined key/value.
      +
      +
      getUserConfigValueOrDefault(String, Object) - Method in interface org.apache.pulsar.functions.api.Context
      +
      +
      Get any user-defined key/value or a default value if none is present.
      +
      +
      getUserConfigValueOrDefault(String, Object) - Method in interface org.apache.pulsar.functions.api.WindowContext
      +
      +
      Get any user-defined key/value or a default value if none is present.
      +
      +
      getValue() - Method in interface org.apache.pulsar.functions.api.Record
      +
      +
      Retrieves the actual data of the record.
      +
      +
      getValue() - Method in class org.apache.pulsar.functions.api.utils.FunctionRecord
      +
       
      +
      getValueSchema() - Method in interface org.apache.pulsar.functions.api.KVRecord
      +
       
      +
      +

      I

      +
      +
      IdentityFunction - Class in org.apache.pulsar.functions.api.utils
      +
       
      +
      IdentityFunction() - Constructor for class org.apache.pulsar.functions.api.utils.IdentityFunction
      +
       
      +
      incrCounter(String, long) - Method in interface org.apache.pulsar.functions.api.BaseContext
      +
      +
      Increment the builtin distributed counter referred by key.
      +
      +
      incrCounter(String, long) - Method in interface org.apache.pulsar.functions.api.state.CounterStateStore
      +
      +
      Increment the builtin distributed counter referred by key.
      +
      +
      incrCounter(String, long) - Method in interface org.apache.pulsar.functions.api.WindowContext
      +
      +
      Increment the builtin distributed counter referred by key.
      +
      +
      incrCounterAsync(String, long) - Method in interface org.apache.pulsar.functions.api.BaseContext
      +
      +
      Increment the builtin distributed counter referred by key + but dont wait for the completion of the increment operation.
      +
      +
      incrCounterAsync(String, long) - Method in interface org.apache.pulsar.functions.api.state.CounterStateStore
      +
      +
      Increment the builtin distributed counter referred by key + but dont wait for the completion of the increment operation.
      +
      +
      init(StateStoreContext) - Method in interface org.apache.pulsar.functions.api.StateStore
      +
      +
      Initialize the state store.
      +
      +
      initialize(Context) - Method in interface org.apache.pulsar.functions.api.Function
      +
      +
      Called once to initialize resources when function instance is started.
      +
      +
      +

      K

      +
      +
      KVRecord<K,V> - Interface in org.apache.pulsar.functions.api
      +
      +
      key value schema record.
      +
      +
      +

      N

      +
      +
      name() - Method in interface org.apache.pulsar.functions.api.StateStore
      +
      +
      The name of this store.
      +
      +
      namespace() - Method in interface org.apache.pulsar.functions.api.StateStore
      +
      +
      The namespace of this store.
      +
      +
      newConsumerBuilder(Schema<X>) - Method in interface org.apache.pulsar.functions.api.Context
      +
      +
      Create a ConsumerBuilder with the schema.
      +
      +
      newOutputMessage(String, Schema<X>) - Method in interface org.apache.pulsar.functions.api.Context
      +
      +
      New output message using schema for serializing to the topic.
      +
      +
      newOutputRecordBuilder(Schema<X>) - Method in interface org.apache.pulsar.functions.api.Context
      +
      +
      Creates a FunctionRecordBuilder initialized with values from this Context.
      +
      +
      +

      O

      +
      +
      org.apache.pulsar.functions.api - package org.apache.pulsar.functions.api
      +
      +
      Provides a simple model for enabling lightweight computation on Apache Pulsar.
      +
      +
      org.apache.pulsar.functions.api.state - package org.apache.pulsar.functions.api.state
      +
      +
      State Store API.
      +
      +
      org.apache.pulsar.functions.api.utils - package org.apache.pulsar.functions.api.utils
      +
      +
      State Store API.
      +
      +
      +

      P

      +
      +
      process(Collection<Record<X>>, WindowContext) - Method in interface org.apache.pulsar.functions.api.WindowFunction
      +
      +
      Process the input.
      +
      +
      process(X, Context) - Method in interface org.apache.pulsar.functions.api.Function
      +
      +
      Process the input.
      +
      +
      publish(String, T) - Method in interface org.apache.pulsar.functions.api.WindowContext
      +
      +
      Publish an object to the topic using default schemas.
      +
      +
      publish(String, T, String) - Method in interface org.apache.pulsar.functions.api.WindowContext
      +
      +
      Publish an object using serDe for serializing to the topic.
      +
      +
      publish(String, X) - Method in interface org.apache.pulsar.functions.api.Context
      +
      +
      Deprecated. +
      in favor of using Context.newOutputMessage(String, Schema)
      +
      +
      +
      publish(String, X, String) - Method in interface org.apache.pulsar.functions.api.Context
      +
      +
      Deprecated. +
      in favor of using Context.newOutputMessage(String, Schema)
      +
      +
      +
      put(String, ByteBuffer) - Method in interface org.apache.pulsar.functions.api.state.ByteBufferStateStore
      +
      +
      Update the state value for the key.
      +
      +
      putAsync(String, ByteBuffer) - Method in interface org.apache.pulsar.functions.api.state.ByteBufferStateStore
      +
      +
      Update the state value for the key, but don't wait for the operation to be completed.
      +
      +
      putState(String, ByteBuffer) - Method in interface org.apache.pulsar.functions.api.BaseContext
      +
      +
      Update the state value for the key.
      +
      +
      putState(String, ByteBuffer) - Method in interface org.apache.pulsar.functions.api.WindowContext
      +
      +
      Update the state value for the key.
      +
      +
      putStateAsync(String, ByteBuffer) - Method in interface org.apache.pulsar.functions.api.BaseContext
      +
      +
      Update the state value for the key, but don't wait for the operation to be completed.
      +
      +
      +

      R

      +
      +
      Record<T> - Interface in org.apache.pulsar.functions.api
      +
      +
      Pulsar IO's Record interface.
      +
      +
      recordMetric(String, double) - Method in interface org.apache.pulsar.functions.api.BaseContext
      +
      +
      Record a user defined metric.
      +
      +
      recordMetric(String, double) - Method in interface org.apache.pulsar.functions.api.WindowContext
      +
      +
      Record a user defined metric.
      +
      +
      +

      S

      +
      +
      SerDe<T> - Interface in org.apache.pulsar.functions.api
      +
      +
      An interface for serializer/deserializer.
      +
      +
      serialize(T) - Method in interface org.apache.pulsar.functions.api.SerDe
      +
       
      +
      StateStore - Interface in org.apache.pulsar.functions.api
      +
       
      +
      StateStoreContext - Interface in org.apache.pulsar.functions.api
      +
      +
      State Store Context Interface.
      +
      +
      StateValue - Class in org.apache.pulsar.functions.api.state
      +
       
      +
      StateValue() - Constructor for class org.apache.pulsar.functions.api.state.StateValue
      +
       
      +
      +

      T

      +
      +
      tenant() - Method in interface org.apache.pulsar.functions.api.StateStore
      +
      +
      The tenant of this store.
      +
      +
      +

      W

      +
      +
      WindowContext - Interface in org.apache.pulsar.functions.api
      +
       
      +
      WindowFunction<X,T> - Interface in org.apache.pulsar.functions.api
      +
      +
      This is the interface of the windowed function api.
      +
      +
      +A B C D F G I K N O P R S T W 
      All Classes and Interfaces|All Packages
      + +
      +
      + + diff --git a/static/api/pulsar-functions/4.0.x/index.html b/static/api/pulsar-functions/4.0.x/index.html new file mode 100644 index 000000000000..b00944b158e4 --- /dev/null +++ b/static/api/pulsar-functions/4.0.x/index.html @@ -0,0 +1,81 @@ + + + + +Overview (Pulsar Functions :: API 4.0.0 API) + + + + + + + + + + + + + +
      + +
      +
      +
      +

      Pulsar Functions :: API 4.0.0 API

      +
      +
      +
      Packages
      +
      +
      Package
      +
      Description
      +
      org.apache.pulsar.functions.api
      +
      +
      Provides a simple model for enabling lightweight computation on Apache Pulsar.
      +
      +
      org.apache.pulsar.functions.api.state
      +
      +
      State Store API.
      +
      +
      org.apache.pulsar.functions.api.utils
      +
      +
      State Store API.
      +
      +
      +
      +
      + +
      +
      + + diff --git a/static/api/pulsar-functions/4.0.x/legal/ADDITIONAL_LICENSE_INFO b/static/api/pulsar-functions/4.0.x/legal/ADDITIONAL_LICENSE_INFO new file mode 100644 index 000000000000..ff700cd09f6e --- /dev/null +++ b/static/api/pulsar-functions/4.0.x/legal/ADDITIONAL_LICENSE_INFO @@ -0,0 +1,37 @@ + ADDITIONAL INFORMATION ABOUT LICENSING + +Certain files distributed by Oracle America, Inc. and/or its affiliates are +subject to the following clarification and special exception to the GPLv2, +based on the GNU Project exception for its Classpath libraries, known as the +GNU Classpath Exception. + +Note that Oracle includes multiple, independent programs in this software +package. Some of those programs are provided under licenses deemed +incompatible with the GPLv2 by the Free Software Foundation and others. +For example, the package includes programs licensed under the Apache +License, Version 2.0 and may include FreeType. Such programs are licensed +to you under their original licenses. + +Oracle facilitates your further distribution of this package by adding the +Classpath Exception to the necessary parts of its GPLv2 code, which permits +you to use that code in combination with other independent modules not +licensed under the GPLv2. However, note that this would not permit you to +commingle code under an incompatible license with Oracle's GPLv2 licensed +code by, for example, cutting and pasting such code into a file also +containing Oracle's GPLv2 licensed code and then distributing the result. + +Additionally, if you were to remove the Classpath Exception from any of the +files to which it applies and distribute the result, you would likely be +required to license some or all of the other code in that distribution under +the GPLv2 as well, and since the GPLv2 is incompatible with the license terms +of some items included in the distribution by Oracle, removing the Classpath +Exception could therefore effectively compromise your ability to further +distribute the package. + +Failing to distribute notices associated with some files may also create +unexpected legal consequences. + +Proceed with caution and we recommend that you obtain the advice of a lawyer +skilled in open source matters before removing the Classpath Exception or +making modifications to this package which may subsequently be redistributed +and/or involve the use of third party software. diff --git a/static/api/pulsar-functions/4.0.x/legal/ASSEMBLY_EXCEPTION b/static/api/pulsar-functions/4.0.x/legal/ASSEMBLY_EXCEPTION new file mode 100644 index 000000000000..429666664e9f --- /dev/null +++ b/static/api/pulsar-functions/4.0.x/legal/ASSEMBLY_EXCEPTION @@ -0,0 +1,27 @@ + +OPENJDK ASSEMBLY EXCEPTION + +The OpenJDK source code made available by Oracle America, Inc. (Oracle) at +openjdk.org ("OpenJDK Code") is distributed under the terms of the GNU +General Public License version 2 +only ("GPL2"), with the following clarification and special exception. + + Linking this OpenJDK Code statically or dynamically with other code + is making a combined work based on this library. Thus, the terms + and conditions of GPL2 cover the whole combination. + + As a special exception, Oracle gives you permission to link this + OpenJDK Code with certain code licensed by Oracle as indicated at + https://openjdk.org/legal/exception-modules-2007-05-08.html + ("Designated Exception Modules") to produce an executable, + regardless of the license terms of the Designated Exception Modules, + and to copy and distribute the resulting executable under GPL2, + provided that the Designated Exception Modules continue to be + governed by the licenses under which they were offered by Oracle. + +As such, it allows licensees and sublicensees of Oracle's GPL2 OpenJDK Code +to build an executable that includes those portions of necessary code that +Oracle could not provide under GPL2 (or that Oracle has provided under GPL2 +with the Classpath exception). If you modify or add to the OpenJDK code, +that new GPL2 code may still be combined with Designated Exception Modules +if the new code is made subject to this exception by its copyright holder. diff --git a/static/api/pulsar-functions/4.0.x/legal/LICENSE b/static/api/pulsar-functions/4.0.x/legal/LICENSE new file mode 100644 index 000000000000..8b400c7ab81b --- /dev/null +++ b/static/api/pulsar-functions/4.0.x/legal/LICENSE @@ -0,0 +1,347 @@ +The GNU General Public License (GPL) + +Version 2, June 1991 + +Copyright (C) 1989, 1991 Free Software Foundation, Inc. +51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + +Everyone is permitted to copy and distribute verbatim copies of this license +document, but changing it is not allowed. + +Preamble + +The licenses for most software are designed to take away your freedom to share +and change it. By contrast, the GNU General Public License is intended to +guarantee your freedom to share and change free software--to make sure the +software is free for all its users. This General Public License applies to +most of the Free Software Foundation's software and to any other program whose +authors commit to using it. (Some other Free Software Foundation software is +covered by the GNU Library General Public License instead.) You can apply it to +your programs, too. + +When we speak of free software, we are referring to freedom, not price. Our +General Public Licenses are designed to make sure that you have the freedom to +distribute copies of free software (and charge for this service if you wish), +that you receive source code or can get it if you want it, that you can change +the software or use pieces of it in new free programs; and that you know you +can do these things. + +To protect your rights, we need to make restrictions that forbid anyone to deny +you these rights or to ask you to surrender the rights. These restrictions +translate to certain responsibilities for you if you distribute copies of the +software, or if you modify it. + +For example, if you distribute copies of such a program, whether gratis or for +a fee, you must give the recipients all the rights that you have. You must +make sure that they, too, receive or can get the source code. And you must +show them these terms so they know their rights. + +We protect your rights with two steps: (1) copyright the software, and (2) +offer you this license which gives you legal permission to copy, distribute +and/or modify the software. + +Also, for each author's protection and ours, we want to make certain that +everyone understands that there is no warranty for this free software. If the +software is modified by someone else and passed on, we want its recipients to +know that what they have is not the original, so that any problems introduced +by others will not reflect on the original authors' reputations. + +Finally, any free program is threatened constantly by software patents. We +wish to avoid the danger that redistributors of a free program will +individually obtain patent licenses, in effect making the program proprietary. +To prevent this, we have made it clear that any patent must be licensed for +everyone's free use or not licensed at all. + +The precise terms and conditions for copying, distribution and modification +follow. + +TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + +0. This License applies to any program or other work which contains a notice +placed by the copyright holder saying it may be distributed under the terms of +this General Public License. The "Program", below, refers to any such program +or work, and a "work based on the Program" means either the Program or any +derivative work under copyright law: that is to say, a work containing the +Program or a portion of it, either verbatim or with modifications and/or +translated into another language. (Hereinafter, translation is included +without limitation in the term "modification".) Each licensee is addressed as +"you". + +Activities other than copying, distribution and modification are not covered by +this License; they are outside its scope. The act of running the Program is +not restricted, and the output from the Program is covered only if its contents +constitute a work based on the Program (independent of having been made by +running the Program). Whether that is true depends on what the Program does. + +1. You may copy and distribute verbatim copies of the Program's source code as +you receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice and +disclaimer of warranty; keep intact all the notices that refer to this License +and to the absence of any warranty; and give any other recipients of the +Program a copy of this License along with the Program. + +You may charge a fee for the physical act of transferring a copy, and you may +at your option offer warranty protection in exchange for a fee. + +2. You may modify your copy or copies of the Program or any portion of it, thus +forming a work based on the Program, and copy and distribute such modifications +or work under the terms of Section 1 above, provided that you also meet all of +these conditions: + + a) You must cause the modified files to carry prominent notices stating + that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in whole or + in part contains or is derived from the Program or any part thereof, to be + licensed as a whole at no charge to all third parties under the terms of + this License. + + c) If the modified program normally reads commands interactively when run, + you must cause it, when started running for such interactive use in the + most ordinary way, to print or display an announcement including an + appropriate copyright notice and a notice that there is no warranty (or + else, saying that you provide a warranty) and that users may redistribute + the program under these conditions, and telling the user how to view a copy + of this License. (Exception: if the Program itself is interactive but does + not normally print such an announcement, your work based on the Program is + not required to print an announcement.) + +These requirements apply to the modified work as a whole. If identifiable +sections of that work are not derived from the Program, and can be reasonably +considered independent and separate works in themselves, then this License, and +its terms, do not apply to those sections when you distribute them as separate +works. But when you distribute the same sections as part of a whole which is a +work based on the Program, the distribution of the whole must be on the terms +of this License, whose permissions for other licensees extend to the entire +whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest your +rights to work written entirely by you; rather, the intent is to exercise the +right to control the distribution of derivative or collective works based on +the Program. + +In addition, mere aggregation of another work not based on the Program with the +Program (or with a work based on the Program) on a volume of a storage or +distribution medium does not bring the other work under the scope of this +License. + +3. You may copy and distribute the Program (or a work based on it, under +Section 2) in object code or executable form under the terms of Sections 1 and +2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable source + code, which must be distributed under the terms of Sections 1 and 2 above + on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three years, to + give any third party, for a charge no more than your cost of physically + performing source distribution, a complete machine-readable copy of the + corresponding source code, to be distributed under the terms of Sections 1 + and 2 above on a medium customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer to + distribute corresponding source code. (This alternative is allowed only + for noncommercial distribution and only if you received the program in + object code or executable form with such an offer, in accord with + Subsection b above.) + +The source code for a work means the preferred form of the work for making +modifications to it. For an executable work, complete source code means all +the source code for all modules it contains, plus any associated interface +definition files, plus the scripts used to control compilation and installation +of the executable. However, as a special exception, the source code +distributed need not include anything that is normally distributed (in either +source or binary form) with the major components (compiler, kernel, and so on) +of the operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering access to copy +from a designated place, then offering equivalent access to copy the source +code from the same place counts as distribution of the source code, even though +third parties are not compelled to copy the source along with the object code. + +4. You may not copy, modify, sublicense, or distribute the Program except as +expressly provided under this License. Any attempt otherwise to copy, modify, +sublicense or distribute the Program is void, and will automatically terminate +your rights under this License. However, parties who have received copies, or +rights, from you under this License will not have their licenses terminated so +long as such parties remain in full compliance. + +5. You are not required to accept this License, since you have not signed it. +However, nothing else grants you permission to modify or distribute the Program +or its derivative works. These actions are prohibited by law if you do not +accept this License. Therefore, by modifying or distributing the Program (or +any work based on the Program), you indicate your acceptance of this License to +do so, and all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + +6. Each time you redistribute the Program (or any work based on the Program), +the recipient automatically receives a license from the original licensor to +copy, distribute or modify the Program subject to these terms and conditions. +You may not impose any further restrictions on the recipients' exercise of the +rights granted herein. You are not responsible for enforcing compliance by +third parties to this License. + +7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), conditions +are imposed on you (whether by court order, agreement or otherwise) that +contradict the conditions of this License, they do not excuse you from the +conditions of this License. If you cannot distribute so as to satisfy +simultaneously your obligations under this License and any other pertinent +obligations, then as a consequence you may not distribute the Program at all. +For example, if a patent license would not permit royalty-free redistribution +of the Program by all those who receive copies directly or indirectly through +you, then the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under any +particular circumstance, the balance of the section is intended to apply and +the section as a whole is intended to apply in other circumstances. + +It is not the purpose of this section to induce you to infringe any patents or +other property right claims or to contest validity of any such claims; this +section has the sole purpose of protecting the integrity of the free software +distribution system, which is implemented by public license practices. Many +people have made generous contributions to the wide range of software +distributed through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing to +distribute software through any other system and a licensee cannot impose that +choice. + +This section is intended to make thoroughly clear what is believed to be a +consequence of the rest of this License. + +8. If the distribution and/or use of the Program is restricted in certain +countries either by patents or by copyrighted interfaces, the original +copyright holder who places the Program under this License may add an explicit +geographical distribution limitation excluding those countries, so that +distribution is permitted only in or among countries not thus excluded. In +such case, this License incorporates the limitation as if written in the body +of this License. + +9. The Free Software Foundation may publish revised and/or new versions of the +General Public License from time to time. Such new versions will be similar in +spirit to the present version, but may differ in detail to address new problems +or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any later +version", you have the option of following the terms and conditions either of +that version or of any later version published by the Free Software Foundation. +If the Program does not specify a version number of this License, you may +choose any version ever published by the Free Software Foundation. + +10. If you wish to incorporate parts of the Program into other free programs +whose distribution conditions are different, write to the author to ask for +permission. For software which is copyrighted by the Free Software Foundation, +write to the Free Software Foundation; we sometimes make exceptions for this. +Our decision will be guided by the two goals of preserving the free status of +all derivatives of our free software and of promoting the sharing and reuse of +software generally. + +NO WARRANTY + +11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR +THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE +STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE +PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, +INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND +FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND +PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, +YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + +12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL +ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE +PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR +INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA +BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A +FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER +OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. + +END OF TERMS AND CONDITIONS + +How to Apply These Terms to Your New Programs + +If you develop a new program, and you want it to be of the greatest possible +use to the public, the best way to achieve this is to make it free software +which everyone can redistribute and change under these terms. + +To do so, attach the following notices to the program. It is safest to attach +them to the start of each source file to most effectively convey the exclusion +of warranty; and each file should have at least the "copyright" line and a +pointer to where the full notice is found. + + One line to give the program's name and a brief idea of what it does. + + Copyright (C) + + This program is free software; you can redistribute it and/or modify it + under the terms of the GNU General Public License as published by the Free + Software Foundation; either version 2 of the License, or (at your option) + any later version. + + This program is distributed in the hope that it will be useful, but WITHOUT + ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for + more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this when it +starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author Gnomovision comes + with ABSOLUTELY NO WARRANTY; for details type 'show w'. This is free + software, and you are welcome to redistribute it under certain conditions; + type 'show c' for details. + +The hypothetical commands 'show w' and 'show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may be +called something other than 'show w' and 'show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your school, +if any, to sign a "copyright disclaimer" for the program, if necessary. Here +is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + 'Gnomovision' (which makes passes at compilers) written by James Hacker. + + signature of Ty Coon, 1 April 1989 + + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Library General Public +License instead of this License. + + +"CLASSPATH" EXCEPTION TO THE GPL + +Certain source files distributed by Oracle America and/or its affiliates are +subject to the following clarification and special exception to the GPL, but +only where Oracle has expressly included in the particular source file's header +the words "Oracle designates this particular file as subject to the "Classpath" +exception as provided by Oracle in the LICENSE file that accompanied this code." + + Linking this library statically or dynamically with other modules is making + a combined work based on this library. Thus, the terms and conditions of + the GNU General Public License cover the whole combination. + + As a special exception, the copyright holders of this library give you + permission to link this library with independent modules to produce an + executable, regardless of the license terms of these independent modules, + and to copy and distribute the resulting executable under terms of your + choice, provided that you also meet, for each linked independent module, + the terms and conditions of the license of that module. An independent + module is a module which is not derived from or based on this library. If + you modify this library, you may extend this exception to your version of + the library, but you are not obligated to do so. If you do not wish to do + so, delete this exception statement from your version. diff --git a/static/api/pulsar-functions/4.0.x/legal/jquery.md b/static/api/pulsar-functions/4.0.x/legal/jquery.md new file mode 100644 index 000000000000..d468b3183a70 --- /dev/null +++ b/static/api/pulsar-functions/4.0.x/legal/jquery.md @@ -0,0 +1,72 @@ +## jQuery v3.6.1 + +### jQuery License +``` +jQuery v 3.6.1 +Copyright OpenJS Foundation and other contributors, https://openjsf.org/ + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +****************************************** + +The jQuery JavaScript Library v3.6.1 also includes Sizzle.js + +Sizzle.js includes the following license: + +Copyright JS Foundation and other contributors, https://js.foundation/ + +This software consists of voluntary contributions made by many +individuals. For exact contribution history, see the revision history +available at https://github.com/jquery/sizzle + +The following license applies to all parts of this software except as +documented below: + +==== + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +==== + +All files located in the node_modules and external directories are +externally maintained libraries used by this software which have their +own licenses; we recommend you read them, as their terms may differ from +the terms above. + +********************* + +``` diff --git a/static/api/pulsar-functions/4.0.x/legal/jqueryUI.md b/static/api/pulsar-functions/4.0.x/legal/jqueryUI.md new file mode 100644 index 000000000000..8bda9d7a85e8 --- /dev/null +++ b/static/api/pulsar-functions/4.0.x/legal/jqueryUI.md @@ -0,0 +1,49 @@ +## jQuery UI v1.13.2 + +### jQuery UI License +``` +Copyright jQuery Foundation and other contributors, https://jquery.org/ + +This software consists of voluntary contributions made by many +individuals. For exact contribution history, see the revision history +available at https://github.com/jquery/jquery-ui + +The following license applies to all parts of this software except as +documented below: + +==== + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +==== + +Copyright and related rights for sample code are waived via CC0. Sample +code is defined as all source code contained within the demos directory. + +CC0: http://creativecommons.org/publicdomain/zero/1.0/ + +==== + +All files located in the node_modules and external directories are +externally maintained libraries used by this software which have their +own licenses; we recommend you read them, as their terms may differ from +the terms above. + +``` diff --git a/static/api/pulsar-functions/4.0.x/link.svg b/static/api/pulsar-functions/4.0.x/link.svg new file mode 100644 index 000000000000..7ccc5ed08cbf --- /dev/null +++ b/static/api/pulsar-functions/4.0.x/link.svg @@ -0,0 +1,31 @@ + + + + + + + + diff --git a/static/api/pulsar-functions/4.0.x/member-search-index.js b/static/api/pulsar-functions/4.0.x/member-search-index.js new file mode 100644 index 000000000000..532cb590a8c5 --- /dev/null +++ b/static/api/pulsar-functions/4.0.x/member-search-index.js @@ -0,0 +1 @@ +memberSearchIndex = [{"p":"org.apache.pulsar.functions.api","c":"Record","l":"ack()"},{"p":"org.apache.pulsar.functions.api.utils","c":"IdentityFunction","l":"apply(Object)","u":"apply(java.lang.Object)"},{"p":"org.apache.pulsar.functions.api","c":"Function","l":"close()"},{"p":"org.apache.pulsar.functions.api","c":"StateStore","l":"close()"},{"p":"org.apache.pulsar.functions.api.state","c":"ByteBufferStateStore","l":"delete(String)","u":"delete(java.lang.String)"},{"p":"org.apache.pulsar.functions.api.state","c":"ByteBufferStateStore","l":"deleteAsync(String)","u":"deleteAsync(java.lang.String)"},{"p":"org.apache.pulsar.functions.api","c":"BaseContext","l":"deleteState(String)","u":"deleteState(java.lang.String)"},{"p":"org.apache.pulsar.functions.api","c":"BaseContext","l":"deleteStateAsync(String)","u":"deleteStateAsync(java.lang.String)"},{"p":"org.apache.pulsar.functions.api","c":"SerDe","l":"deserialize(byte[])"},{"p":"org.apache.pulsar.functions.api","c":"Record","l":"fail()"},{"p":"org.apache.pulsar.functions.api","c":"BaseContext","l":"fatal(Throwable)","u":"fatal(java.lang.Throwable)"},{"p":"org.apache.pulsar.functions.api","c":"StateStore","l":"fqsn()"},{"p":"org.apache.pulsar.functions.api.utils","c":"FunctionRecord","l":"from(Context, Schema)","u":"from(org.apache.pulsar.functions.api.Context,org.apache.pulsar.client.api.Schema)"},{"p":"org.apache.pulsar.functions.api.utils","c":"FunctionRecord","l":"FunctionRecord()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.functions.api.state","c":"ByteBufferStateStore","l":"get(String)","u":"get(java.lang.String)"},{"p":"org.apache.pulsar.functions.api.state","c":"ByteBufferStateStore","l":"getAsync(String)","u":"getAsync(java.lang.String)"},{"p":"org.apache.pulsar.functions.api","c":"BaseContext","l":"getCounter(String)","u":"getCounter(java.lang.String)"},{"p":"org.apache.pulsar.functions.api.state","c":"CounterStateStore","l":"getCounter(String)","u":"getCounter(java.lang.String)"},{"p":"org.apache.pulsar.functions.api","c":"WindowContext","l":"getCounter(String)","u":"getCounter(java.lang.String)"},{"p":"org.apache.pulsar.functions.api","c":"BaseContext","l":"getCounterAsync(String)","u":"getCounterAsync(java.lang.String)"},{"p":"org.apache.pulsar.functions.api.state","c":"CounterStateStore","l":"getCounterAsync(String)","u":"getCounterAsync(java.lang.String)"},{"p":"org.apache.pulsar.functions.api","c":"Context","l":"getCurrentRecord()"},{"p":"org.apache.pulsar.functions.api","c":"Record","l":"getDestinationTopic()"},{"p":"org.apache.pulsar.functions.api.utils","c":"FunctionRecord","l":"getDestinationTopic()"},{"p":"org.apache.pulsar.functions.api","c":"Record","l":"getEventTime()"},{"p":"org.apache.pulsar.functions.api.utils","c":"FunctionRecord","l":"getEventTime()"},{"p":"org.apache.pulsar.functions.api","c":"Context","l":"getFunctionId()"},{"p":"org.apache.pulsar.functions.api","c":"WindowContext","l":"getFunctionId()"},{"p":"org.apache.pulsar.functions.api","c":"Context","l":"getFunctionName()"},{"p":"org.apache.pulsar.functions.api","c":"WindowContext","l":"getFunctionName()"},{"p":"org.apache.pulsar.functions.api","c":"Context","l":"getFunctionVersion()"},{"p":"org.apache.pulsar.functions.api","c":"WindowContext","l":"getFunctionVersion()"},{"p":"org.apache.pulsar.functions.api","c":"Context","l":"getInputTopics()"},{"p":"org.apache.pulsar.functions.api","c":"WindowContext","l":"getInputTopics()"},{"p":"org.apache.pulsar.functions.api","c":"BaseContext","l":"getInstanceId()"},{"p":"org.apache.pulsar.functions.api","c":"WindowContext","l":"getInstanceId()"},{"p":"org.apache.pulsar.functions.api","c":"Record","l":"getKey()"},{"p":"org.apache.pulsar.functions.api.utils","c":"FunctionRecord","l":"getKey()"},{"p":"org.apache.pulsar.functions.api","c":"KVRecord","l":"getKeySchema()"},{"p":"org.apache.pulsar.functions.api","c":"KVRecord","l":"getKeyValueEncodingType()"},{"p":"org.apache.pulsar.functions.api","c":"BaseContext","l":"getLogger()"},{"p":"org.apache.pulsar.functions.api","c":"WindowContext","l":"getLogger()"},{"p":"org.apache.pulsar.functions.api","c":"Record","l":"getMessage()"},{"p":"org.apache.pulsar.functions.api","c":"BaseContext","l":"getNamespace()"},{"p":"org.apache.pulsar.functions.api","c":"WindowContext","l":"getNamespace()"},{"p":"org.apache.pulsar.functions.api","c":"BaseContext","l":"getNumInstances()"},{"p":"org.apache.pulsar.functions.api","c":"WindowContext","l":"getNumInstances()"},{"p":"org.apache.pulsar.functions.api","c":"Context","l":"getOutputSchemaType()"},{"p":"org.apache.pulsar.functions.api","c":"WindowContext","l":"getOutputSchemaType()"},{"p":"org.apache.pulsar.functions.api","c":"Context","l":"getOutputTopic()"},{"p":"org.apache.pulsar.functions.api","c":"WindowContext","l":"getOutputTopic()"},{"p":"org.apache.pulsar.functions.api","c":"Record","l":"getPartitionId()"},{"p":"org.apache.pulsar.functions.api.utils","c":"FunctionRecord","l":"getPartitionId()"},{"p":"org.apache.pulsar.functions.api","c":"Record","l":"getPartitionIndex()"},{"p":"org.apache.pulsar.functions.api.utils","c":"FunctionRecord","l":"getPartitionIndex()"},{"p":"org.apache.pulsar.functions.api","c":"Record","l":"getProperties()"},{"p":"org.apache.pulsar.functions.api.utils","c":"FunctionRecord","l":"getProperties()"},{"p":"org.apache.pulsar.functions.api","c":"Context","l":"getPulsarAdmin()"},{"p":"org.apache.pulsar.functions.api","c":"BaseContext","l":"getPulsarClient()"},{"p":"org.apache.pulsar.functions.api","c":"BaseContext","l":"getPulsarClientBuilder()"},{"p":"org.apache.pulsar.functions.api","c":"Record","l":"getRecordSequence()"},{"p":"org.apache.pulsar.functions.api.utils","c":"FunctionRecord","l":"getRecordSequence()"},{"p":"org.apache.pulsar.functions.api","c":"Record","l":"getSchema()"},{"p":"org.apache.pulsar.functions.api.utils","c":"FunctionRecord","l":"getSchema()"},{"p":"org.apache.pulsar.functions.api","c":"BaseContext","l":"getSecret(String)","u":"getSecret(java.lang.String)"},{"p":"org.apache.pulsar.functions.api","c":"BaseContext","l":"getState(String)","u":"getState(java.lang.String)"},{"p":"org.apache.pulsar.functions.api","c":"WindowContext","l":"getState(String)","u":"getState(java.lang.String)"},{"p":"org.apache.pulsar.functions.api","c":"BaseContext","l":"getStateAsync(String)","u":"getStateAsync(java.lang.String)"},{"p":"org.apache.pulsar.functions.api","c":"BaseContext","l":"getStateStore(String)","u":"getStateStore(java.lang.String)"},{"p":"org.apache.pulsar.functions.api","c":"BaseContext","l":"getStateStore(String, String, String)","u":"getStateStore(java.lang.String,java.lang.String,java.lang.String)"},{"p":"org.apache.pulsar.functions.api.state","c":"ByteBufferStateStore","l":"getStateValue(String)","u":"getStateValue(java.lang.String)"},{"p":"org.apache.pulsar.functions.api.state","c":"ByteBufferStateStore","l":"getStateValueAsync(String)","u":"getStateValueAsync(java.lang.String)"},{"p":"org.apache.pulsar.functions.api","c":"BaseContext","l":"getTenant()"},{"p":"org.apache.pulsar.functions.api","c":"WindowContext","l":"getTenant()"},{"p":"org.apache.pulsar.functions.api","c":"Record","l":"getTopicName()"},{"p":"org.apache.pulsar.functions.api.utils","c":"FunctionRecord","l":"getTopicName()"},{"p":"org.apache.pulsar.functions.api","c":"Context","l":"getUserConfigMap()"},{"p":"org.apache.pulsar.functions.api","c":"WindowContext","l":"getUserConfigMap()"},{"p":"org.apache.pulsar.functions.api","c":"Context","l":"getUserConfigValue(String)","u":"getUserConfigValue(java.lang.String)"},{"p":"org.apache.pulsar.functions.api","c":"WindowContext","l":"getUserConfigValue(String)","u":"getUserConfigValue(java.lang.String)"},{"p":"org.apache.pulsar.functions.api","c":"Context","l":"getUserConfigValueOrDefault(String, Object)","u":"getUserConfigValueOrDefault(java.lang.String,java.lang.Object)"},{"p":"org.apache.pulsar.functions.api","c":"WindowContext","l":"getUserConfigValueOrDefault(String, Object)","u":"getUserConfigValueOrDefault(java.lang.String,java.lang.Object)"},{"p":"org.apache.pulsar.functions.api","c":"Record","l":"getValue()"},{"p":"org.apache.pulsar.functions.api.utils","c":"FunctionRecord","l":"getValue()"},{"p":"org.apache.pulsar.functions.api","c":"KVRecord","l":"getValueSchema()"},{"p":"org.apache.pulsar.functions.api.utils","c":"IdentityFunction","l":"IdentityFunction()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.functions.api","c":"BaseContext","l":"incrCounter(String, long)","u":"incrCounter(java.lang.String,long)"},{"p":"org.apache.pulsar.functions.api.state","c":"CounterStateStore","l":"incrCounter(String, long)","u":"incrCounter(java.lang.String,long)"},{"p":"org.apache.pulsar.functions.api","c":"WindowContext","l":"incrCounter(String, long)","u":"incrCounter(java.lang.String,long)"},{"p":"org.apache.pulsar.functions.api","c":"BaseContext","l":"incrCounterAsync(String, long)","u":"incrCounterAsync(java.lang.String,long)"},{"p":"org.apache.pulsar.functions.api.state","c":"CounterStateStore","l":"incrCounterAsync(String, long)","u":"incrCounterAsync(java.lang.String,long)"},{"p":"org.apache.pulsar.functions.api","c":"StateStore","l":"init(StateStoreContext)","u":"init(org.apache.pulsar.functions.api.StateStoreContext)"},{"p":"org.apache.pulsar.functions.api","c":"Function","l":"initialize(Context)","u":"initialize(org.apache.pulsar.functions.api.Context)"},{"p":"org.apache.pulsar.functions.api","c":"StateStore","l":"name()"},{"p":"org.apache.pulsar.functions.api","c":"StateStore","l":"namespace()"},{"p":"org.apache.pulsar.functions.api","c":"Context","l":"newConsumerBuilder(Schema)","u":"newConsumerBuilder(org.apache.pulsar.client.api.Schema)"},{"p":"org.apache.pulsar.functions.api","c":"Context","l":"newOutputMessage(String, Schema)","u":"newOutputMessage(java.lang.String,org.apache.pulsar.client.api.Schema)"},{"p":"org.apache.pulsar.functions.api","c":"Context","l":"newOutputRecordBuilder(Schema)","u":"newOutputRecordBuilder(org.apache.pulsar.client.api.Schema)"},{"p":"org.apache.pulsar.functions.api","c":"WindowFunction","l":"process(Collection>, WindowContext)","u":"process(java.util.Collection,org.apache.pulsar.functions.api.WindowContext)"},{"p":"org.apache.pulsar.functions.api","c":"Function","l":"process(X, Context)","u":"process(X,org.apache.pulsar.functions.api.Context)"},{"p":"org.apache.pulsar.functions.api","c":"WindowContext","l":"publish(String, T)","u":"publish(java.lang.String,T)"},{"p":"org.apache.pulsar.functions.api","c":"WindowContext","l":"publish(String, T, String)","u":"publish(java.lang.String,T,java.lang.String)"},{"p":"org.apache.pulsar.functions.api","c":"Context","l":"publish(String, X)","u":"publish(java.lang.String,X)"},{"p":"org.apache.pulsar.functions.api","c":"Context","l":"publish(String, X, String)","u":"publish(java.lang.String,X,java.lang.String)"},{"p":"org.apache.pulsar.functions.api.state","c":"ByteBufferStateStore","l":"put(String, ByteBuffer)","u":"put(java.lang.String,java.nio.ByteBuffer)"},{"p":"org.apache.pulsar.functions.api.state","c":"ByteBufferStateStore","l":"putAsync(String, ByteBuffer)","u":"putAsync(java.lang.String,java.nio.ByteBuffer)"},{"p":"org.apache.pulsar.functions.api","c":"BaseContext","l":"putState(String, ByteBuffer)","u":"putState(java.lang.String,java.nio.ByteBuffer)"},{"p":"org.apache.pulsar.functions.api","c":"WindowContext","l":"putState(String, ByteBuffer)","u":"putState(java.lang.String,java.nio.ByteBuffer)"},{"p":"org.apache.pulsar.functions.api","c":"BaseContext","l":"putStateAsync(String, ByteBuffer)","u":"putStateAsync(java.lang.String,java.nio.ByteBuffer)"},{"p":"org.apache.pulsar.functions.api","c":"BaseContext","l":"recordMetric(String, double)","u":"recordMetric(java.lang.String,double)"},{"p":"org.apache.pulsar.functions.api","c":"WindowContext","l":"recordMetric(String, double)","u":"recordMetric(java.lang.String,double)"},{"p":"org.apache.pulsar.functions.api","c":"SerDe","l":"serialize(T)"},{"p":"org.apache.pulsar.functions.api.state","c":"StateValue","l":"StateValue()","u":"%3Cinit%3E()"},{"p":"org.apache.pulsar.functions.api","c":"StateStore","l":"tenant()"}];updateSearchResults(); \ No newline at end of file diff --git a/static/api/pulsar-functions/4.0.x/module-search-index.js b/static/api/pulsar-functions/4.0.x/module-search-index.js new file mode 100644 index 000000000000..0d59754fc4ad --- /dev/null +++ b/static/api/pulsar-functions/4.0.x/module-search-index.js @@ -0,0 +1 @@ +moduleSearchIndex = [];updateSearchResults(); \ No newline at end of file diff --git a/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/BaseContext.html b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/BaseContext.html new file mode 100644 index 000000000000..62be17a0fea0 --- /dev/null +++ b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/BaseContext.html @@ -0,0 +1,549 @@ + + + + +BaseContext (Pulsar Functions :: API 4.0.0 API) + + + + + + + + + + + + + +
      + +
      +
      + +
      +
      Package org.apache.pulsar.functions.api
      +

      Interface BaseContext

      +
      +
      +
      +
      All Known Subinterfaces:
      +
      Context
      +
      +
      +
      @Public +@Stable +public interface BaseContext
      +
      BaseContext provides base contextual information to the executing function/source/sink. + It allows to propagate information, such as pulsar environment, logs, metrics, states etc.
      +
      +
      + +
      +
      +
        + +
      • +
        +

        Method Details

        +
          +
        • +
          +

          getTenant

          +
          String getTenant()
          +
          The tenant this component belongs to.
          +
          +
          Returns:
          +
          the tenant this component belongs to
          +
          +
          +
          • +
        • +
          +

          getNamespace

          +
          String getNamespace()
          +
          The namespace this component belongs to.
          +
          +
          Returns:
          +
          the namespace this component belongs to
          +
          +
          +
          • +
        • +
          +

          getInstanceId

          +
          int getInstanceId()
          +
          The id of the instance that invokes this component.
          +
          +
          Returns:
          +
          the instance id
          +
          +
          +
          • +
        • +
          +

          getNumInstances

          +
          int getNumInstances()
          +
          Get the number of instances that invoke this component.
          +
          +
          Returns:
          +
          the number of instances that invoke this component.
          +
          +
          +
          • +
        • +
          +

          getLogger

          +
          org.slf4j.Logger getLogger()
          +
          The logger object that can be used to log in a component.
          +
          +
          Returns:
          +
          the logger object
          +
          +
          +
          • +
        • +
          +

          getSecret

          +
          String getSecret(String secretName)
          +
          Get the secret associated with this key.
          +
          +
          Parameters:
          +
          secretName - The name of the secret
          +
          Returns:
          +
          The secret if anything was found or null
          +
          +
          +
          • +
        • +
          +

          getStateStore

          +
          default <X extends StateStore> X getStateStore(String name)
          +
          Get the state store with the provided store name in the tenant invalid input: '&' namespace.
          +
          +
          Type Parameters:
          +
          X - the type of interface of the store to return
          +
          Parameters:
          +
          name - the state store name
          +
          Returns:
          +
          the state store instance.
          +
          Throws:
          +
          ClassCastException - if the return type isn't a type + or interface of the actual returned store.
          +
          +
          +
          • +
        • +
          +

          getStateStore

          +
          default <X extends StateStore> X getStateStore(String tenant, + String ns, + String name)
          +
          Get the state store with the provided store name.
          +
          +
          Type Parameters:
          +
          X - the type of interface of the store to return
          +
          Parameters:
          +
          tenant - the state tenant name
          +
          ns - the state namespace name
          +
          name - the state store name
          +
          Returns:
          +
          the state store instance.
          +
          Throws:
          +
          ClassCastException - if the return type isn't a type + or interface of the actual returned store.
          +
          +
          +
          • +
        • +
          +

          putState

          +
          void putState(String key, + ByteBuffer value)
          +
          Update the state value for the key.
          +
          +
          Parameters:
          +
          key - name of the key
          +
          value - state value of the key
          +
          +
          +
          • +
        • +
          +

          putStateAsync

          +
          CompletableFuture<Void> putStateAsync(String key, + ByteBuffer value)
          +
          Update the state value for the key, but don't wait for the operation to be completed.
          +
          +
          Parameters:
          +
          key - name of the key
          +
          value - state value of the key
          +
          +
          +
          • +
        • +
          +

          getState

          +
          ByteBuffer getState(String key)
          +
          Retrieve the state value for the key.
          +
          +
          Parameters:
          +
          key - name of the key
          +
          Returns:
          +
          the state value for the key.
          +
          +
          +
          • +
        • +
          +

          getStateAsync

          +
          CompletableFuture<ByteBuffer> getStateAsync(String key)
          +
          Retrieve the state value for the key, but don't wait for the operation to be completed.
          +
          +
          Parameters:
          +
          key - name of the key
          +
          Returns:
          +
          the state value for the key.
          +
          +
          +
          • +
        • +
          +

          deleteState

          +
          void deleteState(String key)
          +
          Delete the state value for the key.
          +
          +
          Parameters:
          +
          key - name of the key
          +
          +
          +
          • +
        • +
          +

          deleteStateAsync

          +
          CompletableFuture<Void> deleteStateAsync(String key)
          +
          Delete the state value for the key, but don't wait for the operation to be completed.
          +
          +
          Parameters:
          +
          key - name of the key
          +
          +
          +
          • +
        • +
          +

          incrCounter

          +
          void incrCounter(String key, + long amount)
          +
          Increment the builtin distributed counter referred by key.
          +
          +
          Parameters:
          +
          key - The name of the key
          +
          amount - The amount to be incremented
          +
          +
          +
          • +
        • +
          +

          incrCounterAsync

          +
          CompletableFuture<Void> incrCounterAsync(String key, + long amount)
          +
          Increment the builtin distributed counter referred by key + but dont wait for the completion of the increment operation.
          +
          +
          Parameters:
          +
          key - The name of the key
          +
          amount - The amount to be incremented
          +
          +
          +
          • +
        • +
          +

          getCounter

          +
          long getCounter(String key)
          +
          Retrieve the counter value for the key.
          +
          +
          Parameters:
          +
          key - name of the key
          +
          Returns:
          +
          the amount of the counter value for this key
          +
          +
          +
          • +
        • +
          +

          getCounterAsync

          +
          CompletableFuture<Long> getCounterAsync(String key)
          +
          Retrieve the counter value for the key, but don't wait + for the operation to be completed.
          +
          +
          Parameters:
          +
          key - name of the key
          +
          Returns:
          +
          the amount of the counter value for this key
          +
          +
          +
          • +
        • +
          +

          recordMetric

          +
          void recordMetric(String metricName, + double value)
          +
          Record a user defined metric.
          +
          +
          Parameters:
          +
          metricName - The name of the metric
          +
          value - The value of the metric
          +
          +
          +
          • +
        • +
          +

          getPulsarClient

          +
          default org.apache.pulsar.client.api.PulsarClient getPulsarClient()
          +
          Get the pre-configured pulsar client. + + You can use this client to access Pulsar cluster. + The Function will be responsible for disposing this client.
          +
          +
          Returns:
          +
          the instance of pulsar client
          +
          +
          +
          • +
        • +
          +

          getPulsarClientBuilder

          +
          default org.apache.pulsar.client.api.ClientBuilder getPulsarClientBuilder()
          +
          Get the pre-configured pulsar client builder. + + You can use this Builder to setup client to connect to the Pulsar cluster. + But you need to close client properly after using it.
          +
          +
          Returns:
          +
          the instance of pulsar client builder.
          +
          +
          +
          • +
        • +
          +

          fatal

          +
          void fatal(Throwable t)
          +
          Terminate the function instance with a fatal exception.
          +
          +
          Parameters:
          +
          t - the fatal exception to be raised
          +
          +
          +
          • +
        +
        +
        • +
      +
      + +
      + +
      +
      + + diff --git a/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/Context.html b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/Context.html new file mode 100644 index 000000000000..2805bd9e9131 --- /dev/null +++ b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/Context.html @@ -0,0 +1,461 @@ + + + + +Context (Pulsar Functions :: API 4.0.0 API) + + + + + + + + + + + + + +
      + +
      +
      + +
      +
      Package org.apache.pulsar.functions.api
      +

      Interface Context

      +
      +
      +
      +
      All Superinterfaces:
      +
      BaseContext
      +
      +
      +
      @Public +@Stable +public interface Context +extends BaseContext
      +
      Context provides contextual information to the executing function. + Features like which message id we are handling, whats the topic name of the + message, what are our operating constraints, etc can be accessed by the + executing function
      +
      +
      + +
      +
      +
        + +
      • +
        +

        Method Details

        +
          +
        • +
          +

          getInputTopics

          +
          Collection<String> getInputTopics()
          +
          Get a list of all input topics.
          +
          +
          Returns:
          +
          a list of all input topics
          +
          +
          +
          • +
        • +
          +

          getOutputTopic

          +
          String getOutputTopic()
          +
          Get the output topic of the source.
          +
          +
          Returns:
          +
          output topic name
          +
          +
          +
          • +
        • +
          +

          getCurrentRecord

          +
          Record<?> getCurrentRecord()
          +
          Access the record associated with the current input value.
          +
          +
          Returns:
          +
          the current record
          +
          +
          +
          • +
        • +
          +

          getOutputSchemaType

          +
          String getOutputSchemaType()
          +
          Get output schema builtin type or custom class name.
          +
          +
          Returns:
          +
          output schema builtin type or custom class name
          +
          +
          +
          • +
        • +
          +

          getFunctionName

          +
          String getFunctionName()
          +
          The name of the function that we are executing.
          +
          +
          Returns:
          +
          The Function name
          +
          +
          +
          • +
        • +
          +

          getFunctionId

          +
          String getFunctionId()
          +
          The id of the function that we are executing.
          +
          +
          Returns:
          +
          The function id
          +
          +
          +
          • +
        • +
          +

          getFunctionVersion

          +
          String getFunctionVersion()
          +
          The version of the function that we are executing.
          +
          +
          Returns:
          +
          The version id
          +
          +
          +
          • +
        • +
          +

          getUserConfigMap

          +
          Map<String,Object> getUserConfigMap()
          +
          Get a map of all user-defined key/value configs for the function.
          +
          +
          Returns:
          +
          The full map of user-defined config values
          +
          +
          +
          • +
        • +
          +

          getUserConfigValue

          +
          Optional<Object> getUserConfigValue(String key)
          +
          Get any user-defined key/value.
          +
          +
          Parameters:
          +
          key - The key
          +
          Returns:
          +
          The Optional value specified by the user for that key.
          +
          +
          +
          • +
        • +
          +

          getUserConfigValueOrDefault

          +
          Object getUserConfigValueOrDefault(String key, + Object defaultValue)
          +
          Get any user-defined key/value or a default value if none is present.
          +
          +
          Parameters:
          +
          key - the config key to retrieve
          +
          defaultValue - value returned if the key is not found
          +
          Returns:
          +
          Either the user config value associated with a given key or a supplied default value
          +
          +
          +
          • +
        • +
          +

          getPulsarAdmin

          +
          org.apache.pulsar.client.admin.PulsarAdmin getPulsarAdmin()
          +
          Get the pulsar admin client.
          +
          +
          Returns:
          +
          The instance of pulsar admin client
          +
          +
          +
          • +
        • +
          +

          publish

          +
          @Deprecated +<X> CompletableFuture<Void> publish(String topicName, + X object, + String schemaOrSerdeClassName)
          +
          Deprecated. +
          in favor of using newOutputMessage(String, Schema)
          +
          +
          Publish an object using serDe or schema class for serializing to the topic.
          +
          +
          Parameters:
          +
          topicName - The name of the topic for publishing
          +
          object - The object that needs to be published
          +
          schemaOrSerdeClassName - Either a builtin schema type (eg: "avro", "json", "protobuf") or the class name + of the custom schema class
          +
          Returns:
          +
          A future that completes when the framework is done publishing the message
          +
          +
          +
          • +
        • +
          +

          publish

          +
          @Deprecated +<X> CompletableFuture<Void> publish(String topicName, + X object)
          +
          Deprecated. +
          in favor of using newOutputMessage(String, Schema)
          +
          +
          Publish an object to the topic using default schemas.
          +
          +
          Parameters:
          +
          topicName - The name of the topic for publishing
          +
          object - The object that needs to be published
          +
          Returns:
          +
          A future that completes when the framework is done publishing the message
          +
          +
          +
          • +
        • +
          +

          newOutputMessage

          +
          <X> +org.apache.pulsar.client.api.TypedMessageBuilder<X> newOutputMessage(String topicName, + org.apache.pulsar.client.api.Schema<X> schema) + throws org.apache.pulsar.client.api.PulsarClientException
          +
          New output message using schema for serializing to the topic.
          +
          +
          Type Parameters:
          +
          X - the type of message
          +
          Parameters:
          +
          topicName - The name of the topic for output message
          +
          schema - provide a way to convert between serialized data and domain objects
          +
          Returns:
          +
          the message builder instance
          +
          Throws:
          +
          org.apache.pulsar.client.api.PulsarClientException - if an error occurs
          +
          +
          +
          • +
        • +
          +

          newConsumerBuilder

          +
          <X> org.apache.pulsar.client.api.ConsumerBuilder<X> newConsumerBuilder(org.apache.pulsar.client.api.Schema<X> schema) + throws org.apache.pulsar.client.api.PulsarClientException
          +
          Create a ConsumerBuilder with the schema.
          +
          +
          Type Parameters:
          +
          X - the message type of the consumer
          +
          Parameters:
          +
          schema - provide a way to convert between serialized data and domain objects
          +
          Returns:
          +
          the consumer builder instance
          +
          Throws:
          +
          org.apache.pulsar.client.api.PulsarClientException - if an error occurs
          +
          +
          +
          • +
        • +
          +

          newOutputRecordBuilder

          +
          <X> FunctionRecord.FunctionRecordBuilder<X> newOutputRecordBuilder(org.apache.pulsar.client.api.Schema<X> schema)
          +
          Creates a FunctionRecordBuilder initialized with values from this Context. + It can be used in Functions to prepare a Record to return with default values taken from the Context and the + input Record.
          +
          +
          Type Parameters:
          +
          X - the message type of record builder
          +
          Parameters:
          +
          schema - provide a way to convert between serialized data and domain objects
          +
          Returns:
          +
          the record builder instance
          +
          +
          +
          • +
        +
        +
        • +
      +
      + +
      + +
      +
      + + diff --git a/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/Function.html b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/Function.html new file mode 100644 index 000000000000..21c6abf7a5dd --- /dev/null +++ b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/Function.html @@ -0,0 +1,203 @@ + + + + +Function (Pulsar Functions :: API 4.0.0 API) + + + + + + + + + + + + + +
      + +
      +
      + +
      +
      Package org.apache.pulsar.functions.api
      +

      Interface Function<X,T>

      +
      +
      +
      +
      Functional Interface:
      +
      This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
      +
      +
      +
      @Public +@Stable +@FunctionalInterface +public interface Function<X,T>
      +
      This is the core interface of the function api. The process is called + for every message of the input topic of the function. The incoming input bytes + are converted to the input type I for simple Java types(String, Integer, Boolean, + Map, and List types) and for org.Json type. If this serialization approach does not + meet your needs, you can use the byte stream handler defined in RawRequestHandler.
      +
      +
      +
        + +
      • +
        +

        Method Summary

        +
        +
        +
        +
        +
        Modifier and Type
        +
        Method
        +
        Description
        +
        default void
        +
        close()
        +
        +
        Called once to properly close resources when function instance is stopped.
        +
        +
        default void
        +
        initialize(Context context)
        +
        +
        Called once to initialize resources when function instance is started.
        +
        +
        T
        +
        process(X input, + Context context)
        +
        +
        Process the input.
        +
        +
        +
        +
        +
        +
        • +
      +
      +
      +
        + +
      • +
        +

        Method Details

        +
          +
        • +
          +

          process

          +
          T process(X input, + Context context) + throws Exception
          +
          Process the input.
          +
          +
          Returns:
          +
          the output
          +
          Throws:
          +
          Exception
          +
          +
          +
          • +
        • +
          +

          initialize

          +
          default void initialize(Context context) + throws Exception
          +
          Called once to initialize resources when function instance is started.
          +
          +
          Parameters:
          +
          context - The Function context
          +
          Throws:
          +
          Exception - if an error occurs
          +
          +
          +
          • +
        • +
          +

          close

          +
          default void close() + throws Exception
          +
          Called once to properly close resources when function instance is stopped.
          +
          +
          Throws:
          +
          Exception - if an error occurs
          +
          +
          +
          • +
        +
        +
        • +
      +
      + +
      + +
      +
      + + diff --git a/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/KVRecord.html b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/KVRecord.html new file mode 100644 index 000000000000..14db015c5585 --- /dev/null +++ b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/KVRecord.html @@ -0,0 +1,172 @@ + + + + +KVRecord (Pulsar Functions :: API 4.0.0 API) + + + + + + + + + + + + + +
      + +
      +
      + +
      +
      Package org.apache.pulsar.functions.api
      +

      Interface KVRecord<K,V>

      +
      +
      +
      +
      All Superinterfaces:
      +
      Record
      +
      +
      +
      @Public +@Stable +public interface KVRecord<K,V> +extends Record
      +
      key value schema record.
      +
      +
      + +
      +
      +
        + +
      • +
        +

        Method Details

        +
          +
        • +
          +

          getKeySchema

          +
          org.apache.pulsar.client.api.Schema<K> getKeySchema()
          +
          +
          • +
        • +
          +

          getValueSchema

          +
          org.apache.pulsar.client.api.Schema<V> getValueSchema()
          +
          +
          • +
        • +
          +

          getKeyValueEncodingType

          +
          org.apache.pulsar.common.schema.KeyValueEncodingType getKeyValueEncodingType()
          +
          +
          • +
        +
        +
        • +
      +
      + +
      + +
      +
      + + diff --git a/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/Record.html b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/Record.html new file mode 100644 index 000000000000..b51f47aa56ce --- /dev/null +++ b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/Record.html @@ -0,0 +1,323 @@ + + + + +Record (Pulsar Functions :: API 4.0.0 API) + + + + + + + + + + + + + +
      + +
      +
      + +
      +
      Package org.apache.pulsar.functions.api
      +

      Interface Record<T>

      +
      +
      +
      +
      All Known Subinterfaces:
      +
      KVRecord<K,V>
      +
      +
      +
      All Known Implementing Classes:
      +
      FunctionRecord
      +
      +
      +
      @Public +@Stable +public interface Record<T>
      +
      Pulsar IO's Record interface. Record encapsulates the information about a record being read from a Source.
      +
      +
      +
        + +
      • +
        +

        Method Summary

        +
        +
        +
        +
        +
        Modifier and Type
        +
        Method
        +
        Description
        +
        default void
        +
        ack()
        +
        +
        Acknowledge that this record is fully processed.
        +
        +
        default void
        +
        fail()
        +
        +
        To indicate that this record has failed to be processed.
        +
        +
        default Optional<String>
        +
        getDestinationTopic()
        +
        +
        To support message routing on a per message basis.
        +
        +
        default Optional<Long>
        +
        getEventTime()
        +
        +
        Retrieves the event time of the record from the source.
        +
        +
        default Optional<String>
        +
        getKey()
        +
        +
        Return a key if the key has one associated.
        +
        +
        default Optional<org.apache.pulsar.client.api.Message<T>>
        +
        getMessage()
        +
         
        +
        default Optional<String>
        +
        getPartitionId()
        +
        +
        Retrieves the partition information if any of the record.
        +
        +
        default Optional<Integer>
        +
        getPartitionIndex()
        +
        +
        Retrieves the partition index if any of the record.
        +
        +
        default Map<String,String>
        +
        getProperties()
        +
        +
        Retrieves user-defined properties attached to record.
        +
        +
        default Optional<Long>
        +
        getRecordSequence()
        +
        +
        Retrieves the sequence of the record from a source partition.
        +
        +
        default org.apache.pulsar.client.api.Schema<T>
        +
        getSchema()
        +
         
        +
        default Optional<String>
        +
        getTopicName()
        +
        +
        If the record originated from a topic, report the topic name.
        +
        +
        T
        +
        getValue()
        +
        +
        Retrieves the actual data of the record.
        +
        +
        +
        +
        +
        +
        • +
      +
      +
      +
        + +
      • +
        +

        Method Details

        +
          +
        • +
          +

          getTopicName

          +
          default Optional<String> getTopicName()
          +
          If the record originated from a topic, report the topic name.
          +
          +
          • +
        • +
          +

          getKey

          +
          default Optional<String> getKey()
          +
          Return a key if the key has one associated.
          +
          +
          • +
        • +
          +

          getSchema

          +
          default org.apache.pulsar.client.api.Schema<T> getSchema()
          +
          +
          • +
        • +
          +

          getValue

          +
          T getValue()
          +
          Retrieves the actual data of the record.
          +
          +
          Returns:
          +
          The record data
          +
          +
          +
          • +
        • +
          +

          getEventTime

          +
          default Optional<Long> getEventTime()
          +
          Retrieves the event time of the record from the source.
          +
          +
          Returns:
          +
          millis since epoch
          +
          +
          +
          • +
        • +
          +

          getPartitionId

          +
          default Optional<String> getPartitionId()
          +
          Retrieves the partition information if any of the record.
          +
          +
          Returns:
          +
          The partition id where the
          +
          +
          +
          • +
        • +
          +

          getPartitionIndex

          +
          default Optional<Integer> getPartitionIndex()
          +
          Retrieves the partition index if any of the record.
          +
          +
          Returns:
          +
          The partition index
          +
          +
          +
          • +
        • +
          +

          getRecordSequence

          +
          default Optional<Long> getRecordSequence()
          +
          Retrieves the sequence of the record from a source partition.
          +
          +
          Returns:
          +
          Sequence Id associated with the record
          +
          +
          +
          • +
        • +
          +

          getProperties

          +
          default Map<String,String> getProperties()
          +
          Retrieves user-defined properties attached to record.
          +
          +
          Returns:
          +
          Map of user-properties
          +
          +
          +
          • +
        • +
          +

          ack

          +
          default void ack()
          +
          Acknowledge that this record is fully processed.
          +
          +
          • +
        • +
          +

          fail

          +
          default void fail()
          +
          To indicate that this record has failed to be processed.
          +
          +
          • +
        • +
          +

          getDestinationTopic

          +
          default Optional<String> getDestinationTopic()
          +
          To support message routing on a per message basis.
          +
          +
          Returns:
          +
          The topic this message should be written to
          +
          +
          +
          • +
        • +
          +

          getMessage

          +
          default Optional<org.apache.pulsar.client.api.Message<T>> getMessage()
          +
          +
          • +
        +
        +
        • +
      +
      + +
      + +
      +
      + + diff --git a/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/SerDe.html b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/SerDe.html new file mode 100644 index 000000000000..c0cc3030bb25 --- /dev/null +++ b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/SerDe.html @@ -0,0 +1,155 @@ + + + + +SerDe (Pulsar Functions :: API 4.0.0 API) + + + + + + + + + + + + + +
      + +
      +
      + +
      +
      Package org.apache.pulsar.functions.api
      +

      Interface SerDe<T>

      +
      +
      +
      +
      @Public +@Stable +public interface SerDe<T>
      +
      An interface for serializer/deserializer.
      +
      +
      +
        + +
      • +
        +

        Method Summary

        +
        +
        +
        +
        +
        Modifier and Type
        +
        Method
        +
        Description
        +
        T
        +
        deserialize(byte[] input)
        +
         
        +
        byte[]
        +
        serialize(T input)
        +
         
        +
        +
        +
        +
        +
        • +
      +
      +
      +
        + +
      • +
        +

        Method Details

        +
          +
        • +
          +

          deserialize

          +
          T deserialize(byte[] input)
          +
          +
          • +
        • +
          +

          serialize

          +
          byte[] serialize(T input)
          +
          +
          • +
        +
        +
        • +
      +
      + +
      + +
      +
      + + diff --git a/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/StateStore.html b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/StateStore.html new file mode 100644 index 000000000000..b2648ba8fa3a --- /dev/null +++ b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/StateStore.html @@ -0,0 +1,238 @@ + + + + +StateStore (Pulsar Functions :: API 4.0.0 API) + + + + + + + + + + + + + +
      + +
      +
      + +
      +
      Package org.apache.pulsar.functions.api
      +

      Interface StateStore

      +
      +
      +
      +
      All Superinterfaces:
      +
      AutoCloseable
      +
      +
      +
      All Known Subinterfaces:
      +
      ByteBufferStateStore, CounterStateStore
      +
      +
      +
      @Public +@Evolving +public interface StateStore +extends AutoCloseable
      +
      +
      +
        + +
      • +
        +

        Method Summary

        +
        +
        +
        +
        +
        Modifier and Type
        +
        Method
        +
        Description
        +
        void
        +
        close()
        +
         
        +
        String
        +
        fqsn()
        +
        +
        The fully qualified state store name.
        +
        +
        void
        +
        init(StateStoreContext ctx)
        +
        +
        Initialize the state store.
        +
        +
        String
        +
        name()
        +
        +
        The name of this store.
        +
        +
        String
        +
        namespace()
        +
        +
        The namespace of this store.
        +
        +
        String
        +
        tenant()
        +
        +
        The tenant of this store.
        +
        +
        +
        +
        +
        +
        • +
      +
      +
      +
        + +
      • +
        +

        Method Details

        +
          +
        • +
          +

          tenant

          +
          String tenant()
          +
          The tenant of this store.
          +
          +
          Returns:
          +
          the state store tenant.
          +
          +
          +
          • +
        • +
          +

          namespace

          +
          String namespace()
          +
          The namespace of this store.
          +
          +
          Returns:
          +
          the state store namespace.
          +
          +
          +
          • +
        • +
          +

          name

          +
          String name()
          +
          The name of this store.
          +
          +
          Returns:
          +
          the state store name.
          +
          +
          +
          • +
        • +
          +

          fqsn

          +
          String fqsn()
          +
          The fully qualified state store name.
          +
          +
          Returns:
          +
          the fully qualified state store name.
          +
          +
          +
          • +
        • +
          +

          init

          +
          void init(StateStoreContext ctx)
          +
          Initialize the state store.
          +
          +
          Parameters:
          +
          ctx - the state store context
          +
          +
          +
          • +
        • +
          +

          close

          +
          void close()
          +
          +
          Specified by:
          +
          close in interface AutoCloseable
          +
          +
          +
          • +
        +
        +
        • +
      +
      + +
      + +
      +
      + + diff --git a/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/StateStoreContext.html b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/StateStoreContext.html new file mode 100644 index 000000000000..8820c1fd3e49 --- /dev/null +++ b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/StateStoreContext.html @@ -0,0 +1,105 @@ + + + + +StateStoreContext (Pulsar Functions :: API 4.0.0 API) + + + + + + + + + + + + + +
      + +
      +
      + +
      +
      Package org.apache.pulsar.functions.api
      +

      Interface StateStoreContext

      +
      +
      +
      +
      @Public +@Evolving +public interface StateStoreContext
      +
      State Store Context Interface.
      +
      + +
      + +
      +
      + + diff --git a/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/WindowContext.html b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/WindowContext.html new file mode 100644 index 000000000000..e392d6138694 --- /dev/null +++ b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/WindowContext.html @@ -0,0 +1,506 @@ + + + + +WindowContext (Pulsar Functions :: API 4.0.0 API) + + + + + + + + + + + + + +
      + +
      +
      + +
      +
      Package org.apache.pulsar.functions.api
      +

      Interface WindowContext

      +
      +
      +
      +
      @Public +@Stable +public interface WindowContext
      +
      +
      + +
      +
      +
        + +
      • +
        +

        Method Details

        +
          +
        • +
          +

          getTenant

          +
          String getTenant()
          +
          The tenant this function belongs to.
          +
          +
          Returns:
          +
          the tenant this function belongs to
          +
          +
          +
          • +
        • +
          +

          getNamespace

          +
          String getNamespace()
          +
          The namespace this function belongs to.
          +
          +
          Returns:
          +
          the namespace this function belongs to
          +
          +
          +
          • +
        • +
          +

          getFunctionName

          +
          String getFunctionName()
          +
          The name of the function that we are executing.
          +
          +
          Returns:
          +
          The Function name
          +
          +
          +
          • +
        • +
          +

          getFunctionId

          +
          String getFunctionId()
          +
          The id of the function that we are executing.
          +
          +
          Returns:
          +
          The function id
          +
          +
          +
          • +
        • +
          +

          getInstanceId

          +
          int getInstanceId()
          +
          The id of the instance that invokes this function.
          +
          +
          Returns:
          +
          the instance id
          +
          +
          +
          • +
        • +
          +

          getNumInstances

          +
          int getNumInstances()
          +
          Get the number of instances that invoke this function.
          +
          +
          Returns:
          +
          the number of instances that invoke this function.
          +
          +
          +
          • +
        • +
          +

          getFunctionVersion

          +
          String getFunctionVersion()
          +
          The version of the function that we are executing.
          +
          +
          Returns:
          +
          The version id
          +
          +
          +
          • +
        • +
          +

          getInputTopics

          +
          Collection<String> getInputTopics()
          +
          Get a list of all input topics.
          +
          +
          Returns:
          +
          a list of all input topics
          +
          +
          +
          • +
        • +
          +

          getOutputTopic

          +
          String getOutputTopic()
          +
          Get the output topic of the function.
          +
          +
          Returns:
          +
          output topic name
          +
          +
          +
          • +
        • +
          +

          getOutputSchemaType

          +
          String getOutputSchemaType()
          +
          Get output schema builtin type or custom class name.
          +
          +
          Returns:
          +
          output schema builtin type or custom class name
          +
          +
          +
          • +
        • +
          +

          getLogger

          +
          org.slf4j.Logger getLogger()
          +
          The logger object that can be used to log in a function.
          +
          +
          Returns:
          +
          the logger object
          +
          +
          +
          • +
        • +
          +

          incrCounter

          +
          void incrCounter(String key, + long amount)
          +
          Increment the builtin distributed counter referred by key.
          +
          +
          Parameters:
          +
          key - The name of the key
          +
          amount - The amount to be incremented
          +
          +
          +
          • +
        • +
          +

          getCounter

          +
          long getCounter(String key)
          +
          Retrieve the counter value for the key.
          +
          +
          Parameters:
          +
          key - name of the key
          +
          Returns:
          +
          the amount of the counter value for this key
          +
          +
          +
          • +
        • +
          +

          putState

          +
          void putState(String key, + ByteBuffer value)
          +
          Update the state value for the key.
          +
          +
          Parameters:
          +
          key - name of the key
          +
          value - state value of the key
          +
          +
          +
          • +
        • +
          +

          getState

          +
          ByteBuffer getState(String key)
          +
          Retrieve the state value for the key.
          +
          +
          Parameters:
          +
          key - name of the key
          +
          Returns:
          +
          the state value for the key.
          +
          +
          +
          • +
        • +
          +

          getUserConfigMap

          +
          Map<String,Object> getUserConfigMap()
          +
          Get a map of all user-defined key/value configs for the function.
          +
          +
          Returns:
          +
          The full map of user-defined config values
          +
          +
          +
          • +
        • +
          +

          getUserConfigValue

          +
          Optional<Object> getUserConfigValue(String key)
          +
          Get any user-defined key/value.
          +
          +
          Parameters:
          +
          key - The key
          +
          Returns:
          +
          The Optional value specified by the user for that key.
          +
          +
          +
          • +
        • +
          +

          getUserConfigValueOrDefault

          +
          Object getUserConfigValueOrDefault(String key, + Object defaultValue)
          +
          Get any user-defined key/value or a default value if none is present.
          +
          +
          Parameters:
          +
          key - the config key to retrieve
          +
          defaultValue - value returned if the key is not found
          +
          Returns:
          +
          Either the user config value associated with a given key or a supplied default value
          +
          +
          +
          • +
        • +
          +

          recordMetric

          +
          void recordMetric(String metricName, + double value)
          +
          Record a user defined metric.
          +
          +
          Parameters:
          +
          metricName - The name of the metric
          +
          value - The value of the metric
          +
          +
          +
          • +
        • +
          +

          publish

          +
          <T> CompletableFuture<Void> publish(String topicName, + T object, + String schemaOrSerdeClassName)
          +
          Publish an object using serDe for serializing to the topic.
          +
          +
          Parameters:
          +
          topicName - The name of the topic for publishing
          +
          object - The object that needs to be published
          +
          schemaOrSerdeClassName - Either a builtin schema type (eg: "avro", "json", "protobuf") + or the class name of the custom schema class
          +
          Returns:
          +
          A future that completes when the framework is done publishing the message
          +
          +
          +
          • +
        • +
          +

          publish

          +
          <T> CompletableFuture<Void> publish(String topicName, + T object)
          +
          Publish an object to the topic using default schemas.
          +
          +
          Parameters:
          +
          topicName - The name of the topic for publishing
          +
          object - The object that needs to be published
          +
          Returns:
          +
          A future that completes when the framework is done publishing the message
          +
          +
          +
          • +
        +
        +
        • +
      +
      + +
      + +
      +
      + + diff --git a/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/WindowFunction.html b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/WindowFunction.html new file mode 100644 index 000000000000..453db254c139 --- /dev/null +++ b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/WindowFunction.html @@ -0,0 +1,164 @@ + + + + +WindowFunction (Pulsar Functions :: API 4.0.0 API) + + + + + + + + + + + + + +
      + +
      +
      + +
      +
      Package org.apache.pulsar.functions.api
      +

      Interface WindowFunction<X,T>

      +
      +
      +
      +
      Functional Interface:
      +
      This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
      +
      +
      +
      @Public +@Stable +@FunctionalInterface +public interface WindowFunction<X,T>
      +
      This is the interface of the windowed function api. The process method is called + for every triggered window.
      +
      +
      +
        + +
      • +
        +

        Method Summary

        +
        +
        +
        +
        +
        Modifier and Type
        +
        Method
        +
        Description
        +
        T
        +
        process(Collection<Record<X>> input, + WindowContext context)
        +
        +
        Process the input.
        +
        +
        +
        +
        +
        +
        • +
      +
      +
      + +
      + +
      + +
      +
      + + diff --git a/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/class-use/BaseContext.html b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/class-use/BaseContext.html new file mode 100644 index 000000000000..d1fa21864d89 --- /dev/null +++ b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/class-use/BaseContext.html @@ -0,0 +1,91 @@ + + + + +Uses of Interface org.apache.pulsar.functions.api.BaseContext (Pulsar Functions :: API 4.0.0 API) + + + + + + + + + + + + + +
      + +
      +
      +
      +

      Uses of Interface
      org.apache.pulsar.functions.api.BaseContext

      +
      +
      Packages that use BaseContext
      +
      +
      Package
      +
      Description
      +
      org.apache.pulsar.functions.api
      +
      +
      Provides a simple model for enabling lightweight computation on Apache Pulsar.
      +
      +
      +
      + +
      +
      + +
      +
      + + diff --git a/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/class-use/Context.html b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/class-use/Context.html new file mode 100644 index 000000000000..2fac24814760 --- /dev/null +++ b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/class-use/Context.html @@ -0,0 +1,118 @@ + + + + +Uses of Interface org.apache.pulsar.functions.api.Context (Pulsar Functions :: API 4.0.0 API) + + + + + + + + + + + + + +
      + +
      +
      +
      +

      Uses of Interface
      org.apache.pulsar.functions.api.Context

      +
      +
      Packages that use Context
      +
      +
      Package
      +
      Description
      +
      org.apache.pulsar.functions.api
      +
      +
      Provides a simple model for enabling lightweight computation on Apache Pulsar.
      +
      +
      org.apache.pulsar.functions.api.utils
      +
      +
      State Store API.
      +
      +
      +
      + +
      +
      + +
      +
      + + diff --git a/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/class-use/Function.html b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/class-use/Function.html new file mode 100644 index 000000000000..56d183207373 --- /dev/null +++ b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/class-use/Function.html @@ -0,0 +1,62 @@ + + + + +Uses of Interface org.apache.pulsar.functions.api.Function (Pulsar Functions :: API 4.0.0 API) + + + + + + + + + + + + + +
      + +
      +
      +
      +

      Uses of Interface
      org.apache.pulsar.functions.api.Function

      +
      +No usage of org.apache.pulsar.functions.api.Function
      + +
      +
      + + diff --git a/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/class-use/KVRecord.html b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/class-use/KVRecord.html new file mode 100644 index 000000000000..2eef1e9eedb7 --- /dev/null +++ b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/class-use/KVRecord.html @@ -0,0 +1,62 @@ + + + + +Uses of Interface org.apache.pulsar.functions.api.KVRecord (Pulsar Functions :: API 4.0.0 API) + + + + + + + + + + + + + +
      + +
      +
      +
      +

      Uses of Interface
      org.apache.pulsar.functions.api.KVRecord

      +
      +No usage of org.apache.pulsar.functions.api.KVRecord
      + +
      +
      + + diff --git a/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/class-use/Record.html b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/class-use/Record.html new file mode 100644 index 000000000000..b16a6d2c52e7 --- /dev/null +++ b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/class-use/Record.html @@ -0,0 +1,132 @@ + + + + +Uses of Interface org.apache.pulsar.functions.api.Record (Pulsar Functions :: API 4.0.0 API) + + + + + + + + + + + + + +
      + +
      +
      +
      +

      Uses of Interface
      org.apache.pulsar.functions.api.Record

      +
      +
      Packages that use Record
      +
      +
      Package
      +
      Description
      +
      org.apache.pulsar.functions.api
      +
      +
      Provides a simple model for enabling lightweight computation on Apache Pulsar.
      +
      +
      org.apache.pulsar.functions.api.utils
      +
      +
      State Store API.
      +
      +
      +
      + +
      +
      + +
      +
      + + diff --git a/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/class-use/SerDe.html b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/class-use/SerDe.html new file mode 100644 index 000000000000..3a2e92d287d5 --- /dev/null +++ b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/class-use/SerDe.html @@ -0,0 +1,62 @@ + + + + +Uses of Interface org.apache.pulsar.functions.api.SerDe (Pulsar Functions :: API 4.0.0 API) + + + + + + + + + + + + + +
      + +
      +
      +
      +

      Uses of Interface
      org.apache.pulsar.functions.api.SerDe

      +
      +No usage of org.apache.pulsar.functions.api.SerDe
      + +
      +
      + + diff --git a/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/class-use/StateStore.html b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/class-use/StateStore.html new file mode 100644 index 000000000000..45108a9e3871 --- /dev/null +++ b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/class-use/StateStore.html @@ -0,0 +1,123 @@ + + + + +Uses of Interface org.apache.pulsar.functions.api.StateStore (Pulsar Functions :: API 4.0.0 API) + + + + + + + + + + + + + +
      + +
      +
      +
      +

      Uses of Interface
      org.apache.pulsar.functions.api.StateStore

      +
      +
      Packages that use StateStore
      +
      +
      Package
      +
      Description
      +
      org.apache.pulsar.functions.api
      +
      +
      Provides a simple model for enabling lightweight computation on Apache Pulsar.
      +
      +
      org.apache.pulsar.functions.api.state
      +
      +
      State Store API.
      +
      +
      +
      + +
      +
      + +
      +
      + + diff --git a/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/class-use/StateStoreContext.html b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/class-use/StateStoreContext.html new file mode 100644 index 000000000000..0ac772ae5484 --- /dev/null +++ b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/class-use/StateStoreContext.html @@ -0,0 +1,91 @@ + + + + +Uses of Interface org.apache.pulsar.functions.api.StateStoreContext (Pulsar Functions :: API 4.0.0 API) + + + + + + + + + + + + + +
      + +
      +
      +
      +

      Uses of Interface
      org.apache.pulsar.functions.api.StateStoreContext

      +
      +
      Packages that use StateStoreContext
      +
      +
      Package
      +
      Description
      +
      org.apache.pulsar.functions.api
      +
      +
      Provides a simple model for enabling lightweight computation on Apache Pulsar.
      +
      +
      +
      + +
      +
      + +
      +
      + + diff --git a/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/class-use/WindowContext.html b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/class-use/WindowContext.html new file mode 100644 index 000000000000..d46af14fa78e --- /dev/null +++ b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/class-use/WindowContext.html @@ -0,0 +1,92 @@ + + + + +Uses of Interface org.apache.pulsar.functions.api.WindowContext (Pulsar Functions :: API 4.0.0 API) + + + + + + + + + + + + + +
      + +
      +
      +
      +

      Uses of Interface
      org.apache.pulsar.functions.api.WindowContext

      +
      +
      Packages that use WindowContext
      +
      +
      Package
      +
      Description
      +
      org.apache.pulsar.functions.api
      +
      +
      Provides a simple model for enabling lightweight computation on Apache Pulsar.
      +
      +
      +
      + +
      +
      + +
      +
      + + diff --git a/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/class-use/WindowFunction.html b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/class-use/WindowFunction.html new file mode 100644 index 000000000000..1085e6180f49 --- /dev/null +++ b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/class-use/WindowFunction.html @@ -0,0 +1,62 @@ + + + + +Uses of Interface org.apache.pulsar.functions.api.WindowFunction (Pulsar Functions :: API 4.0.0 API) + + + + + + + + + + + + + +
      + +
      +
      +
      +

      Uses of Interface
      org.apache.pulsar.functions.api.WindowFunction

      +
      +No usage of org.apache.pulsar.functions.api.WindowFunction
      + +
      +
      + + diff --git a/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/package-summary.html b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/package-summary.html new file mode 100644 index 000000000000..0e236a0f88ec --- /dev/null +++ b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/package-summary.html @@ -0,0 +1,150 @@ + + + + +org.apache.pulsar.functions.api (Pulsar Functions :: API 4.0.0 API) + + + + + + + + + + + + + +
      + +
      +
      +
      +

      Package org.apache.pulsar.functions.api

      +
      +
      +
      package org.apache.pulsar.functions.api
      +
      +
      Provides a simple model for enabling lightweight computation on Apache Pulsar.
      +
      +
      + +
      +
      + +
      +
      + + diff --git a/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/package-tree.html b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/package-tree.html new file mode 100644 index 000000000000..dbc1d99edecc --- /dev/null +++ b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/package-tree.html @@ -0,0 +1,91 @@ + + + + +org.apache.pulsar.functions.api Class Hierarchy (Pulsar Functions :: API 4.0.0 API) + + + + + + + + + + + + + +
      + +
      +
      +
      +

      Hierarchy For Package org.apache.pulsar.functions.api

      +
      +Package Hierarchies: + +
      +

      Interface Hierarchy

      + +
      +
      + +
      +
      + + diff --git a/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/package-use.html b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/package-use.html new file mode 100644 index 000000000000..512c166061cc --- /dev/null +++ b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/package-use.html @@ -0,0 +1,140 @@ + + + + +Uses of Package org.apache.pulsar.functions.api (Pulsar Functions :: API 4.0.0 API) + + + + + + + + + + + + + +
      + +
      +
      +
      +

      Uses of Package
      org.apache.pulsar.functions.api

      +
      +
      Packages that use org.apache.pulsar.functions.api
      +
      +
      Package
      +
      Description
      +
      org.apache.pulsar.functions.api
      +
      +
      Provides a simple model for enabling lightweight computation on Apache Pulsar.
      +
      +
      org.apache.pulsar.functions.api.state
      +
      +
      State Store API.
      +
      +
      org.apache.pulsar.functions.api.utils
      +
      +
      State Store API.
      +
      +
      +
      + +
      +
      + +
      +
      + + diff --git a/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/state/ByteBufferStateStore.html b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/state/ByteBufferStateStore.html new file mode 100644 index 000000000000..b60a8e12495b --- /dev/null +++ b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/state/ByteBufferStateStore.html @@ -0,0 +1,285 @@ + + + + +ByteBufferStateStore (Pulsar Functions :: API 4.0.0 API) + + + + + + + + + + + + + +
      + +
      +
      + +
      +
      Package org.apache.pulsar.functions.api.state
      +

      Interface ByteBufferStateStore

      +
      +
      +
      +
      All Superinterfaces:
      +
      AutoCloseable, StateStore
      +
      +
      +
      public interface ByteBufferStateStore +extends StateStore
      +
      A key-value state store that stores values in ByteBuffer.
      +
      +
      + +
      +
      +
        + +
      • +
        +

        Method Details

        +
          +
        • +
          +

          put

          +
          void put(String key, + ByteBuffer value)
          +
          Update the state value for the key.
          +
          +
          Parameters:
          +
          key - name of the key
          +
          value - state value of the key
          +
          +
          +
          • +
        • +
          +

          putAsync

          +
          CompletableFuture<Void> putAsync(String key, + ByteBuffer value)
          +
          Update the state value for the key, but don't wait for the operation to be completed.
          +
          +
          Parameters:
          +
          key - name of the key
          +
          value - state value of the key
          +
          +
          +
          • +
        • +
          +

          delete

          +
          void delete(String key)
          +
          Delete the state value for the key.
          +
          +
          Parameters:
          +
          key - name of the key
          +
          +
          +
          • +
        • +
          +

          deleteAsync

          +
          CompletableFuture<Void> deleteAsync(String key)
          +
          Delete the state value for the key, but don't wait for the operation to be completed.
          +
          +
          Parameters:
          +
          key - name of the key
          +
          +
          +
          • +
        • +
          +

          get

          +
          ByteBuffer get(String key)
          +
          Retrieve the state value for the key.
          +
          +
          Parameters:
          +
          key - name of the key
          +
          Returns:
          +
          the state value for the key.
          +
          +
          +
          • +
        • +
          +

          getAsync

          +
          CompletableFuture<ByteBuffer> getAsync(String key)
          +
          Retrieve the state value for the key, but don't wait for the operation to be completed.
          +
          +
          Parameters:
          +
          key - name of the key
          +
          Returns:
          +
          the state value for the key.
          +
          +
          +
          • +
        • +
          +

          getStateValue

          +
          default StateValue getStateValue(String key)
          +
          Retrieve the StateValue for the key.
          +
          +
          Parameters:
          +
          key - name of the key
          +
          Returns:
          +
          the StateValue.
          +
          +
          +
          • +
        • +
          +

          getStateValueAsync

          +
          default CompletableFuture<StateValue> getStateValueAsync(String key)
          +
          Retrieve the StateValue for the key, but don't wait for the operation to be completed.
          +
          +
          Parameters:
          +
          key - name of the key
          +
          Returns:
          +
          the StateValue.
          +
          +
          +
          • +
        +
        +
        • +
      +
      + +
      + +
      +
      + + diff --git a/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/state/CounterStateStore.html b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/state/CounterStateStore.html new file mode 100644 index 000000000000..77c921a6b769 --- /dev/null +++ b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/state/CounterStateStore.html @@ -0,0 +1,221 @@ + + + + +CounterStateStore (Pulsar Functions :: API 4.0.0 API) + + + + + + + + + + + + + +
      + +
      +
      + +
      +
      Package org.apache.pulsar.functions.api.state
      +

      Interface CounterStateStore

      +
      +
      +
      +
      All Superinterfaces:
      +
      AutoCloseable, StateStore
      +
      +
      +
      public interface CounterStateStore +extends StateStore
      +
      The state store supports counters.
      +
      +
      + +
      +
      +
        + +
      • +
        +

        Method Details

        +
          +
        • +
          +

          incrCounter

          +
          void incrCounter(String key, + long amount)
          +
          Increment the builtin distributed counter referred by key.
          +
          +
          Parameters:
          +
          key - The name of the key
          +
          amount - The amount to be incremented
          +
          +
          +
          • +
        • +
          +

          incrCounterAsync

          +
          CompletableFuture<Void> incrCounterAsync(String key, + long amount)
          +
          Increment the builtin distributed counter referred by key + but dont wait for the completion of the increment operation.
          +
          +
          Parameters:
          +
          key - The name of the key
          +
          amount - The amount to be incremented
          +
          +
          +
          • +
        • +
          +

          getCounter

          +
          long getCounter(String key)
          +
          Retrieve the counter value for the key.
          +
          +
          Parameters:
          +
          key - name of the key
          +
          Returns:
          +
          the amount of the counter value for this key
          +
          +
          +
          • +
        • +
          +

          getCounterAsync

          +
          CompletableFuture<Long> getCounterAsync(String key)
          +
          Retrieve the counter value for the key, but don't wait + for the operation to be completed.
          +
          +
          Parameters:
          +
          key - name of the key
          +
          Returns:
          +
          the amount of the counter value for this key
          +
          +
          +
          • +
        +
        +
        • +
      +
      + +
      + +
      +
      + + diff --git a/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/state/StateValue.html b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/state/StateValue.html new file mode 100644 index 000000000000..ab5d4893ae71 --- /dev/null +++ b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/state/StateValue.html @@ -0,0 +1,150 @@ + + + + +StateValue (Pulsar Functions :: API 4.0.0 API) + + + + + + + + + + + + + +
      + +
      +
      + +
      +
      Package org.apache.pulsar.functions.api.state
      +

      Class StateValue

      +
      +
      java.lang.Object +
      org.apache.pulsar.functions.api.state.StateValue
      +
      +
      +
      +
      public class StateValue +extends Object
      +
      +
      + +
      +
      +
        + +
      • +
        +

        Constructor Details

        +
          +
        • +
          +

          StateValue

          +
          public StateValue()
          +
          +
          • +
        +
        +
        • +
      +
      + +
      + +
      +
      + + diff --git a/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/state/class-use/ByteBufferStateStore.html b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/state/class-use/ByteBufferStateStore.html new file mode 100644 index 000000000000..484f526bc4f3 --- /dev/null +++ b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/state/class-use/ByteBufferStateStore.html @@ -0,0 +1,62 @@ + + + + +Uses of Interface org.apache.pulsar.functions.api.state.ByteBufferStateStore (Pulsar Functions :: API 4.0.0 API) + + + + + + + + + + + + + +
      + +
      +
      +
      +

      Uses of Interface
      org.apache.pulsar.functions.api.state.ByteBufferStateStore

      +
      +No usage of org.apache.pulsar.functions.api.state.ByteBufferStateStore
      + +
      +
      + + diff --git a/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/state/class-use/CounterStateStore.html b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/state/class-use/CounterStateStore.html new file mode 100644 index 000000000000..814993043e3f --- /dev/null +++ b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/state/class-use/CounterStateStore.html @@ -0,0 +1,62 @@ + + + + +Uses of Interface org.apache.pulsar.functions.api.state.CounterStateStore (Pulsar Functions :: API 4.0.0 API) + + + + + + + + + + + + + +
      + +
      +
      +
      +

      Uses of Interface
      org.apache.pulsar.functions.api.state.CounterStateStore

      +
      +No usage of org.apache.pulsar.functions.api.state.CounterStateStore
      + +
      +
      + + diff --git a/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/state/class-use/StateValue.html b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/state/class-use/StateValue.html new file mode 100644 index 000000000000..cf836215bf2a --- /dev/null +++ b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/state/class-use/StateValue.html @@ -0,0 +1,102 @@ + + + + +Uses of Class org.apache.pulsar.functions.api.state.StateValue (Pulsar Functions :: API 4.0.0 API) + + + + + + + + + + + + + +
      + +
      +
      +
      +

      Uses of Class
      org.apache.pulsar.functions.api.state.StateValue

      +
      +
      Packages that use StateValue
      +
      +
      Package
      +
      Description
      +
      org.apache.pulsar.functions.api.state
      +
      +
      State Store API.
      +
      +
      +
      + +
      +
      + +
      +
      + + diff --git a/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/state/package-summary.html b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/state/package-summary.html new file mode 100644 index 000000000000..edfd43eb9fe5 --- /dev/null +++ b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/state/package-summary.html @@ -0,0 +1,126 @@ + + + + +org.apache.pulsar.functions.api.state (Pulsar Functions :: API 4.0.0 API) + + + + + + + + + + + + + +
      + +
      +
      +
      +

      Package org.apache.pulsar.functions.api.state

      +
      +
      +
      package org.apache.pulsar.functions.api.state
      +
      +
      State Store API.
      +
      +
      + +
      +
      + +
      +
      + + diff --git a/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/state/package-tree.html b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/state/package-tree.html new file mode 100644 index 000000000000..1a5dcee5fd73 --- /dev/null +++ b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/state/package-tree.html @@ -0,0 +1,91 @@ + + + + +org.apache.pulsar.functions.api.state Class Hierarchy (Pulsar Functions :: API 4.0.0 API) + + + + + + + + + + + + + +
      + +
      +
      +
      +

      Hierarchy For Package org.apache.pulsar.functions.api.state

      +
      +Package Hierarchies: + +
      +

      Class Hierarchy

      + +
      +
      +

      Interface Hierarchy

      + +
      +
      + +
      +
      + + diff --git a/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/state/package-use.html b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/state/package-use.html new file mode 100644 index 000000000000..8808f59da37c --- /dev/null +++ b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/state/package-use.html @@ -0,0 +1,86 @@ + + + + +Uses of Package org.apache.pulsar.functions.api.state (Pulsar Functions :: API 4.0.0 API) + + + + + + + + + + + + + +
      + +
      +
      +
      +

      Uses of Package
      org.apache.pulsar.functions.api.state

      +
      +
      Packages that use org.apache.pulsar.functions.api.state
      +
      +
      Package
      +
      Description
      +
      org.apache.pulsar.functions.api.state
      +
      +
      State Store API.
      +
      +
      +
      + +
      +
      + +
      +
      + + diff --git a/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/utils/FunctionRecord.FunctionRecordBuilder.html b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/utils/FunctionRecord.FunctionRecordBuilder.html new file mode 100644 index 000000000000..bee3a54a926f --- /dev/null +++ b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/utils/FunctionRecord.FunctionRecordBuilder.html @@ -0,0 +1,123 @@ + + + + +FunctionRecord.FunctionRecordBuilder (Pulsar Functions :: API 4.0.0 API) + + + + + + + + + + + + + +
      + +
      +
      + +
      +
      Package org.apache.pulsar.functions.api.utils
      +

      Class FunctionRecord.FunctionRecordBuilder<T>

      +
      +
      java.lang.Object +
      org.apache.pulsar.functions.api.utils.FunctionRecord.FunctionRecordBuilder<T>
      +
      +
      +
      +
      Enclosing class:
      +
      FunctionRecord<T>
      +
      +
      +
      public static class FunctionRecord.FunctionRecordBuilder<T> +extends Object
      +
      +
      + +
      + +
      + +
      +
      + + diff --git a/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/utils/FunctionRecord.html b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/utils/FunctionRecord.html new file mode 100644 index 000000000000..6f60ed6c61fb --- /dev/null +++ b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/utils/FunctionRecord.html @@ -0,0 +1,397 @@ + + + + +FunctionRecord (Pulsar Functions :: API 4.0.0 API) + + + + + + + + + + + + + +
      + +
      +
      + +
      +
      Package org.apache.pulsar.functions.api.utils
      +

      Class FunctionRecord<T>

      +
      +
      java.lang.Object +
      org.apache.pulsar.functions.api.utils.FunctionRecord<T>
      +
      +
      +
      +
      All Implemented Interfaces:
      +
      Record<T>
      +
      +
      +
      public class FunctionRecord<T> +extends Object +implements Record<T>
      +
      +
      + +
      +
      +
        + +
      • +
        +

        Constructor Details

        +
          +
        • +
          +

          FunctionRecord

          +
          public FunctionRecord()
          +
          +
          • +
        +
        +
        • + +
      • +
        +

        Method Details

        +
          +
        • +
          +

          from

          +
          public static <T> +FunctionRecord.FunctionRecordBuilder<T> from(Context context, + org.apache.pulsar.client.api.Schema<T> schema)
          +
          Creates a builder for a Record from a Function Context. + The builder is initialized with the output topic from the Context and with the topicName, key, eventTime, + properties, partitionId, partitionIndex and recordSequence from the Context input Record. + It doesn't initialize a Message at the moment.
          +
          +
          Type Parameters:
          +
          T - type of Record to build
          +
          Parameters:
          +
          context - a Function Context
          +
          Returns:
          +
          a Record builder initialised with values from the Function Context
          +
          +
          +
          • +
        • +
          +

          getValue

          +
          public T getValue()
          +
          Description copied from interface: Record
          +
          Retrieves the actual data of the record.
          +
          +
          Specified by:
          +
          getValue in interface Record<T>
          +
          Returns:
          +
          The record data
          +
          +
          +
          • +
        • +
          +

          getTopicName

          +
          public Optional<String> getTopicName()
          +
          Description copied from interface: Record
          +
          If the record originated from a topic, report the topic name.
          +
          +
          Specified by:
          +
          getTopicName in interface Record<T>
          +
          +
          +
          • +
        • +
          +

          getDestinationTopic

          +
          public Optional<String> getDestinationTopic()
          +
          Description copied from interface: Record
          +
          To support message routing on a per message basis.
          +
          +
          Specified by:
          +
          getDestinationTopic in interface Record<T>
          +
          Returns:
          +
          The topic this message should be written to
          +
          +
          +
          • +
        • +
          +

          getProperties

          +
          public Map<String,String> getProperties()
          +
          Description copied from interface: Record
          +
          Retrieves user-defined properties attached to record.
          +
          +
          Specified by:
          +
          getProperties in interface Record<T>
          +
          Returns:
          +
          Map of user-properties
          +
          +
          +
          • +
        • +
          +

          getKey

          +
          public Optional<String> getKey()
          +
          Description copied from interface: Record
          +
          Return a key if the key has one associated.
          +
          +
          Specified by:
          +
          getKey in interface Record<T>
          +
          +
          +
          • +
        • +
          +

          getSchema

          +
          public org.apache.pulsar.client.api.Schema<T> getSchema()
          +
          +
          Specified by:
          +
          getSchema in interface Record<T>
          +
          +
          +
          • +
        • +
          +

          getEventTime

          +
          public Optional<Long> getEventTime()
          +
          Description copied from interface: Record
          +
          Retrieves the event time of the record from the source.
          +
          +
          Specified by:
          +
          getEventTime in interface Record<T>
          +
          Returns:
          +
          millis since epoch
          +
          +
          +
          • +
        • +
          +

          getPartitionId

          +
          public Optional<String> getPartitionId()
          +
          Description copied from interface: Record
          +
          Retrieves the partition information if any of the record.
          +
          +
          Specified by:
          +
          getPartitionId in interface Record<T>
          +
          Returns:
          +
          The partition id where the
          +
          +
          +
          • +
        • +
          +

          getPartitionIndex

          +
          public Optional<Integer> getPartitionIndex()
          +
          Description copied from interface: Record
          +
          Retrieves the partition index if any of the record.
          +
          +
          Specified by:
          +
          getPartitionIndex in interface Record<T>
          +
          Returns:
          +
          The partition index
          +
          +
          +
          • +
        • +
          +

          getRecordSequence

          +
          public Optional<Long> getRecordSequence()
          +
          Description copied from interface: Record
          +
          Retrieves the sequence of the record from a source partition.
          +
          +
          Specified by:
          +
          getRecordSequence in interface Record<T>
          +
          Returns:
          +
          Sequence Id associated with the record
          +
          +
          +
          • +
        +
        +
        • +
      +
      + +
      + +
      +
      + + diff --git a/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/utils/IdentityFunction.html b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/utils/IdentityFunction.html new file mode 100644 index 000000000000..bf1620800b96 --- /dev/null +++ b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/utils/IdentityFunction.html @@ -0,0 +1,191 @@ + + + + +IdentityFunction (Pulsar Functions :: API 4.0.0 API) + + + + + + + + + + + + + +
      + +
      +
      + +
      +
      Package org.apache.pulsar.functions.api.utils
      +

      Class IdentityFunction

      +
      +
      java.lang.Object +
      org.apache.pulsar.functions.api.utils.IdentityFunction
      +
      +
      +
      +
      All Implemented Interfaces:
      +
      Function<Object,Object>
      +
      +
      +
      @Public +@Stable +public class IdentityFunction +extends Object +implements Function<Object,Object>
      +
      +
      + +
      +
      +
        + +
      • +
        +

        Constructor Details

        +
          +
        • +
          +

          IdentityFunction

          +
          public IdentityFunction()
          +
          +
          • +
        +
        +
        • + +
      • +
        +

        Method Details

        + +
        +
        • +
      +
      + +
      + +
      +
      + + diff --git a/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/utils/class-use/FunctionRecord.FunctionRecordBuilder.html b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/utils/class-use/FunctionRecord.FunctionRecordBuilder.html new file mode 100644 index 000000000000..b536014cf786 --- /dev/null +++ b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/utils/class-use/FunctionRecord.FunctionRecordBuilder.html @@ -0,0 +1,112 @@ + + + + +Uses of Class org.apache.pulsar.functions.api.utils.FunctionRecord.FunctionRecordBuilder (Pulsar Functions :: API 4.0.0 API) + + + + + + + + + + + + + +
      + +
      +
      +
      +

      Uses of Class
      org.apache.pulsar.functions.api.utils.FunctionRecord.FunctionRecordBuilder

      +
      +
      Packages that use FunctionRecord.FunctionRecordBuilder
      +
      +
      Package
      +
      Description
      +
      org.apache.pulsar.functions.api
      +
      +
      Provides a simple model for enabling lightweight computation on Apache Pulsar.
      +
      +
      org.apache.pulsar.functions.api.utils
      +
      +
      State Store API.
      +
      +
      +
      + +
      +
      + +
      +
      + + diff --git a/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/utils/class-use/FunctionRecord.html b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/utils/class-use/FunctionRecord.html new file mode 100644 index 000000000000..a60f64f56a9b --- /dev/null +++ b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/utils/class-use/FunctionRecord.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.functions.api.utils.FunctionRecord (Pulsar Functions :: API 4.0.0 API) + + + + + + + + + + + + + +
      + +
      +
      +
      +

      Uses of Class
      org.apache.pulsar.functions.api.utils.FunctionRecord

      +
      +No usage of org.apache.pulsar.functions.api.utils.FunctionRecord
      + +
      +
      + + diff --git a/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/utils/class-use/IdentityFunction.html b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/utils/class-use/IdentityFunction.html new file mode 100644 index 000000000000..ec2e3f2c731e --- /dev/null +++ b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/utils/class-use/IdentityFunction.html @@ -0,0 +1,62 @@ + + + + +Uses of Class org.apache.pulsar.functions.api.utils.IdentityFunction (Pulsar Functions :: API 4.0.0 API) + + + + + + + + + + + + + +
      + +
      +
      +
      +

      Uses of Class
      org.apache.pulsar.functions.api.utils.IdentityFunction

      +
      +No usage of org.apache.pulsar.functions.api.utils.IdentityFunction
      + +
      +
      + + diff --git a/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/utils/package-summary.html b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/utils/package-summary.html new file mode 100644 index 000000000000..415678737652 --- /dev/null +++ b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/utils/package-summary.html @@ -0,0 +1,120 @@ + + + + +org.apache.pulsar.functions.api.utils (Pulsar Functions :: API 4.0.0 API) + + + + + + + + + + + + + +
      + +
      +
      +
      +

      Package org.apache.pulsar.functions.api.utils

      +
      +
      +
      package org.apache.pulsar.functions.api.utils
      +
      +
      State Store API.
      +
      +
      + +
      +
      + +
      +
      + + diff --git a/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/utils/package-tree.html b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/utils/package-tree.html new file mode 100644 index 000000000000..68e7c8900e59 --- /dev/null +++ b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/utils/package-tree.html @@ -0,0 +1,78 @@ + + + + +org.apache.pulsar.functions.api.utils Class Hierarchy (Pulsar Functions :: API 4.0.0 API) + + + + + + + + + + + + + +
      + +
      +
      +
      +

      Hierarchy For Package org.apache.pulsar.functions.api.utils

      +
      +Package Hierarchies: + +
      +

      Class Hierarchy

      + +
      +
      + +
      +
      + + diff --git a/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/utils/package-use.html b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/utils/package-use.html new file mode 100644 index 000000000000..d2101af985be --- /dev/null +++ b/static/api/pulsar-functions/4.0.x/org/apache/pulsar/functions/api/utils/package-use.html @@ -0,0 +1,101 @@ + + + + +Uses of Package org.apache.pulsar.functions.api.utils (Pulsar Functions :: API 4.0.0 API) + + + + + + + + + + + + + +
      + +
      +
      +
      +

      Uses of Package
      org.apache.pulsar.functions.api.utils

      +
      +
      Packages that use org.apache.pulsar.functions.api.utils
      +
      +
      Package
      +
      Description
      +
      org.apache.pulsar.functions.api
      +
      +
      Provides a simple model for enabling lightweight computation on Apache Pulsar.
      +
      +
      org.apache.pulsar.functions.api.utils
      +
      +
      State Store API.
      +
      +
      +
      + +
      +
      + +
      +
      + + diff --git a/static/api/pulsar-functions/4.0.x/overview-summary.html b/static/api/pulsar-functions/4.0.x/overview-summary.html new file mode 100644 index 000000000000..d927aed25fa8 --- /dev/null +++ b/static/api/pulsar-functions/4.0.x/overview-summary.html @@ -0,0 +1,25 @@ + + + + +Pulsar Functions :: API 4.0.0 API + + + + + + + + + + +
      + +

      index.html

      +
      + + diff --git a/static/api/pulsar-functions/4.0.x/overview-tree.html b/static/api/pulsar-functions/4.0.x/overview-tree.html new file mode 100644 index 000000000000..a737e1111b9c --- /dev/null +++ b/static/api/pulsar-functions/4.0.x/overview-tree.html @@ -0,0 +1,111 @@ + + + + +Class Hierarchy (Pulsar Functions :: API 4.0.0 API) + + + + + + + + + + + + + +
      + +
      +
      +
      +

      Hierarchy For All Packages

      +
      +Package Hierarchies: + +
      +

      Class Hierarchy

      + +
      +
      +

      Interface Hierarchy

      + +
      +
      + +
      +
      + + diff --git a/static/api/pulsar-functions/4.0.x/package-search-index.js b/static/api/pulsar-functions/4.0.x/package-search-index.js new file mode 100644 index 000000000000..4eb765944d74 --- /dev/null +++ b/static/api/pulsar-functions/4.0.x/package-search-index.js @@ -0,0 +1 @@ +packageSearchIndex = [{"l":"All Packages","u":"allpackages-index.html"},{"l":"org.apache.pulsar.functions.api"},{"l":"org.apache.pulsar.functions.api.state"},{"l":"org.apache.pulsar.functions.api.utils"}];updateSearchResults(); \ No newline at end of file diff --git a/static/api/pulsar-functions/4.0.x/resources/glass.png b/static/api/pulsar-functions/4.0.x/resources/glass.png new file mode 100644 index 0000000000000000000000000000000000000000..a7f591f467a1c0c949bbc510156a0c1afb860a6e GIT binary patch literal 499 zcmVJoRsvExf%rEN>jUL}qZ_~k#FbE+Q;{`;0FZwVNX2n-^JoI; zP;4#$8DIy*Yk-P>VN(DUKmPse7mx+ExD4O|;?E5D0Z5($mjO3`*anwQU^s{ZDK#Lz zj>~{qyaIx5K!t%=G&2IJNzg!ChRpyLkO7}Ry!QaotAHAMpbB3AF(}|_f!G-oI|uK6 z`id_dumai5K%C3Y$;tKS_iqMPHg<*|-@e`liWLAggVM!zAP#@l;=c>S03;{#04Z~5 zN_+ss=Yg6*hTr59mzMwZ@+l~q!+?ft!fF66AXT#wWavHt30bZWFCK%!BNk}LN?0Hg z1VF_nfs`Lm^DjYZ1(1uD0u4CSIr)XAaqW6IT{!St5~1{i=i}zAy76p%_|w8rh@@c0Axr!ns=D-X+|*sY6!@wacG9%)Qn*O zl0sa739kT-&_?#oVxXF6tOnqTD)cZ}2vi$`ZU8RLAlo8=_z#*P3xI~i!lEh+Pdu-L zx{d*wgjtXbnGX_Yf@Tc7Q3YhLhPvc8noGJs2DA~1DySiA&6V{5JzFt ojAY1KXm~va;tU{v7C?Xj0BHw!K;2aXV*mgE07*qoM6N<$f;4TDA^-pY literal 0 HcmV?d00001 diff --git a/static/api/pulsar-functions/4.0.x/script-dir/jquery-3.6.1.min.js b/static/api/pulsar-functions/4.0.x/script-dir/jquery-3.6.1.min.js new file mode 100644 index 000000000000..2c69bc908b10 --- /dev/null +++ b/static/api/pulsar-functions/4.0.x/script-dir/jquery-3.6.1.min.js @@ -0,0 +1,2 @@ +/*! jQuery v3.6.1 | (c) OpenJS Foundation and other contributors | jquery.org/license */ +!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(C,e){"use strict";var t=[],r=Object.getPrototypeOf,s=t.slice,g=t.flat?function(e){return t.flat.call(e)}:function(e){return t.concat.apply([],e)},u=t.push,i=t.indexOf,n={},o=n.toString,y=n.hasOwnProperty,a=y.toString,l=a.call(Object),v={},m=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType&&"function"!=typeof e.item},x=function(e){return null!=e&&e===e.window},E=C.document,c={type:!0,src:!0,nonce:!0,noModule:!0};function b(e,t,n){var r,i,o=(n=n||E).createElement("script");if(o.text=e,t)for(r in c)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function w(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[o.call(e)]||"object":typeof e}var f="3.6.1",S=function(e,t){return new S.fn.init(e,t)};function p(e){var t=!!e&&"length"in e&&e.length,n=w(e);return!m(e)&&!x(e)&&("array"===n||0===t||"number"==typeof t&&0+~]|"+M+")"+M+"*"),U=new RegExp(M+"|>"),X=new RegExp(F),V=new RegExp("^"+I+"$"),G={ID:new RegExp("^#("+I+")"),CLASS:new RegExp("^\\.("+I+")"),TAG:new RegExp("^("+I+"|[*])"),ATTR:new RegExp("^"+W),PSEUDO:new RegExp("^"+F),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+R+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,Q=/^(?:input|select|textarea|button)$/i,J=/^h\d$/i,K=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\[\\da-fA-F]{1,6}"+M+"?|\\\\([^\\r\\n\\f])","g"),ne=function(e,t){var n="0x"+e.slice(1)-65536;return t||(n<0?String.fromCharCode(n+65536):String.fromCharCode(n>>10|55296,1023&n|56320))},re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},oe=function(){T()},ae=be(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{H.apply(t=O.call(p.childNodes),p.childNodes),t[p.childNodes.length].nodeType}catch(e){H={apply:t.length?function(e,t){L.apply(e,O.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&(T(e),e=e||C,E)){if(11!==p&&(u=Z.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&v(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return H.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&d.getElementsByClassName&&e.getElementsByClassName)return H.apply(n,e.getElementsByClassName(i)),n}if(d.qsa&&!N[t+" "]&&(!y||!y.test(t))&&(1!==p||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===p&&(U.test(t)||z.test(t))){(f=ee.test(t)&&ve(e.parentNode)||e)===e&&d.scope||((s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=S)),o=(l=h(t)).length;while(o--)l[o]=(s?"#"+s:":scope")+" "+xe(l[o]);c=l.join(",")}try{return H.apply(n,f.querySelectorAll(c)),n}catch(e){N(t,!0)}finally{s===S&&e.removeAttribute("id")}}}return g(t.replace(B,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[S]=!0,e}function ce(e){var t=C.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){var n=e.split("|"),r=n.length;while(r--)b.attrHandle[n[r]]=t}function pe(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function de(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ye(a){return le(function(o){return o=+o,le(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ve(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}for(e in d=se.support={},i=se.isXML=function(e){var t=e&&e.namespaceURI,n=e&&(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},T=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:p;return r!=C&&9===r.nodeType&&r.documentElement&&(a=(C=r).documentElement,E=!i(C),p!=C&&(n=C.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),d.scope=ce(function(e){return a.appendChild(e).appendChild(C.createElement("div")),"undefined"!=typeof e.querySelectorAll&&!e.querySelectorAll(":scope fieldset div").length}),d.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),d.getElementsByTagName=ce(function(e){return e.appendChild(C.createComment("")),!e.getElementsByTagName("*").length}),d.getElementsByClassName=K.test(C.getElementsByClassName),d.getById=ce(function(e){return a.appendChild(e).id=S,!C.getElementsByName||!C.getElementsByName(S).length}),d.getById?(b.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=d.getElementsByTagName?function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):d.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},b.find.CLASS=d.getElementsByClassName&&function(e,t){if("undefined"!=typeof t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],y=[],(d.qsa=K.test(C.querySelectorAll))&&(ce(function(e){var t;a.appendChild(e).innerHTML="",e.querySelectorAll("[msallowcapture^='']").length&&y.push("[*^$]="+M+"*(?:''|\"\")"),e.querySelectorAll("[selected]").length||y.push("\\["+M+"*(?:value|"+R+")"),e.querySelectorAll("[id~="+S+"-]").length||y.push("~="),(t=C.createElement("input")).setAttribute("name",""),e.appendChild(t),e.querySelectorAll("[name='']").length||y.push("\\["+M+"*name"+M+"*="+M+"*(?:''|\"\")"),e.querySelectorAll(":checked").length||y.push(":checked"),e.querySelectorAll("a#"+S+"+*").length||y.push(".#.+[+~]"),e.querySelectorAll("\\\f"),y.push("[\\r\\n\\f]")}),ce(function(e){e.innerHTML="";var t=C.createElement("input");t.setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),e.querySelectorAll("[name=d]").length&&y.push("name"+M+"*[*^$|!~]?="),2!==e.querySelectorAll(":enabled").length&&y.push(":enabled",":disabled"),a.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&y.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),y.push(",.*:")})),(d.matchesSelector=K.test(c=a.matches||a.webkitMatchesSelector||a.mozMatchesSelector||a.oMatchesSelector||a.msMatchesSelector))&&ce(function(e){d.disconnectedMatch=c.call(e,"*"),c.call(e,"[s!='']:x"),s.push("!=",F)}),y=y.length&&new RegExp(y.join("|")),s=s.length&&new RegExp(s.join("|")),t=K.test(a.compareDocumentPosition),v=t||K.test(a.contains)?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)while(t=t.parentNode)if(t===e)return!0;return!1},j=t?function(e,t){if(e===t)return l=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)==(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!d.sortDetached&&t.compareDocumentPosition(e)===n?e==C||e.ownerDocument==p&&v(p,e)?-1:t==C||t.ownerDocument==p&&v(p,t)?1:u?P(u,e)-P(u,t):0:4&n?-1:1)}:function(e,t){if(e===t)return l=!0,0;var n,r=0,i=e.parentNode,o=t.parentNode,a=[e],s=[t];if(!i||!o)return e==C?-1:t==C?1:i?-1:o?1:u?P(u,e)-P(u,t):0;if(i===o)return pe(e,t);n=e;while(n=n.parentNode)a.unshift(n);n=t;while(n=n.parentNode)s.unshift(n);while(a[r]===s[r])r++;return r?pe(a[r],s[r]):a[r]==p?-1:s[r]==p?1:0}),C},se.matches=function(e,t){return se(e,null,null,t)},se.matchesSelector=function(e,t){if(T(e),d.matchesSelector&&E&&!N[t+" "]&&(!s||!s.test(t))&&(!y||!y.test(t)))try{var n=c.call(e,t);if(n||d.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){N(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return G.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&X.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=m[e+" "];return t||(t=new RegExp("(^|"+M+")"+e+"("+M+"|$)"))&&m(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function j(e,n,r){return m(n)?S.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?S.grep(e,function(e){return e===n!==r}):"string"!=typeof n?S.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(S.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||D,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:q.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof S?t[0]:t,S.merge(this,S.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:E,!0)),N.test(r[1])&&S.isPlainObject(t))for(r in t)m(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=E.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):m(e)?void 0!==n.ready?n.ready(e):e(S):S.makeArray(e,this)}).prototype=S.fn,D=S(E);var L=/^(?:parents|prev(?:Until|All))/,H={children:!0,contents:!0,next:!0,prev:!0};function O(e,t){while((e=e[t])&&1!==e.nodeType);return e}S.fn.extend({has:function(e){var t=S(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,he=/^$|^module$|\/(?:java|ecma)script/i;ce=E.createDocumentFragment().appendChild(E.createElement("div")),(fe=E.createElement("input")).setAttribute("type","radio"),fe.setAttribute("checked","checked"),fe.setAttribute("name","t"),ce.appendChild(fe),v.checkClone=ce.cloneNode(!0).cloneNode(!0).lastChild.checked,ce.innerHTML="",v.noCloneChecked=!!ce.cloneNode(!0).lastChild.defaultValue,ce.innerHTML="",v.option=!!ce.lastChild;var ge={thead:[1,"","
      "],col:[2,"","
      "],tr:[2,"","
      "],td:[3,"","
      "],_default:[0,"",""]};function ye(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&A(e,t)?S.merge([e],n):n}function ve(e,t){for(var n=0,r=e.length;n",""]);var me=/<|&#?\w+;/;function xe(e,t,n,r,i){for(var o,a,s,u,l,c,f=t.createDocumentFragment(),p=[],d=0,h=e.length;d\s*$/g;function je(e,t){return A(e,"table")&&A(11!==t.nodeType?t:t.firstChild,"tr")&&S(e).children("tbody")[0]||e}function De(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function qe(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Le(e,t){var n,r,i,o,a,s;if(1===t.nodeType){if(Y.hasData(e)&&(s=Y.get(e).events))for(i in Y.remove(t,"handle events"),s)for(n=0,r=s[i].length;n").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),E.head.appendChild(r[0])},abort:function(){i&&i()}}});var Ut,Xt=[],Vt=/(=)\?(?=&|$)|\?\?/;S.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=Xt.pop()||S.expando+"_"+Ct.guid++;return this[e]=!0,e}}),S.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Vt.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Vt.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=m(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Vt,"$1"+r):!1!==e.jsonp&&(e.url+=(Et.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||S.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=C[r],C[r]=function(){o=arguments},n.always(function(){void 0===i?S(C).removeProp(r):C[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,Xt.push(r)),o&&m(i)&&i(o[0]),o=i=void 0}),"script"}),v.createHTMLDocument=((Ut=E.implementation.createHTMLDocument("").body).innerHTML="
      ",2===Ut.childNodes.length),S.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(v.createHTMLDocument?((r=(t=E.implementation.createHTMLDocument("")).createElement("base")).href=E.location.href,t.head.appendChild(r)):t=E),o=!n&&[],(i=N.exec(e))?[t.createElement(i[1])]:(i=xe([e],t,o),o&&o.length&&S(o).remove(),S.merge([],i.childNodes)));var r,i,o},S.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(S.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},S.expr.pseudos.animated=function(t){return S.grep(S.timers,function(e){return t===e.elem}).length},S.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=S.css(e,"position"),c=S(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=S.css(e,"top"),u=S.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),m(t)&&(t=t.call(e,n,S.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):c.css(f)}},S.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){S.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===S.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===S.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=S(e).offset()).top+=S.css(e,"borderTopWidth",!0),i.left+=S.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-S.css(r,"marginTop",!0),left:t.left-i.left-S.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===S.css(e,"position"))e=e.offsetParent;return e||re})}}),S.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;S.fn[t]=function(e){return B(this,function(e,t,n){var r;if(x(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),S.each(["top","left"],function(e,n){S.cssHooks[n]=_e(v.pixelPosition,function(e,t){if(t)return t=Be(e,n),Pe.test(t)?S(e).position()[n]+"px":t})}),S.each({Height:"height",Width:"width"},function(a,s){S.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){S.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return B(this,function(e,t,n){var r;return x(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?S.css(e,t,i):S.style(e,t,n,i)},s,n?e:void 0,n)}})}),S.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){S.fn[t]=function(e){return this.on(t,e)}}),S.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)},hover:function(e,t){return this.mouseenter(e).mouseleave(t||e)}}),S.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){S.fn[n]=function(e,t){return 0",options:{classes:{},disabled:!1,create:null},_createWidget:function(t,e){e=x(e||this.defaultElement||this)[0],this.element=x(e),this.uuid=i++,this.eventNamespace="."+this.widgetName+this.uuid,this.bindings=x(),this.hoverable=x(),this.focusable=x(),this.classesElementLookup={},e!==this&&(x.data(e,this.widgetFullName,this),this._on(!0,this.element,{remove:function(t){t.target===e&&this.destroy()}}),this.document=x(e.style?e.ownerDocument:e.document||e),this.window=x(this.document[0].defaultView||this.document[0].parentWindow)),this.options=x.widget.extend({},this.options,this._getCreateOptions(),t),this._create(),this.options.disabled&&this._setOptionDisabled(this.options.disabled),this._trigger("create",null,this._getCreateEventData()),this._init()},_getCreateOptions:function(){return{}},_getCreateEventData:x.noop,_create:x.noop,_init:x.noop,destroy:function(){var i=this;this._destroy(),x.each(this.classesElementLookup,function(t,e){i._removeClass(e,t)}),this.element.off(this.eventNamespace).removeData(this.widgetFullName),this.widget().off(this.eventNamespace).removeAttr("aria-disabled"),this.bindings.off(this.eventNamespace)},_destroy:x.noop,widget:function(){return this.element},option:function(t,e){var i,s,n,o=t;if(0===arguments.length)return x.widget.extend({},this.options);if("string"==typeof t)if(o={},t=(i=t.split(".")).shift(),i.length){for(s=o[t]=x.widget.extend({},this.options[t]),n=0;n
      "),i=e.children()[0];return x("body").append(e),t=i.offsetWidth,e.css("overflow","scroll"),t===(i=i.offsetWidth)&&(i=e[0].clientWidth),e.remove(),s=t-i},getScrollInfo:function(t){var e=t.isWindow||t.isDocument?"":t.element.css("overflow-x"),i=t.isWindow||t.isDocument?"":t.element.css("overflow-y"),e="scroll"===e||"auto"===e&&t.widthC(E(s),E(n))?o.important="horizontal":o.important="vertical",c.using.call(this,t,o)}),l.offset(x.extend(u,{using:t}))})},x.ui.position={fit:{left:function(t,e){var i=e.within,s=i.isWindow?i.scrollLeft:i.offset.left,n=i.width,o=t.left-e.collisionPosition.marginLeft,l=s-o,a=o+e.collisionWidth-n-s;e.collisionWidth>n?0n?0",delay:300,options:{icons:{submenu:"ui-icon-caret-1-e"},items:"> *",menus:"ul",position:{my:"left top",at:"right top"},role:"menu",blur:null,focus:null,select:null},_create:function(){this.activeMenu=this.element,this.mouseHandled=!1,this.lastMousePosition={x:null,y:null},this.element.uniqueId().attr({role:this.options.role,tabIndex:0}),this._addClass("ui-menu","ui-widget ui-widget-content"),this._on({"mousedown .ui-menu-item":function(t){t.preventDefault(),this._activateItem(t)},"click .ui-menu-item":function(t){var e=x(t.target),i=x(x.ui.safeActiveElement(this.document[0]));!this.mouseHandled&&e.not(".ui-state-disabled").length&&(this.select(t),t.isPropagationStopped()||(this.mouseHandled=!0),e.has(".ui-menu").length?this.expand(t):!this.element.is(":focus")&&i.closest(".ui-menu").length&&(this.element.trigger("focus",[!0]),this.active&&1===this.active.parents(".ui-menu").length&&clearTimeout(this.timer)))},"mouseenter .ui-menu-item":"_activateItem","mousemove .ui-menu-item":"_activateItem",mouseleave:"collapseAll","mouseleave .ui-menu":"collapseAll",focus:function(t,e){var i=this.active||this._menuItems().first();e||this.focus(t,i)},blur:function(t){this._delay(function(){x.contains(this.element[0],x.ui.safeActiveElement(this.document[0]))||this.collapseAll(t)})},keydown:"_keydown"}),this.refresh(),this._on(this.document,{click:function(t){this._closeOnDocumentClick(t)&&this.collapseAll(t,!0),this.mouseHandled=!1}})},_activateItem:function(t){var e,i;this.previousFilter||t.clientX===this.lastMousePosition.x&&t.clientY===this.lastMousePosition.y||(this.lastMousePosition={x:t.clientX,y:t.clientY},e=x(t.target).closest(".ui-menu-item"),i=x(t.currentTarget),e[0]===i[0]&&(i.is(".ui-state-active")||(this._removeClass(i.siblings().children(".ui-state-active"),null,"ui-state-active"),this.focus(t,i))))},_destroy:function(){var t=this.element.find(".ui-menu-item").removeAttr("role aria-disabled").children(".ui-menu-item-wrapper").removeUniqueId().removeAttr("tabIndex role aria-haspopup");this.element.removeAttr("aria-activedescendant").find(".ui-menu").addBack().removeAttr("role aria-labelledby aria-expanded aria-hidden aria-disabled tabIndex").removeUniqueId().show(),t.children().each(function(){var t=x(this);t.data("ui-menu-submenu-caret")&&t.remove()})},_keydown:function(t){var e,i,s,n=!0;switch(t.keyCode){case x.ui.keyCode.PAGE_UP:this.previousPage(t);break;case x.ui.keyCode.PAGE_DOWN:this.nextPage(t);break;case x.ui.keyCode.HOME:this._move("first","first",t);break;case x.ui.keyCode.END:this._move("last","last",t);break;case x.ui.keyCode.UP:this.previous(t);break;case x.ui.keyCode.DOWN:this.next(t);break;case x.ui.keyCode.LEFT:this.collapse(t);break;case x.ui.keyCode.RIGHT:this.active&&!this.active.is(".ui-state-disabled")&&this.expand(t);break;case x.ui.keyCode.ENTER:case x.ui.keyCode.SPACE:this._activate(t);break;case x.ui.keyCode.ESCAPE:this.collapse(t);break;default:e=this.previousFilter||"",s=n=!1,i=96<=t.keyCode&&t.keyCode<=105?(t.keyCode-96).toString():String.fromCharCode(t.keyCode),clearTimeout(this.filterTimer),i===e?s=!0:i=e+i,e=this._filterMenuItems(i),(e=s&&-1!==e.index(this.active.next())?this.active.nextAll(".ui-menu-item"):e).length||(i=String.fromCharCode(t.keyCode),e=this._filterMenuItems(i)),e.length?(this.focus(t,e),this.previousFilter=i,this.filterTimer=this._delay(function(){delete this.previousFilter},1e3)):delete this.previousFilter}n&&t.preventDefault()},_activate:function(t){this.active&&!this.active.is(".ui-state-disabled")&&(this.active.children("[aria-haspopup='true']").length?this.expand(t):this.select(t))},refresh:function(){var t,e,s=this,n=this.options.icons.submenu,i=this.element.find(this.options.menus);this._toggleClass("ui-menu-icons",null,!!this.element.find(".ui-icon").length),e=i.filter(":not(.ui-menu)").hide().attr({role:this.options.role,"aria-hidden":"true","aria-expanded":"false"}).each(function(){var t=x(this),e=t.prev(),i=x("").data("ui-menu-submenu-caret",!0);s._addClass(i,"ui-menu-icon","ui-icon "+n),e.attr("aria-haspopup","true").prepend(i),t.attr("aria-labelledby",e.attr("id"))}),this._addClass(e,"ui-menu","ui-widget ui-widget-content ui-front"),(t=i.add(this.element).find(this.options.items)).not(".ui-menu-item").each(function(){var t=x(this);s._isDivider(t)&&s._addClass(t,"ui-menu-divider","ui-widget-content")}),i=(e=t.not(".ui-menu-item, .ui-menu-divider")).children().not(".ui-menu").uniqueId().attr({tabIndex:-1,role:this._itemRole()}),this._addClass(e,"ui-menu-item")._addClass(i,"ui-menu-item-wrapper"),t.filter(".ui-state-disabled").attr("aria-disabled","true"),this.active&&!x.contains(this.element[0],this.active[0])&&this.blur()},_itemRole:function(){return{menu:"menuitem",listbox:"option"}[this.options.role]},_setOption:function(t,e){var i;"icons"===t&&(i=this.element.find(".ui-menu-icon"),this._removeClass(i,null,this.options.icons.submenu)._addClass(i,null,e.submenu)),this._super(t,e)},_setOptionDisabled:function(t){this._super(t),this.element.attr("aria-disabled",String(t)),this._toggleClass(null,"ui-state-disabled",!!t)},focus:function(t,e){var i;this.blur(t,t&&"focus"===t.type),this._scrollIntoView(e),this.active=e.first(),i=this.active.children(".ui-menu-item-wrapper"),this._addClass(i,null,"ui-state-active"),this.options.role&&this.element.attr("aria-activedescendant",i.attr("id")),i=this.active.parent().closest(".ui-menu-item").children(".ui-menu-item-wrapper"),this._addClass(i,null,"ui-state-active"),t&&"keydown"===t.type?this._close():this.timer=this._delay(function(){this._close()},this.delay),(i=e.children(".ui-menu")).length&&t&&/^mouse/.test(t.type)&&this._startOpening(i),this.activeMenu=e.parent(),this._trigger("focus",t,{item:e})},_scrollIntoView:function(t){var e,i,s;this._hasScroll()&&(i=parseFloat(x.css(this.activeMenu[0],"borderTopWidth"))||0,s=parseFloat(x.css(this.activeMenu[0],"paddingTop"))||0,e=t.offset().top-this.activeMenu.offset().top-i-s,i=this.activeMenu.scrollTop(),s=this.activeMenu.height(),t=t.outerHeight(),e<0?this.activeMenu.scrollTop(i+e):s",options:{appendTo:null,autoFocus:!1,delay:300,minLength:1,position:{my:"left top",at:"left bottom",collision:"none"},source:null,change:null,close:null,focus:null,open:null,response:null,search:null,select:null},requestIndex:0,pending:0,liveRegionTimer:null,_create:function(){var i,s,n,t=this.element[0].nodeName.toLowerCase(),e="textarea"===t,t="input"===t;this.isMultiLine=e||!t&&this._isContentEditable(this.element),this.valueMethod=this.element[e||t?"val":"text"],this.isNewMenu=!0,this._addClass("ui-autocomplete-input"),this.element.attr("autocomplete","off"),this._on(this.element,{keydown:function(t){if(this.element.prop("readOnly"))s=n=i=!0;else{s=n=i=!1;var e=x.ui.keyCode;switch(t.keyCode){case e.PAGE_UP:i=!0,this._move("previousPage",t);break;case e.PAGE_DOWN:i=!0,this._move("nextPage",t);break;case e.UP:i=!0,this._keyEvent("previous",t);break;case e.DOWN:i=!0,this._keyEvent("next",t);break;case e.ENTER:this.menu.active&&(i=!0,t.preventDefault(),this.menu.select(t));break;case e.TAB:this.menu.active&&this.menu.select(t);break;case e.ESCAPE:this.menu.element.is(":visible")&&(this.isMultiLine||this._value(this.term),this.close(t),t.preventDefault());break;default:s=!0,this._searchTimeout(t)}}},keypress:function(t){if(i)return i=!1,void(this.isMultiLine&&!this.menu.element.is(":visible")||t.preventDefault());if(!s){var e=x.ui.keyCode;switch(t.keyCode){case e.PAGE_UP:this._move("previousPage",t);break;case e.PAGE_DOWN:this._move("nextPage",t);break;case e.UP:this._keyEvent("previous",t);break;case e.DOWN:this._keyEvent("next",t)}}},input:function(t){if(n)return n=!1,void t.preventDefault();this._searchTimeout(t)},focus:function(){this.selectedItem=null,this.previous=this._value()},blur:function(t){clearTimeout(this.searching),this.close(t),this._change(t)}}),this._initSource(),this.menu=x("
        ").appendTo(this._appendTo()).menu({role:null}).hide().attr({unselectable:"on"}).menu("instance"),this._addClass(this.menu.element,"ui-autocomplete","ui-front"),this._on(this.menu.element,{mousedown:function(t){t.preventDefault()},menufocus:function(t,e){var i,s;if(this.isNewMenu&&(this.isNewMenu=!1,t.originalEvent&&/^mouse/.test(t.originalEvent.type)))return this.menu.blur(),void this.document.one("mousemove",function(){x(t.target).trigger(t.originalEvent)});s=e.item.data("ui-autocomplete-item"),!1!==this._trigger("focus",t,{item:s})&&t.originalEvent&&/^key/.test(t.originalEvent.type)&&this._value(s.value),(i=e.item.attr("aria-label")||s.value)&&String.prototype.trim.call(i).length&&(clearTimeout(this.liveRegionTimer),this.liveRegionTimer=this._delay(function(){this.liveRegion.html(x("
        ").text(i))},100))},menuselect:function(t,e){var i=e.item.data("ui-autocomplete-item"),s=this.previous;this.element[0]!==x.ui.safeActiveElement(this.document[0])&&(this.element.trigger("focus"),this.previous=s,this._delay(function(){this.previous=s,this.selectedItem=i})),!1!==this._trigger("select",t,{item:i})&&this._value(i.value),this.term=this._value(),this.close(t),this.selectedItem=i}}),this.liveRegion=x("
        ",{role:"status","aria-live":"assertive","aria-relevant":"additions"}).appendTo(this.document[0].body),this._addClass(this.liveRegion,null,"ui-helper-hidden-accessible"),this._on(this.window,{beforeunload:function(){this.element.removeAttr("autocomplete")}})},_destroy:function(){clearTimeout(this.searching),this.element.removeAttr("autocomplete"),this.menu.element.remove(),this.liveRegion.remove()},_setOption:function(t,e){this._super(t,e),"source"===t&&this._initSource(),"appendTo"===t&&this.menu.element.appendTo(this._appendTo()),"disabled"===t&&e&&this.xhr&&this.xhr.abort()},_isEventTargetInWidget:function(t){var e=this.menu.element[0];return t.target===this.element[0]||t.target===e||x.contains(e,t.target)},_closeOnClickOutside:function(t){this._isEventTargetInWidget(t)||this.close()},_appendTo:function(){var t=this.options.appendTo;return t=!(t=!(t=t&&(t.jquery||t.nodeType?x(t):this.document.find(t).eq(0)))||!t[0]?this.element.closest(".ui-front, dialog"):t).length?this.document[0].body:t},_initSource:function(){var i,s,n=this;Array.isArray(this.options.source)?(i=this.options.source,this.source=function(t,e){e(x.ui.autocomplete.filter(i,t.term))}):"string"==typeof this.options.source?(s=this.options.source,this.source=function(t,e){n.xhr&&n.xhr.abort(),n.xhr=x.ajax({url:s,data:t,dataType:"json",success:function(t){e(t)},error:function(){e([])}})}):this.source=this.options.source},_searchTimeout:function(s){clearTimeout(this.searching),this.searching=this._delay(function(){var t=this.term===this._value(),e=this.menu.element.is(":visible"),i=s.altKey||s.ctrlKey||s.metaKey||s.shiftKey;t&&(e||i)||(this.selectedItem=null,this.search(null,s))},this.options.delay)},search:function(t,e){return t=null!=t?t:this._value(),this.term=this._value(),t.length").append(x("
        ").text(e.label)).appendTo(t)},_move:function(t,e){if(this.menu.element.is(":visible"))return this.menu.isFirstItem()&&/^previous/.test(t)||this.menu.isLastItem()&&/^next/.test(t)?(this.isMultiLine||this._value(this.term),void this.menu.blur()):void this.menu[t](e);this.search(null,e)},widget:function(){return this.menu.element},_value:function(){return this.valueMethod.apply(this.element,arguments)},_keyEvent:function(t,e){this.isMultiLine&&!this.menu.element.is(":visible")||(this._move(t,e),e.preventDefault())},_isContentEditable:function(t){if(!t.length)return!1;var e=t.prop("contentEditable");return"inherit"===e?this._isContentEditable(t.parent()):"true"===e}}),x.extend(x.ui.autocomplete,{escapeRegex:function(t){return t.replace(/[\-\[\]{}()*+?.,\\\^$|#\s]/g,"\\$&")},filter:function(t,e){var i=new RegExp(x.ui.autocomplete.escapeRegex(e),"i");return x.grep(t,function(t){return i.test(t.label||t.value||t)})}}),x.widget("ui.autocomplete",x.ui.autocomplete,{options:{messages:{noResults:"No search results.",results:function(t){return t+(1").text(e))},100))}});x.ui.autocomplete}); \ No newline at end of file diff --git a/static/api/pulsar-functions/4.0.x/script.js b/static/api/pulsar-functions/4.0.x/script.js new file mode 100644 index 000000000000..bb9c8a2415d3 --- /dev/null +++ b/static/api/pulsar-functions/4.0.x/script.js @@ -0,0 +1,253 @@ +/* + * Copyright (c) 2013, 2023, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the LICENSE file that accompanied this code. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +var moduleSearchIndex; +var packageSearchIndex; +var typeSearchIndex; +var memberSearchIndex; +var tagSearchIndex; + +var oddRowColor = "odd-row-color"; +var evenRowColor = "even-row-color"; +var sortAsc = "sort-asc"; +var sortDesc = "sort-desc"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; + +function loadScripts(doc, tag) { + createElem(doc, tag, 'search.js'); + + createElem(doc, tag, 'module-search-index.js'); + createElem(doc, tag, 'package-search-index.js'); + createElem(doc, tag, 'type-search-index.js'); + createElem(doc, tag, 'member-search-index.js'); + createElem(doc, tag, 'tag-search-index.js'); +} + +function createElem(doc, tag, path) { + var script = doc.createElement(tag); + var scriptElement = doc.getElementsByTagName(tag)[0]; + script.src = pathtoroot + path; + scriptElement.parentNode.insertBefore(script, scriptElement); +} + +// Helper for making content containing release names comparable lexicographically +function makeComparable(s) { + return s.toLowerCase().replace(/(\d+)/g, + function(n, m) { + return ("000" + m).slice(-4); + }); +} + +// Switches between two styles depending on a condition +function toggleStyle(classList, condition, trueStyle, falseStyle) { + if (condition) { + classList.remove(falseStyle); + classList.add(trueStyle); + } else { + classList.remove(trueStyle); + classList.add(falseStyle); + } +} + +// Sorts the rows in a table lexicographically by the content of a specific column +function sortTable(header, columnIndex, columns) { + var container = header.parentElement; + var descending = header.classList.contains(sortAsc); + container.querySelectorAll("div.table-header").forEach( + function(header) { + header.classList.remove(sortAsc); + header.classList.remove(sortDesc); + } + ) + var cells = container.children; + var rows = []; + for (var i = columns; i < cells.length; i += columns) { + rows.push(Array.prototype.slice.call(cells, i, i + columns)); + } + var comparator = function(a, b) { + var ka = makeComparable(a[columnIndex].textContent); + var kb = makeComparable(b[columnIndex].textContent); + if (ka < kb) + return descending ? 1 : -1; + if (ka > kb) + return descending ? -1 : 1; + return 0; + }; + var sorted = rows.sort(comparator); + var visible = 0; + sorted.forEach(function(row) { + if (row[0].style.display !== 'none') { + var isEvenRow = visible++ % 2 === 0; + } + row.forEach(function(cell) { + toggleStyle(cell.classList, isEvenRow, evenRowColor, oddRowColor); + container.appendChild(cell); + }) + }); + toggleStyle(header.classList, descending, sortDesc, sortAsc); +} + +// Toggles the visibility of a table category in all tables in a page +function toggleGlobal(checkbox, selected, columns) { + var display = checkbox.checked ? '' : 'none'; + document.querySelectorAll("div.table-tabs").forEach(function(t) { + var id = t.parentElement.getAttribute("id"); + var selectedClass = id + "-tab" + selected; + // if selected is empty string it selects all uncategorized entries + var selectUncategorized = !Boolean(selected); + var visible = 0; + document.querySelectorAll('div.' + id) + .forEach(function(elem) { + if (selectUncategorized) { + if (elem.className.indexOf(selectedClass) === -1) { + elem.style.display = display; + } + } else if (elem.classList.contains(selectedClass)) { + elem.style.display = display; + } + if (elem.style.display === '') { + var isEvenRow = visible++ % (columns * 2) < columns; + toggleStyle(elem.classList, isEvenRow, evenRowColor, oddRowColor); + } + }); + var displaySection = visible === 0 ? 'none' : ''; + t.parentElement.style.display = displaySection; + document.querySelector("li#contents-" + id).style.display = displaySection; + }) +} + +// Shows the elements of a table belonging to a specific category +function show(tableId, selected, columns) { + if (tableId !== selected) { + document.querySelectorAll('div.' + tableId + ':not(.' + selected + ')') + .forEach(function(elem) { + elem.style.display = 'none'; + }); + } + document.querySelectorAll('div.' + selected) + .forEach(function(elem, index) { + elem.style.display = ''; + var isEvenRow = index % (columns * 2) < columns; + toggleStyle(elem.classList, isEvenRow, evenRowColor, oddRowColor); + }); + updateTabs(tableId, selected); +} + +function updateTabs(tableId, selected) { + document.getElementById(tableId + '.tabpanel') + .setAttribute('aria-labelledby', selected); + document.querySelectorAll('button[id^="' + tableId + '"]') + .forEach(function(tab, index) { + if (selected === tab.id || (tableId === selected && index === 0)) { + tab.className = activeTableTab; + tab.setAttribute('aria-selected', true); + tab.setAttribute('tabindex',0); + } else { + tab.className = tableTab; + tab.setAttribute('aria-selected', false); + tab.setAttribute('tabindex',-1); + } + }); +} + +function switchTab(e) { + var selected = document.querySelector('[aria-selected=true]'); + if (selected) { + if ((e.keyCode === 37 || e.keyCode === 38) && selected.previousSibling) { + // left or up arrow key pressed: move focus to previous tab + selected.previousSibling.click(); + selected.previousSibling.focus(); + e.preventDefault(); + } else if ((e.keyCode === 39 || e.keyCode === 40) && selected.nextSibling) { + // right or down arrow key pressed: move focus to next tab + selected.nextSibling.click(); + selected.nextSibling.focus(); + e.preventDefault(); + } + } +} + +var updateSearchResults = function() {}; + +function indexFilesLoaded() { + return moduleSearchIndex + && packageSearchIndex + && typeSearchIndex + && memberSearchIndex + && tagSearchIndex; +} +// Copy the contents of the local snippet to the clipboard +function copySnippet(button) { + copyToClipboard(button.nextElementSibling.innerText); + switchCopyLabel(button, button.firstElementChild); +} +function copyToClipboard(content) { + var textarea = document.createElement("textarea"); + textarea.style.height = 0; + document.body.appendChild(textarea); + textarea.value = content; + textarea.select(); + document.execCommand("copy"); + document.body.removeChild(textarea); +} +function switchCopyLabel(button, span) { + var copied = span.getAttribute("data-copied"); + button.classList.add("visible"); + var initialLabel = span.innerHTML; + span.innerHTML = copied; + setTimeout(function() { + button.classList.remove("visible"); + setTimeout(function() { + if (initialLabel !== copied) { + span.innerHTML = initialLabel; + } + }, 100); + }, 1900); +} +// Workaround for scroll position not being included in browser history (8249133) +document.addEventListener("DOMContentLoaded", function(e) { + var contentDiv = document.querySelector("div.flex-content"); + window.addEventListener("popstate", function(e) { + if (e.state !== null) { + contentDiv.scrollTop = e.state; + } + }); + window.addEventListener("hashchange", function(e) { + history.replaceState(contentDiv.scrollTop, document.title); + }); + var timeoutId; + contentDiv.addEventListener("scroll", function(e) { + if (timeoutId) { + clearTimeout(timeoutId); + } + timeoutId = setTimeout(function() { + history.replaceState(contentDiv.scrollTop, document.title); + }, 100); + }); + if (!location.hash) { + history.replaceState(contentDiv.scrollTop, document.title); + } +}); diff --git a/static/api/pulsar-functions/4.0.x/search-page.js b/static/api/pulsar-functions/4.0.x/search-page.js new file mode 100644 index 000000000000..540c90f57c52 --- /dev/null +++ b/static/api/pulsar-functions/4.0.x/search-page.js @@ -0,0 +1,284 @@ +/* + * Copyright (c) 2022, 2023, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the LICENSE file that accompanied this code. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +"use strict"; +$(function() { + var copy = $("#page-search-copy"); + var expand = $("#page-search-expand"); + var searchLink = $("span#page-search-link"); + var redirect = $("input#search-redirect"); + function setSearchUrlTemplate() { + var href = document.location.href.split(/[#?]/)[0]; + href += "?q=" + "%s"; + if (redirect.is(":checked")) { + href += "&r=1"; + } + searchLink.html(href); + copy[0].onmouseenter(); + } + function copyLink(e) { + copyToClipboard(this.previousSibling.innerText); + switchCopyLabel(this, this.lastElementChild); + } + copy.click(copyLink); + copy[0].onmouseenter = function() {}; + redirect.click(setSearchUrlTemplate); + setSearchUrlTemplate(); + copy.prop("disabled", false); + redirect.prop("disabled", false); + expand.click(function (e) { + var searchInfo = $("div.page-search-info"); + if(this.parentElement.hasAttribute("open")) { + searchInfo.attr("style", "border-width: 0;"); + } else { + searchInfo.attr("style", "border-width: 1px;").height(searchInfo.prop("scrollHeight")); + } + }); +}); +$(window).on("load", function() { + var input = $("#page-search-input"); + var reset = $("#page-search-reset"); + var notify = $("#page-search-notify"); + var resultSection = $("div#result-section"); + var resultContainer = $("div#result-container"); + var searchTerm = ""; + var activeTab = ""; + var fixedTab = false; + var visibleTabs = []; + var feelingLucky = false; + function renderResults(result) { + if (!result.length) { + notify.html(messages.noResult); + } else if (result.length === 1) { + notify.html(messages.oneResult); + } else { + notify.html(messages.manyResults.replace("{0}", result.length)); + } + resultContainer.empty(); + var r = { + "types": [], + "members": [], + "packages": [], + "modules": [], + "searchTags": [] + }; + for (var i in result) { + var item = result[i]; + var arr = r[item.category]; + arr.push(item); + } + if (!activeTab || r[activeTab].length === 0 || !fixedTab) { + Object.keys(r).reduce(function(prev, curr) { + if (r[curr].length > 0 && r[curr][0].score > prev) { + activeTab = curr; + return r[curr][0].score; + } + return prev; + }, 0); + } + if (feelingLucky && activeTab) { + notify.html(messages.redirecting) + var firstItem = r[activeTab][0]; + window.location = getURL(firstItem.indexItem, firstItem.category); + return; + } + if (result.length > 20) { + if (searchTerm[searchTerm.length - 1] === ".") { + if (activeTab === "types" && r["members"].length > r["types"].length) { + activeTab = "members"; + } else if (activeTab === "packages" && r["types"].length > r["packages"].length) { + activeTab = "types"; + } + } + } + var categoryCount = Object.keys(r).reduce(function(prev, curr) { + return prev + (r[curr].length > 0 ? 1 : 0); + }, 0); + visibleTabs = []; + var tabContainer = $("
        ").appendTo(resultContainer); + for (var key in r) { + var id = "#result-tab-" + key.replace("searchTags", "search_tags"); + if (r[key].length) { + var count = r[key].length >= 1000 ? "999+" : r[key].length; + if (result.length > 20 && categoryCount > 1) { + var button = $("").appendTo(tabContainer); + button.click(key, function(e) { + fixedTab = true; + renderResult(e.data, $(this)); + }); + visibleTabs.push(key); + } else { + $("" + categories[key] + + " (" + count + ")").appendTo(tabContainer); + renderTable(key, r[key]).appendTo(resultContainer); + tabContainer = $("
        ").appendTo(resultContainer); + + } + } + } + if (activeTab && result.length > 20 && categoryCount > 1) { + $("button#result-tab-" + activeTab).addClass("active-table-tab"); + renderTable(activeTab, r[activeTab]).appendTo(resultContainer); + } + resultSection.show(); + function renderResult(category, button) { + activeTab = category; + setSearchUrl(); + resultContainer.find("div.summary-table").remove(); + renderTable(activeTab, r[activeTab]).appendTo(resultContainer); + button.siblings().removeClass("active-table-tab"); + button.addClass("active-table-tab"); + } + } + function selectTab(category) { + $("button#result-tab-" + category).click(); + } + function renderTable(category, items) { + var table = $("
        ") + .addClass(category === "modules" + ? "one-column-search-results" + : "two-column-search-results"); + var col1, col2; + if (category === "modules") { + col1 = "Module"; + } else if (category === "packages") { + col1 = "Module"; + col2 = "Package"; + } else if (category === "types") { + col1 = "Package"; + col2 = "Class" + } else if (category === "members") { + col1 = "Class"; + col2 = "Member"; + } else if (category === "searchTags") { + col1 = "Location"; + col2 = "Name"; + } + $("
        " + col1 + "
        ").appendTo(table); + if (category !== "modules") { + $("
        " + col2 + "
        ").appendTo(table); + } + $.each(items, function(index, item) { + var rowColor = index % 2 ? "odd-row-color" : "even-row-color"; + renderItem(item, table, rowColor); + }); + return table; + } + function renderItem(item, table, rowColor) { + var label = getHighlightedText(item.input, item.boundaries, item.prefix.length, item.input.length); + var link = $("") + .attr("href", getURL(item.indexItem, item.category)) + .attr("tabindex", "0") + .addClass("search-result-link") + .html(label); + var container = getHighlightedText(item.input, item.boundaries, 0, item.prefix.length - 1); + if (item.category === "searchTags") { + container = item.indexItem.h || ""; + } + if (item.category !== "modules") { + $("
        ").html(container).addClass("col-plain").addClass(rowColor).appendTo(table); + } + $("
        ").html(link).addClass("col-last").addClass(rowColor).appendTo(table); + } + var timeout; + function schedulePageSearch() { + if (timeout) { + clearTimeout(timeout); + } + timeout = setTimeout(function () { + doPageSearch() + }, 100); + } + function doPageSearch() { + setSearchUrl(); + var term = searchTerm = input.val().trim(); + if (term === "") { + notify.html(messages.enterTerm); + activeTab = ""; + fixedTab = false; + resultContainer.empty(); + resultSection.hide(); + } else { + notify.html(messages.searching); + doSearch({ term: term, maxResults: 1200 }, renderResults); + } + } + function setSearchUrl() { + var query = input.val().trim(); + var url = document.location.pathname; + if (query) { + url += "?q=" + encodeURI(query); + if (activeTab && fixedTab) { + url += "&c=" + activeTab; + } + } + history.replaceState({query: query}, "", url); + } + input.on("input", function(e) { + feelingLucky = false; + schedulePageSearch(); + }); + $(document).keydown(function(e) { + if ((e.ctrlKey || e.metaKey) && (e.key === "ArrowLeft" || e.key === "ArrowRight")) { + if (activeTab && visibleTabs.length > 1) { + var idx = visibleTabs.indexOf(activeTab); + idx += e.key === "ArrowLeft" ? visibleTabs.length - 1 : 1; + selectTab(visibleTabs[idx % visibleTabs.length]); + return false; + } + } + }); + reset.click(function() { + notify.html(messages.enterTerm); + resultSection.hide(); + activeTab = ""; + fixedTab = false; + resultContainer.empty(); + input.val('').focus(); + setSearchUrl(); + }); + input.prop("disabled", false); + reset.prop("disabled", false); + + var urlParams = new URLSearchParams(window.location.search); + if (urlParams.has("q")) { + input.val(urlParams.get("q")) + } + if (urlParams.has("c")) { + activeTab = urlParams.get("c"); + fixedTab = true; + } + if (urlParams.get("r")) { + feelingLucky = true; + } + if (input.val()) { + doPageSearch(); + } else { + notify.html(messages.enterTerm); + } + input.select().focus(); +}); diff --git a/static/api/pulsar-functions/4.0.x/search.html b/static/api/pulsar-functions/4.0.x/search.html new file mode 100644 index 000000000000..e95c2e3c34a2 --- /dev/null +++ b/static/api/pulsar-functions/4.0.x/search.html @@ -0,0 +1,77 @@ + + + + +Search (Pulsar Functions :: API 4.0.0 API) + + + + + + + + + + + + + +
        + +
        +
        +

        Search

        +
        + + +
        +Additional resources +
        +
        +
        +

        The help page provides an introduction to the scope and syntax of JavaDoc search.

        +

        You can use the <ctrl> or <cmd> keys in combination with the left and right arrow keys to switch between result tabs in this page.

        +

        The URL template below may be used to configure this page as a search engine in browsers that support this feature. It has been tested to work in Google Chrome and Mozilla Firefox. Note that other browsers may not support this feature or require a different URL format.

        +link +

        + +

        +
        +

        Loading search index...

        + +
        + +
        +
        + + diff --git a/static/api/pulsar-functions/4.0.x/search.js b/static/api/pulsar-functions/4.0.x/search.js new file mode 100644 index 000000000000..d3986705ef22 --- /dev/null +++ b/static/api/pulsar-functions/4.0.x/search.js @@ -0,0 +1,458 @@ +/* + * Copyright (c) 2015, 2023, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the LICENSE file that accompanied this code. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ +"use strict"; +const messages = { + enterTerm: "Enter a search term", + noResult: "No results found", + oneResult: "Found one result", + manyResults: "Found {0} results", + loading: "Loading search index...", + searching: "Searching...", + redirecting: "Redirecting to first result...", + linkIcon: "Link icon", + linkToSection: "Link to this section" +} +const categories = { + modules: "Modules", + packages: "Packages", + types: "Classes and Interfaces", + members: "Members", + searchTags: "Search Tags" +}; +const highlight = "$&"; +const NO_MATCH = {}; +const MAX_RESULTS = 300; +function checkUnnamed(name, separator) { + return name === "" || !name ? "" : name + separator; +} +function escapeHtml(str) { + return str.replace(//g, ">"); +} +function getHighlightedText(str, boundaries, from, to) { + var start = from; + var text = ""; + for (var i = 0; i < boundaries.length; i += 2) { + var b0 = boundaries[i]; + var b1 = boundaries[i + 1]; + if (b0 >= to || b1 <= from) { + continue; + } + text += escapeHtml(str.slice(start, Math.max(start, b0))); + text += ""; + text += escapeHtml(str.slice(Math.max(start, b0), Math.min(to, b1))); + text += ""; + start = Math.min(to, b1); + } + text += escapeHtml(str.slice(start, to)); + return text; +} +function getURLPrefix(item, category) { + var urlPrefix = ""; + var slash = "/"; + if (category === "modules") { + return item.l + slash; + } else if (category === "packages" && item.m) { + return item.m + slash; + } else if (category === "types" || category === "members") { + if (item.m) { + urlPrefix = item.m + slash; + } else { + $.each(packageSearchIndex, function(index, it) { + if (it.m && item.p === it.l) { + urlPrefix = it.m + slash; + } + }); + } + } + return urlPrefix; +} +function getURL(item, category) { + if (item.url) { + return item.url; + } + var url = getURLPrefix(item, category); + if (category === "modules") { + url += "module-summary.html"; + } else if (category === "packages") { + if (item.u) { + url = item.u; + } else { + url += item.l.replace(/\./g, '/') + "/package-summary.html"; + } + } else if (category === "types") { + if (item.u) { + url = item.u; + } else { + url += checkUnnamed(item.p, "/").replace(/\./g, '/') + item.l + ".html"; + } + } else if (category === "members") { + url += checkUnnamed(item.p, "/").replace(/\./g, '/') + item.c + ".html" + "#"; + if (item.u) { + url += item.u; + } else { + url += item.l; + } + } else if (category === "searchTags") { + url += item.u; + } + item.url = url; + return url; +} +function createMatcher(term, camelCase) { + if (camelCase && !isUpperCase(term)) { + return null; // no need for camel-case matcher for lower case query + } + var pattern = ""; + var upperCase = []; + term.trim().split(/\s+/).forEach(function(w, index, array) { + var tokens = w.split(/(?=[A-Z,.()<>?[\/])/); + for (var i = 0; i < tokens.length; i++) { + var s = tokens[i]; + // ',' and '?' are the only delimiters commonly followed by space in java signatures + pattern += "(" + $.ui.autocomplete.escapeRegex(s).replace(/[,?]/g, "$&\\s*?") + ")"; + upperCase.push(false); + var isWordToken = /\w$/.test(s); + if (isWordToken) { + if (i === tokens.length - 1 && index < array.length - 1) { + // space in query string matches all delimiters + pattern += "(.*?)"; + upperCase.push(isUpperCase(s[0])); + } else { + if (!camelCase && isUpperCase(s) && s.length === 1) { + pattern += "()"; + } else { + pattern += "([a-z0-9$<>?[\\]]*?)"; + } + upperCase.push(isUpperCase(s[0])); + } + } else { + pattern += "()"; + upperCase.push(false); + } + } + }); + var re = new RegExp(pattern, "gi"); + re.upperCase = upperCase; + return re; +} +function findMatch(matcher, input, startOfName, endOfName) { + var from = startOfName; + matcher.lastIndex = from; + var match = matcher.exec(input); + // Expand search area until we get a valid result or reach the beginning of the string + while (!match || match.index + match[0].length < startOfName || endOfName < match.index) { + if (from === 0) { + return NO_MATCH; + } + from = input.lastIndexOf(".", from - 2) + 1; + matcher.lastIndex = from; + match = matcher.exec(input); + } + var boundaries = []; + var matchEnd = match.index + match[0].length; + var score = 5; + var start = match.index; + var prevEnd = -1; + for (var i = 1; i < match.length; i += 2) { + var isUpper = isUpperCase(input[start]); + var isMatcherUpper = matcher.upperCase[i]; + // capturing groups come in pairs, match and non-match + boundaries.push(start, start + match[i].length); + // make sure groups are anchored on a left word boundary + var prevChar = input[start - 1] || ""; + var nextChar = input[start + 1] || ""; + if (start !== 0 && !/[\W_]/.test(prevChar) && !/[\W_]/.test(input[start])) { + if (isUpper && (isLowerCase(prevChar) || isLowerCase(nextChar))) { + score -= 0.1; + } else if (isMatcherUpper && start === prevEnd) { + score -= isUpper ? 0.1 : 1.0; + } else { + return NO_MATCH; + } + } + prevEnd = start + match[i].length; + start += match[i].length + match[i + 1].length; + + // lower score for parts of the name that are missing + if (match[i + 1] && prevEnd < endOfName) { + score -= rateNoise(match[i + 1]); + } + } + // lower score if a type name contains unmatched camel-case parts + if (input[matchEnd - 1] !== "." && endOfName > matchEnd) + score -= rateNoise(input.slice(matchEnd, endOfName)); + score -= rateNoise(input.slice(0, Math.max(startOfName, match.index))); + + if (score <= 0) { + return NO_MATCH; + } + return { + input: input, + score: score, + boundaries: boundaries + }; +} +function isUpperCase(s) { + return s !== s.toLowerCase(); +} +function isLowerCase(s) { + return s !== s.toUpperCase(); +} +function rateNoise(str) { + return (str.match(/([.(])/g) || []).length / 5 + + (str.match(/([A-Z]+)/g) || []).length / 10 + + str.length / 20; +} +function doSearch(request, response) { + var term = request.term.trim(); + var maxResults = request.maxResults || MAX_RESULTS; + if (term.length === 0) { + return this.close(); + } + var matcher = { + plainMatcher: createMatcher(term, false), + camelCaseMatcher: createMatcher(term, true) + } + var indexLoaded = indexFilesLoaded(); + + function getPrefix(item, category) { + switch (category) { + case "packages": + return checkUnnamed(item.m, "/"); + case "types": + return checkUnnamed(item.p, "."); + case "members": + return checkUnnamed(item.p, ".") + item.c + "."; + default: + return ""; + } + } + function useQualifiedName(category) { + switch (category) { + case "packages": + return /[\s/]/.test(term); + case "types": + case "members": + return /[\s.]/.test(term); + default: + return false; + } + } + function searchIndex(indexArray, category) { + var matches = []; + if (!indexArray) { + if (!indexLoaded) { + matches.push({ l: messages.loading, category: category }); + } + return matches; + } + $.each(indexArray, function (i, item) { + var prefix = getPrefix(item, category); + var simpleName = item.l; + var qualifiedName = prefix + simpleName; + var useQualified = useQualifiedName(category); + var input = useQualified ? qualifiedName : simpleName; + var startOfName = useQualified ? prefix.length : 0; + var endOfName = category === "members" && input.indexOf("(", startOfName) > -1 + ? input.indexOf("(", startOfName) : input.length; + var m = findMatch(matcher.plainMatcher, input, startOfName, endOfName); + if (m === NO_MATCH && matcher.camelCaseMatcher) { + m = findMatch(matcher.camelCaseMatcher, input, startOfName, endOfName); + } + if (m !== NO_MATCH) { + m.indexItem = item; + m.prefix = prefix; + m.category = category; + if (!useQualified) { + m.input = qualifiedName; + m.boundaries = m.boundaries.map(function(b) { + return b + prefix.length; + }); + } + matches.push(m); + } + return true; + }); + return matches.sort(function(e1, e2) { + return e2.score - e1.score; + }).slice(0, maxResults); + } + + var result = searchIndex(moduleSearchIndex, "modules") + .concat(searchIndex(packageSearchIndex, "packages")) + .concat(searchIndex(typeSearchIndex, "types")) + .concat(searchIndex(memberSearchIndex, "members")) + .concat(searchIndex(tagSearchIndex, "searchTags")); + + if (!indexLoaded) { + updateSearchResults = function() { + doSearch(request, response); + } + } else { + updateSearchResults = function() {}; + } + response(result); +} +// JQuery search menu implementation +$.widget("custom.catcomplete", $.ui.autocomplete, { + _create: function() { + this._super(); + this.widget().menu("option", "items", "> .result-item"); + // workaround for search result scrolling + this.menu._scrollIntoView = function _scrollIntoView( item ) { + var borderTop, paddingTop, offset, scroll, elementHeight, itemHeight; + if ( this._hasScroll() ) { + borderTop = parseFloat( $.css( this.activeMenu[ 0 ], "borderTopWidth" ) ) || 0; + paddingTop = parseFloat( $.css( this.activeMenu[ 0 ], "paddingTop" ) ) || 0; + offset = item.offset().top - this.activeMenu.offset().top - borderTop - paddingTop; + scroll = this.activeMenu.scrollTop(); + elementHeight = this.activeMenu.height() - 26; + itemHeight = item.outerHeight(); + + if ( offset < 0 ) { + this.activeMenu.scrollTop( scroll + offset ); + } else if ( offset + itemHeight > elementHeight ) { + this.activeMenu.scrollTop( scroll + offset - elementHeight + itemHeight ); + } + } + }; + }, + _renderMenu: function(ul, items) { + var currentCategory = ""; + var widget = this; + widget.menu.bindings = $(); + $.each(items, function(index, item) { + if (item.category && item.category !== currentCategory) { + ul.append("
      • " + categories[item.category] + "
        • "); + currentCategory = item.category; + } + var li = widget._renderItemData(ul, item); + if (item.category) { + li.attr("aria-label", categories[item.category] + " : " + item.l); + } else { + li.attr("aria-label", item.l); + } + li.attr("class", "result-item"); + }); + ul.append("
      • Go to search page
        • "); + }, + _renderItem: function(ul, item) { + var li = $("
      • ").appendTo(ul); + var div = $("
        ").appendTo(li); + var label = item.l + ? item.l + : getHighlightedText(item.input, item.boundaries, 0, item.input.length); + var idx = item.indexItem; + if (item.category === "searchTags" && idx && idx.h) { + if (idx.d) { + div.html(label + " (" + idx.h + ")
        " + + idx.d + "
        "); + } else { + div.html(label + " (" + idx.h + ")"); + } + } else { + div.html(label); + } + return li; + } +}); +$(function() { + var expanded = false; + var windowWidth; + function collapse() { + if (expanded) { + $("div#navbar-top").removeAttr("style"); + $("button#navbar-toggle-button") + .removeClass("expanded") + .attr("aria-expanded", "false"); + expanded = false; + } + } + $("button#navbar-toggle-button").click(function (e) { + if (expanded) { + collapse(); + } else { + var navbar = $("div#navbar-top"); + navbar.height(navbar.prop("scrollHeight")); + $("button#navbar-toggle-button") + .addClass("expanded") + .attr("aria-expanded", "true"); + expanded = true; + windowWidth = window.innerWidth; + } + }); + $("ul.sub-nav-list-small li a").click(collapse); + $("input#search-input").focus(collapse); + $("main").click(collapse); + $("section[id] > :header, :header[id], :header:has(a[id])").each(function(idx, el) { + // Create anchor links for headers with an associated id attribute + var hdr = $(el); + var id = hdr.attr("id") || hdr.parent("section").attr("id") || hdr.children("a").attr("id"); + if (id) { + hdr.append(" " + messages.linkIcon +""); + } + }); + $(window).on("orientationchange", collapse).on("resize", function(e) { + if (expanded && windowWidth !== window.innerWidth) collapse(); + }); + var search = $("#search-input"); + var reset = $("#reset-button"); + search.catcomplete({ + minLength: 1, + delay: 200, + source: doSearch, + response: function(event, ui) { + if (!ui.content.length) { + ui.content.push({ l: messages.noResult }); + } else { + $("#search-input").empty(); + } + }, + autoFocus: true, + focus: function(event, ui) { + return false; + }, + position: { + collision: "flip" + }, + select: function(event, ui) { + if (ui.item.indexItem) { + var url = getURL(ui.item.indexItem, ui.item.category); + window.location.href = pathtoroot + url; + $("#search-input").focus(); + } + } + }); + search.val(''); + search.prop("disabled", false); + reset.prop("disabled", false); + reset.click(function() { + search.val('').focus(); + }); + search.focus(); +}); diff --git a/static/api/pulsar-functions/4.0.x/stylesheet.css b/static/api/pulsar-functions/4.0.x/stylesheet.css new file mode 100644 index 000000000000..f71489f86ccd --- /dev/null +++ b/static/api/pulsar-functions/4.0.x/stylesheet.css @@ -0,0 +1,1272 @@ +/* + * Javadoc style sheet + */ + +@import url('resources/fonts/dejavu.css'); + +/* + * These CSS custom properties (variables) define the core color and font + * properties used in this stylesheet. + */ +:root { + /* body, block and code fonts */ + --body-font-family: 'DejaVu Sans', Arial, Helvetica, sans-serif; + --block-font-family: 'DejaVu Serif', Georgia, "Times New Roman", Times, serif; + --code-font-family: 'DejaVu Sans Mono', monospace; + /* Base font sizes for body and code elements */ + --body-font-size: 14px; + --code-font-size: 14px; + /* Text colors for body and block elements */ + --body-text-color: #353833; + --block-text-color: #474747; + /* Background colors for various structural elements */ + --body-background-color: #ffffff; + --section-background-color: #f8f8f8; + --detail-background-color: #ffffff; + /* Colors for navigation bar and table captions */ + --navbar-background-color: #4D7A97; + --navbar-text-color: #ffffff; + /* Background color for subnavigation and various headers */ + --subnav-background-color: #dee3e9; + /* Background and text colors for selected tabs and navigation items */ + --selected-background-color: #f8981d; + --selected-text-color: #253441; + --selected-link-color: #1f389c; + /* Background colors for generated tables */ + --even-row-color: #ffffff; + --odd-row-color: #eeeeef; + /* Text color for page title */ + --title-color: #2c4557; + /* Text colors for links */ + --link-color: #4A6782; + --link-color-active: #bb7a2a; + /* Snippet colors */ + --snippet-background-color: #ebecee; + --snippet-text-color: var(--block-text-color); + --snippet-highlight-color: #f7c590; + /* Border colors for structural elements and user defined tables */ + --border-color: #ededed; + --table-border-color: #000000; + /* Search input colors */ + --search-input-background-color: #ffffff; + --search-input-text-color: #000000; + --search-input-placeholder-color: #909090; + /* Highlight color for active search tag target */ + --search-tag-highlight-color: #ffff00; + /* Adjustments for icon and active background colors of copy-to-clipboard buttons */ + --copy-icon-brightness: 100%; + --copy-button-background-color-active: rgba(168, 168, 176, 0.3); + /* Colors for invalid tag notifications */ + --invalid-tag-background-color: #ffe6e6; + --invalid-tag-text-color: #000000; +} +/* + * Styles for individual HTML elements. + * + * These are styles that are specific to individual HTML elements. Changing them affects the style of a particular + * HTML element throughout the page. + */ +body { + background-color:var(--body-background-color); + color:var(--body-text-color); + font-family:var(--body-font-family); + font-size:var(--body-font-size); + margin:0; + padding:0; + height:100%; + width:100%; +} +iframe { + margin:0; + padding:0; + height:100%; + width:100%; + overflow-y:scroll; + border:none; +} +a:link, a:visited { + text-decoration:none; + color:var(--link-color); +} +a[href]:hover, a[href]:focus { + text-decoration:none; + color:var(--link-color-active); +} +pre { + font-family:var(--code-font-family); + font-size:1em; +} +h1 { + font-size:1.428em; +} +h2 { + font-size:1.285em; +} +h3 { + font-size:1.14em; +} +h4 { + font-size:1.072em; +} +h5 { + font-size:1.001em; +} +h6 { + font-size:0.93em; +} +/* Disable font boosting for selected elements */ +h1, h2, h3, h4, h5, h6, div.member-signature { + max-height: 1000em; +} +ul { + list-style-type:disc; +} +code, tt { + font-family:var(--code-font-family); +} +:not(h1, h2, h3, h4, h5, h6) > code, +:not(h1, h2, h3, h4, h5, h6) > tt { + font-size:var(--code-font-size); + padding-top:4px; + margin-top:8px; + line-height:1.4em; +} +dt code { + font-family:var(--code-font-family); + font-size:1em; + padding-top:4px; +} +.summary-table dt code { + font-family:var(--code-font-family); + font-size:1em; + vertical-align:top; + padding-top:4px; +} +sup { + font-size:8px; +} +button { + font-family: var(--body-font-family); + font-size: 1em; +} +/* + * Styles for HTML generated by javadoc. + * + * These are style classes that are used by the standard doclet to generate HTML documentation. + */ + +/* + * Styles for document title and copyright. + */ +.about-language { + float:right; + padding:0 21px 8px 8px; + font-size:0.915em; + margin-top:-9px; + height:2.9em; +} +.legal-copy { + margin-left:.5em; +} +/* + * Styles for navigation bar. + */ +@media screen { + div.flex-box { + position:fixed; + display:flex; + flex-direction:column; + height: 100%; + width: 100%; + } + header.flex-header { + flex: 0 0 auto; + } + div.flex-content { + flex: 1 1 auto; + overflow-y: auto; + } +} +.top-nav { + background-color:var(--navbar-background-color); + color:var(--navbar-text-color); + float:left; + width:100%; + clear:right; + min-height:2.8em; + padding:10px 0 0 0; + overflow:hidden; + font-size:0.857em; +} +button#navbar-toggle-button { + display:none; +} +ul.sub-nav-list-small { + display: none; +} +.sub-nav { + background-color:var(--subnav-background-color); + float:left; + width:100%; + overflow:hidden; + font-size:0.857em; +} +.sub-nav div { + clear:left; + float:left; + padding:6px; + text-transform:uppercase; +} +.sub-nav .sub-nav-list { + padding-top:4px; +} +ul.nav-list { + display:block; + margin:0 25px 0 0; + padding:0; +} +ul.sub-nav-list { + float:left; + margin:0 25px 0 0; + padding:0; +} +ul.nav-list li { + list-style:none; + float:left; + padding: 5px 6px; + text-transform:uppercase; +} +.sub-nav .nav-list-search { + float:right; + margin:0; + padding:6px; + clear:none; + text-align:right; + position:relative; +} +ul.sub-nav-list li { + list-style:none; + float:left; +} +.top-nav a:link, .top-nav a:active, .top-nav a:visited { + color:var(--navbar-text-color); + text-decoration:none; + text-transform:uppercase; +} +.top-nav a:hover { + color:var(--link-color-active); +} +.nav-bar-cell1-rev { + background-color:var(--selected-background-color); + color:var(--selected-text-color); + margin: auto 5px; +} +.skip-nav { + position:absolute; + top:auto; + left:-9999px; + overflow:hidden; +} +/* + * Hide navigation links and search box in print layout + */ +@media print { + ul.nav-list, div.sub-nav { + display:none; + } +} +/* + * Styles for page header. + */ +.title { + color:var(--title-color); + margin:10px 0; +} +.sub-title { + margin:5px 0 0 0; +} +ul.contents-list { + margin: 0 0 15px 0; + padding: 0; + list-style: none; +} +ul.contents-list li { + font-size:0.93em; +} +/* + * Styles for headings. + */ +body.class-declaration-page .summary h2, +body.class-declaration-page .details h2, +body.class-use-page h2, +body.module-declaration-page .block-list h2 { + font-style: italic; + padding:0; + margin:15px 0; +} +body.class-declaration-page .summary h3, +body.class-declaration-page .details h3, +body.class-declaration-page .summary .inherited-list h2 { + background-color:var(--subnav-background-color); + border:1px solid var(--border-color); + margin:0 0 6px -8px; + padding:7px 5px; +} +/* + * Styles for page layout containers. + */ +main { + clear:both; + padding:10px 20px; + position:relative; +} +dl.notes > dt { + font-family: var(--body-font-family); + font-size:0.856em; + font-weight:bold; + margin:10px 0 0 0; + color:var(--body-text-color); +} +dl.notes > dd { + margin:5px 10px 10px 0; + font-size:1em; + font-family:var(--block-font-family) +} +dl.name-value > dt { + margin-left:1px; + font-size:1.1em; + display:inline; + font-weight:bold; +} +dl.name-value > dd { + margin:0 0 0 1px; + font-size:1.1em; + display:inline; +} +/* + * Styles for lists. + */ +li.circle { + list-style:circle; +} +ul.horizontal li { + display:inline; + font-size:0.9em; +} +div.inheritance { + margin:0; + padding:0; +} +div.inheritance div.inheritance { + margin-left:2em; +} +ul.block-list, +ul.details-list, +ul.member-list, +ul.summary-list { + margin:10px 0 10px 0; + padding:0; +} +ul.block-list > li, +ul.details-list > li, +ul.member-list > li, +ul.summary-list > li { + list-style:none; + margin-bottom:15px; + line-height:1.4; +} +ul.ref-list { + padding:0; + margin:0; +} +ul.ref-list > li { + list-style:none; +} +.summary-table dl, .summary-table dl dt, .summary-table dl dd { + margin-top:0; + margin-bottom:1px; +} +ul.tag-list, ul.tag-list-long { + padding-left: 0; + list-style: none; +} +ul.tag-list li { + display: inline; +} +ul.tag-list li:not(:last-child):after, +ul.tag-list-long li:not(:last-child):after +{ + content: ", "; + white-space: pre-wrap; +} +ul.preview-feature-list { + list-style: none; + margin:0; + padding:0.1em; + line-height: 1.6em; +} +/* + * Styles for tables. + */ +.summary-table, .details-table { + width:100%; + border-spacing:0; + border:1px solid var(--border-color); + border-top:0; + padding:0; +} +.caption { + position:relative; + text-align:left; + background-repeat:no-repeat; + color:var(--selected-text-color); + clear:none; + overflow:hidden; + padding: 10px 0 0 1px; + margin:0; +} +.caption a:link, .caption a:visited { + color:var(--selected-link-color); +} +.caption a:hover, +.caption a:active { + color:var(--navbar-text-color); +} +.caption span { + font-weight:bold; + white-space:nowrap; + padding:5px 12px 7px 12px; + display:inline-block; + float:left; + background-color:var(--selected-background-color); + border: none; + height:16px; +} +div.table-tabs { + padding:10px 0 0 1px; + margin:10px 0 0 0; +} +div.table-tabs > button { + border: none; + cursor: pointer; + padding: 5px 12px 7px 12px; + font-weight: bold; + margin-right: 8px; +} +div.table-tabs > .active-table-tab { + background: var(--selected-background-color); + color: var(--selected-text-color); +} +div.table-tabs > button.table-tab { + background: var(--navbar-background-color); + color: var(--navbar-text-color); +} +.two-column-search-results { + display: grid; + grid-template-columns: minmax(400px, max-content) minmax(400px, auto); +} +div.checkboxes { + line-height: 2em; +} +div.checkboxes > span { + margin-left: 10px; +} +div.checkboxes > label { + margin-left: 8px; + white-space: nowrap; +} +div.checkboxes > label > input { + margin: 0 2px; +} +.two-column-summary { + display: grid; + grid-template-columns: minmax(25%, max-content) minmax(25%, auto); +} +.three-column-summary { + display: grid; + grid-template-columns: minmax(15%, max-content) minmax(20%, max-content) minmax(20%, auto); +} +.three-column-release-summary { + display: grid; + grid-template-columns: minmax(40%, max-content) minmax(10%, max-content) minmax(40%, auto); +} +.four-column-summary { + display: grid; + grid-template-columns: minmax(10%, max-content) minmax(15%, max-content) minmax(15%, max-content) minmax(15%, auto); +} +@media screen and (max-width: 1000px) { + .four-column-summary { + display: grid; + grid-template-columns: minmax(15%, max-content) minmax(15%, auto); + } +} +@media screen and (max-width: 800px) { + .two-column-search-results { + display: grid; + grid-template-columns: minmax(40%, max-content) minmax(40%, auto); + } + .three-column-summary { + display: grid; + grid-template-columns: minmax(10%, max-content) minmax(25%, auto); + } + .three-column-release-summary { + display: grid; + grid-template-columns: minmax(70%, max-content) minmax(30%, max-content) + } + .three-column-summary .col-last, + .three-column-release-summary .col-last{ + grid-column-end: span 2; + } +} +@media screen and (max-width: 600px) { + .two-column-summary { + display: grid; + grid-template-columns: 1fr; + } +} +.summary-table > div, .details-table > div { + text-align:left; + padding: 8px 3px 3px 7px; + overflow-x: auto; + scrollbar-width: thin; +} +.col-first, .col-second, .col-last, .col-constructor-name, .col-summary-item-name { + vertical-align:top; + padding-right:0; + padding-top:8px; + padding-bottom:3px; +} +.table-header { + background:var(--subnav-background-color); + font-weight: bold; +} +/* Sortable table columns */ +.table-header[onclick] { + cursor: pointer; +} +.table-header[onclick]::after { + content:""; + display:inline-block; + background-image:url('data:image/svg+xml; utf8, \ + \ + '); + background-size:100% 100%; + width:9px; + height:14px; + margin-left:4px; + margin-bottom:-3px; +} +.table-header[onclick].sort-asc::after { + background-image:url('data:image/svg+xml; utf8, \ + \ + \ + '); + +} +.table-header[onclick].sort-desc::after { + background-image:url('data:image/svg+xml; utf8, \ + \ + \ + '); +} +.col-first, .col-first { + font-size:0.93em; +} +.col-second, .col-second, .col-last, .col-constructor-name, .col-summary-item-name, .col-last { + font-size:0.93em; +} +.col-first, .col-second, .col-constructor-name { + vertical-align:top; + overflow: auto; +} +.col-last { + white-space:normal; +} +.col-first a:link, .col-first a:visited, +.col-second a:link, .col-second a:visited, +.col-first a:link, .col-first a:visited, +.col-second a:link, .col-second a:visited, +.col-constructor-name a:link, .col-constructor-name a:visited, +.col-summary-item-name a:link, .col-summary-item-name a:visited { + font-weight:bold; +} +.even-row-color, .even-row-color .table-header { + background-color:var(--even-row-color); +} +.odd-row-color, .odd-row-color .table-header { + background-color:var(--odd-row-color); +} +/* + * Styles for contents. + */ +div.block { + font-size:var(--body-font-size); + font-family:var(--block-font-family); +} +.col-last div { + padding-top:0; +} +.col-last a { + padding-bottom:3px; +} +.module-signature, +.package-signature, +.type-signature, +.member-signature { + font-family:var(--code-font-family); + font-size:1em; + margin:14px 0; + white-space: pre-wrap; +} +.module-signature, +.package-signature, +.type-signature { + margin-top: 0; +} +.member-signature .type-parameters-long, +.member-signature .parameters, +.member-signature .exceptions { + display: inline-block; + vertical-align: top; + white-space: pre; +} +.member-signature .type-parameters { + white-space: normal; +} +/* + * Styles for formatting effect. + */ +.source-line-no { + /* Color of line numbers in source pages can be set via custom property below */ + color:var(--source-linenumber-color, green); + padding:0 30px 0 0; +} +.block { + display:block; + margin:0 10px 5px 0; + color:var(--block-text-color); +} +.deprecated-label, .description-from-type-label, .implementation-label, .member-name-link, +.module-label-in-package, .module-label-in-type, .package-label-in-type, +.package-hierarchy-label, .type-name-label, .type-name-link, .search-tag-link, .preview-label { + font-weight:bold; +} +.deprecation-comment, .help-footnote, .preview-comment { + font-style:italic; +} +.deprecation-block { + font-size:1em; + font-family:var(--block-font-family); + border-style:solid; + border-width:thin; + border-radius:10px; + padding:10px; + margin-bottom:10px; + margin-right:10px; + display:inline-block; +} +.preview-block { + font-size:1em; + font-family:var(--block-font-family); + border-style:solid; + border-width:thin; + border-radius:10px; + padding:10px; + margin-bottom:10px; + margin-right:10px; + display:inline-block; +} +div.block div.deprecation-comment { + font-style:normal; +} +details.invalid-tag, span.invalid-tag { + font-size:1em; + font-family:var(--block-font-family); + color: var(--invalid-tag-text-color); + background: var(--invalid-tag-background-color); + border: thin solid var(--table-border-color); + border-radius:2px; + padding: 2px 4px; + display:inline-block; +} +details summary { + cursor: pointer; +} +/* + * Styles specific to HTML5 elements. + */ +main, nav, header, footer, section { + display:block; +} +/* + * Styles for javadoc search. + */ +.ui-state-active { + /* Overrides the color of selection used in jQuery UI */ + background: var(--selected-background-color); + border: 1px solid var(--selected-background-color); + color: var(--selected-text-color); +} +.ui-autocomplete-category { + font-weight:bold; + font-size:15px; + padding:7px 0 7px 3px; + background-color:var(--navbar-background-color); + color:var(--navbar-text-color); +} +.ui-autocomplete { + max-height:85%; + max-width:65%; + overflow-y:auto; + overflow-x:auto; + scrollbar-width: thin; + white-space:nowrap; + box-shadow: 0 3px 6px rgba(0,0,0,0.16), 0 3px 6px rgba(0,0,0,0.23); +} +ul.ui-autocomplete { + position:fixed; + z-index:1; + background-color: var(--body-background-color); +} +ul.ui-autocomplete li { + float:left; + clear:both; + min-width:100%; +} +ul.ui-autocomplete li.ui-static-link { + position:sticky; + bottom:0; + left:0; + background: var(--subnav-background-color); + padding: 5px 0; + font-family: var(--body-font-family); + font-size: 0.93em; + font-weight: bolder; + z-index: 2; +} +li.ui-static-link a, li.ui-static-link a:visited { + text-decoration:none; + color:var(--link-color); + float:right; + margin-right:20px; +} +.ui-autocomplete .result-item { + font-size: inherit; +} +.ui-autocomplete .result-highlight { + font-weight:bold; +} +#search-input, #page-search-input { + background-image:url('resources/glass.png'); + background-size:13px; + background-repeat:no-repeat; + background-position:2px 3px; + background-color: var(--search-input-background-color); + color: var(--search-input-text-color); + border-color: var(--border-color); + padding-left:20px; + width: 250px; + margin: 0; +} +#search-input { + margin-left: 4px; +} +#reset-button { + background-color: transparent; + background-image:url('resources/x.png'); + background-repeat:no-repeat; + background-size:contain; + border:0; + border-radius:0; + width:12px; + height:12px; + position:absolute; + right:12px; + top:10px; + font-size:0; +} +::placeholder { + color:var(--search-input-placeholder-color); + opacity: 1; +} +.search-tag-desc-result { + font-style:italic; + font-size:11px; +} +.search-tag-holder-result { + font-style:italic; + font-size:12px; +} +.search-tag-result:target { + background-color:var(--search-tag-highlight-color); +} +details.page-search-details { + display: inline-block; +} +div#result-container { + font-size: 1em; +} +div#result-container a.search-result-link { + padding: 0; + margin: 4px 0; + width: 100%; +} +#result-container .result-highlight { + font-weight:bolder; +} +.page-search-info { + background-color: var(--subnav-background-color); + border-radius: 3px; + border: 0 solid var(--border-color); + padding: 0 8px; + overflow: hidden; + height: 0; + transition: all 0.2s ease; +} +div.table-tabs > button.table-tab { + background: var(--navbar-background-color); + color: var(--navbar-text-color); +} +.page-search-header { + padding: 5px 12px 7px 12px; + font-weight: bold; + margin-right: 3px; + background-color:var(--navbar-background-color); + color:var(--navbar-text-color); + display: inline-block; +} +button.page-search-header { + border: none; + cursor: pointer; +} +span#page-search-link { + text-decoration: underline; +} +.module-graph span, .sealed-graph span { + display:none; + position:absolute; +} +.module-graph:hover span, .sealed-graph:hover span { + display:block; + margin: -100px 0 0 100px; + z-index: 1; +} +.inherited-list { + margin: 10px 0 10px 0; +} +section.class-description { + line-height: 1.4; +} +.summary section[class$="-summary"], .details section[class$="-details"], +.class-uses .detail, .serialized-class-details { + padding: 0 20px 5px 10px; + border: 1px solid var(--border-color); + background-color: var(--section-background-color); +} +.inherited-list, section[class$="-details"] .detail { + padding:0 0 5px 8px; + background-color:var(--detail-background-color); + border:none; +} +.vertical-separator { + padding: 0 5px; +} +ul.help-section-list { + margin: 0; +} +ul.help-subtoc > li { + display: inline-block; + padding-right: 5px; + font-size: smaller; +} +ul.help-subtoc > li::before { + content: "\2022" ; + padding-right:2px; +} +.help-note { + font-style: italic; +} +/* + * Indicator icon for external links. + */ +main a[href*="://"]::after { + content:""; + display:inline-block; + background-image:url('data:image/svg+xml; utf8, \ + \ + \ + '); + background-size:100% 100%; + width:7px; + height:7px; + margin-left:2px; + margin-bottom:4px; +} +main a[href*="://"]:hover::after, +main a[href*="://"]:focus::after { + background-image:url('data:image/svg+xml; utf8, \ + \ + \ + '); +} +/* + * Styles for header/section anchor links + */ +a.anchor-link { + opacity: 0; + transition: opacity 0.1s; +} +:hover > a.anchor-link { + opacity: 80%; +} +a.anchor-link:hover, +a.anchor-link:focus-visible, +a.anchor-link.visible { + opacity: 100%; +} +a.anchor-link > img { + width: 0.9em; + height: 0.9em; +} +/* + * Styles for copy-to-clipboard buttons + */ +button.copy { + opacity: 70%; + border: none; + border-radius: 3px; + position: relative; + background:none; + transition: opacity 0.3s; + cursor: pointer; +} +:hover > button.copy { + opacity: 80%; +} +button.copy:hover, +button.copy:active, +button.copy:focus-visible, +button.copy.visible { + opacity: 100%; +} +button.copy img { + position: relative; + background: none; + filter: brightness(var(--copy-icon-brightness)); +} +button.copy:active { + background-color: var(--copy-button-background-color-active); +} +button.copy span { + color: var(--body-text-color); + position: relative; + top: -0.1em; + transition: all 0.1s; + font-size: 0.76rem; + line-height: 1.2em; + opacity: 0; +} +button.copy:hover span, +button.copy:focus-visible span, +button.copy.visible span { + opacity: 100%; +} +/* search page copy button */ +button#page-search-copy { + margin-left: 0.4em; + padding:0.3em; + top:0.13em; +} +button#page-search-copy img { + width: 1.2em; + height: 1.2em; + padding: 0.01em 0; + top: 0.15em; +} +button#page-search-copy span { + color: var(--body-text-color); + line-height: 1.2em; + padding: 0.2em; + top: -0.18em; +} +div.page-search-info:hover button#page-search-copy span { + opacity: 100%; +} +/* snippet copy button */ +button.snippet-copy { + position: absolute; + top: 6px; + right: 6px; + height: 1.7em; + padding: 2px; +} +button.snippet-copy img { + width: 18px; + height: 18px; + padding: 0.05em 0; +} +button.snippet-copy span { + line-height: 1.2em; + padding: 0.2em; + position: relative; + top: -0.5em; +} +div.snippet-container:hover button.snippet-copy span { + opacity: 100%; +} +/* + * Styles for user-provided tables. + * + * borderless: + * No borders, vertical margins, styled caption. + * This style is provided for use with existing doc comments. + * In general, borderless tables should not be used for layout purposes. + * + * plain: + * Plain borders around table and cells, vertical margins, styled caption. + * Best for small tables or for complex tables for tables with cells that span + * rows and columns, when the "striped" style does not work well. + * + * striped: + * Borders around the table and vertical borders between cells, striped rows, + * vertical margins, styled caption. + * Best for tables that have a header row, and a body containing a series of simple rows. + */ + +table.borderless, +table.plain, +table.striped { + margin-top: 10px; + margin-bottom: 10px; +} +table.borderless > caption, +table.plain > caption, +table.striped > caption { + font-weight: bold; + font-size: smaller; +} +table.borderless th, table.borderless td, +table.plain th, table.plain td, +table.striped th, table.striped td { + padding: 2px 5px; +} +table.borderless, +table.borderless > thead > tr > th, table.borderless > tbody > tr > th, table.borderless > tr > th, +table.borderless > thead > tr > td, table.borderless > tbody > tr > td, table.borderless > tr > td { + border: none; +} +table.borderless > thead > tr, table.borderless > tbody > tr, table.borderless > tr { + background-color: transparent; +} +table.plain { + border-collapse: collapse; + border: 1px solid var(--table-border-color); +} +table.plain > thead > tr, table.plain > tbody tr, table.plain > tr { + background-color: transparent; +} +table.plain > thead > tr > th, table.plain > tbody > tr > th, table.plain > tr > th, +table.plain > thead > tr > td, table.plain > tbody > tr > td, table.plain > tr > td { + border: 1px solid var(--table-border-color); +} +table.striped { + border-collapse: collapse; + border: 1px solid var(--table-border-color); +} +table.striped > thead { + background-color: var(--subnav-background-color); +} +table.striped > thead > tr > th, table.striped > thead > tr > td { + border: 1px solid var(--table-border-color); +} +table.striped > tbody > tr:nth-child(even) { + background-color: var(--odd-row-color) +} +table.striped > tbody > tr:nth-child(odd) { + background-color: var(--even-row-color) +} +table.striped > tbody > tr > th, table.striped > tbody > tr > td { + border-left: 1px solid var(--table-border-color); + border-right: 1px solid var(--table-border-color); +} +table.striped > tbody > tr > th { + font-weight: normal; +} +/** + * Tweak style for small screens. + */ +@media screen and (max-width: 920px) { + header.flex-header { + max-height: 100vh; + overflow-y: auto; + } + div#navbar-top { + height: 2.8em; + transition: height 0.35s ease; + } + ul.nav-list { + display: block; + width: 40%; + float:left; + clear: left; + margin: 10px 0 0 0; + padding: 0; + } + ul.nav-list li { + float: none; + padding: 6px; + margin-left: 10px; + margin-top: 2px; + } + ul.sub-nav-list-small { + display:block; + height: 100%; + width: 50%; + float: right; + clear: right; + background-color: var(--subnav-background-color); + color: var(--body-text-color); + margin: 6px 0 0 0; + padding: 0; + } + ul.sub-nav-list-small ul { + padding-left: 20px; + } + ul.sub-nav-list-small a:link, ul.sub-nav-list-small a:visited { + color:var(--link-color); + } + ul.sub-nav-list-small a:hover { + color:var(--link-color-active); + } + ul.sub-nav-list-small li { + list-style:none; + float:none; + padding: 6px; + margin-top: 1px; + text-transform:uppercase; + } + ul.sub-nav-list-small > li { + margin-left: 10px; + } + ul.sub-nav-list-small li p { + margin: 5px 0; + } + div#navbar-sub-list { + display: none; + } + .top-nav a:link, .top-nav a:active, .top-nav a:visited { + display: block; + } + button#navbar-toggle-button { + width: 3.4em; + height: 2.8em; + background-color: transparent; + display: block; + float: left; + border: 0; + margin: 0 10px; + cursor: pointer; + font-size: 10px; + } + button#navbar-toggle-button .nav-bar-toggle-icon { + display: block; + width: 24px; + height: 3px; + margin: 1px 0 4px 0; + border-radius: 2px; + transition: all 0.1s; + background-color: var(--navbar-text-color); + } + button#navbar-toggle-button.expanded span.nav-bar-toggle-icon:nth-child(1) { + transform: rotate(45deg); + transform-origin: 10% 10%; + width: 26px; + } + button#navbar-toggle-button.expanded span.nav-bar-toggle-icon:nth-child(2) { + opacity: 0; + } + button#navbar-toggle-button.expanded span.nav-bar-toggle-icon:nth-child(3) { + transform: rotate(-45deg); + transform-origin: 10% 90%; + width: 26px; + } +} +@media screen and (max-width: 800px) { + .about-language { + padding-right: 16px; + } + ul.nav-list li { + margin-left: 5px; + } + ul.sub-nav-list-small > li { + margin-left: 5px; + } + main { + padding: 10px; + } + .summary section[class$="-summary"], .details section[class$="-details"], + .class-uses .detail, .serialized-class-details { + padding: 0 8px 5px 8px; + } + body { + -webkit-text-size-adjust: none; + } +} +@media screen and (max-width: 400px) { + .about-language { + font-size: 10px; + padding-right: 12px; + } +} +@media screen and (max-width: 400px) { + .nav-list-search { + width: 94%; + } + #search-input, #page-search-input { + width: 70%; + } +} +@media screen and (max-width: 320px) { + .nav-list-search > label { + display: none; + } + .nav-list-search { + width: 90%; + } + #search-input, #page-search-input { + width: 80%; + } +} + +pre.snippet { + background-color: var(--snippet-background-color); + color: var(--snippet-text-color); + padding: 10px; + margin: 12px 0; + overflow: auto; + white-space: pre; +} +div.snippet-container { + position: relative; +} +@media screen and (max-width: 800px) { + pre.snippet { + padding-top: 26px; + } + button.snippet-copy { + top: 4px; + right: 4px; + } +} +pre.snippet .italic { + font-style: italic; +} +pre.snippet .bold { + font-weight: bold; +} +pre.snippet .highlighted { + background-color: var(--snippet-highlight-color); + border-radius: 10%; +} diff --git a/static/api/pulsar-functions/4.0.x/tag-search-index.js b/static/api/pulsar-functions/4.0.x/tag-search-index.js new file mode 100644 index 000000000000..0367dae65da4 --- /dev/null +++ b/static/api/pulsar-functions/4.0.x/tag-search-index.js @@ -0,0 +1 @@ +tagSearchIndex = [];updateSearchResults(); \ No newline at end of file diff --git a/static/api/pulsar-functions/4.0.x/type-search-index.js b/static/api/pulsar-functions/4.0.x/type-search-index.js new file mode 100644 index 000000000000..b2596d1998ce --- /dev/null +++ b/static/api/pulsar-functions/4.0.x/type-search-index.js @@ -0,0 +1 @@ +typeSearchIndex = [{"l":"All Classes and Interfaces","u":"allclasses-index.html"},{"p":"org.apache.pulsar.functions.api","l":"BaseContext"},{"p":"org.apache.pulsar.functions.api.state","l":"ByteBufferStateStore"},{"p":"org.apache.pulsar.functions.api","l":"Context"},{"p":"org.apache.pulsar.functions.api.state","l":"CounterStateStore"},{"p":"org.apache.pulsar.functions.api","l":"Function"},{"p":"org.apache.pulsar.functions.api.utils","l":"FunctionRecord"},{"p":"org.apache.pulsar.functions.api.utils","l":"FunctionRecord.FunctionRecordBuilder"},{"p":"org.apache.pulsar.functions.api.utils","l":"IdentityFunction"},{"p":"org.apache.pulsar.functions.api","l":"KVRecord"},{"p":"org.apache.pulsar.functions.api","l":"Record"},{"p":"org.apache.pulsar.functions.api","l":"SerDe"},{"p":"org.apache.pulsar.functions.api","l":"StateStore"},{"p":"org.apache.pulsar.functions.api","l":"StateStoreContext"},{"p":"org.apache.pulsar.functions.api.state","l":"StateValue"},{"p":"org.apache.pulsar.functions.api","l":"WindowContext"},{"p":"org.apache.pulsar.functions.api","l":"WindowFunction"}];updateSearchResults(); \ No newline at end of file From 092f6f9bc6ab928ac4f00e93ade91d83255e8c84 Mon Sep 17 00:00:00 2001 From: Lari Hotari Date: Mon, 14 Oct 2024 20:48:33 +0300 Subject: [PATCH 3/9] update reference for 4.0.0 --- static/reference/4.0.x/README.md | 3 + static/reference/4.0.x/_sidebar.md | 61 + static/reference/4.0.x/bookkeeper/README.md | 1 + .../reference/4.0.x/bookkeeper/bookkeeper.md | 94 + static/reference/4.0.x/cli.md | 3 + static/reference/4.0.x/client/README.md | 28 + .../client/client-configuration-client.md | 397 + .../client/client-configuration-consumer.md | 282 + .../client/client-configuration-producer.md | 136 + .../client/client-configuration-reader.md | 96 + static/reference/4.0.x/config/README.md | 108 + .../reference-configuration-bookkeeper.md | 583 + .../config/reference-configuration-broker.md | 5999 + .../config/reference-configuration-client.md | 397 + .../reference-configuration-log4j-shell.md | 37 + .../config/reference-configuration-log4j.md | 80 + .../reference-configuration-pulsar-proxy.md | 1371 + .../reference-configuration-standalone.md | 5999 + .../reference-configuration-websocket.md | 683 + .../reference-configuration-zookeeper.md | 83 + static/reference/4.0.x/pulsar-admin/README.md | 16 + .../reference/4.0.x/pulsar-admin/bookies.md | 320 + .../4.0.x/pulsar-admin/broker-stats.md | 438 + .../reference/4.0.x/pulsar-admin/brokers.md | 1768 + .../reference/4.0.x/pulsar-admin/clusters.md | 2030 + .../4.0.x/pulsar-admin/functions-worker.md | 438 + .../reference/4.0.x/pulsar-admin/functions.md | 3610 + .../4.0.x/pulsar-admin/namespaces.md | 181608 ++++++++++++++ .../4.0.x/pulsar-admin/ns-isolation-policy.md | 438 + .../reference/4.0.x/pulsar-admin/packages.md | 574 + .../4.0.x/pulsar-admin/proxy-stats.md | 74 + .../4.0.x/pulsar-admin/resource-quotas.md | 138 + .../4.0.x/pulsar-admin/resourcegroups.md | 320 + .../reference/4.0.x/pulsar-admin/schemas.md | 438 + static/reference/4.0.x/pulsar-admin/sinks.md | 1768 + .../reference/4.0.x/pulsar-admin/sources.md | 1768 + .../reference/4.0.x/pulsar-admin/tenants.md | 320 + .../4.0.x/pulsar-admin/topicPolicies.md | 60588 +++++ static/reference/4.0.x/pulsar-admin/topics.md | 184307 +++++++++++++++ .../4.0.x/pulsar-admin/transactions.md | 2030 + .../reference/4.0.x/pulsar-client/README.md | 12 + .../4.0.x/pulsar-client/pulsar-client.md | 146 + .../reference/4.0.x/pulsar-daemon/README.md | 1 + .../4.0.x/pulsar-daemon/pulsar-daemon.md | 40 + static/reference/4.0.x/pulsar-perf/README.md | 12 + .../4.0.x/pulsar-perf/pulsar-perf.md | 323 + static/reference/4.0.x/pulsar-shell/README.md | 1 + .../4.0.x/pulsar-shell/pulsar-shell.md | 144 + static/reference/4.0.x/pulsar/README.md | 1 + static/reference/4.0.x/pulsar/broker-tool.md | 22 + static/reference/4.0.x/pulsar/broker.md | 19 + .../reference/4.0.x/pulsar/compact-topic.md | 16 + .../4.0.x/pulsar/delete-cluster-metadata.md | 18 + .../4.0.x/pulsar/functions-worker.md | 14 + .../pulsar/initialize-cluster-metadata.md | 32 + .../4.0.x/pulsar/initialize-namespace.md | 17 + ...ialize-transaction-coordinator-metadata.md | 18 + static/reference/4.0.x/pulsar/proxy.md | 19 + static/reference/4.0.x/pulsar/standalone.md | 27 + static/reference/4.0.x/pulsar/tokens.md | 83 + static/reference/4.0.x/pulsar/version.md | 13 + static/reference/4.0.x/pulsar/websocket.md | 13 + 62 files changed, 460423 insertions(+) create mode 100644 static/reference/4.0.x/README.md create mode 100644 static/reference/4.0.x/_sidebar.md create mode 100644 static/reference/4.0.x/bookkeeper/README.md create mode 100644 static/reference/4.0.x/bookkeeper/bookkeeper.md create mode 100644 static/reference/4.0.x/cli.md create mode 100644 static/reference/4.0.x/client/README.md create mode 100644 static/reference/4.0.x/client/client-configuration-client.md create mode 100644 static/reference/4.0.x/client/client-configuration-consumer.md create mode 100644 static/reference/4.0.x/client/client-configuration-producer.md create mode 100644 static/reference/4.0.x/client/client-configuration-reader.md create mode 100644 static/reference/4.0.x/config/README.md create mode 100644 static/reference/4.0.x/config/reference-configuration-bookkeeper.md create mode 100644 static/reference/4.0.x/config/reference-configuration-broker.md create mode 100644 static/reference/4.0.x/config/reference-configuration-client.md create mode 100644 static/reference/4.0.x/config/reference-configuration-log4j-shell.md create mode 100644 static/reference/4.0.x/config/reference-configuration-log4j.md create mode 100644 static/reference/4.0.x/config/reference-configuration-pulsar-proxy.md create mode 100644 static/reference/4.0.x/config/reference-configuration-standalone.md create mode 100644 static/reference/4.0.x/config/reference-configuration-websocket.md create mode 100644 static/reference/4.0.x/config/reference-configuration-zookeeper.md create mode 100644 static/reference/4.0.x/pulsar-admin/README.md create mode 100644 static/reference/4.0.x/pulsar-admin/bookies.md create mode 100644 static/reference/4.0.x/pulsar-admin/broker-stats.md create mode 100644 static/reference/4.0.x/pulsar-admin/brokers.md create mode 100644 static/reference/4.0.x/pulsar-admin/clusters.md create mode 100644 static/reference/4.0.x/pulsar-admin/functions-worker.md create mode 100644 static/reference/4.0.x/pulsar-admin/functions.md create mode 100644 static/reference/4.0.x/pulsar-admin/namespaces.md create mode 100644 static/reference/4.0.x/pulsar-admin/ns-isolation-policy.md create mode 100644 static/reference/4.0.x/pulsar-admin/packages.md create mode 100644 static/reference/4.0.x/pulsar-admin/proxy-stats.md create mode 100644 static/reference/4.0.x/pulsar-admin/resource-quotas.md create mode 100644 static/reference/4.0.x/pulsar-admin/resourcegroups.md create mode 100644 static/reference/4.0.x/pulsar-admin/schemas.md create mode 100644 static/reference/4.0.x/pulsar-admin/sinks.md create mode 100644 static/reference/4.0.x/pulsar-admin/sources.md create mode 100644 static/reference/4.0.x/pulsar-admin/tenants.md create mode 100644 static/reference/4.0.x/pulsar-admin/topicPolicies.md create mode 100644 static/reference/4.0.x/pulsar-admin/topics.md create mode 100644 static/reference/4.0.x/pulsar-admin/transactions.md create mode 100644 static/reference/4.0.x/pulsar-client/README.md create mode 100644 static/reference/4.0.x/pulsar-client/pulsar-client.md create mode 100644 static/reference/4.0.x/pulsar-daemon/README.md create mode 100644 static/reference/4.0.x/pulsar-daemon/pulsar-daemon.md create mode 100644 static/reference/4.0.x/pulsar-perf/README.md create mode 100644 static/reference/4.0.x/pulsar-perf/pulsar-perf.md create mode 100644 static/reference/4.0.x/pulsar-shell/README.md create mode 100644 static/reference/4.0.x/pulsar-shell/pulsar-shell.md create mode 100644 static/reference/4.0.x/pulsar/README.md create mode 100644 static/reference/4.0.x/pulsar/broker-tool.md create mode 100644 static/reference/4.0.x/pulsar/broker.md create mode 100644 static/reference/4.0.x/pulsar/compact-topic.md create mode 100644 static/reference/4.0.x/pulsar/delete-cluster-metadata.md create mode 100644 static/reference/4.0.x/pulsar/functions-worker.md create mode 100644 static/reference/4.0.x/pulsar/initialize-cluster-metadata.md create mode 100644 static/reference/4.0.x/pulsar/initialize-namespace.md create mode 100644 static/reference/4.0.x/pulsar/initialize-transaction-coordinator-metadata.md create mode 100644 static/reference/4.0.x/pulsar/proxy.md create mode 100644 static/reference/4.0.x/pulsar/standalone.md create mode 100644 static/reference/4.0.x/pulsar/tokens.md create mode 100644 static/reference/4.0.x/pulsar/version.md create mode 100644 static/reference/4.0.x/pulsar/websocket.md diff --git a/static/reference/4.0.x/README.md b/static/reference/4.0.x/README.md new file mode 100644 index 000000000000..7308b61184c8 --- /dev/null +++ b/static/reference/4.0.x/README.md @@ -0,0 +1,3 @@ +# Welcome + +> Welcome to Pulsar Configuration Docs. diff --git a/static/reference/4.0.x/_sidebar.md b/static/reference/4.0.x/_sidebar.md new file mode 100644 index 000000000000..3d40539231af --- /dev/null +++ b/static/reference/4.0.x/_sidebar.md @@ -0,0 +1,61 @@ +- [Configuration]() + - [Pulsar](config/) + - [BookKeeper](config/reference-configuration-bookkeeper) + - [Broker](config/reference-configuration-broker) + - [Client](config/reference-configuration-client) + - [Log4j](config/reference-configuration-log4j) + - [Log4j shell](config/reference-configuration-log4j-shell) + - [Standalone](config/reference-configuration-standalone) + - [WebSocket](config/reference-configuration-websocket) + - [Pulsar proxy](config/reference-configuration-pulsar-proxy) + - [ZooKeeper](config/reference-configuration-zookeeper) + - [Client](client/) + - [Client](client/client-configuration-client) + - [Producer](client/client-configuration-producer) + - [Consumer](client/client-configuration-consumer) + - [Reader](client/client-configuration-reader) +- [CLI Tools](cli.md) + - [pulsar-admin](pulsar-admin/) + - [broker-stats](pulsar-admin/broker-stats.md) + - [brokers](pulsar-admin/brokers.md) + - [bookies](pulsar-admin/bookies.md) + - [clusters](pulsar-admin/clusters.md) + - [functions](pulsar-admin/functions.md) + - [functions-worker](pulsar-admin/functions-worker.md) + - [namespaces](pulsar-admin/namespaces.md) + - [ns-isolation-policy](pulsar-admin/ns-isolation-policy.md) + - [sources](pulsar-admin/sources.md) + - [sinks](pulsar-admin/sinks.md) + - [topics](pulsar-admin/topics.md) + - [topicPolicies](pulsar-admin/topicPolicies.md) + - [proxy-stats](pulsar-admin/proxy-stats.md) + - [resourcegroups](pulsar-admin/resourcegroups.md) + - [transactions](pulsar-admin/transactions.md) + - [tenants](pulsar-admin/tenants.md) + - [resource-quotas](pulsar-admin/resource-quotas.md) + - [schemas](pulsar-admin/schemas.md) + - [packages](pulsar-admin/packages.md) + - [pulsar](pulsar/) + - [broker](pulsar/broker.md) + - [broker-tool](pulsar/broker-tool.md) + - [compact-topic](pulsar/compact-topic.md) + - [tokens](pulsar/tokens.md) + - [proxy](pulsar/proxy.md) + - [functions-worker](pulsar/functions-worker.md) + - [standalone](pulsar/standalone.md) + - [initialize-cluster-metadata](pulsar/initialize-cluster-metadata.md) + - [delete-cluster-metadata](pulsar/delete-cluster-metadata.md) + - [initialize-transaction-coordinator-metadata](pulsar/initialize-transaction-coordinator-metadata.md) + - [initialize-namespace](pulsar/initialize-namespace.md) + - [version](pulsar/version.md) + - [websocket](pulsar/websocket.md) + - [pulsar-client](pulsar-client/) + - [pulsar-client](pulsar-client/pulsar-client.md) + - [pulsar-daemon](pulsar-daemon/) + - [pulsar-daemon](pulsar-daemon/pulsar-daemon.md) + - [pulsar-perf](pulsar-perf/) + - [pulsar-perf](pulsar-perf/pulsar-perf.md) + - [pulsar-shell](pulsar-shell/) + - [pulsar-shell](pulsar-shell/pulsar-shell.md) + - [bookkeeper](bookkeeper/) + - [bookkeeper](bookkeeper/bookkeeper.md) diff --git a/static/reference/4.0.x/bookkeeper/README.md b/static/reference/4.0.x/bookkeeper/README.md new file mode 100644 index 000000000000..9d1dd4aed50c --- /dev/null +++ b/static/reference/4.0.x/bookkeeper/README.md @@ -0,0 +1 @@ +> Docs for `bookkeeper`. diff --git a/static/reference/4.0.x/bookkeeper/bookkeeper.md b/static/reference/4.0.x/bookkeeper/bookkeeper.md new file mode 100644 index 000000000000..2c1ab17dff96 --- /dev/null +++ b/static/reference/4.0.x/bookkeeper/bookkeeper.md @@ -0,0 +1,94 @@ +# bookkeeper +A tool for managing BookKeeper. + +### Environment variables + +The table below lists the environment variables that you can use to configure the bookkeeper tool. + +|Variable|Description|Default| +|---|---|---| +|BOOKIE_LOG_CONF|Log4j configuration file|conf/log4j2.yaml| +|BOOKIE_CONF|BookKeeper configuration file|conf/bk_server.conf| +|BOOKIE_EXTRA_OPTS|Extra options to be passed to the JVM|| +|BOOKIE_EXTRA_CLASSPATH|Extra paths for BookKeeper's classpath|| +|ENTRY_FORMATTER_CLASS|The Java class used to format entries|| +|BOOKIE_PID_DIR|Folder where the BookKeeper server PID file should be stored|| +|BOOKIE_STOP_TIMEOUT|Wait time before forcefully killing the Bookie server instance if attempts to stop it are not successful|| +|BOOKIE_GC_LOG|Gc options to be passed to the jvm|| + + +### autorecovery +Runs an auto-recovery service + +Usage + +```bash +bookkeeper autorecovery options +``` + +Options + +|Flag|Description|Default| +|---|---|---| +|`-c`, `--conf`|Configuration for the auto-recovery|| + + +### bookie +Starts up a BookKeeper server (aka bookie) + +Usage + +```bash +bookkeeper bookie options +``` + +Options + +|Flag|Description|Default| +|---|---|---| +|`-c`, `--conf`|Configuration for the auto-recovery|| +|-readOnly|Force start a read-only bookie server|false| +|-withAutoRecovery|Start auto-recovery service bookie server|false| + + +### localbookie +Runs a test ensemble of N bookies locally + +Usage + +```bash +bookkeeper localbookie N +``` + +### upgrade +Upgrade the bookie’s filesystem + +Usage + +```bash +bookkeeper upgrade options +``` + +Options + +|Flag|Description|Default| +|---|---|---| +|`-c`, `--conf`|Configuration for the auto-recovery|| +|`-u`, `--upgrade`|Upgrade the bookie’s directories|| + + +### shell +Run shell for admin commands. To see a full listing of those commands, run bookkeeper shell without an argument. + +Usage + +```bash +bookkeeper shell +``` + +Example + +```bash +bookkeeper shell bookiesanity +``` + diff --git a/static/reference/4.0.x/cli.md b/static/reference/4.0.x/cli.md new file mode 100644 index 000000000000..520d14e5b034 --- /dev/null +++ b/static/reference/4.0.x/cli.md @@ -0,0 +1,3 @@ +# Welcome + +> Welcome to Pulsar CLI Tools Docs. diff --git a/static/reference/4.0.x/client/README.md b/static/reference/4.0.x/client/README.md new file mode 100644 index 000000000000..71df588c6f83 --- /dev/null +++ b/static/reference/4.0.x/client/README.md @@ -0,0 +1,28 @@ +## Client Configurations + +If you create a Java client, producer, consumer, or reader, you can use the `loadConf` configurations. + +- [Client configurations](/@pulsar:version_reference@/client/client-configuration-client) +- [Producer configurations](/@pulsar:version_reference@/client/client-configuration-producer) +- [Consumer configurations](/@pulsar:version_reference@/client/client-configuration-consumer) +- [Reader configurations](/@pulsar:version_reference@/client/client-configuration-reader) + +### Set client memory allocator configs using Java system properties + +You can set the client memory allocator configurations through Java properties.
        + +| Property | Type |
        Description
        | Default | Available values | +|-----------------------------------------|--------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------|-------------------------------------------------------------------------------| +| `pulsar.allocator.pooled` | String | If set to `true`, the client uses a direct memory pool.
        If set to `false`, the client uses a heap memory without pool. | true |
      • true
      • false
        • | +| `pulsar.allocator.exit_on_oom` | String | Whether to exit the JVM when OOM happens. | false |
      • true
      • false
        • | +| `pulsar.allocator.leak_detection` | String | The leak detection policy for Pulsar bytebuf allocator.
      • **Disabled**: No leak detection and no overhead.
      • **Simple**: Instruments 1% of the allocated buffer to track for leaks.
      • **Advanced**: Instruments 1% of the allocated buffer to track for leaks, reporting stack traces of places where the buffer is used.
      • **Paranoid**: Instruments 100% of the allocated buffer to track for leaks, reporting stack traces of places where the buffer is used and introduces a significant overhead.
        • | Disabled |
      • Disabled
      • Simple
      • Advanced
      • Paranoid
        • | +| `pulsar.allocator.out_of_memory_policy` | String | When an OOM occurs, the client throws an exception or fallbacks to heap. | FallbackToHeap |
      • ThrowException
      • FallbackToHeap
        • | + +**Example** + +```conf +Dpulsar.allocator.pooled=true +Dpulsar.allocator.exit_on_oom=false +Dpulsar.allocator.leak_detection=Disabled +Dpulsar.allocator.out_of_memory_policy=ThrowException +``` diff --git a/static/reference/4.0.x/client/client-configuration-client.md b/static/reference/4.0.x/client/client-configuration-client.md new file mode 100644 index 000000000000..8dc58d553f24 --- /dev/null +++ b/static/reference/4.0.x/client/client-configuration-client.md @@ -0,0 +1,397 @@ +# Client + +## Required +### serviceUrl +Pulsar cluster HTTP URL to connect to a broker. + +**Type**: `java.lang.String` + +**Default**: `null` + +## Optional +### authParamMap +Authentication map of the client. + +**Type**: `java.util.Map` + +**Default**: `null` + +### authParams +Authentication parameter of the client. + +**Type**: `java.lang.String` + +**Default**: `null` + +### authPluginClassName +Class name of authentication plugin of the client. + +**Type**: `java.lang.String` + +**Default**: `null` + +### authentication +Authentication settings of the client. + +**Type**: `org.apache.pulsar.client.api.Authentication` + +**Default**: `null` + +### autoCertRefreshSeconds +Seconds of auto refreshing certificate. + +**Type**: `int` + +**Default**: `300` + +### concurrentLookupRequest +The number of concurrent lookup requests that can be sent on each broker connection. Setting a maximum prevents overloading a broker. + +**Type**: `int` + +**Default**: `5000` + +### connectionMaxIdleSeconds +Release the connection if it is not used for more than [connectionMaxIdleSeconds] seconds. If [connectionMaxIdleSeconds] < 0, disabled the feature that auto release the idle connections + +**Type**: `int` + +**Default**: `60` + +### connectionTimeoutMs +Duration of waiting for a connection to a broker to be established.If the duration passes without a response from a broker, the connection attempt is dropped. + +**Type**: `int` + +**Default**: `10000` + +### connectionsPerBroker +Number of connections established between the client and each Broker. A value of 0 means to disable connection pooling. + +**Type**: `int` + +**Default**: `1` + +### description +The extra description of the client version. The length cannot exceed 64. + +**Type**: `java.lang.String` + +**Default**: `null` + +### dnsLookupBindAddress +The Pulsar client dns lookup bind address, default behavior is bind on 0.0.0.0 + +**Type**: `java.lang.String` + +**Default**: `null` + +### dnsLookupBindPort +The Pulsar client dns lookup bind port, takes effect when dnsLookupBindAddress is configured, default value is 0. + +**Type**: `int` + +**Default**: `0` + +### dnsServerAddresses +The Pulsar client dns lookup server address + +**Type**: `java.util.List` + +**Default**: `[]` + +### enableBusyWait +Whether to enable BusyWait for EpollEventLoopGroup. + +**Type**: `boolean` + +**Default**: `false` + +### enableTransaction +Whether to enable transaction. + +**Type**: `boolean` + +**Default**: `false` + +### initialBackoffIntervalNanos +Initial backoff interval (in nanosecond). + +**Type**: `long` + +**Default**: `100000000` + +### keepAliveIntervalSeconds +Seconds of keeping alive interval for each client broker connection. + +**Type**: `int` + +**Default**: `30` + +### listenerName +Listener name for lookup. Clients can use listenerName to choose one of the listeners as the service URL to create a connection to the broker as long as the network is accessible."advertisedListeners" must enabled in broker side. + +**Type**: `java.lang.String` + +**Default**: `null` + +### lookupTimeoutMs +Client lookup timeout (in milliseconds). + +**Type**: `long` + +**Default**: `-1` + +### maxBackoffIntervalNanos +Max backoff interval (in nanosecond). + +**Type**: `long` + +**Default**: `60000000000` + +### maxLookupRedirects +Maximum times of redirected lookup requests. + +**Type**: `int` + +**Default**: `20` + +### maxLookupRequest +Maximum number of lookup requests allowed on each broker connection to prevent overloading a broker. + +**Type**: `int` + +**Default**: `50000` + +### maxNumberOfRejectedRequestPerConnection +Maximum number of rejected requests of a broker in a certain time frame (60 seconds) after the current connection is closed and the client creating a new connection to connect to a different broker. + +**Type**: `int` + +**Default**: `50` + +### memoryLimitBytes +Limit of client memory usage (in byte). The 64M default can guarantee a high producer throughput. + +**Type**: `long` + +**Default**: `67108864` + +### numIoThreads +Number of IO threads. + +**Type**: `int` + +**Default**: `14` + +### numListenerThreads +Number of consumer listener threads. + +**Type**: `int` + +**Default**: `14` + +### operationTimeoutMs +Client operation timeout (in milliseconds). + +**Type**: `long` + +**Default**: `30000` + +### proxyProtocol +Protocol of proxy service. proxyServiceUrl and proxyProtocol must be mutually inclusive. + +**Type**: `org.apache.pulsar.client.api.ProxyProtocol` + +**Default**: `null` + +### proxyServiceUrl +URL of proxy service. proxyServiceUrl and proxyProtocol must be mutually inclusive. + +**Type**: `java.lang.String` + +**Default**: `null` + +### readTimeoutMs +Maximum read time of a request. + +**Type**: `int` + +**Default**: `60000` + +### requestTimeoutMs +Maximum duration for completing a request. + +**Type**: `int` + +**Default**: `60000` + +### serviceUrlProvider +The implementation class of ServiceUrlProvider used to generate ServiceUrl. + +**Type**: `org.apache.pulsar.client.api.ServiceUrlProvider` + +**Default**: `null` + +### socks5ProxyAddress +Address of SOCKS5 proxy. + +**Type**: `java.net.InetSocketAddress` + +**Default**: `null` + +### socks5ProxyPassword +Password of SOCKS5 proxy. + +**Type**: `java.lang.String` + +**Default**: `null` + +### socks5ProxyUsername +User name of SOCKS5 proxy. + +**Type**: `java.lang.String` + +**Default**: `null` + +### sslFactoryPlugin +SSL Factory Plugin class to provide SSLEngine and SSLContext objects. The default class used is DefaultPulsarSslFactory. + +**Type**: `java.lang.String` + +**Default**: `org.apache.pulsar.common.util.DefaultPulsarSslFactory` + +### sslFactoryPluginParams +SSL Factory plugin configuration parameters. + +**Type**: `java.lang.String` + +**Default**: `` + +### sslProvider +The TLS provider used by an internal client to authenticate with other Pulsar brokers. + +**Type**: `java.lang.String` + +**Default**: `null` + +### statsIntervalSeconds +Interval to print client stats (in seconds). + +**Type**: `long` + +**Default**: `60` + +### tlsAllowInsecureConnection +Whether the client accepts untrusted TLS certificates from the broker. + +**Type**: `boolean` + +**Default**: `false` + +### tlsCertificateFilePath +Path to the TLS certificate file. + +**Type**: `java.lang.String` + +**Default**: `null` + +### tlsCiphers +Set of TLS Ciphers. + +**Type**: `java.util.Set` + +**Default**: `[]` + +### tlsHostnameVerificationEnable +Whether the hostname is validated when the client creates a TLS connection with brokers. + +**Type**: `boolean` + +**Default**: `false` + +### tlsKeyFilePath +Path to the TLS key file. + +**Type**: `java.lang.String` + +**Default**: `null` + +### tlsKeyStorePassword +Password of TLS KeyStore. + +**Type**: `java.lang.String` + +**Default**: `null` + +### tlsKeyStorePath +Path of TLS KeyStore. + +**Type**: `java.lang.String` + +**Default**: `null` + +### tlsKeyStoreType +TLS KeyStore type configuration. + +**Type**: `java.lang.String` + +**Default**: `JKS` + +### tlsProtocols +Protocols of TLS. + +**Type**: `java.util.Set` + +**Default**: `[]` + +### tlsTrustCertsFilePath +Path to the trusted TLS certificate file. + +**Type**: `java.lang.String` + +**Default**: `null` + +### tlsTrustStorePassword +Password of TLS TrustStore. + +**Type**: `java.lang.String` + +**Default**: `null` + +### tlsTrustStorePath +Path of TLS TrustStore. + +**Type**: `java.lang.String` + +**Default**: `null` + +### tlsTrustStoreType +TLS TrustStore type configuration. You need to set this configuration when client authentication is required. + +**Type**: `java.lang.String` + +**Default**: `JKS` + +### useKeyStoreTls +Set TLS using KeyStore way. + +**Type**: `boolean` + +**Default**: `false` + +### useTcpNoDelay +Whether to use TCP NoDelay option. + +**Type**: `boolean` + +**Default**: `true` + +### useTls +Whether to use TLS. + +**Type**: `boolean` + +**Default**: `false` + + diff --git a/static/reference/4.0.x/client/client-configuration-consumer.md b/static/reference/4.0.x/client/client-configuration-consumer.md new file mode 100644 index 000000000000..f54a86c61f98 --- /dev/null +++ b/static/reference/4.0.x/client/client-configuration-consumer.md @@ -0,0 +1,282 @@ +# Consumer + +## Required +### topicNames +Topic name + +**Type**: `java.util.Set` + +**Default**: `[]` + +## Optional +### ackTimeoutMillis +Timeout of unacked messages + +**Type**: `long` + +**Default**: `0` + +### ackTimeoutRedeliveryBackoff +Interface for custom message is ackTimeout policy. You can specify `RedeliveryBackoff` for a consumer. + +**Type**: `org.apache.pulsar.client.api.RedeliveryBackoff` + +**Default**: `null` + +### acknowledgementsGroupTimeMicros +Group a consumer acknowledgment for a specified time. + +By default, a consumer uses 100ms grouping time to send out acknowledgments to a broker. + +Setting a group time of 0 sends out acknowledgments immediately. + +A longer ack group time is more efficient at the expense of a slight increase in message re-deliveries after a failure. + +**Type**: `long` + +**Default**: `100000` + +### autoAckOldestChunkedMessageOnQueueFull +Whether to automatically acknowledge pending chunked messages when the threshold of `maxPendingChunkedMessage` is reached. If set to `false`, these messages will be redelivered by their broker. + +**Type**: `boolean` + +**Default**: `false` + +### autoUpdatePartitions +If `autoUpdatePartitions` is enabled, a consumer subscribes to partition increasement automatically. + +**Note**: this is only for partitioned consumers. + +**Type**: `boolean` + +**Default**: `true` + +### consumerName +Consumer name + +**Type**: `java.lang.String` + +**Default**: `null` + +### cryptoFailureAction +Consumer should take action when it receives a message that can not be decrypted. +* **FAIL**: this is the default option to fail messages until crypto succeeds. +* **DISCARD**:silently acknowledge and not deliver message to an application. +* **CONSUME**: deliver encrypted messages to applications. It is the application's responsibility to decrypt the message. + +The decompression of message fails. + +If messages contain batch messages, a client is not be able to retrieve individual messages in batch. + +Delivered encrypted message contains {@link EncryptionContext} which contains encryption and compression information in it using which application can decrypt consumed message payload. + +**Type**: `org.apache.pulsar.client.api.ConsumerCryptoFailureAction` + +**Default**: `FAIL` + +### deadLetterPolicy +Dead letter policy for consumers. + +By default, some messages are probably redelivered many times, even to the extent that it never stops. + +By using the dead letter mechanism, messages have the max redelivery count. **When exceeding the maximum number of redeliveries, messages are sent to the Dead Letter Topic and acknowledged automatically**. + +You can enable the dead letter mechanism by setting `deadLetterPolicy`. + +**Example** +```java +client.newConsumer() +.deadLetterPolicy(DeadLetterPolicy.builder().maxRedeliverCount(10).build()) +.subscribe(); +``` +Default dead letter topic name is `{TopicName}-{Subscription}-DLQ`. + +To set a custom dead letter topic name: +```java +client.newConsumer() +.deadLetterPolicy(DeadLetterPolicy.builder().maxRedeliverCount(10) +.deadLetterTopic("your-topic-name").build()) +.subscribe(); +``` +When specifying the dead letter policy while not specifying `ackTimeoutMillis`, you can set the ack timeout to 30000 millisecond. + +**Type**: `org.apache.pulsar.client.api.DeadLetterPolicy` + +**Default**: `null` + +### expireTimeOfIncompleteChunkedMessageMillis +The time interval to expire incomplete chunks if a consumer fails to receive all the chunks in the specified time period. The default value is 1 minute. + +**Type**: `long` + +**Default**: `60000` + +### maxAcknowledgmentGroupSize +Group a consumer acknowledgment for the number of messages. + +**Type**: `int` + +**Default**: `1000` + +### maxPendingChunkedMessage +The maximum size of a queue holding pending chunked messages. When the threshold is reached, the consumer drops pending messages to optimize memory utilization. + +**Type**: `int` + +**Default**: `10` + +### maxTotalReceiverQueueSizeAcrossPartitions +The max total receiver queue size across partitions. + +This setting reduces the receiver queue size for individual partitions if the total receiver queue size exceeds this value. + +**Type**: `int` + +**Default**: `50000` + +### negativeAckRedeliveryBackoff +Interface for custom message is negativeAcked policy. You can specify `RedeliveryBackoff` for a consumer. + +**Type**: `org.apache.pulsar.client.api.RedeliveryBackoff` + +**Default**: `null` + +### negativeAckRedeliveryDelayMicros +Delay to wait before redelivering messages that failed to be processed. + +When an application uses {@link Consumer#negativeAcknowledge(Message)}, failed messages are redelivered after a fixed timeout. + +**Type**: `long` + +**Default**: `60000000` + +### patternAutoDiscoveryPeriod +Topic auto discovery period when using a pattern for topic's consumer. + +The default value is 1 minute, with a minimum of 1 second. + +**Type**: `int` + +**Default**: `60` + +### priorityLevel +Priority level for a consumer to which a broker gives more priority while dispatching messages in Shared subscription type. + +The broker follows descending priorities. For example, 0=max-priority, 1, 2,... + +In Shared subscription type, the broker **first dispatches messages to the max priority level consumers if they have permits**. Otherwise, the broker considers next priority level consumers. + +**Example 1** +If a subscription has consumerA with `priorityLevel` 0 and consumerB with `priorityLevel` 1, then the broker **only dispatches messages to consumerA until it runs out permits** and then starts dispatching messages to consumerB. + +**Example 2** +Consumer Priority, Level, Permits +C1, 0, 2 +C2, 0, 1 +C3, 0, 1 +C4, 1, 2 +C5, 1, 1 + +Order in which a broker dispatches messages to consumers is: C1, C2, C3, C1, C4, C5, C4. + +**Type**: `int` + +**Default**: `0` + +### properties +A name or value property of this consumer. + +`properties` is application defined metadata attached to a consumer. + +When getting a topic stats, associate this metadata with the consumer stats for easier identification. + +**Type**: `java.util.SortedMap` + +**Default**: `{}` + +### readCompacted +If enabling `readCompacted`, a consumer reads messages from a compacted topic rather than reading a full message backlog of a topic. + +A consumer only sees the latest value for each key in the compacted topic, up until reaching the point in the topic message when compacting backlog. Beyond that point, send messages as normal. + +Only enabling `readCompacted` on subscriptions to persistent topics, which have a single active consumer (like failure or exclusive subscriptions). + +Attempting to enable it on subscriptions to non-persistent topics or on shared subscriptions leads to a subscription call throwing a `PulsarClientException`. + +**Type**: `boolean` + +**Default**: `false` + +### receiverQueueSize +Size of a consumer's receiver queue. + +For example, the number of messages accumulated by a consumer before an application calls `Receive`. + +A value higher than the default value increases consumer throughput, though at the expense of more memory utilization. + +**Type**: `int` + +**Default**: `1000` + +### regexSubscriptionMode +When subscribing to a topic using a regular expression, you can pick a certain type of topics. + +* **PersistentOnly**: only subscribe to persistent topics. +* **NonPersistentOnly**: only subscribe to non-persistent topics. +* **AllTopics**: subscribe to both persistent and non-persistent topics. + +**Type**: `org.apache.pulsar.client.api.RegexSubscriptionMode` + +**Default**: `PersistentOnly` + +### replicateSubscriptionState +If `replicateSubscriptionState` is enabled, a subscription state is replicated to geo-replicated clusters. + +**Type**: `boolean` + +**Default**: `false` + +### subscriptionInitialPosition +Initial position at which to set cursor when subscribing to a topic at first time. + +**Type**: `org.apache.pulsar.client.api.SubscriptionInitialPosition` + +**Default**: `Latest` + +### subscriptionName +Subscription name + +**Type**: `java.lang.String` + +**Default**: `null` + +### subscriptionType +Subscription type. +Four subscription types are available: +* Exclusive +* Failover +* Shared +* Key_Shared + +**Type**: `org.apache.pulsar.client.api.SubscriptionType` + +**Default**: `Exclusive` + +### tickDurationMillis +Granularity of the ack-timeout redelivery. + +Using an higher `tickDurationMillis` reduces the memory overhead to track messages when setting ack-timeout to a bigger value (for example, 1 hour). + +**Type**: `long` + +**Default**: `1000` + +### topicsPattern +The regexp for the topic name(not contains partition suffix). + +**Type**: `java.util.regex.Pattern` + +**Default**: `null` + + diff --git a/static/reference/4.0.x/client/client-configuration-producer.md b/static/reference/4.0.x/client/client-configuration-producer.md new file mode 100644 index 000000000000..d8cbfd5c8c38 --- /dev/null +++ b/static/reference/4.0.x/client/client-configuration-producer.md @@ -0,0 +1,136 @@ +# Producer + +## Required +### topicName +Topic name + +**Type**: `java.lang.String` + +**Default**: `null` + +## Optional +### batchingEnabled +Enable batching of messages. + +**Type**: `boolean` + +**Default**: `true` + +### batchingMaxMessages +The maximum number of messages permitted in a batch. + +**Type**: `int` + +**Default**: `1000` + +### batchingMaxPublishDelayMicros +Batching time period of sending messages. + +**Type**: `long` + +**Default**: `1000` + +### blockIfQueueFull +If it is set to `true`, when the outgoing message queue is full, the `Send` and `SendAsync` methods of producer block, rather than failing and throwing errors. +If it is set to `false`, when the outgoing message queue is full, the `Send` and `SendAsync` methods of producer fail and `ProducerQueueIsFullError` exceptions occur. + +The `MaxPendingMessages` parameter determines the size of the outgoing message queue. + +**Type**: `boolean` + +**Default**: `false` + +### chunkingEnabled +Enable chunking of messages. + +**Type**: `boolean` + +**Default**: `false` + +### compressionType +Message data compression type used by a producer. +Available options: +* [LZ4](https://github.com/lz4/lz4) +* [ZLIB](https://zlib.net/) +* [ZSTD](https://facebook.github.io/zstd/) +* [SNAPPY](https://google.github.io/snappy/) + +**Type**: `org.apache.pulsar.client.api.CompressionType` + +**Default**: `NONE` + +### cryptoFailureAction +Producer should take action when encryption fails. +* **FAIL**: if encryption fails, unencrypted messages fail to send. +* **SEND**: if encryption fails, unencrypted messages are sent. + +**Type**: `org.apache.pulsar.client.api.ProducerCryptoFailureAction` + +**Default**: `FAIL` + +### hashingScheme +Hashing function determining the partition where you publish a particular message (partitioned topics only). +Available options are as follows: +* `pulsar.JavastringHash`: the equivalent of `string.hashCode()` in Java +* `pulsar.Murmur3_32Hash`: applies the [Murmur3](https://en.wikipedia.org/wiki/MurmurHash) hashing function +* `pulsar.BoostHash`: applies the hashing function from C++'s[Boost](https://www.boost.org/doc/libs/1_62_0/doc/html/hash.html) library + +**Type**: `org.apache.pulsar.client.api.HashingScheme` + +**Default**: `JavaStringHash` + +### initialSubscriptionName +Use this configuration to automatically create an initial subscription when creating a topic. If this field is not set, the initial subscription is not created. + +**Type**: `java.lang.String` + +**Default**: `null` + +### maxPendingMessages +The maximum size of a queue holding pending messages. + +For example, a message waiting to receive an acknowledgment from a [broker](https://pulsar.apache.org/docs/reference-terminology#broker). + +By default, when the queue is full, all calls to the `Send` and `SendAsync` methods fail **unless** you set `BlockIfQueueFull` to `true`. + +**Type**: `int` + +**Default**: `0` + +### maxPendingMessagesAcrossPartitions +The maximum number of pending messages across partitions. + +Use the setting to lower the max pending messages for each partition ({@link #setMaxPendingMessages(int)}) if the total number exceeds the configured value. + +**Type**: `int` + +**Default**: `0` + +### messageRoutingMode +Message routing logic for producers on [partitioned topics](https://pulsar.apache.org/docs/concepts-architecture-overview#partitioned-topics). +Apply the logic only when setting no key on messages. +Available options are as follows: +* `pulsar.RoundRobinDistribution`: round robin +* `pulsar.UseSinglePartition`: publish all messages to a single partition +* `pulsar.CustomPartition`: a custom partitioning scheme + +**Type**: `org.apache.pulsar.client.api.MessageRoutingMode` + +**Default**: `null` + +### producerName +Producer name + +**Type**: `java.lang.String` + +**Default**: `null` + +### sendTimeoutMs +Message send timeout in ms. +If a message is not acknowledged by a server before the `sendTimeout` expires, an error occurs. + +**Type**: `long` + +**Default**: `30000` + + diff --git a/static/reference/4.0.x/client/client-configuration-reader.md b/static/reference/4.0.x/client/client-configuration-reader.md new file mode 100644 index 000000000000..8abe16ba92aa --- /dev/null +++ b/static/reference/4.0.x/client/client-configuration-reader.md @@ -0,0 +1,96 @@ +# Reader + +## Required +### topicNames +Topic name + +**Type**: `java.util.Set` + +**Default**: `[]` + +## Optional +### cryptoFailureAction +Consumer should take action when it receives a message that can not be decrypted. +* **FAIL**: this is the default option to fail messages until crypto succeeds. +* **DISCARD**: silently acknowledge and not deliver message to an application. +* **CONSUME**: deliver encrypted messages to applications. It is the application's responsibility to decrypt the message. + +The message decompression fails. + +If messages contain batch messages, a client is not be able to retrieve individual messages in batch. + +Delivered encrypted message contains {@link EncryptionContext} which contains encryption and compression information in it using which application can decrypt consumed message payload. + +**Type**: `org.apache.pulsar.client.api.ConsumerCryptoFailureAction` + +**Default**: `FAIL` + +### cryptoKeyReader +Interface that abstracts the access to a key store. + +**Type**: `org.apache.pulsar.client.api.CryptoKeyReader` + +**Default**: `null` + +### readCompacted +If enabling `readCompacted`, a consumer reads messages from a compacted topic rather than a full message backlog of a topic. + +A consumer only sees the latest value for each key in the compacted topic, up until reaching the point in the topic message when compacting backlog. Beyond that point, send messages as normal. + +`readCompacted` can only be enabled on subscriptions to persistent topics, which have a single active consumer (for example, failure or exclusive subscriptions). + +Attempting to enable it on subscriptions to non-persistent topics or on shared subscriptions leads to a subscription call throwing a `PulsarClientException`. + +**Type**: `boolean` + +**Default**: `false` + +### readerListener +A listener that is called for message received. + +**Type**: `org.apache.pulsar.client.api.ReaderListener` + +**Default**: `null` + +### readerName +Reader name + +**Type**: `java.lang.String` + +**Default**: `null` + +### receiverQueueSize +Size of a consumer's receiver queue. + +For example, the number of messages that can be accumulated by a consumer before an application calls `Receive`. + +A value higher than the default value increases consumer throughput, though at the expense of more memory utilization. + +**Type**: `int` + +**Default**: `1000` + +### resetIncludeHead +If set to true, the first message to be returned is the one specified by `messageId`. + +If set to false, the first message to be returned is the one next to the message specified by `messageId`. + +**Type**: `boolean` + +**Default**: `false` + +### subscriptionName +Subscription name + +**Type**: `java.lang.String` + +**Default**: `null` + +### subscriptionRolePrefix +Prefix of subscription role. + +**Type**: `java.lang.String` + +**Default**: `null` + + diff --git a/static/reference/4.0.x/config/README.md b/static/reference/4.0.x/config/README.md new file mode 100644 index 000000000000..02de38261869 --- /dev/null +++ b/static/reference/4.0.x/config/README.md @@ -0,0 +1,108 @@ +## Pulsar configurations + +You can manage Pulsar configurations through configuration files in +the [`conf`](https://github.com/apache/pulsar/tree/master/conf) directory of a Pulsar installation. + +- [BookKeeper](/@pulsar:version_reference@/config/reference-configuration-bookkeeper) +- [Broker](/@pulsar:version_reference@/config/reference-configuration-broker) +- [Client](/@pulsar:version_reference@/config/reference-configuration-client) +- [Log4j](/@pulsar:version_reference@/config/reference-configuration-log4j) +- [Log4j shell](/@pulsar:version_reference@/config/reference-configuration-log4j-shell) +- [Standalone](/@pulsar:version_reference@/config/reference-configuration-standalone) +- [WebSocket](/@pulsar:version_reference@/config/reference-configuration-websocket) +- [Pulsar proxy](/@pulsar:version_reference@/config/reference-configuration-pulsar-proxy) +- [ZooKeeper](/@pulsar:version_reference@/config/reference-configuration-zookeeper) + +### Override client configurations + +If you want to override the configurations of clients internal to brokers, websockets, and proxies, you can use the +following prefix. + +| Prefix | Description | +|---------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| brokerClient_ | Configure **all** the Pulsar Clients and Pulsar Admin Clients of brokers, websockets, and proxies. These configurations are applied after hard-coded configurations and before the client configurations named in this site. | +| bookkeeper_ | Configure the broker's BookKeeper clients used by managed ledgers and the BookkeeperPackagesStorage bookkeeper client. Takes precedence over most other configuration values. | + +> Notes: +> * This override feature only applies to Pulsar 2.10.1 and later versions. +> * When running the function worker within the broker, you have to configure those clients by using + the `functions_worker.yml` file. These prefixed configurations do not apply to any of those clients. + +### Set specific configurations using Java system property + +You can set specific configurations through Java properties. + +| **Property** | **Description** | +|--------------------|---------------------------------------------------------------------------------------------------------------| +| pulsar.enableUring | Use `io_uring` instead of `epoll` as network IO mode. `-Dpulsar.enableUring=1` means this feature is enabled. | + +## Broker load balancing configurations + +Below is a brief summary of configurations for broker load balancing. + +For detailed descriptions of each configuration, +see [Broker load balancing | Configurations](pathname:///reference/#/@pulsar:version_reference@/config/reference-configuration-broker). + +> Note +> Configurations with an asterisk (*) are only available in the extensible load balancer. + +### Broker load data + +- loadBalancerReportUpdateMinIntervalMillis +- loadBalancerReportUpdateThresholdPercentage +- loadBalancerReportUpdateMaxIntervalMinutes +- loadBalancerBandwithInResourceWeight +- loadBalancerBandwithOutResourceWeight +- loadBalancerCPUResourceWeight +- loadBalancerMemoryResourceWeight +- loadBalancerDirectMemoryResourceWeight +- loadBalancerHistoryResourcePercentage + +### TopK bundle load data + +- loadBalancerReportUpdateMinIntervalMillis +- statsUpdateFrequencyInSecs +- loadBalancerMaxNumberOfBundlesInBundleLoadReport* + +### Bundle-broker assignment + +- loadBalancerAverageResourceUsageDifferenceThresholdPercentage + +### Bundle ownership system topic (ServiceUnitStateChannel) + +- loadBalancerServiceUnitStateTombstoneDelayTimeInSeconds* + +### Bundle unloading + +- loadBalancerEnabled +- loadBalancerSheddingEnabled +- loadBalancerSheddingIntervalMinutes +- loadBalancerSheddingGracePeriodMinutes +- loadBalancerBrokerOverloadedThresholdPercentage +- loadBalancerLoadSheddingStrategy. The default value + is [org.apache.pulsar.broker.loadbalance.impl.ThresholdShedder](https://github.com/apache/pulsar/blob/782e91fe327efe2c9c9107d6c679c2837d43935b/conf/broker.conf#L1324). + Available values are: + - `org.apache.pulsar.broker.loadbalance.impl.ThresholdShedder` + - `org.apache.pulsar.broker.loadbalance.impl.UniformLoadShedder` + - `org.apache.pulsar.broker.loadbalance.impl.OverloadShedder` + - `org.apache.pulsar.broker.loadbalance.extensions.scheduler.TransferShedder` +- loadBalancerTransferEnabled* +- loadBalancerBrokerLoadTargetStd* +- loadBalancerSheddingConditionHitCountThreshold* +- loadBalancerMaxNumberOfBrokerSheddingPerCycle* +- loadBalanceSheddingDelayInSeconds* +- loadBalancerBrokerLoadDataTTLInSeconds* + +### Bundle splitting + +- loadBalancerEnabled +- loadBalancerAutoBundleSplitEnabled +- defaultNamespaceBundleSplitAlgorithm +- loadBalancerNamespaceBundleMaxTopics +- loadBalancerNamespaceBundleMaxSessions +- loadBalancerNamespaceBundleMaxMsgRate +- loadBalancerNamespaceBundleMaxBandwidthMbytes +- loadBalancerNamespaceMaximumBundles +- loadBalancerSplitIntervalMinutes* +- loadBalancerNamespaceBundleSplitConditionHitCountThreshold* +- loadBalancerMaxNumberOfBundlesToSplitPerCycle* diff --git a/static/reference/4.0.x/config/reference-configuration-bookkeeper.md b/static/reference/4.0.x/config/reference-configuration-bookkeeper.md new file mode 100644 index 000000000000..28e85dcaf6c2 --- /dev/null +++ b/static/reference/4.0.x/config/reference-configuration-bookkeeper.md @@ -0,0 +1,583 @@ +# BookKeeper + +BookKeeper is a replicated log storage system that Pulsar uses for durable storage of all messages. + +### bookiePort + +The port on which the bookie server listens. + +**Default**: 3181 + +### allowLoopback + +Whether the bookie is allowed to use a loopback interface as its primary interface (that is the interface used to establish its identity). By default, loopback interfaces are not allowed to work as the primary interface. Using a loopback interface as the primary interface usually indicates a configuration error. For example, it’s fairly common in some VPS setups to not configure a hostname or to have the hostname resolve to `127.0.0.1`. If this is the case, then all bookies in the cluster will establish their identities as `127.0.0.1:3181` and only one will be able to join the cluster. For VPSs configured like this, you should explicitly set the listening interface. + +**Default**: false + +### listeningInterface + +The network interface on which the bookie listens. By default, the bookie listens on all interfaces. + +**Default**: eth0 + +### advertisedAddress + +Configure a specific hostname or IP address that the bookie should use to advertise itself to clients. By default, the bookie advertises either its own IP address or hostname according to the `listeningInterface` and `useHostNameAsBookieID` settings. + +**Default**: N/A + +### allowMultipleDirsUnderSameDiskPartition + +Configure the bookie to enable/disable multiple ledger/index/journal directories in the same filesystem disk partition. + +**Default**: false + +### minUsableSizeForIndexFileCreation + +The minimum safe usable size available in index directory for bookie to create index files while replaying journal at the time of bookie starts in Readonly Mode (in bytes). + +**Default**: 1073741824 + +### journalDirectory + +The directory where BookKeeper outputs its write-ahead log (WAL). + +**Default**: data/bookkeeper/journal + +### journalDirectories + +Directories that BookKeeper outputs its write ahead log. Multiple directories are available, being separated by `,`. For example: `journalDirectories=/tmp/bk-journal1,/tmp/bk-journal2`. If `journalDirectories` is set, the bookies skip `journalDirectory` and use this setting directory. + +**Default**: /tmp/bk-journal + +### ledgerDirectories + +The directory where BookKeeper outputs ledger snapshots. This could define multiple directories to store snapshots separated by `,`, for example `ledgerDirectories=/tmp/bk1-data,/tmp/bk2-data`. Ideally, ledger dirs and the journal dir are each in a different device, which reduces the contention between random I/O and sequential write. It is possible to run with a single disk, but performance will be significantly lower. + +**Default**: data/bookkeeper/ledgers + +### ledgerManagerType + +The type of ledger manager used to manage how ledgers are stored, managed, and garbage collected. See [BookKeeper Internals](https://bookkeeper.apache.org/docs/next/getting-started/concepts) for more info. + +**Default**: hierarchical + +### zkLedgersRootPath + +The root ZooKeeper path used to store ledger metadata. This parameter is used by the ZooKeeper-based ledger manager as a root znode to store all ledgers. + +**Default**: /ledgers + +### ledgerStorageClass + +Ledger storage implementation class + +**Default**: org.apache.bookkeeper.bookie.storage.ldb.DbLedgerStorage + +### entryLogFilePreallocationEnabled + +Enable or disable entry logger preallocation + +**Default**: true + +### logSizeLimit + +Max file size of the entry logger, in bytes. A new entry log file will be created when the old one reaches the file size limitation. + +**Default**: 1073741824 + +### minorCompactionThreshold + +Threshold of minor compaction. Entry log files whose remaining size percentage reaches below this threshold will be compacted in a minor compaction. If set to less than zero, the minor compaction is disabled. + +**Default**: 0.2 + +### minorCompactionInterval + +Time interval to run minor compaction, in seconds. If set to less than zero, the minor compaction is disabled. Note: should be greater than gcWaitTime. + +**Default**: 3600 + +### majorCompactionThreshold + +The threshold of major compaction. Entry log files whose remaining size percentage reaches below this threshold will be compacted in a major compaction. Those entry log files whose remaining size percentage is still higher than the threshold will never be compacted. If set to less than zero, the major compaction is disabled. + +**Default**: 0.5 + +### majorCompactionInterval + +The time interval to run major compaction, in seconds. If set to less than zero, the major compaction is disabled. Note: should be greater than gcWaitTime. + +**Default**: 86400 + +### readOnlyModeEnabled + +If `readOnlyModeEnabled=true`, then on all full ledger disks, bookie will be converted to read-only mode and serve only read requests. Otherwise the bookie will be shutdown. + +**Default**: true + +### forceReadOnlyBookie + +Whether the bookie is force started in read only mode. + +**Default**: false + +### persistBookieStatusEnabled + +Persist the bookie status locally on the disks. So the bookies can keep their status upon restarts. + +**Default**: false + +### compactionMaxOutstandingRequests + +Sets the maximum number of entries that can be compacted without flushing. When compacting, the entries are written to the entrylog and the new offsets are cached in memory. Once the entrylog is flushed the index is updated with the new offsets. This parameter controls the number of entries added to the entrylog before a flush is forced. A higher value for this parameter means more memory will be used for offsets. Each offset consists of 3 longs. This parameter should not be modified unless you’re fully aware of the consequences. + +**Default**: 100000 + +### compactionRate + +The rate at which compaction will read entries, in adds per second. + +**Default**: 1000 + +### isThrottleByBytes + +Throttle compaction by bytes or by entries. + +**Default**: false + +### compactionRateByEntries + +The rate at which compaction will read entries, in adds per second. + +**Default**: 1000 + +### compactionRateByBytes + +Set the rate at which compaction reads entries. The unit is bytes added per second. + +**Default**: 1000000 + +### journalMaxSizeMB + +Max file size of journal file, in megabytes. A new journal file will be created when the old one reaches the file size limitation. + +**Default**: 2048 + +### journalMaxBackups + +The max number of old journal files to keep. Keeping a number of old journal files would help data recovery in special cases. + +**Default**: 5 + +### journalPreAllocSizeMB + +How space to pre-allocate at a time in the journal. + +**Default**: 16 + +### journalWriteBufferSizeKB + +The of the write buffers used for the journal. + +**Default**: 64 + +### journalRemoveFromPageCache + +Whether pages should be removed from the page cache after force write. + +**Default**: true + +### journalAdaptiveGroupWrites + +Whether to group journal force writes, which optimizes group commit for higher throughput. + +**Default**: true + +### journalMaxGroupWaitMSec + +The maximum latency to impose on a journal write to achieve grouping. + +**Default**: 1 + +### journalAlignmentSize + +All the journal writes and commits should be aligned to given size + +**Default**: 4096 + +### journalBufferedWritesThreshold + +Maximum writes to buffer to achieve grouping + +**Default**: 524288 + +### journalFlushWhenQueueEmpty + +If we should flush the journal when journal queue is empty + +**Default**: false + +### numJournalCallbackThreads + +The number of threads that should handle journal callbacks + +**Default**: 8 + +### openLedgerRereplicationGracePeriod + +The grace period, in milliseconds, that the replication worker waits before fencing and replicating a ledger fragment that's still being written to upon bookie failure. + +**Default**: 30000 + +### rereplicationEntryBatchSize + +The number of max entries to keep in fragment for re-replication + +**Default**: 100 + +### autoRecoveryDaemonEnabled + +Whether the bookie itself can start auto-recovery service. + +**Default**: true + +### lostBookieRecoveryDelay + +How long to wait, in seconds, before starting auto recovery of a lost bookie. + +**Default**: 0 + +### gcWaitTime + +How long the interval to trigger next garbage collection, in milliseconds. Since garbage collection is running in background, too frequent gc will heart performance. It is better to give a higher number of gc interval if there is enough disk capacity. + +**Default**: 900000 + +### gcOverreplicatedLedgerWaitTime + +How long the interval to trigger next garbage collection of overreplicated ledgers, in milliseconds. This should not be run very frequently since we read the metadata for all the ledgers on the bookie from zk. + +**Default**: 86400000 + +### flushInterval + +How long the interval to flush ledger index pages to disk, in milliseconds. Flushing index files will introduce much random disk I/O. If separating journal dir and ledger dirs each on different devices, flushing would not affect performance. But if putting journal dir and ledger dirs on same device, performance degrade significantly on too frequent flushing. You can consider increment flush interval to get better performance, but you need to pay more time on bookie server restart after failure. + +**Default**: 60000 + +### bookieDeathWatchInterval + +Interval to watch whether bookie is dead or not, in milliseconds + +**Default**: 1000 + +### allowStorageExpansion + +Allow the bookie storage to expand. Newly added ledger and index dirs must be empty. + +**Default**: false + +### zkServers + +A list of one of more servers on which zookeeper is running. The server list can be comma separated values, for example: zkServers=zk1:2181,zk2:2181,zk3:2181. + +**Default**: localhost:2181 + +### zkTimeout + +ZooKeeper client session timeout in milliseconds Bookie server will exit if it received SESSION_EXPIRED because it was partitioned off from ZooKeeper for more than the session timeout JVM garbage collection, disk I/O will cause SESSION_EXPIRED. Increment this value could help avoiding this issue + +**Default**: 30000 + +### zkRetryBackoffStartMs + +The start time that the Zookeeper client backoff retries in milliseconds. + +**Default**: 1000 + +### zkRetryBackoffMaxMs + +The maximum time that the Zookeeper client backoff retries in milliseconds. + +**Default**: 10000 + +### zkEnableSecurity + +Set ACLs on every node written on ZooKeeper, allowing users to read and write BookKeeper metadata stored on ZooKeeper. In order to make ACLs work you need to setup ZooKeeper JAAS authentication. All the bookies and Client need to share the same user, and this is usually done using Kerberos authentication. See ZooKeeper documentation. + +**Default**: false + +### httpServerEnabled + +The flag enables/disables starting the admin http server. + +**Default**: false + +### httpServerPort + +The HTTP server port to listen on. By default, the value is `8080`. If you want to keep it consistent with the Prometheus stats provider, you can set it to `8000`. + +**Default**: 8080 + +### httpServerClass + +The http server class. + +**Default**: org.apache.bookkeeper.http.vertx.VertxHttpServer + +### serverTcpNoDelay + +This settings is used to enabled/disabled Nagle’s algorithm, which is a means of improving the efficiency of TCP/IP networks by reducing the number of packets that need to be sent over the network. If you are sending many small messages, such that more than one can fit in a single IP packet, setting server.tcpnodelay to false to enable Nagle algorithm can provide better performance. + +**Default**: true + +### serverSockKeepalive + +This setting is used to send keep-alive messages on connection-oriented sockets. + +**Default**: true + +### serverTcpLinger + +The socket linger timeout on close. When enabled, a close or shutdown will not return until all queued messages for the socket have been successfully sent or the linger timeout has been reached. Otherwise, the call returns immediately and the closing is done in the background. + +**Default**: 0 + +### byteBufAllocatorSizeMax + +The maximum buf size of the received ByteBuf allocator. + +**Default**: 1048576 + +### nettyMaxFrameSizeBytes + +The maximum netty frame size in bytes. Any message received larger than this will be rejected. + +**Default**: 5253120 + +### openFileLimit + +Max number of ledger index files could be opened in bookie server If number of ledger index files reaches this limitation, bookie server started to swap some ledgers from memory to disk. Too frequent swap will affect performance. You can tune this number to gain performance according your requirements. + +**Default**: 0 + +### pageSize + +Size of a index page in ledger cache, in bytes A larger index page can improve performance writing page to disk, which is efficient when you have small number of ledgers and these ledgers have similar number of entries. If you have large number of ledgers and each ledger has fewer entries, smaller index page would improve memory usage. + +**Default**: 8192 + +### pageLimit + +How many index pages provided in ledger cache If number of index pages reaches this limitation, bookie server starts to swap some ledgers from memory to disk. You can increment this value when you found swap became more frequent. But make sure pageLimit\*pageSize should not more than JVM max memory limitation, otherwise you would got OutOfMemoryException. In general, incrementing pageLimit, using smaller index page would gain better performance in lager number of ledgers with fewer entries case If pageLimit is -1, bookie server will use 1/3 of JVM memory to compute the limitation of number of index pages. + +**Default**: 0 + +### readOnlyModeEnabled + +If all ledger directories configured are full, then support only read requests for clients. If "readOnlyModeEnabled=true" then on all ledger disks full, bookie will be converted to read-only mode and serve only read requests. Otherwise the bookie will be shutdown. By default this will be disabled. + +**Default**: true + +### diskUsageThreshold + +For each ledger dir, maximum disk space which can be used. Default is 0.95f. i.e. 95% of disk can be used at most after which nothing will be written to that partition. If all ledger dir partitions are full, then bookie will turn to readonly mode if ‘readOnlyModeEnabled=true’ is set, else it will shutdown. Valid values should be in between 0 and 1 (exclusive). + +**Default**: 0.95 + +### diskCheckInterval + +Disk check interval in milli seconds, interval to check the ledger dirs usage. + +**Default**: 10000 + +### auditorPeriodicCheckInterval + +Interval at which the auditor will do a check of all ledgers in the cluster. By default this runs once a week. The interval is set in seconds. To disable the periodic check completely, set this to 0. Note that periodic checking will put extra load on the cluster, so it should not be run more frequently than once a day. + +**Default**: 604800 + +### sortedLedgerStorageEnabled + +Whether sorted-ledger storage is enabled. + +**Default**: true + +### auditorPeriodicBookieCheckInterval + +The interval between auditor bookie checks. The auditor bookie check, checks ledger metadata to see which bookies should contain entries for each ledger. If a bookie which should contain entries is unavailable, thea the ledger containing that entry is marked for recovery. Setting this to 0 disabled the periodic check. Bookie checks will still run when a bookie fails. The interval is specified in seconds. + +**Default**: 86400 + +### numAddWorkerThreads + +The number of threads that should handle write requests. if zero, the writes would be handled by netty threads directly. + +**Default**: 0 + +### numReadWorkerThreads + +The number of threads that should handle read requests. if zero, the reads would be handled by netty threads directly. + +**Default**: 8 + +### numHighPriorityWorkerThreads + +The umber of threads that should be used for high priority requests (i.e. recovery reads and adds, and fencing). + +**Default**: 8 + +### maxPendingReadRequestsPerThread + +If read workers threads are enabled, limit the number of pending requests, to avoid the executor queue to grow indefinitely. + +**Default**: 2500 + +### maxPendingAddRequestsPerThread + +The limited number of pending requests, which is used to avoid the executor queue to grow indefinitely when add workers threads are enabled. + +**Default**: 10000 + +### isForceGCAllowWhenNoSpace + +Whether force compaction is allowed when the disk is full or almost full. Forcing GC could get some space back, but could also fill up the disk space more quickly. This is because new log files are created before GC, while old garbage log files are deleted after GC. + +**Default**: false + +### verifyMetadataOnGC + +True if the bookie should double check `readMetadata` prior to GC. + +**Default**: false + +### flushEntrylogBytes + +Entry log flush interval in bytes. Flushing in smaller chunks but more frequently reduces spikes in disk I/O. Flushing too frequently may also affect performance negatively. + +**Default**: 268435456 + +### readBufferSizeBytes + +The number of bytes we should use as capacity for BufferedReadChannel. + +**Default**: 4096 + +### writeBufferSizeBytes + +The number of bytes used as capacity for the write buffer + +**Default**: 65536 + +### useHostNameAsBookieID + +Whether the bookie should use its hostname to register with the coordination service (e.g.: zookeeper service). When false, bookie will use its ip address for the registration. + +**Default**: false + +### bookieId + +If you want to custom a bookie ID or use a dynamic network address for the bookie, you can set the `bookieId`.

        Bookie advertises itself using the `bookieId` rather than the `BookieSocketAddress` (`hostname:port` or `IP:port`). If you set the `bookieId`, then the `useHostNameAsBookieID` does not take effect.

        The `bookieId` is a non-empty string that can contain ASCII digits and letters ([a-zA-Z9-0]), colons, dashes, and dots.

        For more information about `bookieId`, see [here](http://bookkeeper.apache.org/bps/BP-41-bookieid/). + +**Default**: N/A + +### allowEphemeralPorts + +Whether the bookie is allowed to use an ephemeral port (port 0) as its server port. By default, an ephemeral port is not allowed. Using an ephemeral port as the service port usually indicates a configuration error. However, in unit tests, using an ephemeral port will address port conflict problems and allow running tests in parallel. + +**Default**: false + +### enableLocalTransport + +Whether the bookie is allowed to listen for the BookKeeper clients executed on the local JVM. + +**Default**: false + +### disableServerSocketBind + +Whether the bookie is allowed to disable bind on network interfaces. This bookie will be available only to BookKeeper clients executed on the local JVM. + +**Default**: false + +### skipListArenaChunkSize + +The number of bytes that we should use as chunk allocation for `org.apache.bookkeeper.bookie.SkipListArena`. + +**Default**: 4194304 + +### skipListArenaMaxAllocSize + +The maximum size that we should allocate from the skiplist arena. Allocations larger than this should be allocated directly by the VM to avoid fragmentation. + +**Default**: 131072 + +### bookieAuthProviderFactoryClass + +The factory class name of the bookie authentication provider. If this is null, then there is no authentication. + +**Default**: null + +### statsProviderClass + + **Default**: org.apache.bookkeeper.stats.prometheus.PrometheusMetricsProvider + + **Default**: + +### prometheusStatsHttpPort + + **Default**: 8000 + + **Default**: + +### dbStorage_writeCacheMaxSizeMb + +Size of Write Cache. Memory is allocated from JVM direct memory. Write cache is used to buffer entries before flushing into the entry log. For good performance, it should be big enough to hold a substantial amount of entries in the flush interval. + +**Default**: 25% of direct memory + +### dbStorage_readAheadCacheMaxSizeMb + +Size of Read cache. Memory is allocated from JVM direct memory. This read cache is pre-filled doing read-ahead whenever a cache miss happens. By default, it is allocated to 25% of the available direct memory. + +**Default**: N/A + +### dbStorage_readAheadCacheBatchSize + +How many entries to pre-fill in cache after a read cache miss + +**Default**: 1000 + +### dbStorage_rocksDB_blockCacheSize + +Size of RocksDB block-cache. For best performance, this cache should be big enough to hold a significant portion of the index database which can reach ~2GB in some cases. By default, it uses 10% of direct memory. + +**Default**: N/A + +### dbStorage_rocksDB_writeBufferSizeMB + +**Default**: 64 + +### dbStorage_rocksDB_sstSizeInMB + +**Default**: 64 + +### dbStorage_rocksDB_blockSize + +**Default**: 65536 + +### dbStorage_rocksDB_bloomFilterBitsPerKey + +**Default**: 10 + +### dbStorage_rocksDB_numLevels + +**Default**: -1 + +### dbStorage_rocksDB_numFilesInLevel0 + +**Default**: 4 + +### dbStorage_rocksDB_maxSizeInLevel1MB + +**Default**: 256 diff --git a/static/reference/4.0.x/config/reference-configuration-broker.md b/static/reference/4.0.x/config/reference-configuration-broker.md new file mode 100644 index 000000000000..9fd5b499843d --- /dev/null +++ b/static/reference/4.0.x/config/reference-configuration-broker.md @@ -0,0 +1,5999 @@ +# Broker + +## Required +### clusterName +Name of the cluster to which this broker belongs to + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Server + +## Optional +### topicFactoryClassName +Factory class-name to create topic with custom workflow + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `true` + +**Category**: + +### zookeeperSessionExpiredPolicy +There are two policies to apply when broker metadata session expires: session expired happens, "shutdown" or "reconnect". + + With "shutdown", the broker will be restarted. + + With "reconnect", the broker will keep serving the topics, while attempting to recreate a new session. + +**Type**: `org.apache.pulsar.broker.MetadataSessionExpiredPolicy` + +**Default**: `reconnect` + +**Dynamic**: `false` + +**Category**: + +### authenticationEnabled +Enable authentication + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Authentication + +### authenticationProviders +Authentication provider name list, which is a list of class names + +**Type**: `java.util.Set` + +**Default**: `[]` + +**Dynamic**: `false` + +**Category**: Authentication + +### authenticationRefreshCheckSeconds +Interval of time for checking for expired authentication credentials + +**Type**: `int` + +**Default**: `60` + +**Dynamic**: `false` + +**Category**: Authentication + +### brokerClientAuthenticationParameters +Authentication parameters of the authentication plugin the broker is using to connect to other brokers + +**Type**: `java.lang.String` + +**Default**: `` + +**Dynamic**: `true` + +**Category**: Authentication + +### brokerClientAuthenticationPlugin +Authentication settings of the broker itself. + +Used when the broker connects to other brokers, either in same or other clusters. Default uses plugin which disables authentication + +**Type**: `java.lang.String` + +**Default**: `org.apache.pulsar.client.impl.auth.AuthenticationDisabled` + +**Dynamic**: `true` + +**Category**: Authentication + +### brokerClientCertificateFilePath +TLS certificate file for internal client, used by the internal client to authenticate with Pulsar brokers + +**Type**: `java.lang.String` + +**Default**: `` + +**Dynamic**: `false` + +**Category**: Authentication + +### brokerClientKeyFilePath +TLS private key file for internal client, used by the internal client to authenticate with Pulsar brokers + +**Type**: `java.lang.String` + +**Default**: `` + +**Dynamic**: `false` + +**Category**: Authentication + +### brokerClientTrustCertsFilePath +TLS trusted certificate file for internal client, used by the internal client to authenticate with Pulsar brokers + +**Type**: `java.lang.String` + +**Default**: `` + +**Dynamic**: `false` + +**Category**: Authentication + +### anonymousUserRole +When this parameter is not empty, unauthenticated users perform as anonymousUserRole + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Authorization + +### authenticateOriginalAuthData +If this flag is set then the broker authenticates the original Auth data else it just accepts the originalPrincipal and authorizes it (if required) + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Authorization + +### authorizationAllowWildcardsMatching +Allow wildcard matching in authorization + +(wildcard matching only applicable if wildcard-char: * presents at first or last position eg: *.pulsar.service, pulsar.service.*) + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Authorization + +### authorizationEnabled +Enforce authorization + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Authorization + +### authorizationProvider +Authorization provider fully qualified class-name + +**Type**: `java.lang.String` + +**Default**: `org.apache.pulsar.broker.authorization.PulsarAuthorizationProvider` + +**Dynamic**: `false` + +**Category**: Authorization + +### proxyRoles +Role names that are treated as `proxy roles`. + +If the broker sees a request with role as proxyRoles - it will demand to see the original client role or certificate. + +**Type**: `java.util.Set` + +**Default**: `[]` + +**Dynamic**: `false` + +**Category**: Authorization + +### superUserRoles +Role names that are treated as `super-user`, meaning they will be able to do all admin operations and publish/consume from all topics + +**Type**: `java.util.Set` + +**Default**: `[]` + +**Dynamic**: `true` + +**Category**: Authorization + +### additionalServletDirectory +The directory to locate broker additional servlet + +**Type**: `java.lang.String` + +**Default**: `./brokerAdditionalServlet` + +**Dynamic**: `false` + +**Category**: Broker Plugin + +### additionalServlets +List of broker additional servlet to load, which is a list of broker additional servlet names + +**Type**: `java.util.Set` + +**Default**: `[]` + +**Dynamic**: `false` + +**Category**: Broker Plugin + +### functionsWorkerEnablePackageManagement +Flag indicates enabling or disabling function worker using unified PackageManagement service. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Functions + +### functionsWorkerEnabled +Flag indicates enabling or disabling function worker on brokers + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Functions + +### functionsWorkerServiceNarPackage +The nar package for the function worker service + +**Type**: `java.lang.String` + +**Default**: `` + +**Dynamic**: `false` + +**Category**: Functions + +### disableHttpDebugMethods +If true, the broker will reject all HTTP requests using the TRACE and TRACK verbs. + This setting may be necessary if the broker is deployed into an environment that uses http port + scanning and flags web servers allowing the TRACE method as insecure. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: HTTP + +### httpMaxRequestHeaderSize + The maximum size in bytes of the request header. + Larger headers will allow for more and/or larger cookies plus larger form content encoded in a URL. + However, larger headers consume more memory and can make a server more vulnerable to denial of service + attacks. + + +**Type**: `int` + +**Default**: `8192` + +**Dynamic**: `false` + +**Category**: HTTP + +### httpMaxRequestSize +If \>0, it will reject all HTTP requests with bodies larged than the configured limit + +**Type**: `long` + +**Default**: `-1` + +**Dynamic**: `false` + +**Category**: HTTP + +### httpRequestsFailOnUnknownPropertiesEnabled +Admin API fail on unknown request parameter in request-body. see PIP-179. Default false. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `true` + +**Category**: HTTP + +### httpRequestsLimitEnabled +Enable the enforcement of limits on the incoming HTTP requests + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: HTTP + +### httpRequestsMaxPerSecond +Max HTTP requests per seconds allowed. The excess of requests will be rejected with HTTP code 429 (Too many requests) + +**Type**: `double` + +**Default**: `100.0` + +**Dynamic**: `false` + +**Category**: HTTP + +### brokerClientSslProvider +The TLS Provider used by internal client to authenticate with other Pulsar brokers + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: KeyStoreTLS + +### brokerClientTlsCiphers +Specify the tls cipher the internal client will use to negotiate during TLS Handshake (a comma-separated list of ciphers). + +Examples:- [TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256]. + used by the internal client to authenticate with Pulsar brokers + +**Type**: `java.util.Set` + +**Default**: `[]` + +**Dynamic**: `false` + +**Category**: KeyStoreTLS + +### brokerClientTlsEnabledWithKeyStore +Whether internal client use KeyStore type to authenticate with other Pulsar brokers + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: KeyStoreTLS + +### brokerClientTlsKeyStore +TLS KeyStore path for internal client, used by the internal client to authenticate with Pulsar brokers + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: KeyStoreTLS + +### brokerClientTlsKeyStorePassword +TLS KeyStore password for internal client, used by the internal client to authenticate with Pulsar brokers + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: KeyStoreTLS + +### brokerClientTlsKeyStoreType +TLS KeyStore type configuration for internal client: JKS, PKCS12, used by the internal client to authenticate with Pulsar brokers + +**Type**: `java.lang.String` + +**Default**: `JKS` + +**Dynamic**: `false` + +**Category**: KeyStoreTLS + +### brokerClientTlsProtocols +Specify the tls protocols the broker will use to negotiate during TLS handshake (a comma-separated list of protocol names). + +Examples:- [TLSv1.3, TLSv1.2] + used by the internal client to authenticate with Pulsar brokers + +**Type**: `java.util.Set` + +**Default**: `[]` + +**Dynamic**: `false` + +**Category**: KeyStoreTLS + +### brokerClientTlsTrustStore +TLS TrustStore path for internal client, used by the internal client to authenticate with Pulsar brokers + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: KeyStoreTLS + +### brokerClientTlsTrustStorePassword +TLS TrustStore password for internal client, used by the internal client to authenticate with Pulsar brokers + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: KeyStoreTLS + +### brokerClientTlsTrustStoreType +TLS TrustStore type configuration for internal client: JKS, PKCS12 used by the internal client to authenticate with Pulsar brokers + +**Type**: `java.lang.String` + +**Default**: `JKS` + +**Dynamic**: `false` + +**Category**: KeyStoreTLS + +### tlsEnabledWithKeyStore +Enable TLS with KeyStore type configuration in broker + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: KeyStoreTLS + +### tlsKeyStore +TLS KeyStore path in broker + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: KeyStoreTLS + +### tlsKeyStorePassword +TLS KeyStore password for broker + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: KeyStoreTLS + +### tlsKeyStoreType +TLS KeyStore type configuration in broker: JKS, PKCS12 + +**Type**: `java.lang.String` + +**Default**: `JKS` + +**Dynamic**: `false` + +**Category**: KeyStoreTLS + +### tlsProvider +Specify the TLS provider for the broker service: +When using TLS authentication with CACert, the valid value is either OPENSSL or JDK. +When using TLS authentication with KeyStore, available values can be SunJSSE, Conscrypt and etc. + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: KeyStoreTLS + +### tlsTrustStore +TLS TrustStore path in broker + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: KeyStoreTLS + +### tlsTrustStorePassword +TLS TrustStore password for broker, null means empty password. + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: KeyStoreTLS + +### tlsTrustStoreType +TLS TrustStore type configuration in broker: JKS, PKCS12 + +**Type**: `java.lang.String` + +**Default**: `JKS` + +**Dynamic**: `false` + +**Category**: KeyStoreTLS + +### defaultNamespaceBundleSplitAlgorithm +Default algorithm name for namespace bundle split + +**Type**: `java.lang.String` + +**Default**: `range_equally_divide` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### flowOrQpsDifferenceThresholdPercentage +In FlowOrQpsEquallyDivideBundleSplitAlgorithm, if msgRate \>= loadBalancerNamespaceBundleMaxMsgRate * (100 + flowOrQpsDifferenceThresholdPercentage)/100.0 or throughput \>= loadBalancerNamespaceBundleMaxBandwidthMbytes * (100 + flowOrQpsDifferenceThresholdPercentage)/100.0, execute split bundle + +**Type**: `int` + +**Default**: `10` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalanceSheddingDelayInSeconds +Delay (in seconds) to the next unloading cycle after unloading. The logic tries to give enough time for brokers to recompute load after unloading. The bigger value will delay the next unloading cycle longer. (only used in load balancer extension TransferShedder) + +**Type**: `long` + +**Default**: `180` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerAutoBundleSplitEnabled +enable/disable automatic namespace bundle split + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerAutoUnloadSplitBundlesEnabled +enable/disable automatic unloading of split bundles + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerAverageResourceUsageDifferenceThresholdPercentage +Average resource usage difference threshold to determine a broker whether to be a best candidate in LeastResourceUsageWithWeight.(eg: broker1 with 10% resource usage with weight and broker2 with 30% and broker3 with 80% will have 40% average resource usage. The placement strategy can select broker1 and broker2 as best candidates.) + +**Type**: `int` + +**Default**: `10` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerAvgShedderHighThreshold +The high threshold for the difference between the highest and lowest loaded brokers. + +**Type**: `int` + +**Default**: `40` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerAvgShedderHitCountHighThreshold +The number of times the high threshold is triggered before the bundle is unloaded. + +**Type**: `int` + +**Default**: `2` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerAvgShedderHitCountLowThreshold +The number of times the low threshold is triggered before the bundle is unloaded. + +**Type**: `int` + +**Default**: `8` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerAvgShedderLowThreshold +The low threshold for the difference between the highest and lowest loaded brokers. + +**Type**: `int` + +**Default**: `15` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerBandwidthInResourceWeight +BandwidthIn Resource Usage Weight + +**Type**: `double` + +**Default**: `1.0` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerBandwidthOutResourceWeight +BandwidthOut Resource Usage Weight + +**Type**: `double` + +**Default**: `1.0` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerBandwithInResourceWeight +BandwidthIn Resource Usage Weight, Deprecated: Use loadBalancerBandwidthInResourceWeight + +**Type**: `double` + +**Default**: `1.0` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerBandwithOutResourceWeight +BandwidthOut Resource Usage Weight, Deprecated: Use loadBalancerBandwidthOutResourceWeight + +**Type**: `double` + +**Default**: `1.0` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerBrokerLoadDataTTLInSeconds +Broker load data time to live (TTL in seconds). The logic tries to avoid (possibly unavailable) brokers with out-dated load data, and those brokers will be ignored in the load computation. When tuning this value, please consider loadBalancerReportUpdateMaxIntervalMinutes. The current default value is loadBalancerReportUpdateMaxIntervalMinutes * 120, reflecting twice the duration in seconds. (only used in load balancer extension TransferShedder) + +**Type**: `long` + +**Default**: `1800` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerBrokerLoadTargetStd +The target standard deviation of the resource usage across brokers (100% resource usage is 1.0 load). The shedder logic tries to distribute bundle load across brokers to meet this target std. The smaller value will incur load balancing more frequently. (only used in load balancer extension TransferShedder) + +**Type**: `double` + +**Default**: `0.25` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerBrokerMaxTopics +Usage threshold to allocate max number of topics to broker + +**Type**: `int` + +**Default**: `50000` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerBrokerOverloadedThresholdPercentage +Usage threshold to determine a broker as over-loaded + +**Type**: `int` + +**Default**: `85` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerBrokerThresholdShedderPercentage +Usage threshold to determine a broker whether to start threshold shedder + +**Type**: `int` + +**Default**: `10` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerBundleUnloadMinThroughputThreshold +Bundle unload minimum throughput threshold (MB) + +**Type**: `double` + +**Default**: `10.0` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerCPUResourceWeight +CPU Resource Usage Weight + +**Type**: `double` + +**Default**: `1.0` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerDebugModeEnabled +Option to enable the debug mode for the load balancer logics. The debug mode prints more logs to provide more information such as load balance states and decisions. (only used in load balancer extension logics) + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerDirectMemoryResourceWeight +Direct Memory Resource Usage Weight. Direct memory usage cannot accurately reflect the machine's load, and it is not recommended to use it to score the machine's load. + +**Type**: `double` + +**Default**: `0.0` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerDistributeBundlesEvenlyEnabled +enable/disable distribute bundles evenly + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerEnabled +Enable load balancer + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `false` + +**Category**: Load Balancer + +### loadBalancerHistoryResourcePercentage +Resource history Usage Percentage When adding new resource usage info + +**Type**: `double` + +**Default**: `0.9` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerHostUsageCheckIntervalMinutes +Frequency of report to collect, in minutes + +**Type**: `int` + +**Default**: `1` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerInFlightServiceUnitStateWaitingTimeInMillis +Time to wait before fixing any stuck in-flight service unit states. The leader monitor fixes any in-flight service unit(bundle) states by reassigning the ownerships if stuck too long, longer than this period.(only used in load balancer extension logics) + +**Type**: `long` + +**Default**: `30000` + +**Dynamic**: `false` + +**Category**: Load Balancer + +### loadBalancerLoadPlacementStrategy +load balance placement strategy + +**Type**: `java.lang.String` + +**Default**: `org.apache.pulsar.broker.loadbalance.impl.LeastLongTermMessageRate` + +**Dynamic**: `false` + +**Category**: Load Balancer + +### loadBalancerLoadSheddingStrategy +load balance load shedding strategy (It requires broker restart if value is changed using dynamic config). Default is ThresholdShedder since 2.10.0 + +**Type**: `java.lang.String` + +**Default**: `org.apache.pulsar.broker.loadbalance.impl.ThresholdShedder` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerMaxNumberOfBrokerSheddingPerCycle +Maximum number of brokers to unload bundle load for each unloading cycle. The bigger value will incur more unloading/transfers for each unloading cycle. (only used in load balancer extension TransferShedder) + +**Type**: `int` + +**Default**: `3` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerMaxNumberOfBundlesInBundleLoadReport +Max number of bundles in bundle load report from each broker. The load balancer distributes bundles across brokers, based on topK bundle load data and other broker load data.The bigger value will increase the overhead of reporting many bundles in load data. Used for ExtensibleLoadManagerImpl and ModularLoadManagerImpl, default value is 10. User can disable the bundle filtering feature of ModularLoadManagerImpl by setting to -1.Enabling this feature can reduce the pressure on the zookeeper when doing load report.WARNING: too small value could result in a long load balance time. + +**Type**: `int` + +**Default**: `10` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerMaxNumberOfBundlesToSplitPerCycle +Max number of bundles to split to per cycle. (only used in load balancer extension logics) + +**Type**: `int` + +**Default**: `10` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerMsgRateDifferenceShedderThreshold +Message-rate percentage threshold between highest and least loaded brokers for uniform load shedding. (eg: broker1 with 50K msgRate and broker2 with 30K msgRate will have 66% msgRate difference and load balancer can unload bundles from broker-1 to broker-2) + +**Type**: `double` + +**Default**: `50.0` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerMsgThroughputMultiplierDifferenceShedderThreshold +Message-throughput threshold between highest and least loaded brokers for uniform load shedding. (eg: broker1 with 450MB msgRate and broker2 with 100MB msgRate will have 4.5 times msgThroughout difference and load balancer can unload bundles from broker-1 to broker-2) + +**Type**: `double` + +**Default**: `4.0` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerMultiPhaseBundleUnload +Enables the multi-phase unloading of bundles. Set to true, forwards destination broker information to consumers and producers during bundle unload, allowing them to quickly reconnect to the broker without performing an additional topic lookup. + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `false` + +**Category**: Load Balancer + +### loadBalancerNamespaceBundleMaxBandwidthMbytes +maximum bandwidth (in + out) in a bundle, otherwise bundle split will be triggered + +**Type**: `int` + +**Default**: `100` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerNamespaceBundleMaxMsgRate +maximum msgRate (in + out) in a bundle, otherwise bundle split will be triggered + +**Type**: `int` + +**Default**: `30000` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerNamespaceBundleMaxSessions +maximum sessions (producers + consumers) in a bundle, otherwise bundle split will be triggered(disable threshold check with value -1) + +**Type**: `int` + +**Default**: `1000` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerNamespaceBundleMaxTopics +maximum topics in a bundle, otherwise bundle split will be triggered + +**Type**: `int` + +**Default**: `1000` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerNamespaceBundleSplitConditionHitCountThreshold +Threshold to the consecutive count of fulfilled split conditions. If the split scheduler consecutively finds bundles that meet split conditions many times bigger than this threshold, the scheduler will trigger splits on the bundles (if the number of bundles is less than loadBalancerNamespaceMaximumBundles). (only used in load balancer extension logics) + +**Type**: `int` + +**Default**: `3` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerNamespaceMaximumBundles +maximum number of bundles in a namespace + +**Type**: `int` + +**Default**: `128` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerOverrideBrokerNicSpeedGbps +Option to override the auto-detected network interfaces max speed + +**Type**: `java.util.Optional` + +**Default**: `Optional.empty` + +**Dynamic**: `false` + +**Category**: Load Balancer + +### loadBalancerReportUpdateMaxIntervalMinutes +Min delay of load report to collect, in minutes + +**Type**: `int` + +**Default**: `15` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerReportUpdateMinIntervalMillis +maximum interval to update load report + +**Type**: `int` + +**Default**: `5000` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerReportUpdateThresholdPercentage +Percentage of change to trigger load report update + +**Type**: `int` + +**Default**: `10` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerResourceQuotaUpdateIntervalMinutes +Interval to flush dynamic resource quota to ZooKeeper + +**Type**: `int` + +**Default**: `15` + +**Dynamic**: `false` + +**Category**: Load Balancer + +### loadBalancerServiceUnitStateMonitorIntervalInSeconds +Interval between service unit state monitor checks. The service unit(bundle) state channel is periodically monitored by the leader broker at this interval to fix any orphan bundle ownerships, stuck in-flight states, and other cleanup jobs.`loadBalancerServiceUnitStateTombstoneDelayTimeInSeconds` * 1000 must be bigger than `loadBalancerInFlightServiceUnitStateWaitingTimeInMillis`.(only used in load balancer extension logics) + +**Type**: `long` + +**Default**: `60` + +**Dynamic**: `false` + +**Category**: Load Balancer + +### loadBalancerServiceUnitStateTombstoneDelayTimeInSeconds +After this delay, the service-unit state channel tombstones any service units (e.g., bundles) in semi-terminal states. For example, after splits, parent bundles will be `deleted`, and then after this delay, the parent bundles' state will be `tombstoned` in the service-unit state channel. Pulsar does not immediately remove such semi-terminal states to avoid unnecessary system confusion, as the bundles in the `tombstoned` state might temporarily look available to reassign. Rarely, one could lower this delay in order to aggressively clean the service-unit state channel when there are a large number of bundles. minimum value = 30 secs(only used in load balancer extension logics) + +**Type**: `long` + +**Default**: `3600` + +**Dynamic**: `false` + +**Category**: Load Balancer + +### loadBalancerServiceUnitTableViewSyncer +Specify ServiceUnitTableViewSyncer to sync service unit(bundle) states between metadata store and system topic table views during migration from one to the other. One could enable this syncer before migration and disable it after the migration finishes. It accepts `MetadataStoreToSystemTopicSyncer` or `SystemTopicToMetadataStoreSyncer` to enable it. It accepts `None` to disable it. + +**Type**: `org.apache.pulsar.broker.ServiceConfiguration.ServiceUnitTableViewSyncerType` + +**Default**: `None` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerSheddingBundlesWithPoliciesEnabled +Option to automatically unload namespace bundles with affinity(isolation) or anti-affinity group policies.Such bundles are not ideal targets to auto-unload as destination brokers are limited.(only used in load balancer extension logics) + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerSheddingConditionHitCountThreshold +Threshold to the consecutive count of fulfilled shedding(unload) conditions. If the unload scheduler consecutively finds bundles that meet unload conditions many times bigger than this threshold, the scheduler will shed the bundles. The bigger value will incur less bundle unloading/transfers. (only used in load balancer extension TransferShedder) + +**Type**: `int` + +**Default**: `3` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerSheddingEnabled +Enable/disable automatic bundle unloading for load-shedding + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerSheddingGracePeriodMinutes +Prevent the same topics to be shed and moved to other broker more than once within this timeframe + +**Type**: `long` + +**Default**: `30` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerSheddingIntervalMinutes +Load shedding interval. + +Broker periodically checks whether some traffic should be offload from some over-loaded broker to other under-loaded brokers + +**Type**: `int` + +**Default**: `1` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerSplitIntervalMinutes +Service units'(bundles) split interval. Broker periodically checks whether some service units(e.g. bundles) should split if they become hot-spots. (only used in load balancer extension logics) + +**Type**: `int` + +**Default**: `1` + +**Dynamic**: `false` + +**Category**: Load Balancer + +### loadBalancerTransferEnabled +Option to enable the bundle transfer mode when distributing bundle loads. On: transfer bundles from overloaded brokers to underloaded -- pre-assigns the destination broker upon unloading). Off: unload bundles from overloaded brokers -- post-assigns the destination broker upon lookups). (only used in load balancer extension TransferShedder) + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadManagerClassName +Name of load manager to use + +**Type**: `java.lang.String` + +**Default**: `org.apache.pulsar.broker.loadbalance.impl.ModularLoadManagerImpl` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadManagerServiceUnitStateTableViewClassName +Name of ServiceUnitStateTableView implementation class to use + +**Type**: `java.lang.String` + +**Default**: `org.apache.pulsar.broker.loadbalance.extensions.channel.ServiceUnitStateTableViewImpl` + +**Dynamic**: `false` + +**Category**: Load Balancer + +### lowerBoundarySheddingEnabled +When [current usage < average usage - threshold], the broker with the highest load will be triggered to unload + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Load Balancer + +### maxUnloadBundleNumPerShedding +For each uniform balanced unload, the maximum number of bundles that can be unloaded. The default value is -1, which means no limit + +**Type**: `int` + +**Default**: `-1` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### maxUnloadPercentage +In the UniformLoadShedder and AvgShedder strategy, the maximum unload ratio.For AvgShedder, recommend to set to 0.5, so that it will distribute the load evenly between the highest and lowest brokers. + +**Type**: `double` + +**Default**: `0.2` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### minUnloadMessage +In the UniformLoadShedder and AvgShedder strategy, the minimum message that triggers unload. + +**Type**: `int` + +**Default**: `1000` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### minUnloadMessageThroughput +In the UniformLoadShedder and AvgShedder strategy, the minimum throughput that triggers unload. + +**Type**: `int` + +**Default**: `1048576` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### namespaceBundleUnloadingTimeoutMs +Time to wait for the unloading of a namespace bundle + +**Type**: `long` + +**Default**: `60000` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### supportedNamespaceBundleSplitAlgorithms +Supported algorithms name for namespace bundle split + +**Type**: `java.util.List` + +**Default**: `[range_equally_divide, topic_count_equally_divide, specified_positions_divide, flow_or_qps_equally_divide]` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### topicBundleAssignmentStrategy +Name of topic bundle assignment strategy to use + +**Type**: `java.lang.String` + +**Default**: `org.apache.pulsar.common.naming.ConsistentHashingTopicBundleAssigner` + +**Dynamic**: `false` + +**Category**: Load Balancer + +### aggregatePublisherStatsByProducerName +If true, aggregate publisher stats of PartitionedTopicStats by producerName + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Metrics + +### authenticateMetricsEndpoint +Whether the '/metrics' endpoint requires authentication. Defaults to false.'authenticationEnabled' must also be set for this to take effect. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Metrics + +### exposeBundlesMetricsInPrometheus +Enable expose the broker bundles metrics. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `true` + +**Category**: Metrics + +### exposeConsumerLevelMetricsInPrometheus +If true, export consumer level metrics otherwise namespace level + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Metrics + +### exposeManagedCursorMetricsInPrometheus +If true, export managed cursor metrics + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Metrics + +### exposeManagedLedgerMetricsInPrometheus +If true, export managed ledger metrics (aggregated by namespace) + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `false` + +**Category**: Metrics + +### exposePreciseBacklogInPrometheus +Enable expose the precise backlog stats. + Set false to use published counter and consumed counter to calculate, + this would be more efficient but may be inaccurate. Default is false. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Metrics + +### exposeProducerLevelMetricsInPrometheus +If true, export producer level metrics otherwise namespace level + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Metrics + +### exposePublisherStats +If true, export publisher stats when returning topics stats from the admin rest api + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `false` + +**Category**: Metrics + +### exposeSubscriptionBacklogSizeInPrometheus +Enable expose the backlog size for each subscription when generating stats. + Locking is used for fetching the status so default to false. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Metrics + +### exposeTopicLevelMetricsInPrometheus +If true, export topic level metrics otherwise namespace level + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `false` + +**Category**: Metrics + +### healthCheckMetricsUpdateTimeInSeconds +HealthCheck update frequency in seconds. Disable health check with value -1 (Default value -1) + +**Type**: `int` + +**Default**: `-1` + +**Dynamic**: `false` + +**Category**: Metrics + +### jvmGCMetricsLoggerClassName +Classname of Pluggable JVM GC metrics logger that can log GC specific metrics + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Metrics + +### metricsBufferResponse +Set to true to enable the broker to cache the metrics response; the default is false. The caching period is defined by `managedLedgerStatsPeriodSeconds`. The broker returns the same response for subsequent requests within the same period. Ensure that the scrape interval of your monitoring system matches the caching period. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Metrics + +### metricsServletTimeoutMs +Time in milliseconds that metrics endpoint would time out. Default is 30s. + Increase it if there are a lot of topics to expose topic-level metrics. + Set it to 0 to disable timeout. + +**Type**: `long` + +**Default**: `30000` + +**Dynamic**: `false` + +**Category**: Metrics + +### splitTopicAndPartitionLabelInPrometheus +Enable splitting topic and partition label in Prometheus. + If enabled, a topic name will split into 2 parts, one is topic name without partition index, + another one is partition index, e.g. (topic=xxx, partition=0). + If the topic is a non-partitioned topic, -1 will be used for the partition index. + If disabled, one label to represent the topic and partition, e.g. (topic=xxx-partition-0) + Default is false. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Metrics + +### statsUpdateFrequencyInSecs +Stats update frequency in seconds + +**Type**: `int` + +**Default**: `60` + +**Dynamic**: `false` + +**Category**: Metrics + +### statsUpdateInitialDelayInSecs +Stats update initial delay in seconds + +**Type**: `int` + +**Default**: `60` + +**Dynamic**: `false` + +**Category**: Metrics + +### enablePackagesManagement +Enable the packages management service or not + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Packages Management + +### packagesManagementLedgerRootPath +The bookkeeper ledger root path + +**Type**: `java.lang.String` + +**Default**: `/ledgers` + +**Dynamic**: `false` + +**Category**: Packages Management + +### packagesManagementStorageProvider +The packages management service storage service provider + +**Type**: `java.lang.String` + +**Default**: `org.apache.pulsar.packages.management.storage.bookkeeper.BookKeeperPackagesStorageProvider` + +**Dynamic**: `false` + +**Category**: Packages Management + +### packagesReplicas +When the packages storage provider is bookkeeper, you can use this configuration to +control the number of replicas for storing the package + +**Type**: `int` + +**Default**: `1` + +**Dynamic**: `false` + +**Category**: Packages Management + +### activeConsumerFailoverDelayTimeMillis +How long to delay rewinding cursor and dispatching messages when active consumer is changed + +**Type**: `int` + +**Default**: `1000` + +**Dynamic**: `false` + +**Category**: Policies + +### additionalSystemCursorNames +Additional system subscriptions that will be ignored by ttl check. The cursor names are comma separated. Default is empty. + +**Type**: `java.util.Set` + +**Default**: `[]` + +**Dynamic**: `false` + +**Category**: Policies + +### backlogQuotaCheckEnabled +Enable backlog quota check. Enforces actions on topic when the quota is reached + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `false` + +**Category**: Policies + +### backlogQuotaCheckIntervalInSeconds +How often to check for topics that have reached the quota. It only takes effects when `backlogQuotaCheckEnabled` is true + +**Type**: `int` + +**Default**: `60` + +**Dynamic**: `false` + +**Category**: Policies + +### backlogQuotaDefaultLimitBytes +Default per-topic backlog quota limit by size, less than 0 means no limitation. default is -1. Increase it if you want to allow larger msg backlog + +**Type**: `long` + +**Default**: `-1` + +**Dynamic**: `false` + +**Category**: Policies + +### backlogQuotaDefaultLimitGB +@deprecated - Use backlogQuotaDefaultLimitByte instead. + +**Type**: `double` + +**Default**: `-1.0` + +**Dynamic**: `false` + +**Category**: Policies + +### backlogQuotaDefaultLimitSecond +Default per-topic backlog quota limit by time in second, less than 0 means no limitation. default is -1. Increase it if you want to allow larger msg backlog + +**Type**: `int` + +**Default**: `-1` + +**Dynamic**: `false` + +**Category**: Policies + +### backlogQuotaDefaultRetentionPolicy +Default backlog quota retention policy. Default is producer_request_hold + +'producer_request_hold' Policy which holds producer's send request until theresource becomes available (or holding times out) +'producer_exception' Policy which throws javax.jms.ResourceAllocationException to the producer +'consumer_backlog_eviction' Policy which evicts the oldest message from the slowest consumer's backlog + +**Type**: `org.apache.pulsar.common.policies.data.BacklogQuota.RetentionPolicy` + +**Default**: `producer_request_hold` + +**Dynamic**: `false` + +**Category**: Policies + +### brokerDeduplicationEnabled +Set the default behavior for message deduplication in the broker. + +This can be overridden per-namespace. If enabled, broker will reject messages that were already stored in the topic + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Policies + +### brokerDeduplicationEntriesInterval +Number of entries after which a dedup info snapshot is taken. + +A bigger interval will lead to less snapshots being taken though it would increase the topic recovery time, when the entries published after the snapshot need to be replayed + +**Type**: `int` + +**Default**: `1000` + +**Dynamic**: `false` + +**Category**: Policies + +### brokerDeduplicationMaxNumberOfProducers +Maximum number of producer information that it's going to be persisted for deduplication purposes + +**Type**: `int` + +**Default**: `10000` + +**Dynamic**: `false` + +**Category**: Policies + +### brokerDeduplicationProducerInactivityTimeoutMinutes +Time of inactivity after which the broker will discard the deduplication information relative to a disconnected producer. Default is 6 hours. + +**Type**: `int` + +**Default**: `360` + +**Dynamic**: `false` + +**Category**: Policies + +### brokerDeduplicationSnapshotFrequencyInSeconds +How often is the thread pool scheduled to check whether a snapshot needs to be taken.(disable with value 0) + +**Type**: `int` + +**Default**: `120` + +**Dynamic**: `false` + +**Category**: Policies + +### brokerDeduplicationSnapshotIntervalSeconds +If this time interval is exceeded, a snapshot will be taken.It will run simultaneously with `brokerDeduplicationEntriesInterval` + +**Type**: `java.lang.Integer` + +**Default**: `120` + +**Dynamic**: `false` + +**Category**: Policies + +### brokerDeleteInactivePartitionedTopicMetadataEnabled +Metadata of inactive partitioned topic will not be automatically cleaned up by default. +Note: If `allowAutoTopicCreation` and this option are enabled at the same time, +it may appear that a partitioned topic has just been deleted but is automatically created as a non-partitioned topic. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `true` + +**Category**: Policies + +### brokerDeleteInactiveTopicsEnabled +Enable the deletion of inactive topics. +If only enable this option, will not clean the metadata of partitioned topic. + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `true` + +**Category**: Policies + +### brokerDeleteInactiveTopicsFrequencySeconds +How often to check for inactive topics + +**Type**: `int` + +**Default**: `60` + +**Dynamic**: `true` + +**Category**: Policies + +### brokerDeleteInactiveTopicsMaxInactiveDurationSeconds +Max duration of topic inactivity in seconds, default is not present +If not present, 'brokerDeleteInactiveTopicsFrequencySeconds' will be used +Topics that are inactive for longer than this value will be deleted + +**Type**: `java.lang.Integer` + +**Default**: `null` + +**Dynamic**: `true` + +**Category**: Policies + +### brokerDeleteInactiveTopicsMode +Set the inactive topic delete mode. Default is delete_when_no_subscriptions +'delete_when_no_subscriptions' mode only delete the topic which has no subscriptions and no active producers +'delete_when_subscriptions_caught_up' mode only delete the topic that all subscriptions has no backlogs(caught up) and no active producers/consumers + +**Type**: `org.apache.pulsar.common.policies.data.InactiveTopicDeleteMode` + +**Default**: `delete_when_no_subscriptions` + +**Dynamic**: `true` + +**Category**: Policies + +### brokerMaxConnections +The maximum number of connections in the broker. If it exceeds, new connections are rejected. + +**Type**: `int` + +**Default**: `0` + +**Dynamic**: `false` + +**Category**: Policies + +### brokerMaxConnectionsPerIp +The maximum number of connections per IP. If it exceeds, new connections are rejected. + +**Type**: `int` + +**Default**: `0` + +**Dynamic**: `false` + +**Category**: Policies + +### defaultNumberOfNamespaceBundles +When a namespace is created without specifying the number of bundle, this value will be used as the default + +**Type**: `int` + +**Default**: `4` + +**Dynamic**: `true` + +**Category**: Policies + +### defaultRetentionSizeInMB +Default retention size. 0 means retention is disabled. -1 means data is not removed by size quota + +**Type**: `int` + +**Default**: `0` + +**Dynamic**: `false` + +**Category**: Policies + +### defaultRetentionTimeInMinutes +Default message retention time. 0 means retention is disabled. -1 means data is not removed by time quota + +**Type**: `int` + +**Default**: `0` + +**Dynamic**: `false` + +**Category**: Policies + +### dispatchThrottlingOnBatchMessageEnabled +Apply dispatch rate limiting on batch message instead individual messages with in batch message. (Default is disabled) + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `true` + +**Category**: Policies + +### dispatchThrottlingOnNonBacklogConsumerEnabled +Default dispatch-throttling is disabled for consumers which already caught-up with published messages and don't have backlog. This enables dispatch-throttling for non-backlog consumers as well. + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `true` + +**Category**: Policies + +### dispatchThrottlingRatePerReplicatorInByte +Default number of message-bytes dispatching throttling-limit for every replicator in replication. + +Using a value of 0, is disabling replication message-byte dispatch-throttling + +**Type**: `long` + +**Default**: `0` + +**Dynamic**: `true` + +**Category**: Policies + +### dispatchThrottlingRatePerReplicatorInMsg +Default number of message dispatching throttling-limit for every replicator in replication. + +Using a value of 0, is disabling replication message dispatch-throttling + +**Type**: `int` + +**Default**: `0` + +**Dynamic**: `true` + +**Category**: Policies + +### dispatchThrottlingRatePerSubscriptionInByte +Default number of message-bytes dispatching throttling-limit for a subscription. + +Using a value of 0, is disabling default message-byte dispatch-throttling. + +**Type**: `long` + +**Default**: `0` + +**Dynamic**: `true` + +**Category**: Policies + +### dispatchThrottlingRatePerSubscriptionInMsg +Default number of message dispatching throttling-limit for a subscription. + +Using a value of 0, is disabling default message dispatch-throttling. + +**Type**: `int` + +**Default**: `0` + +**Dynamic**: `true` + +**Category**: Policies + +### dispatchThrottlingRatePerTopicInByte +Default number of message-bytes dispatching throttling-limit for every topic. + +Using a value of 0, is disabling default message-byte dispatch-throttling + +**Type**: `long` + +**Default**: `0` + +**Dynamic**: `true` + +**Category**: Policies + +### dispatchThrottlingRatePerTopicInMsg +Default number of message dispatching throttling-limit for every topic. + +Using a value of 0, is disabling default message dispatch-throttling + +**Type**: `int` + +**Default**: `0` + +**Dynamic**: `true` + +**Category**: Policies + +### dispatchThrottlingRateRelativeToPublishRate +Dispatch rate-limiting relative to publish rate. (Enabling flag will make broker to dynamically update dispatch-rate relatively to publish-rate: throttle-dispatch-rate = (publish-rate + configured dispatch-rate) + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `true` + +**Category**: Policies + +### dispatcherRetryBackoffInitialTimeInMs +On Shared and KeyShared subscriptions, if all available messages in the subscription are filtered out and not dispatched to any consumer, message dispatching will be rescheduled with a backoff delay. This parameter sets the initial backoff delay in milliseconds. + +**Type**: `int` + +**Default**: `1` + +**Dynamic**: `false` + +**Category**: Policies + +### dispatcherRetryBackoffMaxTimeInMs +On Shared and KeyShared subscriptions, if all available messages in the subscription are filtered out and not dispatched to any consumer, message dispatching will be rescheduled with a backoff delay. This parameter sets the maximum backoff delay in milliseconds. + +**Type**: `int` + +**Default**: `10` + +**Dynamic**: `false` + +**Category**: Policies + +### enableBrokerSideSubscriptionPatternEvaluation +Enables evaluating subscription pattern on broker side. + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `false` + +**Category**: Policies + +### forceDeleteNamespaceAllowed +Allow forced deletion of namespaces. Default is false. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `true` + +**Category**: Policies + +### forceDeleteTenantAllowed +Allow forced deletion of tenants. Default is false. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `true` + +**Category**: Policies + +### isAllowAutoUpdateSchemaEnabled +Allow schema to be auto updated at broker level. User can override this by 'is_allow_auto_update_schema' of namespace policy. This is enabled by default. + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `true` + +**Category**: Policies + +### keySharedLookAheadMsgInReplayThresholdPerConsumer +For Key_Shared subscriptions, if messages cannot be dispatched to consumers due to a slow consumer or a blocked key hash (because of ordering constraints), the broker will continue reading more messages from the backlog and attempt to dispatch them to consumers until the number of replay messages reaches the calculated threshold. +Formula: threshold = min(keySharedLookAheadMsgInReplayThresholdPerConsumer * connected consumer count, keySharedLookAheadMsgInReplayThresholdPerSubscription). +Setting this value to 0 will disable the limit calculated per consumer. + +**Type**: `int` + +**Default**: `2000` + +**Dynamic**: `true` + +**Category**: Policies + +### keySharedLookAheadMsgInReplayThresholdPerSubscription +For Key_Shared subscriptions, if messages cannot be dispatched to consumers due to a slow consumer or a blocked key hash (because of ordering constraints), the broker will continue reading more messages from the backlog and attempt to dispatch them to consumers until the number of replay messages reaches the calculated threshold. +Formula: threshold = min(keySharedLookAheadMsgInReplayThresholdPerConsumer * connected consumer count, keySharedLookAheadMsgInReplayThresholdPerSubscription). +This value should be set to a value less than 2 * managedLedgerMaxUnackedRangesToPersist. +Setting this value to 0 will disable the limit calculated per subscription. + + +**Type**: `int` + +**Default**: `20000` + +**Dynamic**: `true` + +**Category**: Policies + +### keySharedUnblockingIntervalMs +For Key_Shared subscriptions, when a blocked key hash gets unblocked, a redelivery will be attempted after a delay. This setting controls the delay. The reason to have the delay is to batch multiple unblocking events instead of triggering redelivery for each unblocking event. + +**Type**: `long` + +**Default**: `10` + +**Dynamic**: `true` + +**Category**: Policies + +### maxConsumerMetadataSize +Maximum size of Consumer metadata + +**Type**: `int` + +**Default**: `1024` + +**Dynamic**: `false` + +**Category**: Policies + +### maxNamespacesPerTenant +The maximum number of namespaces that each tenant can create.This configuration is not precise control, in a concurrent scenario, the threshold will be exceeded + +**Type**: `int` + +**Default**: `0` + +**Dynamic**: `true` + +**Category**: Policies + +### maxPendingPublishRequestsPerConnection +Max pending publish requests per connection to avoid keeping large number of pending requests in memory. Default: 1000 + +**Type**: `int` + +**Default**: `1000` + +**Dynamic**: `false` + +**Category**: Policies + +### maxSecondsToClearTopicNameCache +A Specifies the minimum number of seconds that the topic name stays in memory, to avoid clear cache frequently when there are too many topics are in use. + +**Type**: `int` + +**Default**: `7200` + +**Dynamic**: `false` + +**Category**: Policies + +### maxTopicsPerNamespace +Max number of topics allowed to be created in the namespace. When the topics reach the max topics of the namespace, the broker should reject the new topic request(include topic auto-created by the producer or consumer) until the number of connected consumers decrease. Using a value of 0, is disabling maxTopicsPerNamespace-limit check. + +**Type**: `int` + +**Default**: `0` + +**Dynamic**: `true` + +**Category**: Policies + +### maxUnackedMessagesPerBroker +Max number of unacknowledged messages allowed per broker. + + Once this limit reaches, broker will stop dispatching messages to all shared subscription which has higher number of unack messages until subscriptions start acknowledging messages back and unack count reaches to `limit/2`. Using a value of 0, is disabling unackedMessage-limit check and broker doesn't block dispatchers + +**Type**: `int` + +**Default**: `0` + +**Dynamic**: `false` + +**Category**: Policies + +### maxUnackedMessagesPerConsumer +Max number of unacknowledged messages allowed to receive messages by a consumer on a shared subscription. + + Broker will stop sending messages to consumer once, this limit reaches until consumer starts acknowledging messages back and unack count reaches to `maxUnackedMessagesPerConsumer/2`. Using a value of 0, it is disabling unackedMessage-limit check and consumer can receive messages without any restriction + +**Type**: `int` + +**Default**: `50000` + +**Dynamic**: `false` + +**Category**: Policies + +### maxUnackedMessagesPerSubscription +Max number of unacknowledged messages allowed per shared subscription. + + Broker will stop dispatching messages to all consumers of the subscription once this limit reaches until consumer starts acknowledging messages back and unack count reaches to `limit/2`. Using a value of 0, is disabling unackedMessage-limit check and dispatcher can dispatch messages without any restriction + +**Type**: `int` + +**Default**: `200000` + +**Dynamic**: `false` + +**Category**: Policies + +### maxUnackedMessagesPerSubscriptionOnBrokerBlocked +Once broker reaches maxUnackedMessagesPerBroker limit, it blocks subscriptions which has higher unacked messages than this percentage limit and subscription will not receive any new messages until that subscription acks back `limit/2` messages + +**Type**: `double` + +**Default**: `0.16` + +**Dynamic**: `false` + +**Category**: Policies + +### messageExpiryCheckIntervalInMinutes +How frequently to proactively check and purge expired messages + +**Type**: `int` + +**Default**: `5` + +**Dynamic**: `false` + +**Category**: Policies + +### preciseTimeBasedBacklogQuotaCheck +Whether to enable precise time based backlog quota check. Enabling precise time based backlog quota check will cause broker to read first entry in backlog of the slowest cursor on a ledger which will mostly result in reading entry from BookKeeper's disk which can have negative impact on overall performance. Disabling precise time based backlog quota check will just use the timestamp indicating when a ledger was closed, which is of coarser granularity. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Policies + +### resourceUsageTransportClassName +Default policy for publishing usage reports to system topic is disabled.This enables publishing of usage reports + +**Type**: `java.lang.String` + +**Default**: `` + +**Dynamic**: `false` + +**Category**: Policies + +### resourceUsageTransportPublishIntervalInSecs +Default interval to publish usage reports if resourceUsagePublishToTopic is enabled. + +**Type**: `int` + +**Default**: `60` + +**Dynamic**: `true` + +**Category**: Policies + +### subscribeRatePeriodPerConsumerInSecond +Rate period for {subscribeThrottlingRatePerConsumer}. Default is 30s. + +**Type**: `int` + +**Default**: `30` + +**Dynamic**: `true` + +**Category**: Policies + +### subscribeThrottlingRatePerConsumer +Too many subscribe requests from a consumer can cause broker rewinding consumer cursors and loading data from bookies, hence causing high network bandwidth usage When the positive value is set, broker will throttle the subscribe requests for one consumer. Otherwise, the throttling will be disabled. The default value of this setting is 0 - throttling is disabled. + +**Type**: `int` + +**Default**: `0` + +**Dynamic**: `true` + +**Category**: Policies + +### subscriptionBacklogScanMaxEntries +Maximum number of entries to process while scanning a subscription to calculate the accurate backlog + +**Type**: `long` + +**Default**: `10000` + +**Dynamic**: `false` + +**Category**: Policies + +### subscriptionBacklogScanMaxTimeMs +Maximum time to spend while scanning a subscription to calculate the accurate backlog + +**Type**: `long` + +**Default**: `120000` + +**Dynamic**: `false` + +**Category**: Policies + +### subscriptionExpirationTimeMinutes +How long to delete inactive subscriptions from last consuming. When it is 0, inactive subscriptions are not deleted automatically + +**Type**: `int` + +**Default**: `0` + +**Dynamic**: `false` + +**Category**: Policies + +### subscriptionExpiryCheckIntervalInMinutes +How frequently to proactively check and purge expired subscription + +**Type**: `int` + +**Default**: `5` + +**Dynamic**: `false` + +**Category**: Policies + +### subscriptionKeySharedConsistentHashingReplicaPoints +On KeyShared subscriptions, number of points in the consistent-hashing ring. The higher the number, the more equal the assignment of keys to consumers + +**Type**: `int` + +**Default**: `100` + +**Dynamic**: `false` + +**Category**: Policies + +### subscriptionKeySharedEnable +Enable Key_Shared subscription (default is enabled). +@deprecated - use subscriptionTypesEnabled instead. + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `true` + +**Category**: Policies + +### subscriptionKeySharedUseClassicPersistentImplementation +For persistent Key_Shared subscriptions, enables the use of the classic implementation of the Key_Shared subscription that was used before Pulsar 4.0.0 and PIP-379. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `true` + +**Category**: Policies + +### subscriptionKeySharedUseConsistentHashing +On KeyShared subscriptions, with default AUTO_SPLIT mode, use splitting ranges or consistent hashing to reassign keys to new consumers (default is consistent hashing) + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `false` + +**Category**: Policies + +### subscriptionPatternMaxLength +Max length of subscription pattern + +**Type**: `int` + +**Default**: `50` + +**Dynamic**: `false` + +**Category**: Policies + +### subscriptionRedeliveryTrackerEnabled +Enable subscription message redelivery tracker to send redelivery count to consumer (default is enabled) + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `true` + +**Category**: Policies + +### subscriptionSharedUseClassicPersistentImplementation +For persistent Shared subscriptions, enables the use of the classic implementation of the Shared subscription that was used before Pulsar 4.0.0. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `true` + +**Category**: Policies + +### subscriptionTypesEnabled +Enable subscription types (default is all type enabled) + +**Type**: `java.util.Set` + +**Default**: `[Failover, Shared, Key_Shared, Exclusive]` + +**Dynamic**: `true` + +**Category**: Policies + +### topicNameCacheMaxCapacity +Max capacity of the topic name cache. -1 means unlimited cache; 0 means broker will clear all cache per maxSecondsToClearTopicNameCache, it does not mean broker will not cache TopicName. + +**Type**: `int` + +**Default**: `100000` + +**Dynamic**: `true` + +**Category**: Policies + +### topicPublisherThrottlingTickTimeMillis +Tick time to schedule task that checks topic publish rate limiting across all topics Reducing to lower value can give more accuracy while throttling publish but it uses more CPU to perform frequent check. (Disable publish throttling with value 0) + +**Type**: `int` + +**Default**: `10` + +**Dynamic**: `true` + +**Category**: Policies + +### ttlDurationDefaultInSeconds +Default ttl for namespaces if ttl is not already configured at namespace policies. (disable default-ttl with value 0) + +**Type**: `int` + +**Default**: `0` + +**Dynamic**: `false` + +**Category**: Policies + +### unblockStuckSubscriptionEnabled +Broker periodically checks if subscription is stuck and unblock if flag is enabled. (Default is disabled) + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `true` + +**Category**: Policies + +### messagingProtocols +List of messaging protocols to load, which is a list of protocol names + +**Type**: `java.util.Set` + +**Default**: `[]` + +**Dynamic**: `false` + +**Category**: Protocols + +### protocolHandlerDirectory +The directory to locate messaging protocol handlers + +**Type**: `java.lang.String` + +**Default**: `./protocols` + +**Dynamic**: `false` + +**Category**: Protocols + +### useSeparateThreadPoolForProtocolHandlers +Use a separate ThreadPool for each Protocol Handler + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `false` + +**Category**: Protocols + +### brokerClientTlsEnabled +Enable TLS when talking with other brokers in the same cluster (admin operation) or different clusters (replication) + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `true` + +**Category**: Replication + +### createTopicToRemoteClusterForReplication +Whether the internal replicator will trigger topic auto-creation on the remote cluster. + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `false` + +**Category**: Replication + +### replicationConnectionsPerBroker +Max number of connections to open for each broker in a remote cluster. + +More connections host-to-host lead to better throughput over high-latency links + +**Type**: `int` + +**Default**: `16` + +**Dynamic**: `false` + +**Category**: Replication + +### replicationMetricsEnabled +Enable replication metrics + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `false` + +**Category**: Replication + +### replicationPolicyCheckDurationSeconds +Duration to check replication policy to avoid replicator inconsistency due to missing ZooKeeper watch (disable with value 0) + +**Type**: `int` + +**Default**: `600` + +**Dynamic**: `false` + +**Category**: Replication + +### replicationProducerQueueSize +Replicator producer queue size. When dynamically modified, it only takes effect for the newly added replicators + +**Type**: `int` + +**Default**: `1000` + +**Dynamic**: `true` + +**Category**: Replication + +### replicatorPrefix +replicator prefix used for replicator producer name and cursor name + +**Type**: `java.lang.String` + +**Default**: `pulsar.repl` + +**Dynamic**: `false` + +**Category**: Replication + +### inflightSaslContextExpiryMs +how often the broker expires the inflight SASL context. + +**Type**: `long` + +**Default**: `30000` + +**Dynamic**: `false` + +**Category**: SASL Authentication Provider + +### kinitCommand +kerberos kinit command. + +**Type**: `java.lang.String` + +**Default**: `/usr/bin/kinit` + +**Dynamic**: `false` + +**Category**: SASL Authentication Provider + +### maxInflightSaslContext +Maximum number of inflight sasl context. + +**Type**: `long` + +**Default**: `50000` + +**Dynamic**: `false` + +**Category**: SASL Authentication Provider + +### saslJaasClientAllowedIds +This is a regexp, which limits the range of possible ids which can connect to the Broker using SASL. + Default value is: ".*pulsar.*", so only clients whose id contains 'pulsar' are allowed to connect. + +**Type**: `java.lang.String` + +**Default**: `.*pulsar.*` + +**Dynamic**: `false` + +**Category**: SASL Authentication Provider + +### saslJaasServerRoleTokenSignerSecretPath +Path to file containing the secret to be used to SaslRoleTokenSigner +The secret can be specified like: +saslJaasServerRoleTokenSignerSecretPath=file:///my/saslRoleTokenSignerSecret.key. + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: SASL Authentication Provider + +### saslJaasServerSectionName +Service Principal, for login context name. Default value is "PulsarBroker". + +**Type**: `java.lang.String` + +**Default**: `PulsarBroker` + +**Dynamic**: `false` + +**Category**: SASL Authentication Provider + +### isSchemaValidationEnforced +Enforce schema validation on following cases: + + - if a producer without a schema attempts to produce to a topic with schema, the producer will be + failed to connect. PLEASE be carefully on using this, since non-java clients don't support schema. + if you enable this setting, it will cause non-java clients failed to produce. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Schema + +### schemaCompatibilityStrategy +The schema compatibility strategy in broker level + +**Type**: `org.apache.pulsar.common.policies.data.SchemaCompatibilityStrategy` + +**Default**: `FULL` + +**Dynamic**: `false` + +**Category**: Schema + +### schemaRegistryCompatibilityCheckers +The list compatibility checkers to be used in schema registry + +**Type**: `java.util.Set` + +**Default**: `[org.apache.pulsar.broker.service.schema.ProtobufNativeSchemaCompatibilityCheck, org.apache.pulsar.broker.service.schema.JsonSchemaCompatibilityCheck, org.apache.pulsar.broker.service.schema.AvroSchemaCompatibilityCheck]` + +**Dynamic**: `false` + +**Category**: Schema + +### schemaRegistryStorageClassName +The schema storage implementation used by this broker + +**Type**: `java.lang.String` + +**Default**: `org.apache.pulsar.broker.service.schema.BookkeeperSchemaStorageFactory` + +**Dynamic**: `false` + +**Category**: Schema + +### systemTopicSchemaCompatibilityStrategy +The schema compatibility strategy to use for system topics + +**Type**: `org.apache.pulsar.common.policies.data.SchemaCompatibilityStrategy` + +**Default**: `ALWAYS_COMPATIBLE` + +**Dynamic**: `false` + +**Category**: Schema + +### acknowledgmentAtBatchIndexLevelEnabled +Whether to enable the acknowledge of batch local index + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Server + +### advertisedAddress +Hostname or IP address the service advertises to the outside world. If not set, the value of `InetAddress.getLocalHost().getCanonicalHostName()` is used. + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Server + +### advertisedListeners +Used to specify multiple advertised listeners for the broker. The value must format as :pulsar://:,multiple listeners should separate with commas.Do not use this configuration with advertisedAddress and brokerServicePort.The Default value is absent means use advertisedAddress and brokerServicePort. + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Server + +### allowOverrideEntryFilters +Whether allow topic level entry filters policies overrides broker configuration. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `true` + +**Category**: Server + +### autoShrinkForConsumerPendingAcksMap +Whether to enable the automatic shrink of pendingAcks map, the default is false, which means it is not enabled. When there are a large number of share or key share consumers in the cluster, it can be enabled to reduce the memory consumption caused by pendingAcks. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Server + +### bindAddress +Hostname or IP address the service binds on + +**Type**: `java.lang.String` + +**Default**: `0.0.0.0` + +**Dynamic**: `false` + +**Category**: Server + +### bindAddresses +Used to specify additional bind addresses for the broker. The value must format as :://:, multiple bind addresses should be separated with commas. Associates each bind address with an advertised listener and protocol handler. Note that the brokerServicePort, brokerServicePortTls, webServicePort, and webServicePortTls properties define additional bindings. + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Server + +### bootstrapNamespaces +A comma-separated list of namespaces to bootstrap + +**Type**: `java.util.List` + +**Default**: `[]` + +**Dynamic**: `false` + +**Category**: Server + +### brokerEntryMetadataInterceptors +List of interceptors for entry metadata. + +**Type**: `java.util.Set` + +**Default**: `[]` + +**Dynamic**: `false` + +**Category**: Server + +### brokerEntryPayloadProcessors +List of interceptors for payload processing. + +**Type**: `java.util.Set` + +**Default**: `[]` + +**Dynamic**: `false` + +**Category**: Server + +### brokerInterceptors +List of broker interceptor to load, which is a list of broker interceptor names + +**Type**: `java.util.Set` + +**Default**: `[]` + +**Dynamic**: `false` + +**Category**: Server + +### brokerInterceptorsDirectory +The directory to locate broker interceptors + +**Type**: `java.lang.String` + +**Default**: `./interceptors` + +**Dynamic**: `false` + +**Category**: Server + +### brokerPublisherThrottlingMaxByteRate +Max Rate(in 1 seconds) of Byte allowed to publish for a broker when broker publish rate limiting enabled. (Disable byte rate limit with value 0) + +**Type**: `long` + +**Default**: `0` + +**Dynamic**: `true` + +**Category**: Server + +### brokerPublisherThrottlingMaxMessageRate +Max Rate(in 1 seconds) of Message allowed to publish for a broker when broker publish rate limiting enabled. (Disable message rate limit with value 0) + +**Type**: `int` + +**Default**: `0` + +**Dynamic**: `true` + +**Category**: Server + +### brokerPublisherThrottlingTickTimeMillis +Tick time to schedule task that checks broker publish rate limiting across all topics Reducing to lower value can give more accuracy while throttling publish but it uses more CPU to perform frequent check. (Disable publish throttling with value 0) + +**Type**: `int` + +**Default**: `50` + +**Dynamic**: `true` + +**Category**: Server + +### brokerServiceCompactionMonitorIntervalInSeconds +Interval between checks to see if topics with compaction policies need to be compacted + +**Type**: `int` + +**Default**: `60` + +**Dynamic**: `false` + +**Category**: Server + +### brokerServiceCompactionPhaseOneLoopTimeInSeconds +Timeout for each read request in the compaction phase one loop, If the execution time of one single message read operation exceeds this time, the compaction will not proceed. + +**Type**: `long` + +**Default**: `30` + +**Dynamic**: `false` + +**Category**: Server + +### brokerServiceCompactionThresholdInBytes +The estimated backlog size is greater than this threshold, compression will be triggered. +Using a value of 0, is disabling compression check. + +**Type**: `long` + +**Default**: `0` + +**Dynamic**: `false` + +**Category**: Server + +### brokerServicePort +The port for serving binary protobuf requests. If set, defines a server binding for bindAddress:brokerServicePort. The Default value is 6650. + +**Type**: `java.util.Optional` + +**Default**: `Optional[6650]` + +**Dynamic**: `false` + +**Category**: Server + +### brokerServicePortTls +The port for serving TLS-secured binary protobuf requests. If set, defines a server binding for bindAddress:brokerServicePortTls. + +**Type**: `java.util.Optional` + +**Default**: `Optional.empty` + +**Dynamic**: `false` + +**Category**: Server + +### brokerShutdownTimeoutMs +Time to wait for broker graceful shutdown. After this time elapses, the process will be killed + +**Type**: `long` + +**Default**: `60000` + +**Dynamic**: `true` + +**Category**: Server + +### clientLibraryVersionCheckEnabled +Enable check for minimum allowed client library version + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `true` + +**Category**: Server + +### clusterMigrationAutoResourceCreation +Flag to start cluster migration for topic only after creating all topic's resources such as tenant, namespaces, subscriptions at new green cluster. (Default disabled). + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Server + +### clusterMigrationCheckDurationSeconds +Interval between checks to see if cluster is migrated and marks topic migrated if cluster is marked migrated. Disable with value 0. (Default disabled). + +**Type**: `int` + +**Default**: `0` + +**Dynamic**: `false` + +**Category**: Server + +### compactionServiceFactoryClassName +The class name of the factory that implements the topic compaction service. + +**Type**: `java.lang.String` + +**Default**: `org.apache.pulsar.compaction.PulsarCompactionServiceFactory` + +**Dynamic**: `false` + +**Category**: Server + +### configurationMetadataStoreUrl +The metadata store URL for the configuration data. If empty, we fall back to use metadataStoreUrl + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Server + +### configurationMetadataSyncEventTopic +Event topic to sync configuration-metadata between separate pulsar clusters on different cloud platforms. + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `true` + +**Category**: Server + +### configurationStoreConfigPath +Configuration file path for configuration metadata store. + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Server + +### connectionLivenessCheckTimeoutMillis +Timeout for connection liveness check used to check liveness of possible consumer or producer duplicates. Helps prevent ProducerFencedException with exclusive producer, ConsumerAssignException with range conflict for Key Shared with sticky hash ranges or ConsumerBusyException in the case of an exclusive consumer. Set to 0 to disable connection liveness check. + +**Type**: `long` + +**Default**: `5000` + +**Dynamic**: `false` + +**Category**: Server + +### delayedDeliveryEnabled +Whether to enable the delayed delivery for messages. + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `false` + +**Category**: Server + +### delayedDeliveryFixedDelayDetectionLookahead +Size of the lookahead window to use when detecting if all the messages in the topic have a fixed delay for InMemoryDelayedDeliveryTracker (the default DelayedDeliverTracker). Default is 50,000. Setting the lookahead window to 0 will disable the logic to handle fixed delays in messages in a different way. + +**Type**: `long` + +**Default**: `50000` + +**Dynamic**: `false` + +**Category**: Server + +### delayedDeliveryMaxDelayInMillis +The max allowed delay for delayed delivery (in milliseconds). If the broker receives a message which exceeds this max delay, then it will return an error to the producer. The default value is 0 which means there is no limit on the max delivery delay. + +**Type**: `long` + +**Default**: `0` + +**Dynamic**: `false` + +**Category**: Server + +### delayedDeliveryMaxIndexesPerBucketSnapshotSegment +The max number of delayed message index in per bucket snapshot segment, -1 means no limitation, after reaching the max number limitation, the snapshot segment will be cut off. + +**Type**: `int` + +**Default**: `5000` + +**Dynamic**: `false` + +**Category**: Server + +### delayedDeliveryMaxNumBuckets +The max number of delayed message index bucket, after reaching the max buckets limitation, the adjacent buckets will be merged.(disable with value -1) + +**Type**: `int` + +**Default**: `-1` + +**Dynamic**: `false` + +**Category**: Server + +### delayedDeliveryMaxTimeStepPerBucketSnapshotSegmentSeconds +The delayed message index time step(in seconds) in per bucket snapshot segment, after reaching the max time step limitation, the snapshot segment will be cut off. + +**Type**: `int` + +**Default**: `300` + +**Dynamic**: `false` + +**Category**: Server + +### delayedDeliveryMinIndexCountPerBucket +The delayed message index bucket min index count. When the index count of the current bucket is more than this value and all message indexes of current ledger have already been added to the tracker we will seal the bucket. + +**Type**: `long` + +**Default**: `50000` + +**Dynamic**: `false` + +**Category**: Server + +### delayedDeliveryTickTimeMillis +Control the tick time for when retrying on delayed delivery, affecting the accuracy of the delivery time compared to the scheduled time. Default is 1 second. Note that this time is used to configure the HashedWheelTimer's tick time. + +**Type**: `long` + +**Default**: `1000` + +**Dynamic**: `false` + +**Category**: Server + +### delayedDeliveryTrackerFactoryClassName +Class name of the factory that implements the delayed deliver tracker. +If value is "org.apache.pulsar.broker.delayed.BucketDelayedDeliveryTrackerFactory", will create bucket based delayed message index tracker. + + +**Type**: `java.lang.String` + +**Default**: `org.apache.pulsar.broker.delayed.InMemoryDelayedDeliveryTrackerFactory` + +**Dynamic**: `false` + +**Category**: Server + +### dispatchThrottlingForFilteredEntriesEnabled +Whether the broker should count filtered entries in dispatch rate limit calculations. When disabled, only messages sent to a consumer count towards a dispatch rate limit at the broker, topic, and subscription level. When enabled, messages filtered out due to entry filter logic are counted towards each relevant rate limit. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Server + +### dispatchThrottlingRateInByte +Default bytes per second dispatch throttling-limit for whole broker. Using a value of 0, is disabling default message-byte dispatch-throttling + +**Type**: `long` + +**Default**: `0` + +**Dynamic**: `true` + +**Category**: Server + +### dispatchThrottlingRateInMsg +Default messages per second dispatch throttling-limit for whole broker. Using a value of 0, is disabling default message-byte dispatch-throttling + +**Type**: `int` + +**Default**: `0` + +**Dynamic**: `true` + +**Category**: Server + +### dispatcherDispatchMessagesInSubscriptionThread +Dispatch messages and execute broker side filters in a per-subscription thread + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `true` + +**Category**: Server + +### dispatcherEntryFilterRescheduledMessageDelay +Time in milliseconds to delay the new delivery of a message when an EntryFilter returns RESCHEDULE. + +**Type**: `int` + +**Default**: `1000` + +**Dynamic**: `true` + +**Category**: Server + +### dispatcherMaxReadBatchSize +Max number of entries to read from bookkeeper. By default it is 100 entries. + +**Type**: `int` + +**Default**: `100` + +**Dynamic**: `true` + +**Category**: Server + +### dispatcherMaxReadSizeBytes +Max size in bytes of entries to read from bookkeeper. By default it is 5MB. + +**Type**: `int` + +**Default**: `5242880` + +**Dynamic**: `true` + +**Category**: Server + +### dispatcherMaxRoundRobinBatchSize +Max number of entries to dispatch for a shared subscription. By default it is 20 entries. + +**Type**: `int` + +**Default**: `20` + +**Dynamic**: `true` + +**Category**: Server + +### dispatcherMinReadBatchSize +Min number of entries to read from bookkeeper. By default it is 1 entries.When there is an error occurred on reading entries from bookkeeper, the broker will backoff the batch size to this minimum number. + +**Type**: `int` + +**Default**: `1` + +**Dynamic**: `true` + +**Category**: Server + +### dispatcherReadFailureBackoffInitialTimeInMs +The read failure backoff initial time in milliseconds. By default it is 15s. + +**Type**: `int` + +**Default**: `15000` + +**Dynamic**: `true` + +**Category**: Server + +### dispatcherReadFailureBackoffMandatoryStopTimeInMs +The read failure backoff mandatory stop time in milliseconds. By default it is 0s. + +**Type**: `int` + +**Default**: `0` + +**Dynamic**: `true` + +**Category**: Server + +### dispatcherReadFailureBackoffMaxTimeInMs +The read failure backoff max time in milliseconds. By default it is 60s. + +**Type**: `int` + +**Default**: `60000` + +**Dynamic**: `true` + +**Category**: Server + +### enableBusyWait +Option to enable busy-wait settings. Default is false. WARNING: This option will enable spin-waiting on executors and IO threads in order to reduce latency during context switches. The spinning will consume 100% CPU even when the broker is not doing any work. It is recommended to reduce the number of IO threads and BK client threads to only have few CPU cores busy. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Server + +### enableNamespaceIsolationUpdateOnTime +This config never takes effect and will be removed in the next release + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Server + +### enableNonPersistentTopics +Enable broker to load non-persistent topics + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `false` + +**Category**: Server + +### enablePersistentTopics +Enable broker to load persistent topics + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `false` + +**Category**: Server + +### enableReplicatedSubscriptions +Enable tracking of replicated subscriptions state across clusters. + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `false` + +**Category**: Server + +### enableRunBookieAutoRecoveryTogether +Enable to run bookie autorecovery along with broker + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Server + +### enableRunBookieTogether +Enable to run bookie along with broker + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Server + +### encryptionRequireOnProducer +Enforce producer to publish encrypted messages.(default disable). + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Server + +### entryFilterNames + Class name of pluggable entry filter that decides whether the entry needs to be filtered.You can use this class to decide which entries can be sent to consumers.Multiple names need to be separated by commas. + +**Type**: `java.util.List` + +**Default**: `[]` + +**Dynamic**: `true` + +**Category**: Server + +### entryFiltersDirectory + The directory for all the entry filter implementations. + +**Type**: `java.lang.String` + +**Default**: `` + +**Dynamic**: `true` + +**Category**: Server + +### exposingBrokerEntryMetadataToClientEnabled +Enable or disable exposing broker entry metadata to client. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Server + +### failureDomainsEnabled +Enable cluster's failure-domain which can distribute brokers into logical region + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `true` + +**Category**: Server + +### haProxyProtocolEnabled +Enable or disable the proxy protocol. If true, the real IP addresses of consumers and producers can be obtained when getting topic statistics data. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Server + +### httpServerAcceptQueueSize +Capacity for accept queue in the HTTP server Default is set to 8192. + +**Type**: `int` + +**Default**: `8192` + +**Dynamic**: `false` + +**Category**: Server + +### httpServerGzipCompressionExcludedPaths +Gzip compression is enabled by default. Specific paths can be excluded from compression. +There are 2 syntaxes supported, Servlet url-pattern based, and Regex based. +If the spec starts with '^' the spec is assumed to be a regex based path spec and will match with normal Java regex rules. +If the spec starts with '/' then spec is assumed to be a Servlet url-pattern rules path spec for either an exact match or prefix based match. +If the spec starts with '*.' then spec is assumed to be a Servlet url-pattern rules path spec for a suffix based match. +All other syntaxes are unsupported. +Disable all compression with ^.* or ^.*$ + +**Type**: `java.util.List` + +**Default**: `[]` + +**Dynamic**: `false` + +**Category**: Server + +### httpServerThreadPoolQueueSize +Capacity for thread pool queue in the HTTP server Default is set to 8192. + +**Type**: `int` + +**Default**: `8192` + +**Dynamic**: `false` + +**Category**: Server + +### internalListenerName +Used to specify the internal listener name for the broker.The listener name must contain in the advertisedListeners.The Default value is absent, the broker uses the first listener as the internal listener. + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Server + +### isDelayedDeliveryDeliverAtTimeStrict +Whether the deliverAt time is strictly followed. When false (default), messages may be sent to consumers before the deliverAt time by as much as the tickTimeMillis. This can reduce the overhead on the broker of maintaining the delayed index for a potentially very short time period. When true, messages will not be sent to consumer until the deliverAt time has passed, and they may be as late as the deliverAt time plus the tickTimeMillis for the topic plus the delayedDeliveryTickTimeMillis. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Server + +### keepAliveIntervalSeconds +How often to check pulsar connection is still alive + +**Type**: `int` + +**Default**: `30` + +**Dynamic**: `false` + +**Category**: Server + +### lazyCursorRecovery +Whether to recover cursors lazily when trying to recover a managed ledger backing a persistent topic. It can improve write availability of topics. +The caveat is now when recovered ledger is ready to write we're not sure if all old consumers last mark delete position can be recovered or not. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Server + +### lookupPropertyPrefix +The properties whose name starts with this prefix will be uploaded to the metadata store for the topic lookup + +**Type**: `java.lang.String` + +**Default**: `lookup.` + +**Dynamic**: `false` + +**Category**: Server + +### maxConcurrentHttpRequests +Max concurrent web requests + +**Type**: `int` + +**Default**: `1024` + +**Dynamic**: `false` + +**Category**: Server + +### maxConcurrentLookupRequest +Max number of concurrent lookup request broker allows to throttle heavy incoming lookup traffic + +**Type**: `int` + +**Default**: `50000` + +**Dynamic**: `true` + +**Category**: Server + +### maxConcurrentNonPersistentMessagePerConnection +Max concurrent non-persistent message can be processed per connection + +**Type**: `int` + +**Default**: `1000` + +**Dynamic**: `false` + +**Category**: Server + +### maxConcurrentTopicLoadRequest +Max number of concurrent topic loading request broker allows to control number of zk-operations + +**Type**: `int` + +**Default**: `5000` + +**Dynamic**: `true` + +**Category**: Server + +### maxConsumersPerSubscription +Max number of consumers allowed to connect to subscription. + +Once this limit reaches, Broker will reject new consumers until the number of connected consumers decrease. Using a value of 0, is disabling maxConsumersPerSubscription-limit check. + +**Type**: `int` + +**Default**: `0` + +**Dynamic**: `false` + +**Category**: Server + +### maxConsumersPerTopic +Max number of consumers allowed to connect to topic. + +Once this limit reaches, Broker will reject new consumers until the number of connected consumers decrease. Using a value of 0, is disabling maxConsumersPerTopic-limit check. + +**Type**: `int` + +**Default**: `0` + +**Dynamic**: `false` + +**Category**: Server + +### maxHttpServerConnections +Maximum number of inbound http connections. (0 to disable limiting) + +**Type**: `int` + +**Default**: `2048` + +**Dynamic**: `false` + +**Category**: Server + +### maxMessagePublishBufferSizeInMB +Max memory size for broker handling messages sending from producers. + + If the processing message size exceed this value, broker will stop read data from the connection. The processing messages means messages are sends to broker but broker have not send response to client, usually waiting to write to bookies. + + It's shared across all the topics running in the same broker. + + Use -1 to disable the memory limitation. Default is 1/2 of direct memory. + + + +**Type**: `int` + +**Default**: `4608` + +**Dynamic**: `true` + +**Category**: Server + +### maxMessageSize +Max size of messages. + +**Type**: `int` + +**Default**: `5242880` + +**Dynamic**: `false` + +**Category**: Server + +### maxNumPartitionsPerPartitionedTopic +The number of partitions per partitioned topic. +If try to create or update partitioned topics by exceeded number of partitions, then fail. +Use 0 or negative number to disable the check. + +**Type**: `int` + +**Default**: `0` + +**Dynamic**: `true` + +**Category**: Server + +### maxProducersPerTopic +Max number of producers allowed to connect to topic. + +Once this limit reaches, Broker will reject new producers until the number of connected producers decrease. Using a value of 0, is disabling maxProducersPerTopic-limit check. + +**Type**: `int` + +**Default**: `0` + +**Dynamic**: `false` + +**Category**: Server + +### maxPublishRatePerTopicInBytes +Max Rate(in 1 seconds) of Byte allowed to publish for a topic when topic publish rate limiting enabled. (Disable byte rate limit with value 0) + +**Type**: `long` + +**Default**: `0` + +**Dynamic**: `true` + +**Category**: Server + +### maxPublishRatePerTopicInMessages +Max Rate(in 1 seconds) of Message allowed to publish for a topic when topic publish rate limiting enabled. (Disable byte rate limit with value 0) + +**Type**: `int` + +**Default**: `0` + +**Dynamic**: `true` + +**Category**: Server + +### maxSameAddressConsumersPerTopic +Max number of consumers with the same IP address allowed to connect to topic. + +Once this limit reaches, Broker will reject new consumers until the number of connected consumers with the same IP address decrease. Using a value of 0, is disabling maxSameAddressConsumersPerTopic-limit check. + +**Type**: `int` + +**Default**: `0` + +**Dynamic**: `false` + +**Category**: Server + +### maxSameAddressProducersPerTopic +Max number of producers with the same IP address allowed to connect to topic. + +Once this limit reaches, Broker will reject new producers until the number of connected producers with the same IP address decrease. Using a value of 0, is disabling maxSameAddressProducersPerTopic-limit check. + +**Type**: `int` + +**Default**: `0` + +**Dynamic**: `false` + +**Category**: Server + +### maxSubscriptionsPerTopic +Max number of subscriptions allowed to subscribe to topic. + +Once this limit reaches, broker will reject new subscription until the number of subscribed subscriptions decrease. + Using a value of 0, is disabling maxSubscriptionsPerTopic limit check. + +**Type**: `int` + +**Default**: `0` + +**Dynamic**: `false` + +**Category**: Server + +### maxTenants +The maximum number of tenants that each pulsar cluster can create.This configuration is not precise control, in a concurrent scenario, the threshold will be exceeded. + +**Type**: `int` + +**Default**: `0` + +**Dynamic**: `true` + +**Category**: Server + +### messagePublishBufferCheckIntervalInMillis +Interval between checks to see if message publish buffer size is exceed the max message publish buffer size + +**Type**: `int` + +**Default**: `100` + +**Dynamic**: `false` + +**Category**: Server + +### metadataStoreAllowReadOnlyOperations +Is metadata store read-only operations. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Server + +### metadataStoreBatchingEnabled +Whether we should enable metadata operations batching + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `false` + +**Category**: Server + +### metadataStoreBatchingMaxDelayMillis +Maximum delay to impose on batching grouping + +**Type**: `int` + +**Default**: `5` + +**Dynamic**: `false` + +**Category**: Server + +### metadataStoreBatchingMaxOperations +Maximum number of operations to include in a singular batch + +**Type**: `int` + +**Default**: `1000` + +**Dynamic**: `false` + +**Category**: Server + +### metadataStoreBatchingMaxSizeKb +Maximum size of a batch + +**Type**: `int` + +**Default**: `128` + +**Dynamic**: `false` + +**Category**: Server + +### metadataStoreCacheExpirySeconds +Metadata store cache expiry time in seconds. + +**Type**: `int` + +**Default**: `300` + +**Dynamic**: `false` + +**Category**: Server + +### metadataStoreConfigPath +Configuration file path for local metadata store. + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Server + +### metadataStoreOperationTimeoutSeconds +Metadata store operation timeout in seconds. + +**Type**: `int` + +**Default**: `30` + +**Dynamic**: `false` + +**Category**: Server + +### metadataStoreSessionTimeoutMillis +Metadata store session timeout in milliseconds. + +**Type**: `long` + +**Default**: `30000` + +**Dynamic**: `false` + +**Category**: Server + +### metadataStoreUrl +The metadata store URL. + Examples: + * zk:my-zk-1:2181,my-zk-2:2181,my-zk-3:2181 + * my-zk-1:2181,my-zk-2:2181,my-zk-3:2181 (will default to ZooKeeper when the schema is not specified) + * zk:my-zk-1:2181,my-zk-2:2181,my-zk-3:2181/my-chroot-path (to add a ZK chroot path) + + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Server + +### metadataSyncEventTopic +Event topic to sync metadata between separate pulsar clusters on different cloud platforms. + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `true` + +**Category**: Server + +### numAcceptorThreads +Number of threads to use for Netty Acceptor. Default is set to `1` + +**Type**: `int` + +**Default**: `1` + +**Dynamic**: `false` + +**Category**: Server + +### numCacheExecutorThreadPoolSize +Number of thread pool size to use for pulsar zookeeper callback service.The cache executor thread pool is used for restarting global zookeeper session. Default is 10 + +**Type**: `int` + +**Default**: `10` + +**Dynamic**: `false` + +**Category**: Server + +### numExecutorThreadPoolSize +Number of threads to use for pulsar broker service. The executor in thread pool will do basic broker operation like load/unload bundle, update managedLedgerConfig, update topic/subscription/replicator message dispatch rate, do leader election etc. Default is set to 20 + +**Type**: `int` + +**Default**: `14` + +**Dynamic**: `false` + +**Category**: Server + +### numHttpServerThreads +Number of threads to use for HTTP requests processing Default is set to `2 * Runtime.getRuntime().availableProcessors()` + +**Type**: `int` + +**Default**: `28` + +**Dynamic**: `false` + +**Category**: Server + +### numIOThreads +Number of threads to use for Netty IO. Default is set to `2 * Runtime.getRuntime().availableProcessors()` + +**Type**: `int` + +**Default**: `28` + +**Dynamic**: `false` + +**Category**: Server + +### numOrderedExecutorThreads +Number of threads to use for orderedExecutor. The ordered executor is used to operate with zookeeper, such as init zookeeper client, get namespace policies from zookeeper etc. It also used to split bundle. Default is 8 + +**Type**: `int` + +**Default**: `8` + +**Dynamic**: `false` + +**Category**: Server + +### preciseDispatcherFlowControl +Precise dispatcher flow control according to history message number of each entry + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `true` + +**Category**: Server + +### preciseTopicPublishRateLimiterEnable +Enable precise rate limit for topic publish + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Server + +### preferLaterVersions +If true, (and ModularLoadManagerImpl is being used), the load manager will attempt to use only brokers running the latest software version (to minimize impact to bundles) + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `true` + +**Category**: Server + +### replicatedSubscriptionsSnapshotFrequencyMillis +Frequency of snapshots for replicated subscriptions tracking. + +**Type**: `int` + +**Default**: `1000` + +**Dynamic**: `false` + +**Category**: Server + +### replicatedSubscriptionsSnapshotMaxCachedPerSubscription +Max number of snapshot to be cached per subscription. + +**Type**: `int` + +**Default**: `10` + +**Dynamic**: `false` + +**Category**: Server + +### replicatedSubscriptionsSnapshotTimeoutSeconds +Timeout for building a consistent snapshot for tracking replicated subscriptions state. + +**Type**: `int` + +**Default**: `30` + +**Dynamic**: `false` + +**Category**: Server + +### replicationStartAt +The position that replication task start at, it can be set to earliest or latest (default). + +**Type**: `java.lang.String` + +**Default**: `latest` + +**Dynamic**: `true` + +**Category**: Server + +### retentionCheckIntervalInSeconds +Check between intervals to see if consumed ledgers need to be trimmed + +**Type**: `int` + +**Default**: `120` + +**Dynamic**: `false` + +**Category**: Server + +### skipBrokerShutdownOnOOM +Flag to skip broker shutdown when broker handles Out of memory error + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `true` + +**Category**: Server + +### statusFilePath +Path for the file used to determine the rotation status for the broker when responding to service discovery health checks + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Server + +### strictBookieAffinityEnabled +Enable or disable strict bookie affinity. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Server + +### strictTopicNameEnabled +# Enable strict topic name check. Which includes two parts as follows: +# 1. Mark `-partition-` as a keyword. +# E.g. + Create a non-partitioned topic. + No corresponding partitioned topic + - persistent://public/default/local-name (passed) + - persistent://public/default/local-name-partition-z (rejected by keyword) + - persistent://public/default/local-name-partition-0 (rejected by keyword) + Has corresponding partitioned topic, partitions=2 and topic partition name is persistent://public/default/local-name + - persistent://public/default/local-name-partition-0 (passed, Because it is the partition topic's sub-partition) + - persistent://public/default/local-name-partition-z (rejected by keyword) + - persistent://public/default/local-name-partition-4 (rejected, Because it exceeds the number of maximum partitions) + Create a partitioned topic(topic metadata) + - persistent://public/default/local-name (passed) + - persistent://public/default/local-name-partition-z (rejected by keyword) + - persistent://public/default/local-name-partition-0 (rejected by keyword) +# 2. Allowed alphanumeric (a-zA-Z_0-9) and these special chars -=:. for topic name. +# NOTE: This flag will be removed in some major releases in the future. + + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Server + +### systemTopicEnabled +Enable or disable system topic. + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `false` + +**Category**: Server + +### topicCompactionRetainNullKey +Whether retain null-key message during topic compaction. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Server + +### topicFencingTimeoutSeconds +If a topic remains fenced for this number of seconds, it will be closed forcefully. + If it is set to 0 or a negative number, the fenced topic will not be closed. + +**Type**: `int` + +**Default**: `0` + +**Dynamic**: `false` + +**Category**: Server + +### topicLevelPoliciesEnabled +Enable or disable topic level policies, topic level policies depends on the system topic, please enable the system topic first. + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `false` + +**Category**: Server + +### topicLoadTimeoutSeconds +Amount of seconds to timeout when loading a topic. In situations with many geo-replicated clusters, this may need raised. + +**Type**: `long` + +**Default**: `60` + +**Dynamic**: `false` + +**Category**: Server + +### topicOrderedExecutorThreadNum +Number of worker threads to serve topic ordered executor + +**Type**: `int` + +**Default**: `14` + +**Dynamic**: `false` + +**Category**: Server + +### topicPoliciesServiceClassName +The class name of the topic policies service. The default config only takes affect when the systemTopicEnable config is true + +**Type**: `java.lang.String` + +**Default**: `org.apache.pulsar.broker.service.SystemTopicBasedTopicPoliciesService` + +**Dynamic**: `false` + +**Category**: Server + +### transactionLogBatchedWriteEnabled +Provide a mechanism allowing the Transaction Log Store to aggregate multiple records into a batched record and persist into a single BK entry. This will make Pulsar transactions work more efficiently, aka batched log. see: https://github.com/apache/pulsar/issues/15370. Default false + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `true` + +**Category**: Server + +### transactionLogBatchedWriteMaxDelayInMillis +If enabled the feature that transaction log batch, this attribute means maximum wait time(in millis) for the first record in a batch, default 1 millisecond. + +**Type**: `int` + +**Default**: `1` + +**Dynamic**: `false` + +**Category**: Server + +### transactionLogBatchedWriteMaxRecords +If enabled the feature that transaction log batch, this attribute means maximum log records count in a batch, default 512. + +**Type**: `int` + +**Default**: `512` + +**Dynamic**: `false` + +**Category**: Server + +### transactionLogBatchedWriteMaxSize +If enabled the feature that transaction log batch, this attribute means bytes size in a batch, default 4m. + +**Type**: `int` + +**Default**: `4194304` + +**Dynamic**: `false` + +**Category**: Server + +### transactionPendingAckBatchedWriteEnabled +Provide a mechanism allowing the transaction pending ack Log Store to aggregate multiple records into a batched record and persist into a single BK entry. This will make Pulsar transactions work more efficiently, aka batched log. see: https://github.com/apache/pulsar/issues/15370. Default false. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `true` + +**Category**: Server + +### transactionPendingAckBatchedWriteMaxDelayInMillis +If enabled the feature that transaction pending ack log batch, this attribute means maximum wait time(in millis) for the first record in a batch, default 1 millisecond. + +**Type**: `int` + +**Default**: `1` + +**Dynamic**: `false` + +**Category**: Server + +### transactionPendingAckBatchedWriteMaxRecords +If enabled the feature that transaction log batch, this attribute means maximum log records count in a batch, default 512. + +**Type**: `int` + +**Default**: `512` + +**Dynamic**: `false` + +**Category**: Server + +### transactionPendingAckBatchedWriteMaxSize +If enabled the feature that transaction pending ack log batch, this attribute means bytes size in a batch, default 4m. + +**Type**: `int` + +**Default**: `4194304` + +**Dynamic**: `false` + +**Category**: Server + +### webServiceHaProxyProtocolEnabled +Enable or disable the use of HA proxy protocol for resolving the client IP for http/https requests. Default is false. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Server + +### webServiceLogDetailedAddresses +Add detailed client/remote and server/local addresses and ports to http/https request logging. +Defaults to true when either webServiceHaProxyProtocolEnabled or webServiceTrustXForwardedFor is enabled. + +**Type**: `java.lang.Boolean` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Server + +### webServicePort +The port for serving http requests + +**Type**: `java.util.Optional` + +**Default**: `Optional[8080]` + +**Dynamic**: `false` + +**Category**: Server + +### webServicePortTls +The port for serving https requests + +**Type**: `java.util.Optional` + +**Default**: `Optional.empty` + +**Dynamic**: `false` + +**Category**: Server + +### webServiceTlsProvider +Specify the TLS provider for the web service: SunJSSE, Conscrypt and etc. + +**Type**: `java.lang.String` + +**Default**: `Conscrypt` + +**Dynamic**: `false` + +**Category**: Server + +### webServiceTrustXForwardedFor +Trust X-Forwarded-For header for resolving the client IP for http/https requests. +Default is false. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Server + +### bookkeeperClientAuthenticationParameters +Parameters for bookkeeper auth plugin + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperClientAuthenticationParametersName +BookKeeper auth plugin implementation specifics parameters name and values + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperClientAuthenticationPlugin +Authentication plugin to use when connecting to bookies + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperClientEnforceMinNumRacksPerWriteQuorum +Enforces rack-aware bookie selection policy to pick bookies from 'bookkeeperClientMinNumRacksPerWriteQuorum' racks for a writeQuorum. + +If BK can't find bookie then it would throw BKNotEnoughBookiesException instead of picking random one. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperClientExposeStatsToPrometheus +whether expose managed ledger client stats to prometheus + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperClientGetBookieInfoIntervalSeconds +Set the interval to periodically check bookie info + +**Type**: `int` + +**Default**: `86400` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperClientGetBookieInfoRetryIntervalSeconds +Set the interval to retry a failed bookie info lookup + +**Type**: `int` + +**Default**: `60` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperClientHealthCheckEnabled +Enable bookies health check. + + Bookies that have more than the configured number of failure within the interval will be quarantined for some time. During this period, new ledgers won't be created on these bookies + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperClientHealthCheckErrorThresholdPerInterval +Bookies health check error threshold per check interval + +**Type**: `long` + +**Default**: `5` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperClientHealthCheckIntervalSeconds +Bookies health check interval in seconds + +**Type**: `long` + +**Default**: `60` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperClientHealthCheckQuarantineTimeInSeconds +Bookie health check quarantined time in seconds + +**Type**: `long` + +**Default**: `1800` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperClientIsolationGroups +Enable bookie isolation by specifying a list of bookie groups to choose from. + +Any bookie outside the specified groups will not be used by the broker + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperClientLimitStatsLogging +whether limit per_channel_bookie_client metrics of bookkeeper client stats + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperClientMinNumRacksPerWriteQuorum +Minimum number of racks per write quorum. + +BK rack-aware bookie selection policy will try to get bookies from at least 'bookkeeperClientMinNumRacksPerWriteQuorum' racks for a write quorum. + +**Type**: `int` + +**Default**: `2` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperClientNumIoThreads +Number of BookKeeper client IO threads. Default is Runtime.getRuntime().availableProcessors() * 2 + +**Type**: `int` + +**Default**: `28` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperClientNumWorkerThreads +Number of BookKeeper client worker threads. Default is Runtime.getRuntime().availableProcessors() + +**Type**: `int` + +**Default**: `14` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperClientQuarantineRatio +bookie quarantine ratio to avoid all clients quarantine the high pressure bookie servers at the same time + +**Type**: `double` + +**Default**: `1.0` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperClientRackawarePolicyEnabled +Enable rack-aware bookie selection policy. + +BK will chose bookies from different racks when forming a new bookie ensemble + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperClientRegionawarePolicyEnabled +Enable region-aware bookie selection policy. + +BK will chose bookies from different regions and racks when forming a new bookie ensemble + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperClientReorderReadSequenceEnabled +Enable/disable reordering read sequence on reading entries + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperClientSecondaryIsolationGroups +Enable bookie secondary-isolation group if bookkeeperClientIsolationGroups doesn't have enough bookie available. + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperClientSeparatedIoThreadsEnabled +Use separated IO threads for BookKeeper client. Default is false, which will use Pulsar IO threads + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperClientSpeculativeReadTimeoutInMillis +Speculative reads are initiated if a read request doesn't complete within a certain time Using a value of 0, is disabling the speculative reads + +**Type**: `int` + +**Default**: `0` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperClientThrottleValue +Throttle value for bookkeeper client + +**Type**: `int` + +**Default**: `0` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperClientTimeoutInSeconds +Timeout for BK add / read operations + +**Type**: `long` + +**Default**: `30` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperDiskWeightBasedPlacementEnabled +Enable/disable disk weight based placement. Default is false + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperEnableStickyReads +Enable/disable having read operations for a ledger to be sticky to a single bookie. +If this flag is enabled, the client will use one single bookie (by preference) to read all entries for a ledger. + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperExplicitLacIntervalInMills +Set the interval to check the need for sending an explicit LAC + +**Type**: `int` + +**Default**: `0` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperMetadataServiceUri +Metadata service uri that bookkeeper is used for loading corresponding metadata driver and resolving its metadata service location + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperNumberOfChannelsPerBookie +Number of channels per bookie + +**Type**: `int` + +**Default**: `16` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperTLSCertificateFilePath +Path for the TLS certificate file + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperTLSClientAuthentication +Enable tls authentication with bookie + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperTLSKeyFilePath +Path for the TLS private key file + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperTLSKeyFileType +Supported type: PEM, JKS, PKCS12. Default value: PEM + +**Type**: `java.lang.String` + +**Default**: `PEM` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperTLSKeyStorePasswordPath +Path to file containing keystore password, if the client keystore is password protected. + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperTLSProviderFactoryClass +Set the client security provider factory class name. Default: org.apache.bookkeeper.tls.TLSContextFactory + +**Type**: `java.lang.String` + +**Default**: `org.apache.bookkeeper.tls.TLSContextFactory` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperTLSTrustCertTypes +Supported type: PEM, JKS, PKCS12. Default value: PEM + +**Type**: `java.lang.String` + +**Default**: `PEM` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperTLSTrustCertsFilePath +Path for the trusted TLS certificate file + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperTLSTrustStorePasswordPath +Path to file containing truststore password, if the client truststore is password protected. + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperTlsCertFilesRefreshDurationSeconds +Tls cert refresh duration at bookKeeper-client in seconds (0 to disable check) + +**Type**: `int` + +**Default**: `300` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperUseV2WireProtocol +Use older Bookkeeper wire protocol with bookie + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `true` + +**Category**: Storage (BookKeeper) + +### managedLedgerOffloadAutoTriggerSizeThresholdBytes +The number of bytes before triggering automatic offload to long term storage + +**Type**: `long` + +**Default**: `-1` + +**Dynamic**: `false` + +**Category**: Storage (Ledger Offloading) + +### managedLedgerOffloadDeletionLagMs +Delay between a ledger being successfully offloaded to long term storage, and the ledger being deleted from bookkeeper + +**Type**: `long` + +**Default**: `14400000` + +**Dynamic**: `false` + +**Category**: Storage (Ledger Offloading) + +### managedLedgerOffloadDriver +Driver to use to offload old data to long term storage + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Storage (Ledger Offloading) + +### managedLedgerOffloadMaxThreads +Maximum number of thread pool threads for ledger offloading + +**Type**: `int` + +**Default**: `2` + +**Dynamic**: `false` + +**Category**: Storage (Ledger Offloading) + +### managedLedgerOffloadPrefetchRounds +Maximum prefetch rounds for ledger reading for offloading + +**Type**: `int` + +**Default**: `1` + +**Dynamic**: `false` + +**Category**: Storage (Ledger Offloading) + +### managedLedgerOffloadThresholdInSeconds +The threshold to triggering automatic offload to long term storage + +**Type**: `long` + +**Default**: `-1` + +**Dynamic**: `false` + +**Category**: Storage (Ledger Offloading) + +### managedLedgerUnackedRangesOpenCacheSetEnabled +Use Open Range-Set to cache unacked messages (it is memory efficient but it can take more cpu) + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `false` + +**Category**: Storage (Ledger Offloading) + +### narExtractionDirectory +The directory where nar Extraction of offloaders happens + +**Type**: `java.lang.String` + +**Default**: `/var/folders/gt/xywq0qwd4cvdqfhy7t7js7b00000gn/T/` + +**Dynamic**: `false` + +**Category**: Storage (Ledger Offloading) + +### offloadersDirectory +The directory to locate offloaders + +**Type**: `java.lang.String` + +**Default**: `./offloaders` + +**Dynamic**: `false` + +**Category**: Storage (Ledger Offloading) + +### triggerOffloadOnTopicLoad +Trigger offload on topic load or not. Default is false + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Storage (Ledger Offloading) + +### allowAutoSubscriptionCreation +Allow automated creation of subscriptions if set to true (default value). + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `true` + +**Category**: Storage (Managed Ledger) + +### allowAutoTopicCreation +Allow automated creation of topics if set to true (default value). + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `true` + +**Category**: Storage (Managed Ledger) + +### allowAutoTopicCreationType +The type of topic that is allowed to be automatically created.(partitioned/non-partitioned) + +**Type**: `org.apache.pulsar.common.policies.data.TopicType` + +**Default**: `non-partitioned` + +**Dynamic**: `true` + +**Category**: Storage (Managed Ledger) + +### autoSkipNonRecoverableData +Skip reading non-recoverable/unreadable data-ledger under managed-ledger's list. + + It helps when data-ledgers gets corrupted at bookkeeper and managed-cursor is stuck at that ledger. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `true` + +**Category**: Storage (Managed Ledger) + +### cacheEvictionByMarkDeletedPosition +Evicting cache data by the slowest markDeletedPosition or readPosition. The default is to evict through readPosition. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### defaultNumPartitions +The number of partitioned topics that is allowed to be automatically created if allowAutoTopicCreationType is partitioned. + +**Type**: `int` + +**Default**: `1` + +**Dynamic**: `true` + +**Category**: Storage (Managed Ledger) + +### dispatcherPauseOnAckStatePersistentEnabled +After enabling this feature, Pulsar will stop delivery messages to clients if the cursor metadata is too large to persist, it will help to reduce the duplicates caused by the ack state that can not be fully persistent. Default false. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `true` + +**Category**: Storage (Managed Ledger) + +### managedCursorInfoCompressionThresholdInBytes +ManagedCursorInfo compression size threshold (bytes), only compress metadata when origin size more then this value. +0 means compression will always apply. + + +**Type**: `long` + +**Default**: `16384` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### managedCursorInfoCompressionType +ManagedCursorInfo compression type, option values (NONE, LZ4, ZLIB, ZSTD, SNAPPY). +If value is NONE, then save the ManagedCursorInfo bytes data directly. + +**Type**: `java.lang.String` + +**Default**: `NONE` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### managedLedgerAddEntryTimeoutSeconds +Add entry timeout when broker tries to publish message to bookkeeper.(0 to disable it) + +**Type**: `long` + +**Default**: `0` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### managedLedgerCacheCopyEntries +Whether we should make a copy of the entry payloads when inserting in cache + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### managedLedgerCacheEvictionFrequency +Configure the cache eviction frequency for the managed ledger cache. + +**Type**: `double` + +**Default**: `0.0` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### managedLedgerCacheEvictionIntervalMs +Configure the cache eviction interval in milliseconds for the managed ledger cache, default is 10ms + +**Type**: `long` + +**Default**: `10` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### managedLedgerCacheEvictionTimeThresholdMillis +All entries that have stayed in cache for more than the configured time, will be evicted + +**Type**: `long` + +**Default**: `1000` + +**Dynamic**: `true` + +**Category**: Storage (Managed Ledger) + +### managedLedgerCacheEvictionWatermark +Threshold to which bring down the cache level when eviction is triggered + +**Type**: `double` + +**Default**: `0.9` + +**Dynamic**: `true` + +**Category**: Storage (Managed Ledger) + +### managedLedgerCacheSizeMB +Amount of memory to use for caching data payload in managed ledger. + +This memory is allocated from JVM direct memory and it's shared across all the topics running in the same broker. By default, uses 1/5th of available direct memory + +**Type**: `int` + +**Default**: `1843` + +**Dynamic**: `true` + +**Category**: Storage (Managed Ledger) + +### managedLedgerCursorBackloggedThreshold +Configure the threshold (in number of entries) from where a cursor should be considered 'backlogged' and thus should be set as inactive. + +**Type**: `long` + +**Default**: `1000` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### managedLedgerCursorMaxEntriesPerLedger +Max number of entries to append to a cursor ledger + +**Type**: `int` + +**Default**: `50000` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### managedLedgerCursorPositionFlushSeconds +How frequently to flush the cursor positions that were accumulated due to rate limiting. (seconds). Default is 60 seconds + +**Type**: `int` + +**Default**: `60` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### managedLedgerCursorRolloverTimeInSeconds +Max time before triggering a rollover on a cursor ledger + +**Type**: `int` + +**Default**: `14400` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### managedLedgerDataReadPriority +Read priority when ledgers exists in both bookkeeper and the second layer storage. + +**Type**: `java.lang.String` + +**Default**: `tiered-storage-first` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### managedLedgerDefaultAckQuorum +Ack quorum (Qa) size, Number of guaranteed copies (acks to wait for before a write is considered completed) + +**Type**: `int` + +**Default**: `2` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### managedLedgerDefaultEnsembleSize +Ensemble (E) size, Number of bookies to use for storing entries in a ledger. +Please notice that sticky reads enabled by bookkeeperEnableStickyReads=true aren’t used unless ensemble size (E) equals write quorum (Qw) size. + +**Type**: `int` + +**Default**: `2` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### managedLedgerDefaultMarkDeleteRateLimit +Rate limit the amount of writes per second generated by consumer acking the messages + +**Type**: `double` + +**Default**: `1.0` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### managedLedgerDefaultWriteQuorum +Write quorum (Qw) size, Replication factor for storing entries (messages) in a ledger. + +**Type**: `int` + +**Default**: `2` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### managedLedgerDigestType +Default type of checksum to use when writing to BookKeeper. + +Default is `CRC32C`. Other possible options are `CRC32`, `MAC` or `DUMMY` (no checksum). + +**Type**: `org.apache.bookkeeper.client.api.DigestType` + +**Default**: `CRC32C` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### managedLedgerForceRecovery +Skip managed ledger failure to forcefully recover managed ledger. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `true` + +**Category**: Storage (Managed Ledger) + +### managedLedgerInactiveLedgerRolloverTimeSeconds +Time to rollover ledger for inactive topic (duration without any publish on that topic). Disable rollover with value 0 (Default value 0) + +**Type**: `int` + +**Default**: `0` + +**Dynamic**: `true` + +**Category**: Storage (Managed Ledger) + +### managedLedgerInfoCompressionThresholdInBytes +ManagedLedgerInfo compression size threshold (bytes), only compress metadata when origin size more then this value. +0 means compression will always apply. + + +**Type**: `long` + +**Default**: `16384` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### managedLedgerInfoCompressionType +ManagedLedgerInfo compression type, option values (NONE, LZ4, ZLIB, ZSTD, SNAPPY). +If value is invalid or NONE, then save the ManagedLedgerInfo bytes data directly. + +**Type**: `java.lang.String` + +**Default**: `NONE` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### managedLedgerMaxAckQuorum +Max number of guaranteed copies (acks to wait before write is complete) + +**Type**: `int` + +**Default**: `5` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### managedLedgerMaxBacklogBetweenCursorsForCaching +Maximum backlog entry difference to prevent caching entries that can't be reused + +**Type**: `int` + +**Default**: `1000` + +**Dynamic**: `true` + +**Category**: Storage (Managed Ledger) + +### managedLedgerMaxEnsembleSize +Max number of bookies to use when creating a ledger + +**Type**: `int` + +**Default**: `5` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### managedLedgerMaxEntriesPerLedger +Max number of entries to append to a ledger before triggering a rollover. + +A ledger rollover is triggered after the min rollover time has passed and one of the following conditions is true: the max rollover time has been reached, the max entries have been written to the ledger, or the max ledger size has been written to the ledger + +**Type**: `int` + +**Default**: `50000` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### managedLedgerMaxLedgerRolloverTimeMinutes +Maximum time before forcing a ledger rollover for a topic + +**Type**: `int` + +**Default**: `240` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### managedLedgerMaxReadsInFlightSizeInMB +Maximum buffer size for bytes read from storage. This is the memory retained by data read from storage (or cache) until it has been delivered to the Consumer Netty channel. Use O to disable + +**Type**: `long` + +**Default**: `0` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### managedLedgerMaxSizePerLedgerMbytes +Maximum ledger size before triggering a rollover for a topic (MB) + +**Type**: `int` + +**Default**: `2048` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### managedLedgerMaxUnackedRangesToPersist +Max number of `acknowledgment holes` that are going to be persistently stored. + +When acknowledging out of order, a consumer will leave holes that are supposed to be quickly filled by acking all the messages. The information of which messages are acknowledged is persisted by compressing in `ranges` of messages that were acknowledged. After the max number of ranges is reached, the information will only be tracked in memory and messages will be redelivered in case of crashes. + +**Type**: `int` + +**Default**: `10000` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### managedLedgerMaxUnackedRangesToPersistInMetadataStore +Max number of `acknowledgment holes` that can be stored in MetadataStore. + +If number of unack message range is higher than this limit then broker will persist unacked ranges into bookkeeper to avoid additional data overhead into MetadataStore. + +**Type**: `int` + +**Default**: `1000` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### managedLedgerMaxWriteQuorum +Max number of copies to store for each message + +**Type**: `int` + +**Default**: `5` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### managedLedgerMetadataOperationsTimeoutSeconds +operation timeout while updating managed-ledger metadata. + +**Type**: `long` + +**Default**: `60` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### managedLedgerMinLedgerRolloverTimeMinutes +Minimum time between ledger rollover for a topic + +**Type**: `int` + +**Default**: `10` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### managedLedgerMinimumBacklogCursorsForCaching +Minimum cursors that must be in backlog state to cache and reuse the read entries.(Default =0 to disable backlog reach cache) + +**Type**: `int` + +**Default**: `0` + +**Dynamic**: `true` + +**Category**: Storage (Managed Ledger) + +### managedLedgerMinimumBacklogEntriesForCaching +Minimum backlog entries for any cursor before start caching reads + +**Type**: `int` + +**Default**: `1000` + +**Dynamic**: `true` + +**Category**: Storage (Managed Ledger) + +### managedLedgerNewEntriesCheckDelayInMillis +New entries check delay for the cursor under the managed ledger. +If no new messages in the topic, the cursor will try to check again after the delay time. +For consumption latency sensitive scenario, can set to a smaller value or set to 0. +Of course, this may degrade consumption throughput. Default is 10ms. + +**Type**: `int` + +**Default**: `10` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### managedLedgerNumSchedulerThreads +Number of threads to be used for managed ledger scheduled tasks + +**Type**: `int` + +**Default**: `14` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### managedLedgerPassword +Default password to use when writing to BookKeeper. + +Default is ``. + +**Type**: `java.lang.String` + +**Default**: `` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### managedLedgerPrometheusStatsLatencyRolloverSeconds +Managed ledger prometheus stats latency rollover seconds + +**Type**: `int` + +**Default**: `60` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### managedLedgerReadEntryTimeoutSeconds +Read entries timeout when broker tries to read messages from bookkeeper (0 to disable it) + +**Type**: `long` + +**Default**: `0` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### managedLedgerStatsPeriodSeconds +How frequently to refresh the stats. (seconds). Default is 60 seconds + +**Type**: `int` + +**Default**: `60` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### managedLedgerStorageClassName +The class of the managed ledger storage + +**Type**: `java.lang.String` + +**Default**: `org.apache.pulsar.broker.ManagedLedgerClientFactory` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### managedLedgerTraceTaskExecution +Whether trace managed ledger task execution time + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `true` + +**Category**: Storage (Managed Ledger) + +### persistentUnackedRangesWithMultipleEntriesEnabled +If enabled, the maximum "acknowledgment holes" will not be limited and "acknowledgment holes" are stored in multiple entries. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### schemaLedgerForceRecovery +Skip schema ledger failure to forcefully recover topic successfully. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `true` + +**Category**: Storage (Managed Ledger) + +### brokerClientSslFactoryPlugin +SSL Factory Plugin class used by internal client to provide SSLEngine and SSLContext objects. The default class used is DefaultSslFactory. + +**Type**: `java.lang.String` + +**Default**: `org.apache.pulsar.common.util.DefaultPulsarSslFactory` + +**Dynamic**: `false` + +**Category**: TLS + +### brokerClientSslFactoryPluginParams +SSL Factory plugin configuration parameters used by internal client. + +**Type**: `java.lang.String` + +**Default**: `` + +**Dynamic**: `false` + +**Category**: TLS + +### sslFactoryPlugin +SSL Factory Plugin class to provide SSLEngine and SSLContext objects. The default class used is DefaultSslFactory. + +**Type**: `java.lang.String` + +**Default**: `org.apache.pulsar.common.util.DefaultPulsarSslFactory` + +**Dynamic**: `false` + +**Category**: TLS + +### sslFactoryPluginParams +SSL Factory plugin configuration parameters. + +**Type**: `java.lang.String` + +**Default**: `` + +**Dynamic**: `false` + +**Category**: TLS + +### tlsAllowInsecureConnection +Accept untrusted TLS certificate from client + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: TLS + +### tlsCertRefreshCheckDurationSec +Tls cert refresh duration in seconds (set 0 to check on every new connection) + +**Type**: `long` + +**Default**: `300` + +**Dynamic**: `false` + +**Category**: TLS + +### tlsCertificateFilePath +Path for the TLS certificate file + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: TLS + +### tlsCiphers +Specify the tls cipher the broker will use to negotiate during TLS Handshake. + +Example:- [TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256] + +**Type**: `java.util.Set` + +**Default**: `[]` + +**Dynamic**: `false` + +**Category**: TLS + +### tlsEnabled +Enable TLS + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: TLS + +### tlsHostnameVerificationEnabled +Whether the hostname is validated when the broker creates a TLS connection with other brokers + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: TLS + +### tlsKeyFilePath +Path for the TLS private key file + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: TLS + +### tlsProtocols +Specify the tls protocols the broker will use to negotiate during TLS Handshake. + +Example:- [TLSv1.3, TLSv1.2] + +**Type**: `java.util.Set` + +**Default**: `[]` + +**Dynamic**: `false` + +**Category**: TLS + +### tlsRequireTrustedClientCertOnConnect +Specify whether Client certificates are required for TLS Reject. +the Connection if the Client Certificate is not trusted + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: TLS + +### tlsTrustCertsFilePath +Path for the trusted TLS certificate file + +**Type**: `java.lang.String` + +**Default**: `` + +**Dynamic**: `false` + +**Category**: TLS + +### webServiceTlsCiphers +Specify the tls cipher the proxy's web service will use to negotiate during TLS Handshake. + +Example:- [TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256] + +**Type**: `java.util.Set` + +**Default**: `[]` + +**Dynamic**: `false` + +**Category**: TLS + +### webServiceTlsProtocols +Specify the tls protocols the proxy's web service will use to negotiate during TLS Handshake. + +Example:- [TLSv1.3, TLSv1.2] + +**Type**: `java.util.Set` + +**Default**: `[]` + +**Dynamic**: `false` + +**Category**: TLS + +### maxActiveTransactionsPerCoordinator +The max active transactions per transaction coordinator, default value 0 indicates no limit. + +**Type**: `long` + +**Default**: `0` + +**Dynamic**: `false` + +**Category**: Transaction + +### numTransactionReplayThreadPoolSize +Number of threads to use for pulsar transaction replay PendingAckStore or TransactionBuffer.Default is 5 + +**Type**: `int` + +**Default**: `14` + +**Dynamic**: `false` + +**Category**: Transaction + +### transactionBufferClientMaxConcurrentRequests +The max concurrent requests for transaction buffer client. + +**Type**: `int` + +**Default**: `1000` + +**Dynamic**: `false` + +**Category**: Transaction + +### transactionBufferClientOperationTimeoutInMills +The transaction buffer client's operation timeout in milliseconds. + +**Type**: `long` + +**Default**: `3000` + +**Dynamic**: `false` + +**Category**: Transaction + +### transactionBufferProviderClassName +Class name for transaction buffer provider + +**Type**: `java.lang.String` + +**Default**: `org.apache.pulsar.broker.transaction.buffer.impl.TopicTransactionBufferProvider` + +**Dynamic**: `false` + +**Category**: Transaction + +### transactionBufferSegmentedSnapshotEnabled +Whether to enable segmented transaction buffer snapshot to handle a large number of aborted transactions. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Transaction + +### transactionBufferSnapshotMaxTransactionCount +Transaction buffer take snapshot transaction countIf transaction buffer enables snapshot segment, transaction buffer updates snapshot metadataafter the number of transaction operations reaches this value. + +**Type**: `int` + +**Default**: `1000` + +**Dynamic**: `false` + +**Category**: Transaction + +### transactionBufferSnapshotMinTimeInMillis +The interval time for transaction buffer to take snapshots.If transaction buffer enables snapshot segment, it is the interval time for transaction buffer to update snapshot metadata. + +**Type**: `int` + +**Default**: `5000` + +**Dynamic**: `false` + +**Category**: Transaction + +### transactionBufferSnapshotSegmentSize +Transaction buffer stores the transaction ID of aborted transactions and takes snapshots.This configuration determines the size of the snapshot segment. The default value is 256 KB (262144 bytes). + +**Type**: `int` + +**Default**: `262144` + +**Dynamic**: `false` + +**Category**: Transaction + +### transactionCoordinatorEnabled +Enable transaction coordinator in broker + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Transaction + +### transactionMetadataStoreProviderClassName +Class name for transaction metadata store provider + +**Type**: `java.lang.String` + +**Default**: `org.apache.pulsar.transaction.coordinator.impl.MLTransactionMetadataStoreProvider` + +**Dynamic**: `false` + +**Category**: Transaction + +### transactionPendingAckLogIndexMinLag +MLPendingAckStore maintain a ConcurrentSkipListMap pendingAckLogIndex`,it store the position in pendingAckStore as value and save a position used to determinewhether the previous data can be cleaned up as a key.transactionPendingAckLogIndexMinLag is used to configure the minimum lag between indexes + +**Type**: `long` + +**Default**: `500` + +**Dynamic**: `false` + +**Category**: Transaction + +### transactionPendingAckStoreProviderClassName +Class name for transaction pending ack store provider + +**Type**: `java.lang.String` + +**Default**: `org.apache.pulsar.broker.transaction.pendingack.impl.MLPendingAckStoreProvider` + +**Dynamic**: `false` + +**Category**: Transaction + +### isRunningStandalone +Flag indicates whether to run broker in standalone mode + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: WebSocket + +### webSocketConnectionsPerBroker +Number of connections per Broker in Pulsar Client used in WebSocket proxy + +**Type**: `int` + +**Default**: `14` + +**Dynamic**: `false` + +**Category**: WebSocket + +### webSocketMaxTextFrameSize +The maximum size of a text message during parsing in WebSocket proxy. + +**Type**: `int` + +**Default**: `1048576` + +**Dynamic**: `false` + +**Category**: WebSocket + +### webSocketNumIoThreads +Number of IO threads in Pulsar Client used in WebSocket proxy + +**Type**: `int` + +**Default**: `14` + +**Dynamic**: `false` + +**Category**: WebSocket + +### webSocketNumServiceThreads +Number of threads used by Websocket service + +**Type**: `int` + +**Default**: `20` + +**Dynamic**: `false` + +**Category**: WebSocket + +### webSocketPingDurationSeconds +Interval of time to sending the ping to keep alive in WebSocket proxy. This value greater than 0 means enabled + +**Type**: `int` + +**Default**: `-1` + +**Dynamic**: `false` + +**Category**: WebSocket + +### webSocketPulsarClientMemoryLimitInMB +Memory limit in MBs for direct memory in Pulsar Client used in WebSocket proxy + +**Type**: `int` + +**Default**: `0` + +**Dynamic**: `false` + +**Category**: WebSocket + +### webSocketServiceEnabled +Enable the WebSocket API service in broker + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: WebSocket + +### webSocketSessionIdleTimeoutMillis +Time in milliseconds that idle WebSocket session times out + +**Type**: `int` + +**Default**: `300000` + +**Dynamic**: `false` + +**Category**: WebSocket + +## Deprecated +### loadBalancerBrokerComfortLoadLevelPercentage +Usage threshold to determine a broker is having just right level of load (only used by SimpleLoadManagerImpl) + +**Type**: `int` + +**Default**: `65` + +**Dynamic**: `false` + +**Category**: Load Balancer + +### loadBalancerBrokerUnderloadedThresholdPercentage +Usage threshold to determine a broker as under-loaded (only used by SimpleLoadManagerImpl) + +**Type**: `int` + +**Default**: `50` + +**Dynamic**: `false` + +**Category**: Load Balancer + +### loadBalancerMemoryResourceWeight +Memory Resource Usage Weight. Deprecated: Memory is no longer used as a load balancing item. + +**Type**: `double` + +**Default**: `0.0` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerPlacementStrategy +load placement strategy[weightedRandomSelection/leastLoadedServer] (only used by SimpleLoadManagerImpl) + +**Type**: `java.lang.String` + +**Default**: `leastLoadedServer` + +**Dynamic**: `false` + +**Category**: Load Balancer + +### brokerServicePurgeInactiveFrequencyInSeconds +How often broker checks for inactive topics to be deleted (topics with no subscriptions and no one connected) Deprecated in favor of using `brokerDeleteInactiveTopicsFrequencySeconds` +@deprecated - unused. + +**Type**: `int` + +**Default**: `60` + +**Dynamic**: `false` + +**Category**: Policies + +### replicationTlsEnabled +@deprecated - Use brokerClientTlsEnabled instead. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Replication + +### configurationStoreServers +Configuration store connection string (as a comma-separated list). Deprecated in favor of `configurationMetadataStoreUrl` + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Server + +### globalZookeeperServers +Global Zookeeper quorum connection string (as a comma-separated list). Deprecated in favor of using `configurationStoreServers` + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Server + +### numWorkerThreadsForNonPersistentTopic +Number of worker threads to serve non-persistent topic. +@deprecated - use topicOrderedExecutorThreadNum instead. + +**Type**: `int` + +**Default**: `-1` + +**Dynamic**: `false` + +**Category**: Server + +### zooKeeperAllowReadOnlyOperations +Is zookeeper allow read-only operations. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Server + +### zooKeeperCacheExpirySeconds +ZooKeeper cache expiry time in seconds. @deprecated - Use metadataStoreCacheExpirySeconds instead. + +**Type**: `int` + +**Default**: `-1` + +**Dynamic**: `false` + +**Category**: Server + +### zooKeeperOperationTimeoutSeconds +ZooKeeper operation timeout in seconds. @deprecated - Use metadataStoreOperationTimeoutSeconds instead. + +**Type**: `int` + +**Default**: `-1` + +**Dynamic**: `false` + +**Category**: Server + +### zooKeeperSessionTimeoutMillis +ZooKeeper session timeout in milliseconds. @deprecated - Use metadataStoreSessionTimeoutMillis instead. + +**Type**: `long` + +**Default**: `-1` + +**Dynamic**: `false` + +**Category**: Server + +### zookeeperServers +The Zookeeper quorum connection string (as a comma-separated list). Deprecated in favour of metadataStoreUrl + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Server + +### managedLedgerMaxUnackedRangesToPersistInZooKeeper +Max number of `acknowledgment holes` that can be stored in Zookeeper. + +If number of unack message range is higher than this limit then broker will persist unacked ranges into bookkeeper to avoid additional data overhead into zookeeper. +@deprecated - use managedLedgerMaxUnackedRangesToPersistInMetadataStore. + +**Type**: `int` + +**Default**: `-1` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + + diff --git a/static/reference/4.0.x/config/reference-configuration-client.md b/static/reference/4.0.x/config/reference-configuration-client.md new file mode 100644 index 000000000000..8dc58d553f24 --- /dev/null +++ b/static/reference/4.0.x/config/reference-configuration-client.md @@ -0,0 +1,397 @@ +# Client + +## Required +### serviceUrl +Pulsar cluster HTTP URL to connect to a broker. + +**Type**: `java.lang.String` + +**Default**: `null` + +## Optional +### authParamMap +Authentication map of the client. + +**Type**: `java.util.Map` + +**Default**: `null` + +### authParams +Authentication parameter of the client. + +**Type**: `java.lang.String` + +**Default**: `null` + +### authPluginClassName +Class name of authentication plugin of the client. + +**Type**: `java.lang.String` + +**Default**: `null` + +### authentication +Authentication settings of the client. + +**Type**: `org.apache.pulsar.client.api.Authentication` + +**Default**: `null` + +### autoCertRefreshSeconds +Seconds of auto refreshing certificate. + +**Type**: `int` + +**Default**: `300` + +### concurrentLookupRequest +The number of concurrent lookup requests that can be sent on each broker connection. Setting a maximum prevents overloading a broker. + +**Type**: `int` + +**Default**: `5000` + +### connectionMaxIdleSeconds +Release the connection if it is not used for more than [connectionMaxIdleSeconds] seconds. If [connectionMaxIdleSeconds] < 0, disabled the feature that auto release the idle connections + +**Type**: `int` + +**Default**: `60` + +### connectionTimeoutMs +Duration of waiting for a connection to a broker to be established.If the duration passes without a response from a broker, the connection attempt is dropped. + +**Type**: `int` + +**Default**: `10000` + +### connectionsPerBroker +Number of connections established between the client and each Broker. A value of 0 means to disable connection pooling. + +**Type**: `int` + +**Default**: `1` + +### description +The extra description of the client version. The length cannot exceed 64. + +**Type**: `java.lang.String` + +**Default**: `null` + +### dnsLookupBindAddress +The Pulsar client dns lookup bind address, default behavior is bind on 0.0.0.0 + +**Type**: `java.lang.String` + +**Default**: `null` + +### dnsLookupBindPort +The Pulsar client dns lookup bind port, takes effect when dnsLookupBindAddress is configured, default value is 0. + +**Type**: `int` + +**Default**: `0` + +### dnsServerAddresses +The Pulsar client dns lookup server address + +**Type**: `java.util.List` + +**Default**: `[]` + +### enableBusyWait +Whether to enable BusyWait for EpollEventLoopGroup. + +**Type**: `boolean` + +**Default**: `false` + +### enableTransaction +Whether to enable transaction. + +**Type**: `boolean` + +**Default**: `false` + +### initialBackoffIntervalNanos +Initial backoff interval (in nanosecond). + +**Type**: `long` + +**Default**: `100000000` + +### keepAliveIntervalSeconds +Seconds of keeping alive interval for each client broker connection. + +**Type**: `int` + +**Default**: `30` + +### listenerName +Listener name for lookup. Clients can use listenerName to choose one of the listeners as the service URL to create a connection to the broker as long as the network is accessible."advertisedListeners" must enabled in broker side. + +**Type**: `java.lang.String` + +**Default**: `null` + +### lookupTimeoutMs +Client lookup timeout (in milliseconds). + +**Type**: `long` + +**Default**: `-1` + +### maxBackoffIntervalNanos +Max backoff interval (in nanosecond). + +**Type**: `long` + +**Default**: `60000000000` + +### maxLookupRedirects +Maximum times of redirected lookup requests. + +**Type**: `int` + +**Default**: `20` + +### maxLookupRequest +Maximum number of lookup requests allowed on each broker connection to prevent overloading a broker. + +**Type**: `int` + +**Default**: `50000` + +### maxNumberOfRejectedRequestPerConnection +Maximum number of rejected requests of a broker in a certain time frame (60 seconds) after the current connection is closed and the client creating a new connection to connect to a different broker. + +**Type**: `int` + +**Default**: `50` + +### memoryLimitBytes +Limit of client memory usage (in byte). The 64M default can guarantee a high producer throughput. + +**Type**: `long` + +**Default**: `67108864` + +### numIoThreads +Number of IO threads. + +**Type**: `int` + +**Default**: `14` + +### numListenerThreads +Number of consumer listener threads. + +**Type**: `int` + +**Default**: `14` + +### operationTimeoutMs +Client operation timeout (in milliseconds). + +**Type**: `long` + +**Default**: `30000` + +### proxyProtocol +Protocol of proxy service. proxyServiceUrl and proxyProtocol must be mutually inclusive. + +**Type**: `org.apache.pulsar.client.api.ProxyProtocol` + +**Default**: `null` + +### proxyServiceUrl +URL of proxy service. proxyServiceUrl and proxyProtocol must be mutually inclusive. + +**Type**: `java.lang.String` + +**Default**: `null` + +### readTimeoutMs +Maximum read time of a request. + +**Type**: `int` + +**Default**: `60000` + +### requestTimeoutMs +Maximum duration for completing a request. + +**Type**: `int` + +**Default**: `60000` + +### serviceUrlProvider +The implementation class of ServiceUrlProvider used to generate ServiceUrl. + +**Type**: `org.apache.pulsar.client.api.ServiceUrlProvider` + +**Default**: `null` + +### socks5ProxyAddress +Address of SOCKS5 proxy. + +**Type**: `java.net.InetSocketAddress` + +**Default**: `null` + +### socks5ProxyPassword +Password of SOCKS5 proxy. + +**Type**: `java.lang.String` + +**Default**: `null` + +### socks5ProxyUsername +User name of SOCKS5 proxy. + +**Type**: `java.lang.String` + +**Default**: `null` + +### sslFactoryPlugin +SSL Factory Plugin class to provide SSLEngine and SSLContext objects. The default class used is DefaultPulsarSslFactory. + +**Type**: `java.lang.String` + +**Default**: `org.apache.pulsar.common.util.DefaultPulsarSslFactory` + +### sslFactoryPluginParams +SSL Factory plugin configuration parameters. + +**Type**: `java.lang.String` + +**Default**: `` + +### sslProvider +The TLS provider used by an internal client to authenticate with other Pulsar brokers. + +**Type**: `java.lang.String` + +**Default**: `null` + +### statsIntervalSeconds +Interval to print client stats (in seconds). + +**Type**: `long` + +**Default**: `60` + +### tlsAllowInsecureConnection +Whether the client accepts untrusted TLS certificates from the broker. + +**Type**: `boolean` + +**Default**: `false` + +### tlsCertificateFilePath +Path to the TLS certificate file. + +**Type**: `java.lang.String` + +**Default**: `null` + +### tlsCiphers +Set of TLS Ciphers. + +**Type**: `java.util.Set` + +**Default**: `[]` + +### tlsHostnameVerificationEnable +Whether the hostname is validated when the client creates a TLS connection with brokers. + +**Type**: `boolean` + +**Default**: `false` + +### tlsKeyFilePath +Path to the TLS key file. + +**Type**: `java.lang.String` + +**Default**: `null` + +### tlsKeyStorePassword +Password of TLS KeyStore. + +**Type**: `java.lang.String` + +**Default**: `null` + +### tlsKeyStorePath +Path of TLS KeyStore. + +**Type**: `java.lang.String` + +**Default**: `null` + +### tlsKeyStoreType +TLS KeyStore type configuration. + +**Type**: `java.lang.String` + +**Default**: `JKS` + +### tlsProtocols +Protocols of TLS. + +**Type**: `java.util.Set` + +**Default**: `[]` + +### tlsTrustCertsFilePath +Path to the trusted TLS certificate file. + +**Type**: `java.lang.String` + +**Default**: `null` + +### tlsTrustStorePassword +Password of TLS TrustStore. + +**Type**: `java.lang.String` + +**Default**: `null` + +### tlsTrustStorePath +Path of TLS TrustStore. + +**Type**: `java.lang.String` + +**Default**: `null` + +### tlsTrustStoreType +TLS TrustStore type configuration. You need to set this configuration when client authentication is required. + +**Type**: `java.lang.String` + +**Default**: `JKS` + +### useKeyStoreTls +Set TLS using KeyStore way. + +**Type**: `boolean` + +**Default**: `false` + +### useTcpNoDelay +Whether to use TCP NoDelay option. + +**Type**: `boolean` + +**Default**: `true` + +### useTls +Whether to use TLS. + +**Type**: `boolean` + +**Default**: `false` + + diff --git a/static/reference/4.0.x/config/reference-configuration-log4j-shell.md b/static/reference/4.0.x/config/reference-configuration-log4j-shell.md new file mode 100644 index 000000000000..43fca015c0d2 --- /dev/null +++ b/static/reference/4.0.x/config/reference-configuration-log4j-shell.md @@ -0,0 +1,37 @@ +# Log4j shell + +### bookkeeper.root.logger + +**Default**: ERROR,CONSOLE + +### log4j.rootLogger + +**Default**: ${bookkeeper.root.logger} + +### log4j.appender.CONSOLE + +**Default**: org.apache.log4j.ConsoleAppender + +### log4j.appender.CONSOLE.Threshold + +**Default**: DEBUG + +### log4j.appender.CONSOLE.layout + +**Default**: org.apache.log4j.PatternLayout + +### log4j.appender.CONSOLE.layout.ConversionPattern + +**Default**: %d{ABSOLUTE} %-5p %m%n + +### log4j.logger.org.apache.zookeeper + +**Default**: ERROR + +### log4j.logger.org.apache.bookkeeper + +**Default**: ERROR + +### log4j.logger.org.apache.bookkeeper.bookie.BookieShell + +**Default**: INFO diff --git a/static/reference/4.0.x/config/reference-configuration-log4j.md b/static/reference/4.0.x/config/reference-configuration-log4j.md new file mode 100644 index 000000000000..6aa18e03a23b --- /dev/null +++ b/static/reference/4.0.x/config/reference-configuration-log4j.md @@ -0,0 +1,80 @@ +# Log4j + +You can set the log level and configuration in the [log4j2.yaml](https://github.com/apache/pulsar/blob/d557e0aa286866363bc6261dec87790c055db1b0/conf/log4j2.yaml#L155) file. The following logging configuration parameters are available. + +### pulsar.root.logger + +**Default**: WARN,CONSOLE + +### pulsar.log.dir + +**Default**: logs + +### pulsar.log.file + +**Default**: pulsar.log + +### log4j.rootLogger + +**Default**: ${pulsar.root.logger} + +### log4j.appender.CONSOLE + +**Default**: org.apache.log4j.ConsoleAppender + +### log4j.appender.CONSOLE.Threshold + +**Default**: DEBUG + +### log4j.appender.CONSOLE.layout + +**Default**: org.apache.log4j.PatternLayout + +### log4j.appender.CONSOLE.layout.ConversionPattern + +**Default**: %d{ISO8601} - %-5p - [%t:%C{1}@%L] - %m%n + +### log4j.appender.ROLLINGFILE + +**Default**: org.apache.log4j.DailyRollingFileAppender + +### log4j.appender.ROLLINGFILE.Threshold + +**Default**: DEBUG + +### log4j.appender.ROLLINGFILE.File + +**Default**: ${pulsar.log.dir}/${pulsar.log.file} + +### log4j.appender.ROLLINGFILE.layout + +**Default**: org.apache.log4j.PatternLayout + +### log4j.appender.ROLLINGFILE.layout.ConversionPattern + +**Default**: %d{ISO8601} - %-5p [%t:%C{1}@%L] - %m%n + +### log4j.appender.TRACEFILE + +**Default**: org.apache.log4j.FileAppender + +### log4j.appender.TRACEFILE.Threshold + +**Default**: TRACE + +### log4j.appender.TRACEFILE.File + +**Default**: pulsar-trace.log + +### log4j.appender.TRACEFILE.layout + +**Default**: org.apache.log4j.PatternLayout + +### log4j.appender.TRACEFILE.layout.ConversionPattern + +**Default**: %d{ISO8601} - %-5p [%t:%C{1}@%L][%x] - %m%n + +> Note: 'topic' in log4j2.appender is configurable. +> +> - If you want to append all logs to a single topic, set the same topic name. +> - If you want to append logs to different topics, you can set different topic names. diff --git a/static/reference/4.0.x/config/reference-configuration-pulsar-proxy.md b/static/reference/4.0.x/config/reference-configuration-pulsar-proxy.md new file mode 100644 index 000000000000..f0ffabfaaf1a --- /dev/null +++ b/static/reference/4.0.x/config/reference-configuration-pulsar-proxy.md @@ -0,0 +1,1371 @@ +# Pulsar proxy + +## Required +## Optional +### brokerClientAuthenticationParameters +The authentication parameters used by the Pulsar proxy to authenticate with Pulsar brokers + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Broker Client Authorization + +### brokerClientAuthenticationPlugin +The authentication plugin used by the Pulsar proxy to authenticate with Pulsar brokers + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Broker Client Authorization + +### brokerClientCertificateFilePath +The path to the TLS certificate used by the Pulsar proxy to authenticate with Pulsar brokers + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Broker Client Authorization + +### brokerClientKeyFilePath +The path to TLS private key used by the Pulsar proxy to authenticate with Pulsar brokers + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Broker Client Authorization + +### brokerClientTrustCertsFilePath +The path to trusted certificates used by the Pulsar proxy to authenticate with Pulsar brokers + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Broker Client Authorization + +### tlsEnabledWithBroker +Whether TLS is enabled when communicating with Pulsar brokers + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Broker Client Authorization + +### brokerServiceURL +If does not set metadataStoreUrl or configurationMetadataStoreUrl, this url should point to the discovery service provider. URL must have the pulsar:// prefix. And does not support multi url yet. + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Broker Discovery + +### brokerServiceURLTLS +If does not set metadataStoreUrl or configurationMetadataStoreUrl, this url should point to the discovery service provider. URL must have the pulsar+ssl:// prefix. And does not support multi url yet. + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Broker Discovery + +### brokerWebServiceURL +The web service url points to the discovery service provider of the broker cluster, and does not support multi url yet. + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Broker Discovery + +### brokerWebServiceURLTLS +The tls web service url points to the discovery service provider of the broker cluster, and does not support multi url yet. + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Broker Discovery + +### configurationMetadataStoreUrl +The metadata store URL for the configuration data. If empty, we fall back to use metadataStoreUrl + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Broker Discovery + +### functionWorkerWebServiceURL +The web service url points to the discovery service provider of the function worker cluster, and does not support multi url yet. Only configure it when you setup function workers in a separate cluster + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Broker Discovery + +### functionWorkerWebServiceURLTLS +The tls web service url points to the discovery service provider of the function worker cluster, and does not support multi url yet. Only configure it when you setup function workers in a separate cluster + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Broker Discovery + +### metadataStoreUrl +The metadata store URL. + Examples: + * zk:my-zk-1:2181,my-zk-2:2181,my-zk-3:2181 + * my-zk-1:2181,my-zk-2:2181,my-zk-3:2181 (will default to ZooKeeper when the schema is not specified) + * zk:my-zk-1:2181,my-zk-2:2181,my-zk-3:2181/my-chroot-path (to add a ZK chroot path) + + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Broker Discovery + +### brokerProxyAllowedHostNames +Allowed broker target host names. Supports multiple comma separated entries and a wildcard. + +**Type**: `java.lang.String` + +**Default**: `*` + +**Dynamic**: `false` + +**Category**: Broker Proxy + +### brokerProxyAllowedIPAddresses +Allowed broker target ip addresses or ip networks / netmasks. Supports multiple comma separated entries. + +**Type**: `java.lang.String` + +**Default**: `*` + +**Dynamic**: `false` + +**Category**: Broker Proxy + +### brokerProxyAllowedTargetPorts +Allowed broker target ports + +**Type**: `java.lang.String` + +**Default**: `6650,6651` + +**Dynamic**: `false` + +**Category**: Broker Proxy + +### brokerProxyConnectTimeoutMs +Broker proxy connect timeout. +The timeout value for Broker proxy connect timeout is in millisecond. Set to 0 to disable. + +**Type**: `int` + +**Default**: `10000` + +**Dynamic**: `false` + +**Category**: Broker Proxy + +### brokerProxyReadTimeoutMs +Broker proxy read timeout. +The timeout value for Broker proxy read timeout is in millisecond. Set to 0 to disable. + +**Type**: `int` + +**Default**: `75000` + +**Dynamic**: `false` + +**Category**: Broker Proxy + +### checkActiveBrokers +When enabled, checks that the target broker is active before connecting. zookeeperServers and configurationStoreServers must be configured in proxy configuration for retrieving the active brokers. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Broker Proxy + +### enableProxyStatsEndpoints +Whether to enable the proxy's /metrics and /proxy-stats http endpoints + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `false` + +**Category**: HTTP + +### httpInputMaxReplayBufferSize +Http input buffer max size. + +The maximum amount of data that will be buffered for incoming http requests so that the request body can be replayed when the backend broker issues a redirect response. + +**Type**: `int` + +**Default**: `5242880` + +**Dynamic**: `false` + +**Category**: HTTP + +### httpMaxRequestHeaderSize + The maximum size in bytes of the request header. + Larger headers will allow for more and/or larger cookies plus larger form content encoded in a URL. + However, larger headers consume more memory and can make a server more vulnerable to denial of service + attacks. + + +**Type**: `int` + +**Default**: `8192` + +**Dynamic**: `false` + +**Category**: HTTP + +### httpNumThreads +Number of threads to use for HTTP requests processing + +**Type**: `int` + +**Default**: `28` + +**Dynamic**: `false` + +**Category**: HTTP + +### httpOutputBufferSize +Http output buffer size. + +The amount of data that will be buffered for http requests before it is flushed to the channel. A larger buffer size may result in higher http throughput though it may take longer for the client to see data. If using HTTP streaming via the reverse proxy, this should be set to the minimum value, 1, so that clients see the data as soon as possible. + +**Type**: `int` + +**Default**: `32768` + +**Dynamic**: `false` + +**Category**: HTTP + +### httpProxyTimeout +Http proxy timeout. + +The timeout value for HTTP proxy is in millisecond. + +**Type**: `int` + +**Default**: `300000` + +**Dynamic**: `false` + +**Category**: HTTP + +### httpRequestsLimitEnabled +Enable the enforcement of limits on the incoming HTTP requests + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: HTTP + +### httpRequestsMaxPerSecond +Max HTTP requests per seconds allowed. The excess of requests will be rejected with HTTP code 429 (Too many requests) + +**Type**: `double` + +**Default**: `100.0` + +**Dynamic**: `false` + +**Category**: HTTP + +### httpReverseProxyConfigs +Http directs to redirect to non-pulsar services + +**Type**: `java.util.Set` + +**Default**: `[]` + +**Dynamic**: `false` + +**Category**: HTTP + +### metricsServletTimeoutMs +Time in milliseconds that metrics endpoint would time out. Default is 30s. + Set it to 0 to disable timeout. + +**Type**: `long` + +**Default**: `30000` + +**Dynamic**: `false` + +**Category**: HTTP + +### brokerClientSslProvider +The TLS Provider used by the Pulsar proxy to authenticate with Pulsar brokers + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: KeyStoreTLS + +### brokerClientTlsCiphers +Specify the tls cipher the proxy will use to negotiate during TLS Handshake (a comma-separated list of ciphers). + +Examples:- [TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256]. + used by the Pulsar proxy to authenticate with Pulsar brokers + +**Type**: `java.util.Set` + +**Default**: `[]` + +**Dynamic**: `false` + +**Category**: KeyStoreTLS + +### brokerClientTlsEnabledWithKeyStore +Whether the Pulsar proxy use KeyStore type to authenticate with Pulsar brokers + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: KeyStoreTLS + +### brokerClientTlsKeyStore +TLS KeyStore path for internal client, used by the Pulsar proxy to authenticate with Pulsar brokers + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: KeyStoreTLS + +### brokerClientTlsKeyStorePassword +TLS KeyStore password for proxy, used by the Pulsar proxy to authenticate with Pulsar brokers + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: KeyStoreTLS + +### brokerClientTlsKeyStoreType +TLS KeyStore type configuration for proxy: JKS, PKCS12 used by the Pulsar proxy to authenticate with Pulsar brokers + +**Type**: `java.lang.String` + +**Default**: `JKS` + +**Dynamic**: `false` + +**Category**: KeyStoreTLS + +### brokerClientTlsProtocols +Specify the tls protocols the broker will use to negotiate during TLS handshake (a comma-separated list of protocol names). + +Examples:- [TLSv1.3, TLSv1.2] + used by the Pulsar proxy to authenticate with Pulsar brokers + +**Type**: `java.util.Set` + +**Default**: `[]` + +**Dynamic**: `false` + +**Category**: KeyStoreTLS + +### brokerClientTlsTrustStore +TLS TrustStore path for proxy, used by the Pulsar proxy to authenticate with Pulsar brokers + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: KeyStoreTLS + +### brokerClientTlsTrustStorePassword +TLS TrustStore password for proxy, used by the Pulsar proxy to authenticate with Pulsar brokers + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: KeyStoreTLS + +### brokerClientTlsTrustStoreType +TLS TrustStore type configuration for proxy: JKS, PKCS12 used by the Pulsar proxy to authenticate with Pulsar brokers + +**Type**: `java.lang.String` + +**Default**: `JKS` + +**Dynamic**: `false` + +**Category**: KeyStoreTLS + +### tlsEnabledWithKeyStore +Enable TLS with KeyStore type configuration for proxy + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: KeyStoreTLS + +### tlsKeyStore +TLS KeyStore path for proxy + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: KeyStoreTLS + +### tlsKeyStorePassword +TLS KeyStore password for proxy + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: KeyStoreTLS + +### tlsKeyStoreType +TLS KeyStore type configuration for proxy: JKS, PKCS12 + +**Type**: `java.lang.String` + +**Default**: `JKS` + +**Dynamic**: `false` + +**Category**: KeyStoreTLS + +### tlsProvider +Specify the TLS provider for the broker service: +When using TLS authentication with CACert, the valid value is either OPENSSL or JDK. +When using TLS authentication with KeyStore, available values can be SunJSSE, Conscrypt and etc. + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: KeyStoreTLS + +### tlsTrustStore +TLS TrustStore path for proxy + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: KeyStoreTLS + +### tlsTrustStorePassword +TLS TrustStore password for proxy, null means empty password. + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: KeyStoreTLS + +### tlsTrustStoreType +TLS TrustStore type configuration for proxy: JKS, PKCS12 + +**Type**: `java.lang.String` + +**Default**: `JKS` + +**Dynamic**: `false` + +**Category**: KeyStoreTLS + +### webServiceTlsProvider +Specify the TLS provider for the web service, available values can be SunJSSE, Conscrypt and etc. + +**Type**: `java.lang.String` + +**Default**: `Conscrypt` + +**Dynamic**: `false` + +**Category**: KeyStoreTLS + +### authenticateMetricsEndpoint +Whether the '/metrics' endpoint requires authentication. Defaults to true.'authenticationEnabled' must also be set for this to take effect. + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `false` + +**Category**: Proxy Authentication + +### authenticationEnabled +Whether authentication is enabled for the Pulsar proxy + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Proxy Authentication + +### authenticationProviders +Authentication provider name list (a comma-separated list of class names + +**Type**: `java.util.Set` + +**Default**: `[]` + +**Dynamic**: `false` + +**Category**: Proxy Authentication + +### authenticationRefreshCheckSeconds +Interval of time for checking for expired authentication credentials. Disable by setting to 0. + +**Type**: `int` + +**Default**: `60` + +**Dynamic**: `false` + +**Category**: Proxy Authentication + +### anonymousUserRole +When this parameter is not empty, unauthenticated users perform as anonymousUserRole + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Proxy Authorization + +### authorizationEnabled +Whether authorization is enforced by the Pulsar proxy + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Proxy Authorization + +### authorizationProvider +Authorization provider as a fully qualified class name + +**Type**: `java.lang.String` + +**Default**: `org.apache.pulsar.broker.authorization.PulsarAuthorizationProvider` + +**Dynamic**: `false` + +**Category**: Proxy Authorization + +### forwardAuthorizationCredentials +Whether client authorization credentials are forwarded to the broker for re-authorization.Authentication must be enabled via configuring `authenticationEnabled` to be true for thisto take effect + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Proxy Authorization + +### superUserRoles +A list of role names (a comma-separated list of strings) that are treated as `super-user`, meaning they will be able to do all admin operations and publish & consume from all topics + +**Type**: `java.util.Set` + +**Default**: `[]` + +**Dynamic**: `false` + +**Category**: Proxy Authorization + +### maxConcurrentInboundConnections +Max concurrent inbound connections. The proxy will reject requests beyond that + +**Type**: `int` + +**Default**: `10000` + +**Dynamic**: `false` + +**Category**: RateLimiting + +### maxConcurrentInboundConnectionsPerIp +The maximum number of connections per IP. If it exceeds, new connections are rejected. + +**Type**: `int` + +**Default**: `0` + +**Dynamic**: `false` + +**Category**: RateLimiting + +### maxConcurrentLookupRequests +Max concurrent lookup requests. The proxy will reject requests beyond that + +**Type**: `int` + +**Default**: `50000` + +**Dynamic**: `false` + +**Category**: RateLimiting + +### kinitCommand +kerberos kinit command. + +**Type**: `java.lang.String` + +**Default**: `/usr/bin/kinit` + +**Dynamic**: `false` + +**Category**: SASL Authentication Provider + +### saslJaasClientAllowedIds +This is a regexp, which limits the range of possible ids which can connect to the Broker using SASL. + Default value is: ".*pulsar.*", so only clients whose id contains 'pulsar' are allowed to connect. + +**Type**: `java.lang.String` + +**Default**: `.*pulsar.*` + +**Dynamic**: `false` + +**Category**: SASL Authentication Provider + +### saslJaasServerRoleTokenSignerSecretPath +Path to file containing the secret to be used to SaslRoleTokenSigner +The secret can be specified like: +saslJaasServerRoleTokenSignerSecretPath=file:///my/saslRoleTokenSignerSecret.key. + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: SASL Authentication Provider + +### saslJaasServerSectionName +Service Principal, for login context name. Default value is "PulsarProxy". + +**Type**: `java.lang.String` + +**Default**: `PulsarProxy` + +**Dynamic**: `false` + +**Category**: SASL Authentication Provider + +### advertisedAddress +Hostname or IP address the service advertises to the outside world. If not set, the value of `InetAddress.getLocalHost().getCanonicalHostName()` is used. + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Server + +### bindAddress +Hostname or IP address the service binds on + +**Type**: `java.lang.String` + +**Default**: `0.0.0.0` + +**Dynamic**: `false` + +**Category**: Server + +### haProxyProtocolEnabled +Enable or disable the proxy protocol. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Server + +### httpServerAcceptQueueSize +Capacity for accept queue in the HTTP server Default is set to 8192. + +**Type**: `int` + +**Default**: `8192` + +**Dynamic**: `false` + +**Category**: Server + +### httpServerThreadPoolQueueSize +Capacity for thread pool queue in the HTTP server Default is set to 8192. + +**Type**: `int` + +**Default**: `8192` + +**Dynamic**: `false` + +**Category**: Server + +### maxConcurrentHttpRequests +Max concurrent web requests + +**Type**: `int` + +**Default**: `1024` + +**Dynamic**: `false` + +**Category**: Server + +### maxHttpServerConnections +Maximum number of inbound http connections. (0 to disable limiting) + +**Type**: `int` + +**Default**: `2048` + +**Dynamic**: `false` + +**Category**: Server + +### maxMessageSize +Max size of messages. + +**Type**: `int` + +**Default**: `5242880` + +**Dynamic**: `false` + +**Category**: Server + +### metadataStoreAllowReadOnlyOperations +Is metadata store read-only operations. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Server + +### metadataStoreCacheExpirySeconds +Metadata store cache expiry time in seconds. + +**Type**: `int` + +**Default**: `300` + +**Dynamic**: `false` + +**Category**: Server + +### metadataStoreSessionTimeoutMillis +Metadata store session timeout in milliseconds. + +**Type**: `int` + +**Default**: `30000` + +**Dynamic**: `false` + +**Category**: Server + +### narExtractionDirectory +The directory where nar Extraction happens + +**Type**: `java.lang.String` + +**Default**: `/var/folders/gt/xywq0qwd4cvdqfhy7t7js7b00000gn/T/` + +**Dynamic**: `false` + +**Category**: Server + +### numAcceptorThreads +Number of threads used for Netty Acceptor. Default is set to `1` + +**Type**: `int` + +**Default**: `1` + +**Dynamic**: `false` + +**Category**: Server + +### numIOThreads +Number of threads used for Netty IO. Default is set to `2 * Runtime.getRuntime().availableProcessors()` + +**Type**: `int` + +**Default**: `28` + +**Dynamic**: `false` + +**Category**: Server + +### proxyLogLevel +Proxy log level, default is 0. 0: Do not log any tcp channel info 1: Parse and log any tcp channel info and command info without message body 2: Parse and log channel info, command info and message body + +**Type**: `java.util.Optional` + +**Default**: `Optional[0]` + +**Dynamic**: `false` + +**Category**: Server + +### proxyZeroCopyModeEnabled +Enables zero-copy transport of data across network interfaces using the spice. Zero copy mode cannot be used when TLS is enabled or when proxyLogLevel is \> 0. + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `false` + +**Category**: Server + +### servicePort +The port for serving binary protobuf request + +**Type**: `java.util.Optional` + +**Default**: `Optional[6650]` + +**Dynamic**: `false` + +**Category**: Server + +### servicePortTls +The port for serving tls secured binary protobuf request + +**Type**: `java.util.Optional` + +**Default**: `Optional.empty` + +**Dynamic**: `false` + +**Category**: Server + +### statusFilePath +Path for the file used to determine the rotation status for the proxy instance when responding to service discovery health checks + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Server + +### webServiceHaProxyProtocolEnabled +Enable or disable the use of HA proxy protocol for resolving the client IP for http/https requests. Default is false. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Server + +### webServiceLogDetailedAddresses +Add detailed client/remote and server/local addresses and ports to http/https request logging. +Defaults to true when either webServiceHaProxyProtocolEnabled or webServiceTrustXForwardedFor is enabled. + +**Type**: `java.lang.Boolean` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Server + +### webServicePort +The port for serving http requests + +**Type**: `java.util.Optional` + +**Default**: `Optional[8080]` + +**Dynamic**: `false` + +**Category**: Server + +### webServicePortTls +The port for serving https requests + +**Type**: `java.util.Optional` + +**Default**: `Optional.empty` + +**Dynamic**: `false` + +**Category**: Server + +### webServiceTrustXForwardedFor +Trust X-Forwarded-For header for resolving the client IP for http/https requests. +Default is false. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Server + +### brokerClientSslFactoryPlugin +SSL Factory Plugin class used by internal client to provide SSLEngine and SSLContext objects. The default class used is DefaultSslFactory. + +**Type**: `java.lang.String` + +**Default**: `org.apache.pulsar.common.util.DefaultPulsarSslFactory` + +**Dynamic**: `false` + +**Category**: TLS + +### brokerClientSslFactoryPluginParams +SSL Factory plugin configuration parameters used by internal client. + +**Type**: `java.lang.String` + +**Default**: `` + +**Dynamic**: `false` + +**Category**: TLS + +### sslFactoryPlugin +SSL Factory Plugin class to provide SSLEngine and SSLContext objects. The default class used is DefaultSslFactory. + +**Type**: `java.lang.String` + +**Default**: `org.apache.pulsar.common.util.DefaultPulsarSslFactory` + +**Dynamic**: `false` + +**Category**: TLS + +### sslFactoryPluginParams +SSL Factory plugin configuration parameters. + +**Type**: `java.lang.String` + +**Default**: `` + +**Dynamic**: `false` + +**Category**: TLS + +### tlsAllowInsecureConnection +Accept untrusted TLS certificate from client. + +If true, a client with a cert which cannot be verified with the `tlsTrustCertsFilePath` cert will be allowed to connect to the server, though the cert will not be used for client authentication + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: TLS + +### tlsCertRefreshCheckDurationSec +Tls cert refresh duration in seconds (set 0 to check on every new connection) + +**Type**: `long` + +**Default**: `300` + +**Dynamic**: `false` + +**Category**: TLS + +### tlsCertificateFilePath +Path for the TLS certificate file + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: TLS + +### tlsCiphers +Specify the tls cipher the proxy will use to negotiate during TLS Handshake (a comma-separated list of ciphers). + +Examples:- [TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256] + +**Type**: `java.util.Set` + +**Default**: `[]` + +**Dynamic**: `false` + +**Category**: TLS + +### tlsHostnameVerificationEnabled +Whether the hostname is validated when the proxy creates a TLS connection with brokers + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: TLS + +### tlsKeyFilePath +Path for the TLS private key file + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: TLS + +### tlsProtocols +Specify the tls protocols the broker will use to negotiate during TLS handshake (a comma-separated list of protocol names). + +Examples:- [TLSv1.3, TLSv1.2] + +**Type**: `java.util.Set` + +**Default**: `[]` + +**Dynamic**: `false` + +**Category**: TLS + +### tlsRequireTrustedClientCertOnConnect +Whether client certificates are required for TLS. + + Connections are rejected if the client certificate isn't trusted + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: TLS + +### tlsTrustCertsFilePath +Path for the trusted TLS certificate file. + +This cert is used to verify that any certs presented by connecting clients are signed by a certificate authority. If this verification fails, then the certs are untrusted and the connections are dropped + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: TLS + +### webServiceTlsCiphers +Specify the tls cipher the proxy's web service will use to negotiate during TLS Handshake. + +Example:- [TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256] + +**Type**: `java.util.Set` + +**Default**: `[]` + +**Dynamic**: `false` + +**Category**: TLS + +### webServiceTlsProtocols +Specify the tls protocols the proxy's web service will use to negotiate during TLS Handshake. + +Example:- [TLSv1.3, TLSv1.2] + +**Type**: `java.util.Set` + +**Default**: `[]` + +**Dynamic**: `false` + +**Category**: TLS + +### clusterName +Name of the cluster to which this broker belongs to + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: WebSocket + +### webSocketPingDurationSeconds +Interval of time to sending the ping to keep alive in WebSocket proxy. This value greater than 0 means enabled + +**Type**: `int` + +**Default**: `-1` + +**Dynamic**: `false` + +**Category**: WebSocket + +### webSocketServiceEnabled +Enable or disable the WebSocket servlet + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: WebSocket + +### additionalServletDirectory +The directory to locate proxy additional servlet + +**Type**: `java.lang.String` + +**Default**: `./proxyAdditionalServlet` + +**Dynamic**: `false` + +**Category**: proxy plugin + +### additionalServlets +List of proxy additional servlet to load, which is a list of proxy additional servlet names + +**Type**: `java.util.Set` + +**Default**: `[]` + +**Dynamic**: `false` + +**Category**: proxy plugin + +### proxyAdditionalServletDirectory +The directory to locate proxy additional servlet + +**Type**: `java.lang.String` + +**Default**: `./proxyAdditionalServlet` + +**Dynamic**: `false` + +**Category**: proxy plugin + +### proxyAdditionalServlets +List of proxy additional servlet to load, which is a list of proxy additional servlet names + +**Type**: `java.util.Set` + +**Default**: `[]` + +**Dynamic**: `false` + +**Category**: proxy plugin + +### proxyExtensions +List of messaging protocols to load, which is a list of extension names + +**Type**: `java.util.Set` + +**Default**: `[]` + +**Dynamic**: `false` + +**Category**: proxy plugin + +### proxyExtensionsDirectory +The directory to locate proxy extensions + +**Type**: `java.lang.String` + +**Default**: `./proxyextensions` + +**Dynamic**: `false` + +**Category**: proxy plugin + +### useSeparateThreadPoolForProxyExtensions +Use a separate ThreadPool for each Proxy Extension + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `false` + +**Category**: proxy plugin + +## Deprecated +### configurationStoreServers +Configuration store connection string (as a comma-separated list). Deprecated in favor of `configurationMetadataStoreUrl` + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Broker Discovery + +### globalZookeeperServers +Global ZooKeeper quorum connection string (as a comma-separated list) + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Broker Discovery + +### zooKeeperCacheExpirySeconds +ZooKeeper cache expiry time in seconds. @deprecated - Use metadataStoreCacheExpirySeconds instead. + +**Type**: `int` + +**Default**: `-1` + +**Dynamic**: `false` + +**Category**: Broker Discovery + +### zookeeperServers +The ZooKeeper quorum connection string (as a comma-separated list) + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Broker Discovery + +### zookeeperSessionTimeoutMs +ZooKeeper session timeout in milliseconds. @deprecated - Use metadataStoreSessionTimeoutMillis instead. + +**Type**: `int` + +**Default**: `-1` + +**Dynamic**: `false` + +**Category**: Broker Discovery + +### zooKeeperAllowReadOnlyOperations +Is zooKeeper allow read-only operations. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Server + + diff --git a/static/reference/4.0.x/config/reference-configuration-standalone.md b/static/reference/4.0.x/config/reference-configuration-standalone.md new file mode 100644 index 000000000000..9fd5b499843d --- /dev/null +++ b/static/reference/4.0.x/config/reference-configuration-standalone.md @@ -0,0 +1,5999 @@ +# Broker + +## Required +### clusterName +Name of the cluster to which this broker belongs to + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Server + +## Optional +### topicFactoryClassName +Factory class-name to create topic with custom workflow + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `true` + +**Category**: + +### zookeeperSessionExpiredPolicy +There are two policies to apply when broker metadata session expires: session expired happens, "shutdown" or "reconnect". + + With "shutdown", the broker will be restarted. + + With "reconnect", the broker will keep serving the topics, while attempting to recreate a new session. + +**Type**: `org.apache.pulsar.broker.MetadataSessionExpiredPolicy` + +**Default**: `reconnect` + +**Dynamic**: `false` + +**Category**: + +### authenticationEnabled +Enable authentication + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Authentication + +### authenticationProviders +Authentication provider name list, which is a list of class names + +**Type**: `java.util.Set` + +**Default**: `[]` + +**Dynamic**: `false` + +**Category**: Authentication + +### authenticationRefreshCheckSeconds +Interval of time for checking for expired authentication credentials + +**Type**: `int` + +**Default**: `60` + +**Dynamic**: `false` + +**Category**: Authentication + +### brokerClientAuthenticationParameters +Authentication parameters of the authentication plugin the broker is using to connect to other brokers + +**Type**: `java.lang.String` + +**Default**: `` + +**Dynamic**: `true` + +**Category**: Authentication + +### brokerClientAuthenticationPlugin +Authentication settings of the broker itself. + +Used when the broker connects to other brokers, either in same or other clusters. Default uses plugin which disables authentication + +**Type**: `java.lang.String` + +**Default**: `org.apache.pulsar.client.impl.auth.AuthenticationDisabled` + +**Dynamic**: `true` + +**Category**: Authentication + +### brokerClientCertificateFilePath +TLS certificate file for internal client, used by the internal client to authenticate with Pulsar brokers + +**Type**: `java.lang.String` + +**Default**: `` + +**Dynamic**: `false` + +**Category**: Authentication + +### brokerClientKeyFilePath +TLS private key file for internal client, used by the internal client to authenticate with Pulsar brokers + +**Type**: `java.lang.String` + +**Default**: `` + +**Dynamic**: `false` + +**Category**: Authentication + +### brokerClientTrustCertsFilePath +TLS trusted certificate file for internal client, used by the internal client to authenticate with Pulsar brokers + +**Type**: `java.lang.String` + +**Default**: `` + +**Dynamic**: `false` + +**Category**: Authentication + +### anonymousUserRole +When this parameter is not empty, unauthenticated users perform as anonymousUserRole + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Authorization + +### authenticateOriginalAuthData +If this flag is set then the broker authenticates the original Auth data else it just accepts the originalPrincipal and authorizes it (if required) + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Authorization + +### authorizationAllowWildcardsMatching +Allow wildcard matching in authorization + +(wildcard matching only applicable if wildcard-char: * presents at first or last position eg: *.pulsar.service, pulsar.service.*) + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Authorization + +### authorizationEnabled +Enforce authorization + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Authorization + +### authorizationProvider +Authorization provider fully qualified class-name + +**Type**: `java.lang.String` + +**Default**: `org.apache.pulsar.broker.authorization.PulsarAuthorizationProvider` + +**Dynamic**: `false` + +**Category**: Authorization + +### proxyRoles +Role names that are treated as `proxy roles`. + +If the broker sees a request with role as proxyRoles - it will demand to see the original client role or certificate. + +**Type**: `java.util.Set` + +**Default**: `[]` + +**Dynamic**: `false` + +**Category**: Authorization + +### superUserRoles +Role names that are treated as `super-user`, meaning they will be able to do all admin operations and publish/consume from all topics + +**Type**: `java.util.Set` + +**Default**: `[]` + +**Dynamic**: `true` + +**Category**: Authorization + +### additionalServletDirectory +The directory to locate broker additional servlet + +**Type**: `java.lang.String` + +**Default**: `./brokerAdditionalServlet` + +**Dynamic**: `false` + +**Category**: Broker Plugin + +### additionalServlets +List of broker additional servlet to load, which is a list of broker additional servlet names + +**Type**: `java.util.Set` + +**Default**: `[]` + +**Dynamic**: `false` + +**Category**: Broker Plugin + +### functionsWorkerEnablePackageManagement +Flag indicates enabling or disabling function worker using unified PackageManagement service. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Functions + +### functionsWorkerEnabled +Flag indicates enabling or disabling function worker on brokers + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Functions + +### functionsWorkerServiceNarPackage +The nar package for the function worker service + +**Type**: `java.lang.String` + +**Default**: `` + +**Dynamic**: `false` + +**Category**: Functions + +### disableHttpDebugMethods +If true, the broker will reject all HTTP requests using the TRACE and TRACK verbs. + This setting may be necessary if the broker is deployed into an environment that uses http port + scanning and flags web servers allowing the TRACE method as insecure. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: HTTP + +### httpMaxRequestHeaderSize + The maximum size in bytes of the request header. + Larger headers will allow for more and/or larger cookies plus larger form content encoded in a URL. + However, larger headers consume more memory and can make a server more vulnerable to denial of service + attacks. + + +**Type**: `int` + +**Default**: `8192` + +**Dynamic**: `false` + +**Category**: HTTP + +### httpMaxRequestSize +If \>0, it will reject all HTTP requests with bodies larged than the configured limit + +**Type**: `long` + +**Default**: `-1` + +**Dynamic**: `false` + +**Category**: HTTP + +### httpRequestsFailOnUnknownPropertiesEnabled +Admin API fail on unknown request parameter in request-body. see PIP-179. Default false. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `true` + +**Category**: HTTP + +### httpRequestsLimitEnabled +Enable the enforcement of limits on the incoming HTTP requests + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: HTTP + +### httpRequestsMaxPerSecond +Max HTTP requests per seconds allowed. The excess of requests will be rejected with HTTP code 429 (Too many requests) + +**Type**: `double` + +**Default**: `100.0` + +**Dynamic**: `false` + +**Category**: HTTP + +### brokerClientSslProvider +The TLS Provider used by internal client to authenticate with other Pulsar brokers + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: KeyStoreTLS + +### brokerClientTlsCiphers +Specify the tls cipher the internal client will use to negotiate during TLS Handshake (a comma-separated list of ciphers). + +Examples:- [TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256]. + used by the internal client to authenticate with Pulsar brokers + +**Type**: `java.util.Set` + +**Default**: `[]` + +**Dynamic**: `false` + +**Category**: KeyStoreTLS + +### brokerClientTlsEnabledWithKeyStore +Whether internal client use KeyStore type to authenticate with other Pulsar brokers + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: KeyStoreTLS + +### brokerClientTlsKeyStore +TLS KeyStore path for internal client, used by the internal client to authenticate with Pulsar brokers + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: KeyStoreTLS + +### brokerClientTlsKeyStorePassword +TLS KeyStore password for internal client, used by the internal client to authenticate with Pulsar brokers + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: KeyStoreTLS + +### brokerClientTlsKeyStoreType +TLS KeyStore type configuration for internal client: JKS, PKCS12, used by the internal client to authenticate with Pulsar brokers + +**Type**: `java.lang.String` + +**Default**: `JKS` + +**Dynamic**: `false` + +**Category**: KeyStoreTLS + +### brokerClientTlsProtocols +Specify the tls protocols the broker will use to negotiate during TLS handshake (a comma-separated list of protocol names). + +Examples:- [TLSv1.3, TLSv1.2] + used by the internal client to authenticate with Pulsar brokers + +**Type**: `java.util.Set` + +**Default**: `[]` + +**Dynamic**: `false` + +**Category**: KeyStoreTLS + +### brokerClientTlsTrustStore +TLS TrustStore path for internal client, used by the internal client to authenticate with Pulsar brokers + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: KeyStoreTLS + +### brokerClientTlsTrustStorePassword +TLS TrustStore password for internal client, used by the internal client to authenticate with Pulsar brokers + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: KeyStoreTLS + +### brokerClientTlsTrustStoreType +TLS TrustStore type configuration for internal client: JKS, PKCS12 used by the internal client to authenticate with Pulsar brokers + +**Type**: `java.lang.String` + +**Default**: `JKS` + +**Dynamic**: `false` + +**Category**: KeyStoreTLS + +### tlsEnabledWithKeyStore +Enable TLS with KeyStore type configuration in broker + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: KeyStoreTLS + +### tlsKeyStore +TLS KeyStore path in broker + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: KeyStoreTLS + +### tlsKeyStorePassword +TLS KeyStore password for broker + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: KeyStoreTLS + +### tlsKeyStoreType +TLS KeyStore type configuration in broker: JKS, PKCS12 + +**Type**: `java.lang.String` + +**Default**: `JKS` + +**Dynamic**: `false` + +**Category**: KeyStoreTLS + +### tlsProvider +Specify the TLS provider for the broker service: +When using TLS authentication with CACert, the valid value is either OPENSSL or JDK. +When using TLS authentication with KeyStore, available values can be SunJSSE, Conscrypt and etc. + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: KeyStoreTLS + +### tlsTrustStore +TLS TrustStore path in broker + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: KeyStoreTLS + +### tlsTrustStorePassword +TLS TrustStore password for broker, null means empty password. + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: KeyStoreTLS + +### tlsTrustStoreType +TLS TrustStore type configuration in broker: JKS, PKCS12 + +**Type**: `java.lang.String` + +**Default**: `JKS` + +**Dynamic**: `false` + +**Category**: KeyStoreTLS + +### defaultNamespaceBundleSplitAlgorithm +Default algorithm name for namespace bundle split + +**Type**: `java.lang.String` + +**Default**: `range_equally_divide` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### flowOrQpsDifferenceThresholdPercentage +In FlowOrQpsEquallyDivideBundleSplitAlgorithm, if msgRate \>= loadBalancerNamespaceBundleMaxMsgRate * (100 + flowOrQpsDifferenceThresholdPercentage)/100.0 or throughput \>= loadBalancerNamespaceBundleMaxBandwidthMbytes * (100 + flowOrQpsDifferenceThresholdPercentage)/100.0, execute split bundle + +**Type**: `int` + +**Default**: `10` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalanceSheddingDelayInSeconds +Delay (in seconds) to the next unloading cycle after unloading. The logic tries to give enough time for brokers to recompute load after unloading. The bigger value will delay the next unloading cycle longer. (only used in load balancer extension TransferShedder) + +**Type**: `long` + +**Default**: `180` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerAutoBundleSplitEnabled +enable/disable automatic namespace bundle split + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerAutoUnloadSplitBundlesEnabled +enable/disable automatic unloading of split bundles + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerAverageResourceUsageDifferenceThresholdPercentage +Average resource usage difference threshold to determine a broker whether to be a best candidate in LeastResourceUsageWithWeight.(eg: broker1 with 10% resource usage with weight and broker2 with 30% and broker3 with 80% will have 40% average resource usage. The placement strategy can select broker1 and broker2 as best candidates.) + +**Type**: `int` + +**Default**: `10` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerAvgShedderHighThreshold +The high threshold for the difference between the highest and lowest loaded brokers. + +**Type**: `int` + +**Default**: `40` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerAvgShedderHitCountHighThreshold +The number of times the high threshold is triggered before the bundle is unloaded. + +**Type**: `int` + +**Default**: `2` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerAvgShedderHitCountLowThreshold +The number of times the low threshold is triggered before the bundle is unloaded. + +**Type**: `int` + +**Default**: `8` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerAvgShedderLowThreshold +The low threshold for the difference between the highest and lowest loaded brokers. + +**Type**: `int` + +**Default**: `15` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerBandwidthInResourceWeight +BandwidthIn Resource Usage Weight + +**Type**: `double` + +**Default**: `1.0` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerBandwidthOutResourceWeight +BandwidthOut Resource Usage Weight + +**Type**: `double` + +**Default**: `1.0` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerBandwithInResourceWeight +BandwidthIn Resource Usage Weight, Deprecated: Use loadBalancerBandwidthInResourceWeight + +**Type**: `double` + +**Default**: `1.0` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerBandwithOutResourceWeight +BandwidthOut Resource Usage Weight, Deprecated: Use loadBalancerBandwidthOutResourceWeight + +**Type**: `double` + +**Default**: `1.0` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerBrokerLoadDataTTLInSeconds +Broker load data time to live (TTL in seconds). The logic tries to avoid (possibly unavailable) brokers with out-dated load data, and those brokers will be ignored in the load computation. When tuning this value, please consider loadBalancerReportUpdateMaxIntervalMinutes. The current default value is loadBalancerReportUpdateMaxIntervalMinutes * 120, reflecting twice the duration in seconds. (only used in load balancer extension TransferShedder) + +**Type**: `long` + +**Default**: `1800` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerBrokerLoadTargetStd +The target standard deviation of the resource usage across brokers (100% resource usage is 1.0 load). The shedder logic tries to distribute bundle load across brokers to meet this target std. The smaller value will incur load balancing more frequently. (only used in load balancer extension TransferShedder) + +**Type**: `double` + +**Default**: `0.25` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerBrokerMaxTopics +Usage threshold to allocate max number of topics to broker + +**Type**: `int` + +**Default**: `50000` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerBrokerOverloadedThresholdPercentage +Usage threshold to determine a broker as over-loaded + +**Type**: `int` + +**Default**: `85` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerBrokerThresholdShedderPercentage +Usage threshold to determine a broker whether to start threshold shedder + +**Type**: `int` + +**Default**: `10` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerBundleUnloadMinThroughputThreshold +Bundle unload minimum throughput threshold (MB) + +**Type**: `double` + +**Default**: `10.0` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerCPUResourceWeight +CPU Resource Usage Weight + +**Type**: `double` + +**Default**: `1.0` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerDebugModeEnabled +Option to enable the debug mode for the load balancer logics. The debug mode prints more logs to provide more information such as load balance states and decisions. (only used in load balancer extension logics) + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerDirectMemoryResourceWeight +Direct Memory Resource Usage Weight. Direct memory usage cannot accurately reflect the machine's load, and it is not recommended to use it to score the machine's load. + +**Type**: `double` + +**Default**: `0.0` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerDistributeBundlesEvenlyEnabled +enable/disable distribute bundles evenly + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerEnabled +Enable load balancer + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `false` + +**Category**: Load Balancer + +### loadBalancerHistoryResourcePercentage +Resource history Usage Percentage When adding new resource usage info + +**Type**: `double` + +**Default**: `0.9` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerHostUsageCheckIntervalMinutes +Frequency of report to collect, in minutes + +**Type**: `int` + +**Default**: `1` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerInFlightServiceUnitStateWaitingTimeInMillis +Time to wait before fixing any stuck in-flight service unit states. The leader monitor fixes any in-flight service unit(bundle) states by reassigning the ownerships if stuck too long, longer than this period.(only used in load balancer extension logics) + +**Type**: `long` + +**Default**: `30000` + +**Dynamic**: `false` + +**Category**: Load Balancer + +### loadBalancerLoadPlacementStrategy +load balance placement strategy + +**Type**: `java.lang.String` + +**Default**: `org.apache.pulsar.broker.loadbalance.impl.LeastLongTermMessageRate` + +**Dynamic**: `false` + +**Category**: Load Balancer + +### loadBalancerLoadSheddingStrategy +load balance load shedding strategy (It requires broker restart if value is changed using dynamic config). Default is ThresholdShedder since 2.10.0 + +**Type**: `java.lang.String` + +**Default**: `org.apache.pulsar.broker.loadbalance.impl.ThresholdShedder` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerMaxNumberOfBrokerSheddingPerCycle +Maximum number of brokers to unload bundle load for each unloading cycle. The bigger value will incur more unloading/transfers for each unloading cycle. (only used in load balancer extension TransferShedder) + +**Type**: `int` + +**Default**: `3` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerMaxNumberOfBundlesInBundleLoadReport +Max number of bundles in bundle load report from each broker. The load balancer distributes bundles across brokers, based on topK bundle load data and other broker load data.The bigger value will increase the overhead of reporting many bundles in load data. Used for ExtensibleLoadManagerImpl and ModularLoadManagerImpl, default value is 10. User can disable the bundle filtering feature of ModularLoadManagerImpl by setting to -1.Enabling this feature can reduce the pressure on the zookeeper when doing load report.WARNING: too small value could result in a long load balance time. + +**Type**: `int` + +**Default**: `10` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerMaxNumberOfBundlesToSplitPerCycle +Max number of bundles to split to per cycle. (only used in load balancer extension logics) + +**Type**: `int` + +**Default**: `10` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerMsgRateDifferenceShedderThreshold +Message-rate percentage threshold between highest and least loaded brokers for uniform load shedding. (eg: broker1 with 50K msgRate and broker2 with 30K msgRate will have 66% msgRate difference and load balancer can unload bundles from broker-1 to broker-2) + +**Type**: `double` + +**Default**: `50.0` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerMsgThroughputMultiplierDifferenceShedderThreshold +Message-throughput threshold between highest and least loaded brokers for uniform load shedding. (eg: broker1 with 450MB msgRate and broker2 with 100MB msgRate will have 4.5 times msgThroughout difference and load balancer can unload bundles from broker-1 to broker-2) + +**Type**: `double` + +**Default**: `4.0` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerMultiPhaseBundleUnload +Enables the multi-phase unloading of bundles. Set to true, forwards destination broker information to consumers and producers during bundle unload, allowing them to quickly reconnect to the broker without performing an additional topic lookup. + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `false` + +**Category**: Load Balancer + +### loadBalancerNamespaceBundleMaxBandwidthMbytes +maximum bandwidth (in + out) in a bundle, otherwise bundle split will be triggered + +**Type**: `int` + +**Default**: `100` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerNamespaceBundleMaxMsgRate +maximum msgRate (in + out) in a bundle, otherwise bundle split will be triggered + +**Type**: `int` + +**Default**: `30000` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerNamespaceBundleMaxSessions +maximum sessions (producers + consumers) in a bundle, otherwise bundle split will be triggered(disable threshold check with value -1) + +**Type**: `int` + +**Default**: `1000` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerNamespaceBundleMaxTopics +maximum topics in a bundle, otherwise bundle split will be triggered + +**Type**: `int` + +**Default**: `1000` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerNamespaceBundleSplitConditionHitCountThreshold +Threshold to the consecutive count of fulfilled split conditions. If the split scheduler consecutively finds bundles that meet split conditions many times bigger than this threshold, the scheduler will trigger splits on the bundles (if the number of bundles is less than loadBalancerNamespaceMaximumBundles). (only used in load balancer extension logics) + +**Type**: `int` + +**Default**: `3` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerNamespaceMaximumBundles +maximum number of bundles in a namespace + +**Type**: `int` + +**Default**: `128` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerOverrideBrokerNicSpeedGbps +Option to override the auto-detected network interfaces max speed + +**Type**: `java.util.Optional` + +**Default**: `Optional.empty` + +**Dynamic**: `false` + +**Category**: Load Balancer + +### loadBalancerReportUpdateMaxIntervalMinutes +Min delay of load report to collect, in minutes + +**Type**: `int` + +**Default**: `15` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerReportUpdateMinIntervalMillis +maximum interval to update load report + +**Type**: `int` + +**Default**: `5000` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerReportUpdateThresholdPercentage +Percentage of change to trigger load report update + +**Type**: `int` + +**Default**: `10` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerResourceQuotaUpdateIntervalMinutes +Interval to flush dynamic resource quota to ZooKeeper + +**Type**: `int` + +**Default**: `15` + +**Dynamic**: `false` + +**Category**: Load Balancer + +### loadBalancerServiceUnitStateMonitorIntervalInSeconds +Interval between service unit state monitor checks. The service unit(bundle) state channel is periodically monitored by the leader broker at this interval to fix any orphan bundle ownerships, stuck in-flight states, and other cleanup jobs.`loadBalancerServiceUnitStateTombstoneDelayTimeInSeconds` * 1000 must be bigger than `loadBalancerInFlightServiceUnitStateWaitingTimeInMillis`.(only used in load balancer extension logics) + +**Type**: `long` + +**Default**: `60` + +**Dynamic**: `false` + +**Category**: Load Balancer + +### loadBalancerServiceUnitStateTombstoneDelayTimeInSeconds +After this delay, the service-unit state channel tombstones any service units (e.g., bundles) in semi-terminal states. For example, after splits, parent bundles will be `deleted`, and then after this delay, the parent bundles' state will be `tombstoned` in the service-unit state channel. Pulsar does not immediately remove such semi-terminal states to avoid unnecessary system confusion, as the bundles in the `tombstoned` state might temporarily look available to reassign. Rarely, one could lower this delay in order to aggressively clean the service-unit state channel when there are a large number of bundles. minimum value = 30 secs(only used in load balancer extension logics) + +**Type**: `long` + +**Default**: `3600` + +**Dynamic**: `false` + +**Category**: Load Balancer + +### loadBalancerServiceUnitTableViewSyncer +Specify ServiceUnitTableViewSyncer to sync service unit(bundle) states between metadata store and system topic table views during migration from one to the other. One could enable this syncer before migration and disable it after the migration finishes. It accepts `MetadataStoreToSystemTopicSyncer` or `SystemTopicToMetadataStoreSyncer` to enable it. It accepts `None` to disable it. + +**Type**: `org.apache.pulsar.broker.ServiceConfiguration.ServiceUnitTableViewSyncerType` + +**Default**: `None` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerSheddingBundlesWithPoliciesEnabled +Option to automatically unload namespace bundles with affinity(isolation) or anti-affinity group policies.Such bundles are not ideal targets to auto-unload as destination brokers are limited.(only used in load balancer extension logics) + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerSheddingConditionHitCountThreshold +Threshold to the consecutive count of fulfilled shedding(unload) conditions. If the unload scheduler consecutively finds bundles that meet unload conditions many times bigger than this threshold, the scheduler will shed the bundles. The bigger value will incur less bundle unloading/transfers. (only used in load balancer extension TransferShedder) + +**Type**: `int` + +**Default**: `3` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerSheddingEnabled +Enable/disable automatic bundle unloading for load-shedding + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerSheddingGracePeriodMinutes +Prevent the same topics to be shed and moved to other broker more than once within this timeframe + +**Type**: `long` + +**Default**: `30` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerSheddingIntervalMinutes +Load shedding interval. + +Broker periodically checks whether some traffic should be offload from some over-loaded broker to other under-loaded brokers + +**Type**: `int` + +**Default**: `1` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerSplitIntervalMinutes +Service units'(bundles) split interval. Broker periodically checks whether some service units(e.g. bundles) should split if they become hot-spots. (only used in load balancer extension logics) + +**Type**: `int` + +**Default**: `1` + +**Dynamic**: `false` + +**Category**: Load Balancer + +### loadBalancerTransferEnabled +Option to enable the bundle transfer mode when distributing bundle loads. On: transfer bundles from overloaded brokers to underloaded -- pre-assigns the destination broker upon unloading). Off: unload bundles from overloaded brokers -- post-assigns the destination broker upon lookups). (only used in load balancer extension TransferShedder) + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadManagerClassName +Name of load manager to use + +**Type**: `java.lang.String` + +**Default**: `org.apache.pulsar.broker.loadbalance.impl.ModularLoadManagerImpl` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadManagerServiceUnitStateTableViewClassName +Name of ServiceUnitStateTableView implementation class to use + +**Type**: `java.lang.String` + +**Default**: `org.apache.pulsar.broker.loadbalance.extensions.channel.ServiceUnitStateTableViewImpl` + +**Dynamic**: `false` + +**Category**: Load Balancer + +### lowerBoundarySheddingEnabled +When [current usage < average usage - threshold], the broker with the highest load will be triggered to unload + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Load Balancer + +### maxUnloadBundleNumPerShedding +For each uniform balanced unload, the maximum number of bundles that can be unloaded. The default value is -1, which means no limit + +**Type**: `int` + +**Default**: `-1` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### maxUnloadPercentage +In the UniformLoadShedder and AvgShedder strategy, the maximum unload ratio.For AvgShedder, recommend to set to 0.5, so that it will distribute the load evenly between the highest and lowest brokers. + +**Type**: `double` + +**Default**: `0.2` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### minUnloadMessage +In the UniformLoadShedder and AvgShedder strategy, the minimum message that triggers unload. + +**Type**: `int` + +**Default**: `1000` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### minUnloadMessageThroughput +In the UniformLoadShedder and AvgShedder strategy, the minimum throughput that triggers unload. + +**Type**: `int` + +**Default**: `1048576` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### namespaceBundleUnloadingTimeoutMs +Time to wait for the unloading of a namespace bundle + +**Type**: `long` + +**Default**: `60000` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### supportedNamespaceBundleSplitAlgorithms +Supported algorithms name for namespace bundle split + +**Type**: `java.util.List` + +**Default**: `[range_equally_divide, topic_count_equally_divide, specified_positions_divide, flow_or_qps_equally_divide]` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### topicBundleAssignmentStrategy +Name of topic bundle assignment strategy to use + +**Type**: `java.lang.String` + +**Default**: `org.apache.pulsar.common.naming.ConsistentHashingTopicBundleAssigner` + +**Dynamic**: `false` + +**Category**: Load Balancer + +### aggregatePublisherStatsByProducerName +If true, aggregate publisher stats of PartitionedTopicStats by producerName + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Metrics + +### authenticateMetricsEndpoint +Whether the '/metrics' endpoint requires authentication. Defaults to false.'authenticationEnabled' must also be set for this to take effect. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Metrics + +### exposeBundlesMetricsInPrometheus +Enable expose the broker bundles metrics. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `true` + +**Category**: Metrics + +### exposeConsumerLevelMetricsInPrometheus +If true, export consumer level metrics otherwise namespace level + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Metrics + +### exposeManagedCursorMetricsInPrometheus +If true, export managed cursor metrics + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Metrics + +### exposeManagedLedgerMetricsInPrometheus +If true, export managed ledger metrics (aggregated by namespace) + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `false` + +**Category**: Metrics + +### exposePreciseBacklogInPrometheus +Enable expose the precise backlog stats. + Set false to use published counter and consumed counter to calculate, + this would be more efficient but may be inaccurate. Default is false. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Metrics + +### exposeProducerLevelMetricsInPrometheus +If true, export producer level metrics otherwise namespace level + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Metrics + +### exposePublisherStats +If true, export publisher stats when returning topics stats from the admin rest api + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `false` + +**Category**: Metrics + +### exposeSubscriptionBacklogSizeInPrometheus +Enable expose the backlog size for each subscription when generating stats. + Locking is used for fetching the status so default to false. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Metrics + +### exposeTopicLevelMetricsInPrometheus +If true, export topic level metrics otherwise namespace level + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `false` + +**Category**: Metrics + +### healthCheckMetricsUpdateTimeInSeconds +HealthCheck update frequency in seconds. Disable health check with value -1 (Default value -1) + +**Type**: `int` + +**Default**: `-1` + +**Dynamic**: `false` + +**Category**: Metrics + +### jvmGCMetricsLoggerClassName +Classname of Pluggable JVM GC metrics logger that can log GC specific metrics + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Metrics + +### metricsBufferResponse +Set to true to enable the broker to cache the metrics response; the default is false. The caching period is defined by `managedLedgerStatsPeriodSeconds`. The broker returns the same response for subsequent requests within the same period. Ensure that the scrape interval of your monitoring system matches the caching period. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Metrics + +### metricsServletTimeoutMs +Time in milliseconds that metrics endpoint would time out. Default is 30s. + Increase it if there are a lot of topics to expose topic-level metrics. + Set it to 0 to disable timeout. + +**Type**: `long` + +**Default**: `30000` + +**Dynamic**: `false` + +**Category**: Metrics + +### splitTopicAndPartitionLabelInPrometheus +Enable splitting topic and partition label in Prometheus. + If enabled, a topic name will split into 2 parts, one is topic name without partition index, + another one is partition index, e.g. (topic=xxx, partition=0). + If the topic is a non-partitioned topic, -1 will be used for the partition index. + If disabled, one label to represent the topic and partition, e.g. (topic=xxx-partition-0) + Default is false. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Metrics + +### statsUpdateFrequencyInSecs +Stats update frequency in seconds + +**Type**: `int` + +**Default**: `60` + +**Dynamic**: `false` + +**Category**: Metrics + +### statsUpdateInitialDelayInSecs +Stats update initial delay in seconds + +**Type**: `int` + +**Default**: `60` + +**Dynamic**: `false` + +**Category**: Metrics + +### enablePackagesManagement +Enable the packages management service or not + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Packages Management + +### packagesManagementLedgerRootPath +The bookkeeper ledger root path + +**Type**: `java.lang.String` + +**Default**: `/ledgers` + +**Dynamic**: `false` + +**Category**: Packages Management + +### packagesManagementStorageProvider +The packages management service storage service provider + +**Type**: `java.lang.String` + +**Default**: `org.apache.pulsar.packages.management.storage.bookkeeper.BookKeeperPackagesStorageProvider` + +**Dynamic**: `false` + +**Category**: Packages Management + +### packagesReplicas +When the packages storage provider is bookkeeper, you can use this configuration to +control the number of replicas for storing the package + +**Type**: `int` + +**Default**: `1` + +**Dynamic**: `false` + +**Category**: Packages Management + +### activeConsumerFailoverDelayTimeMillis +How long to delay rewinding cursor and dispatching messages when active consumer is changed + +**Type**: `int` + +**Default**: `1000` + +**Dynamic**: `false` + +**Category**: Policies + +### additionalSystemCursorNames +Additional system subscriptions that will be ignored by ttl check. The cursor names are comma separated. Default is empty. + +**Type**: `java.util.Set` + +**Default**: `[]` + +**Dynamic**: `false` + +**Category**: Policies + +### backlogQuotaCheckEnabled +Enable backlog quota check. Enforces actions on topic when the quota is reached + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `false` + +**Category**: Policies + +### backlogQuotaCheckIntervalInSeconds +How often to check for topics that have reached the quota. It only takes effects when `backlogQuotaCheckEnabled` is true + +**Type**: `int` + +**Default**: `60` + +**Dynamic**: `false` + +**Category**: Policies + +### backlogQuotaDefaultLimitBytes +Default per-topic backlog quota limit by size, less than 0 means no limitation. default is -1. Increase it if you want to allow larger msg backlog + +**Type**: `long` + +**Default**: `-1` + +**Dynamic**: `false` + +**Category**: Policies + +### backlogQuotaDefaultLimitGB +@deprecated - Use backlogQuotaDefaultLimitByte instead. + +**Type**: `double` + +**Default**: `-1.0` + +**Dynamic**: `false` + +**Category**: Policies + +### backlogQuotaDefaultLimitSecond +Default per-topic backlog quota limit by time in second, less than 0 means no limitation. default is -1. Increase it if you want to allow larger msg backlog + +**Type**: `int` + +**Default**: `-1` + +**Dynamic**: `false` + +**Category**: Policies + +### backlogQuotaDefaultRetentionPolicy +Default backlog quota retention policy. Default is producer_request_hold + +'producer_request_hold' Policy which holds producer's send request until theresource becomes available (or holding times out) +'producer_exception' Policy which throws javax.jms.ResourceAllocationException to the producer +'consumer_backlog_eviction' Policy which evicts the oldest message from the slowest consumer's backlog + +**Type**: `org.apache.pulsar.common.policies.data.BacklogQuota.RetentionPolicy` + +**Default**: `producer_request_hold` + +**Dynamic**: `false` + +**Category**: Policies + +### brokerDeduplicationEnabled +Set the default behavior for message deduplication in the broker. + +This can be overridden per-namespace. If enabled, broker will reject messages that were already stored in the topic + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Policies + +### brokerDeduplicationEntriesInterval +Number of entries after which a dedup info snapshot is taken. + +A bigger interval will lead to less snapshots being taken though it would increase the topic recovery time, when the entries published after the snapshot need to be replayed + +**Type**: `int` + +**Default**: `1000` + +**Dynamic**: `false` + +**Category**: Policies + +### brokerDeduplicationMaxNumberOfProducers +Maximum number of producer information that it's going to be persisted for deduplication purposes + +**Type**: `int` + +**Default**: `10000` + +**Dynamic**: `false` + +**Category**: Policies + +### brokerDeduplicationProducerInactivityTimeoutMinutes +Time of inactivity after which the broker will discard the deduplication information relative to a disconnected producer. Default is 6 hours. + +**Type**: `int` + +**Default**: `360` + +**Dynamic**: `false` + +**Category**: Policies + +### brokerDeduplicationSnapshotFrequencyInSeconds +How often is the thread pool scheduled to check whether a snapshot needs to be taken.(disable with value 0) + +**Type**: `int` + +**Default**: `120` + +**Dynamic**: `false` + +**Category**: Policies + +### brokerDeduplicationSnapshotIntervalSeconds +If this time interval is exceeded, a snapshot will be taken.It will run simultaneously with `brokerDeduplicationEntriesInterval` + +**Type**: `java.lang.Integer` + +**Default**: `120` + +**Dynamic**: `false` + +**Category**: Policies + +### brokerDeleteInactivePartitionedTopicMetadataEnabled +Metadata of inactive partitioned topic will not be automatically cleaned up by default. +Note: If `allowAutoTopicCreation` and this option are enabled at the same time, +it may appear that a partitioned topic has just been deleted but is automatically created as a non-partitioned topic. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `true` + +**Category**: Policies + +### brokerDeleteInactiveTopicsEnabled +Enable the deletion of inactive topics. +If only enable this option, will not clean the metadata of partitioned topic. + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `true` + +**Category**: Policies + +### brokerDeleteInactiveTopicsFrequencySeconds +How often to check for inactive topics + +**Type**: `int` + +**Default**: `60` + +**Dynamic**: `true` + +**Category**: Policies + +### brokerDeleteInactiveTopicsMaxInactiveDurationSeconds +Max duration of topic inactivity in seconds, default is not present +If not present, 'brokerDeleteInactiveTopicsFrequencySeconds' will be used +Topics that are inactive for longer than this value will be deleted + +**Type**: `java.lang.Integer` + +**Default**: `null` + +**Dynamic**: `true` + +**Category**: Policies + +### brokerDeleteInactiveTopicsMode +Set the inactive topic delete mode. Default is delete_when_no_subscriptions +'delete_when_no_subscriptions' mode only delete the topic which has no subscriptions and no active producers +'delete_when_subscriptions_caught_up' mode only delete the topic that all subscriptions has no backlogs(caught up) and no active producers/consumers + +**Type**: `org.apache.pulsar.common.policies.data.InactiveTopicDeleteMode` + +**Default**: `delete_when_no_subscriptions` + +**Dynamic**: `true` + +**Category**: Policies + +### brokerMaxConnections +The maximum number of connections in the broker. If it exceeds, new connections are rejected. + +**Type**: `int` + +**Default**: `0` + +**Dynamic**: `false` + +**Category**: Policies + +### brokerMaxConnectionsPerIp +The maximum number of connections per IP. If it exceeds, new connections are rejected. + +**Type**: `int` + +**Default**: `0` + +**Dynamic**: `false` + +**Category**: Policies + +### defaultNumberOfNamespaceBundles +When a namespace is created without specifying the number of bundle, this value will be used as the default + +**Type**: `int` + +**Default**: `4` + +**Dynamic**: `true` + +**Category**: Policies + +### defaultRetentionSizeInMB +Default retention size. 0 means retention is disabled. -1 means data is not removed by size quota + +**Type**: `int` + +**Default**: `0` + +**Dynamic**: `false` + +**Category**: Policies + +### defaultRetentionTimeInMinutes +Default message retention time. 0 means retention is disabled. -1 means data is not removed by time quota + +**Type**: `int` + +**Default**: `0` + +**Dynamic**: `false` + +**Category**: Policies + +### dispatchThrottlingOnBatchMessageEnabled +Apply dispatch rate limiting on batch message instead individual messages with in batch message. (Default is disabled) + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `true` + +**Category**: Policies + +### dispatchThrottlingOnNonBacklogConsumerEnabled +Default dispatch-throttling is disabled for consumers which already caught-up with published messages and don't have backlog. This enables dispatch-throttling for non-backlog consumers as well. + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `true` + +**Category**: Policies + +### dispatchThrottlingRatePerReplicatorInByte +Default number of message-bytes dispatching throttling-limit for every replicator in replication. + +Using a value of 0, is disabling replication message-byte dispatch-throttling + +**Type**: `long` + +**Default**: `0` + +**Dynamic**: `true` + +**Category**: Policies + +### dispatchThrottlingRatePerReplicatorInMsg +Default number of message dispatching throttling-limit for every replicator in replication. + +Using a value of 0, is disabling replication message dispatch-throttling + +**Type**: `int` + +**Default**: `0` + +**Dynamic**: `true` + +**Category**: Policies + +### dispatchThrottlingRatePerSubscriptionInByte +Default number of message-bytes dispatching throttling-limit for a subscription. + +Using a value of 0, is disabling default message-byte dispatch-throttling. + +**Type**: `long` + +**Default**: `0` + +**Dynamic**: `true` + +**Category**: Policies + +### dispatchThrottlingRatePerSubscriptionInMsg +Default number of message dispatching throttling-limit for a subscription. + +Using a value of 0, is disabling default message dispatch-throttling. + +**Type**: `int` + +**Default**: `0` + +**Dynamic**: `true` + +**Category**: Policies + +### dispatchThrottlingRatePerTopicInByte +Default number of message-bytes dispatching throttling-limit for every topic. + +Using a value of 0, is disabling default message-byte dispatch-throttling + +**Type**: `long` + +**Default**: `0` + +**Dynamic**: `true` + +**Category**: Policies + +### dispatchThrottlingRatePerTopicInMsg +Default number of message dispatching throttling-limit for every topic. + +Using a value of 0, is disabling default message dispatch-throttling + +**Type**: `int` + +**Default**: `0` + +**Dynamic**: `true` + +**Category**: Policies + +### dispatchThrottlingRateRelativeToPublishRate +Dispatch rate-limiting relative to publish rate. (Enabling flag will make broker to dynamically update dispatch-rate relatively to publish-rate: throttle-dispatch-rate = (publish-rate + configured dispatch-rate) + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `true` + +**Category**: Policies + +### dispatcherRetryBackoffInitialTimeInMs +On Shared and KeyShared subscriptions, if all available messages in the subscription are filtered out and not dispatched to any consumer, message dispatching will be rescheduled with a backoff delay. This parameter sets the initial backoff delay in milliseconds. + +**Type**: `int` + +**Default**: `1` + +**Dynamic**: `false` + +**Category**: Policies + +### dispatcherRetryBackoffMaxTimeInMs +On Shared and KeyShared subscriptions, if all available messages in the subscription are filtered out and not dispatched to any consumer, message dispatching will be rescheduled with a backoff delay. This parameter sets the maximum backoff delay in milliseconds. + +**Type**: `int` + +**Default**: `10` + +**Dynamic**: `false` + +**Category**: Policies + +### enableBrokerSideSubscriptionPatternEvaluation +Enables evaluating subscription pattern on broker side. + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `false` + +**Category**: Policies + +### forceDeleteNamespaceAllowed +Allow forced deletion of namespaces. Default is false. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `true` + +**Category**: Policies + +### forceDeleteTenantAllowed +Allow forced deletion of tenants. Default is false. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `true` + +**Category**: Policies + +### isAllowAutoUpdateSchemaEnabled +Allow schema to be auto updated at broker level. User can override this by 'is_allow_auto_update_schema' of namespace policy. This is enabled by default. + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `true` + +**Category**: Policies + +### keySharedLookAheadMsgInReplayThresholdPerConsumer +For Key_Shared subscriptions, if messages cannot be dispatched to consumers due to a slow consumer or a blocked key hash (because of ordering constraints), the broker will continue reading more messages from the backlog and attempt to dispatch them to consumers until the number of replay messages reaches the calculated threshold. +Formula: threshold = min(keySharedLookAheadMsgInReplayThresholdPerConsumer * connected consumer count, keySharedLookAheadMsgInReplayThresholdPerSubscription). +Setting this value to 0 will disable the limit calculated per consumer. + +**Type**: `int` + +**Default**: `2000` + +**Dynamic**: `true` + +**Category**: Policies + +### keySharedLookAheadMsgInReplayThresholdPerSubscription +For Key_Shared subscriptions, if messages cannot be dispatched to consumers due to a slow consumer or a blocked key hash (because of ordering constraints), the broker will continue reading more messages from the backlog and attempt to dispatch them to consumers until the number of replay messages reaches the calculated threshold. +Formula: threshold = min(keySharedLookAheadMsgInReplayThresholdPerConsumer * connected consumer count, keySharedLookAheadMsgInReplayThresholdPerSubscription). +This value should be set to a value less than 2 * managedLedgerMaxUnackedRangesToPersist. +Setting this value to 0 will disable the limit calculated per subscription. + + +**Type**: `int` + +**Default**: `20000` + +**Dynamic**: `true` + +**Category**: Policies + +### keySharedUnblockingIntervalMs +For Key_Shared subscriptions, when a blocked key hash gets unblocked, a redelivery will be attempted after a delay. This setting controls the delay. The reason to have the delay is to batch multiple unblocking events instead of triggering redelivery for each unblocking event. + +**Type**: `long` + +**Default**: `10` + +**Dynamic**: `true` + +**Category**: Policies + +### maxConsumerMetadataSize +Maximum size of Consumer metadata + +**Type**: `int` + +**Default**: `1024` + +**Dynamic**: `false` + +**Category**: Policies + +### maxNamespacesPerTenant +The maximum number of namespaces that each tenant can create.This configuration is not precise control, in a concurrent scenario, the threshold will be exceeded + +**Type**: `int` + +**Default**: `0` + +**Dynamic**: `true` + +**Category**: Policies + +### maxPendingPublishRequestsPerConnection +Max pending publish requests per connection to avoid keeping large number of pending requests in memory. Default: 1000 + +**Type**: `int` + +**Default**: `1000` + +**Dynamic**: `false` + +**Category**: Policies + +### maxSecondsToClearTopicNameCache +A Specifies the minimum number of seconds that the topic name stays in memory, to avoid clear cache frequently when there are too many topics are in use. + +**Type**: `int` + +**Default**: `7200` + +**Dynamic**: `false` + +**Category**: Policies + +### maxTopicsPerNamespace +Max number of topics allowed to be created in the namespace. When the topics reach the max topics of the namespace, the broker should reject the new topic request(include topic auto-created by the producer or consumer) until the number of connected consumers decrease. Using a value of 0, is disabling maxTopicsPerNamespace-limit check. + +**Type**: `int` + +**Default**: `0` + +**Dynamic**: `true` + +**Category**: Policies + +### maxUnackedMessagesPerBroker +Max number of unacknowledged messages allowed per broker. + + Once this limit reaches, broker will stop dispatching messages to all shared subscription which has higher number of unack messages until subscriptions start acknowledging messages back and unack count reaches to `limit/2`. Using a value of 0, is disabling unackedMessage-limit check and broker doesn't block dispatchers + +**Type**: `int` + +**Default**: `0` + +**Dynamic**: `false` + +**Category**: Policies + +### maxUnackedMessagesPerConsumer +Max number of unacknowledged messages allowed to receive messages by a consumer on a shared subscription. + + Broker will stop sending messages to consumer once, this limit reaches until consumer starts acknowledging messages back and unack count reaches to `maxUnackedMessagesPerConsumer/2`. Using a value of 0, it is disabling unackedMessage-limit check and consumer can receive messages without any restriction + +**Type**: `int` + +**Default**: `50000` + +**Dynamic**: `false` + +**Category**: Policies + +### maxUnackedMessagesPerSubscription +Max number of unacknowledged messages allowed per shared subscription. + + Broker will stop dispatching messages to all consumers of the subscription once this limit reaches until consumer starts acknowledging messages back and unack count reaches to `limit/2`. Using a value of 0, is disabling unackedMessage-limit check and dispatcher can dispatch messages without any restriction + +**Type**: `int` + +**Default**: `200000` + +**Dynamic**: `false` + +**Category**: Policies + +### maxUnackedMessagesPerSubscriptionOnBrokerBlocked +Once broker reaches maxUnackedMessagesPerBroker limit, it blocks subscriptions which has higher unacked messages than this percentage limit and subscription will not receive any new messages until that subscription acks back `limit/2` messages + +**Type**: `double` + +**Default**: `0.16` + +**Dynamic**: `false` + +**Category**: Policies + +### messageExpiryCheckIntervalInMinutes +How frequently to proactively check and purge expired messages + +**Type**: `int` + +**Default**: `5` + +**Dynamic**: `false` + +**Category**: Policies + +### preciseTimeBasedBacklogQuotaCheck +Whether to enable precise time based backlog quota check. Enabling precise time based backlog quota check will cause broker to read first entry in backlog of the slowest cursor on a ledger which will mostly result in reading entry from BookKeeper's disk which can have negative impact on overall performance. Disabling precise time based backlog quota check will just use the timestamp indicating when a ledger was closed, which is of coarser granularity. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Policies + +### resourceUsageTransportClassName +Default policy for publishing usage reports to system topic is disabled.This enables publishing of usage reports + +**Type**: `java.lang.String` + +**Default**: `` + +**Dynamic**: `false` + +**Category**: Policies + +### resourceUsageTransportPublishIntervalInSecs +Default interval to publish usage reports if resourceUsagePublishToTopic is enabled. + +**Type**: `int` + +**Default**: `60` + +**Dynamic**: `true` + +**Category**: Policies + +### subscribeRatePeriodPerConsumerInSecond +Rate period for {subscribeThrottlingRatePerConsumer}. Default is 30s. + +**Type**: `int` + +**Default**: `30` + +**Dynamic**: `true` + +**Category**: Policies + +### subscribeThrottlingRatePerConsumer +Too many subscribe requests from a consumer can cause broker rewinding consumer cursors and loading data from bookies, hence causing high network bandwidth usage When the positive value is set, broker will throttle the subscribe requests for one consumer. Otherwise, the throttling will be disabled. The default value of this setting is 0 - throttling is disabled. + +**Type**: `int` + +**Default**: `0` + +**Dynamic**: `true` + +**Category**: Policies + +### subscriptionBacklogScanMaxEntries +Maximum number of entries to process while scanning a subscription to calculate the accurate backlog + +**Type**: `long` + +**Default**: `10000` + +**Dynamic**: `false` + +**Category**: Policies + +### subscriptionBacklogScanMaxTimeMs +Maximum time to spend while scanning a subscription to calculate the accurate backlog + +**Type**: `long` + +**Default**: `120000` + +**Dynamic**: `false` + +**Category**: Policies + +### subscriptionExpirationTimeMinutes +How long to delete inactive subscriptions from last consuming. When it is 0, inactive subscriptions are not deleted automatically + +**Type**: `int` + +**Default**: `0` + +**Dynamic**: `false` + +**Category**: Policies + +### subscriptionExpiryCheckIntervalInMinutes +How frequently to proactively check and purge expired subscription + +**Type**: `int` + +**Default**: `5` + +**Dynamic**: `false` + +**Category**: Policies + +### subscriptionKeySharedConsistentHashingReplicaPoints +On KeyShared subscriptions, number of points in the consistent-hashing ring. The higher the number, the more equal the assignment of keys to consumers + +**Type**: `int` + +**Default**: `100` + +**Dynamic**: `false` + +**Category**: Policies + +### subscriptionKeySharedEnable +Enable Key_Shared subscription (default is enabled). +@deprecated - use subscriptionTypesEnabled instead. + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `true` + +**Category**: Policies + +### subscriptionKeySharedUseClassicPersistentImplementation +For persistent Key_Shared subscriptions, enables the use of the classic implementation of the Key_Shared subscription that was used before Pulsar 4.0.0 and PIP-379. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `true` + +**Category**: Policies + +### subscriptionKeySharedUseConsistentHashing +On KeyShared subscriptions, with default AUTO_SPLIT mode, use splitting ranges or consistent hashing to reassign keys to new consumers (default is consistent hashing) + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `false` + +**Category**: Policies + +### subscriptionPatternMaxLength +Max length of subscription pattern + +**Type**: `int` + +**Default**: `50` + +**Dynamic**: `false` + +**Category**: Policies + +### subscriptionRedeliveryTrackerEnabled +Enable subscription message redelivery tracker to send redelivery count to consumer (default is enabled) + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `true` + +**Category**: Policies + +### subscriptionSharedUseClassicPersistentImplementation +For persistent Shared subscriptions, enables the use of the classic implementation of the Shared subscription that was used before Pulsar 4.0.0. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `true` + +**Category**: Policies + +### subscriptionTypesEnabled +Enable subscription types (default is all type enabled) + +**Type**: `java.util.Set` + +**Default**: `[Failover, Shared, Key_Shared, Exclusive]` + +**Dynamic**: `true` + +**Category**: Policies + +### topicNameCacheMaxCapacity +Max capacity of the topic name cache. -1 means unlimited cache; 0 means broker will clear all cache per maxSecondsToClearTopicNameCache, it does not mean broker will not cache TopicName. + +**Type**: `int` + +**Default**: `100000` + +**Dynamic**: `true` + +**Category**: Policies + +### topicPublisherThrottlingTickTimeMillis +Tick time to schedule task that checks topic publish rate limiting across all topics Reducing to lower value can give more accuracy while throttling publish but it uses more CPU to perform frequent check. (Disable publish throttling with value 0) + +**Type**: `int` + +**Default**: `10` + +**Dynamic**: `true` + +**Category**: Policies + +### ttlDurationDefaultInSeconds +Default ttl for namespaces if ttl is not already configured at namespace policies. (disable default-ttl with value 0) + +**Type**: `int` + +**Default**: `0` + +**Dynamic**: `false` + +**Category**: Policies + +### unblockStuckSubscriptionEnabled +Broker periodically checks if subscription is stuck and unblock if flag is enabled. (Default is disabled) + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `true` + +**Category**: Policies + +### messagingProtocols +List of messaging protocols to load, which is a list of protocol names + +**Type**: `java.util.Set` + +**Default**: `[]` + +**Dynamic**: `false` + +**Category**: Protocols + +### protocolHandlerDirectory +The directory to locate messaging protocol handlers + +**Type**: `java.lang.String` + +**Default**: `./protocols` + +**Dynamic**: `false` + +**Category**: Protocols + +### useSeparateThreadPoolForProtocolHandlers +Use a separate ThreadPool for each Protocol Handler + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `false` + +**Category**: Protocols + +### brokerClientTlsEnabled +Enable TLS when talking with other brokers in the same cluster (admin operation) or different clusters (replication) + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `true` + +**Category**: Replication + +### createTopicToRemoteClusterForReplication +Whether the internal replicator will trigger topic auto-creation on the remote cluster. + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `false` + +**Category**: Replication + +### replicationConnectionsPerBroker +Max number of connections to open for each broker in a remote cluster. + +More connections host-to-host lead to better throughput over high-latency links + +**Type**: `int` + +**Default**: `16` + +**Dynamic**: `false` + +**Category**: Replication + +### replicationMetricsEnabled +Enable replication metrics + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `false` + +**Category**: Replication + +### replicationPolicyCheckDurationSeconds +Duration to check replication policy to avoid replicator inconsistency due to missing ZooKeeper watch (disable with value 0) + +**Type**: `int` + +**Default**: `600` + +**Dynamic**: `false` + +**Category**: Replication + +### replicationProducerQueueSize +Replicator producer queue size. When dynamically modified, it only takes effect for the newly added replicators + +**Type**: `int` + +**Default**: `1000` + +**Dynamic**: `true` + +**Category**: Replication + +### replicatorPrefix +replicator prefix used for replicator producer name and cursor name + +**Type**: `java.lang.String` + +**Default**: `pulsar.repl` + +**Dynamic**: `false` + +**Category**: Replication + +### inflightSaslContextExpiryMs +how often the broker expires the inflight SASL context. + +**Type**: `long` + +**Default**: `30000` + +**Dynamic**: `false` + +**Category**: SASL Authentication Provider + +### kinitCommand +kerberos kinit command. + +**Type**: `java.lang.String` + +**Default**: `/usr/bin/kinit` + +**Dynamic**: `false` + +**Category**: SASL Authentication Provider + +### maxInflightSaslContext +Maximum number of inflight sasl context. + +**Type**: `long` + +**Default**: `50000` + +**Dynamic**: `false` + +**Category**: SASL Authentication Provider + +### saslJaasClientAllowedIds +This is a regexp, which limits the range of possible ids which can connect to the Broker using SASL. + Default value is: ".*pulsar.*", so only clients whose id contains 'pulsar' are allowed to connect. + +**Type**: `java.lang.String` + +**Default**: `.*pulsar.*` + +**Dynamic**: `false` + +**Category**: SASL Authentication Provider + +### saslJaasServerRoleTokenSignerSecretPath +Path to file containing the secret to be used to SaslRoleTokenSigner +The secret can be specified like: +saslJaasServerRoleTokenSignerSecretPath=file:///my/saslRoleTokenSignerSecret.key. + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: SASL Authentication Provider + +### saslJaasServerSectionName +Service Principal, for login context name. Default value is "PulsarBroker". + +**Type**: `java.lang.String` + +**Default**: `PulsarBroker` + +**Dynamic**: `false` + +**Category**: SASL Authentication Provider + +### isSchemaValidationEnforced +Enforce schema validation on following cases: + + - if a producer without a schema attempts to produce to a topic with schema, the producer will be + failed to connect. PLEASE be carefully on using this, since non-java clients don't support schema. + if you enable this setting, it will cause non-java clients failed to produce. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Schema + +### schemaCompatibilityStrategy +The schema compatibility strategy in broker level + +**Type**: `org.apache.pulsar.common.policies.data.SchemaCompatibilityStrategy` + +**Default**: `FULL` + +**Dynamic**: `false` + +**Category**: Schema + +### schemaRegistryCompatibilityCheckers +The list compatibility checkers to be used in schema registry + +**Type**: `java.util.Set` + +**Default**: `[org.apache.pulsar.broker.service.schema.ProtobufNativeSchemaCompatibilityCheck, org.apache.pulsar.broker.service.schema.JsonSchemaCompatibilityCheck, org.apache.pulsar.broker.service.schema.AvroSchemaCompatibilityCheck]` + +**Dynamic**: `false` + +**Category**: Schema + +### schemaRegistryStorageClassName +The schema storage implementation used by this broker + +**Type**: `java.lang.String` + +**Default**: `org.apache.pulsar.broker.service.schema.BookkeeperSchemaStorageFactory` + +**Dynamic**: `false` + +**Category**: Schema + +### systemTopicSchemaCompatibilityStrategy +The schema compatibility strategy to use for system topics + +**Type**: `org.apache.pulsar.common.policies.data.SchemaCompatibilityStrategy` + +**Default**: `ALWAYS_COMPATIBLE` + +**Dynamic**: `false` + +**Category**: Schema + +### acknowledgmentAtBatchIndexLevelEnabled +Whether to enable the acknowledge of batch local index + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Server + +### advertisedAddress +Hostname or IP address the service advertises to the outside world. If not set, the value of `InetAddress.getLocalHost().getCanonicalHostName()` is used. + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Server + +### advertisedListeners +Used to specify multiple advertised listeners for the broker. The value must format as :pulsar://:,multiple listeners should separate with commas.Do not use this configuration with advertisedAddress and brokerServicePort.The Default value is absent means use advertisedAddress and brokerServicePort. + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Server + +### allowOverrideEntryFilters +Whether allow topic level entry filters policies overrides broker configuration. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `true` + +**Category**: Server + +### autoShrinkForConsumerPendingAcksMap +Whether to enable the automatic shrink of pendingAcks map, the default is false, which means it is not enabled. When there are a large number of share or key share consumers in the cluster, it can be enabled to reduce the memory consumption caused by pendingAcks. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Server + +### bindAddress +Hostname or IP address the service binds on + +**Type**: `java.lang.String` + +**Default**: `0.0.0.0` + +**Dynamic**: `false` + +**Category**: Server + +### bindAddresses +Used to specify additional bind addresses for the broker. The value must format as :://:, multiple bind addresses should be separated with commas. Associates each bind address with an advertised listener and protocol handler. Note that the brokerServicePort, brokerServicePortTls, webServicePort, and webServicePortTls properties define additional bindings. + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Server + +### bootstrapNamespaces +A comma-separated list of namespaces to bootstrap + +**Type**: `java.util.List` + +**Default**: `[]` + +**Dynamic**: `false` + +**Category**: Server + +### brokerEntryMetadataInterceptors +List of interceptors for entry metadata. + +**Type**: `java.util.Set` + +**Default**: `[]` + +**Dynamic**: `false` + +**Category**: Server + +### brokerEntryPayloadProcessors +List of interceptors for payload processing. + +**Type**: `java.util.Set` + +**Default**: `[]` + +**Dynamic**: `false` + +**Category**: Server + +### brokerInterceptors +List of broker interceptor to load, which is a list of broker interceptor names + +**Type**: `java.util.Set` + +**Default**: `[]` + +**Dynamic**: `false` + +**Category**: Server + +### brokerInterceptorsDirectory +The directory to locate broker interceptors + +**Type**: `java.lang.String` + +**Default**: `./interceptors` + +**Dynamic**: `false` + +**Category**: Server + +### brokerPublisherThrottlingMaxByteRate +Max Rate(in 1 seconds) of Byte allowed to publish for a broker when broker publish rate limiting enabled. (Disable byte rate limit with value 0) + +**Type**: `long` + +**Default**: `0` + +**Dynamic**: `true` + +**Category**: Server + +### brokerPublisherThrottlingMaxMessageRate +Max Rate(in 1 seconds) of Message allowed to publish for a broker when broker publish rate limiting enabled. (Disable message rate limit with value 0) + +**Type**: `int` + +**Default**: `0` + +**Dynamic**: `true` + +**Category**: Server + +### brokerPublisherThrottlingTickTimeMillis +Tick time to schedule task that checks broker publish rate limiting across all topics Reducing to lower value can give more accuracy while throttling publish but it uses more CPU to perform frequent check. (Disable publish throttling with value 0) + +**Type**: `int` + +**Default**: `50` + +**Dynamic**: `true` + +**Category**: Server + +### brokerServiceCompactionMonitorIntervalInSeconds +Interval between checks to see if topics with compaction policies need to be compacted + +**Type**: `int` + +**Default**: `60` + +**Dynamic**: `false` + +**Category**: Server + +### brokerServiceCompactionPhaseOneLoopTimeInSeconds +Timeout for each read request in the compaction phase one loop, If the execution time of one single message read operation exceeds this time, the compaction will not proceed. + +**Type**: `long` + +**Default**: `30` + +**Dynamic**: `false` + +**Category**: Server + +### brokerServiceCompactionThresholdInBytes +The estimated backlog size is greater than this threshold, compression will be triggered. +Using a value of 0, is disabling compression check. + +**Type**: `long` + +**Default**: `0` + +**Dynamic**: `false` + +**Category**: Server + +### brokerServicePort +The port for serving binary protobuf requests. If set, defines a server binding for bindAddress:brokerServicePort. The Default value is 6650. + +**Type**: `java.util.Optional` + +**Default**: `Optional[6650]` + +**Dynamic**: `false` + +**Category**: Server + +### brokerServicePortTls +The port for serving TLS-secured binary protobuf requests. If set, defines a server binding for bindAddress:brokerServicePortTls. + +**Type**: `java.util.Optional` + +**Default**: `Optional.empty` + +**Dynamic**: `false` + +**Category**: Server + +### brokerShutdownTimeoutMs +Time to wait for broker graceful shutdown. After this time elapses, the process will be killed + +**Type**: `long` + +**Default**: `60000` + +**Dynamic**: `true` + +**Category**: Server + +### clientLibraryVersionCheckEnabled +Enable check for minimum allowed client library version + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `true` + +**Category**: Server + +### clusterMigrationAutoResourceCreation +Flag to start cluster migration for topic only after creating all topic's resources such as tenant, namespaces, subscriptions at new green cluster. (Default disabled). + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Server + +### clusterMigrationCheckDurationSeconds +Interval between checks to see if cluster is migrated and marks topic migrated if cluster is marked migrated. Disable with value 0. (Default disabled). + +**Type**: `int` + +**Default**: `0` + +**Dynamic**: `false` + +**Category**: Server + +### compactionServiceFactoryClassName +The class name of the factory that implements the topic compaction service. + +**Type**: `java.lang.String` + +**Default**: `org.apache.pulsar.compaction.PulsarCompactionServiceFactory` + +**Dynamic**: `false` + +**Category**: Server + +### configurationMetadataStoreUrl +The metadata store URL for the configuration data. If empty, we fall back to use metadataStoreUrl + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Server + +### configurationMetadataSyncEventTopic +Event topic to sync configuration-metadata between separate pulsar clusters on different cloud platforms. + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `true` + +**Category**: Server + +### configurationStoreConfigPath +Configuration file path for configuration metadata store. + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Server + +### connectionLivenessCheckTimeoutMillis +Timeout for connection liveness check used to check liveness of possible consumer or producer duplicates. Helps prevent ProducerFencedException with exclusive producer, ConsumerAssignException with range conflict for Key Shared with sticky hash ranges or ConsumerBusyException in the case of an exclusive consumer. Set to 0 to disable connection liveness check. + +**Type**: `long` + +**Default**: `5000` + +**Dynamic**: `false` + +**Category**: Server + +### delayedDeliveryEnabled +Whether to enable the delayed delivery for messages. + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `false` + +**Category**: Server + +### delayedDeliveryFixedDelayDetectionLookahead +Size of the lookahead window to use when detecting if all the messages in the topic have a fixed delay for InMemoryDelayedDeliveryTracker (the default DelayedDeliverTracker). Default is 50,000. Setting the lookahead window to 0 will disable the logic to handle fixed delays in messages in a different way. + +**Type**: `long` + +**Default**: `50000` + +**Dynamic**: `false` + +**Category**: Server + +### delayedDeliveryMaxDelayInMillis +The max allowed delay for delayed delivery (in milliseconds). If the broker receives a message which exceeds this max delay, then it will return an error to the producer. The default value is 0 which means there is no limit on the max delivery delay. + +**Type**: `long` + +**Default**: `0` + +**Dynamic**: `false` + +**Category**: Server + +### delayedDeliveryMaxIndexesPerBucketSnapshotSegment +The max number of delayed message index in per bucket snapshot segment, -1 means no limitation, after reaching the max number limitation, the snapshot segment will be cut off. + +**Type**: `int` + +**Default**: `5000` + +**Dynamic**: `false` + +**Category**: Server + +### delayedDeliveryMaxNumBuckets +The max number of delayed message index bucket, after reaching the max buckets limitation, the adjacent buckets will be merged.(disable with value -1) + +**Type**: `int` + +**Default**: `-1` + +**Dynamic**: `false` + +**Category**: Server + +### delayedDeliveryMaxTimeStepPerBucketSnapshotSegmentSeconds +The delayed message index time step(in seconds) in per bucket snapshot segment, after reaching the max time step limitation, the snapshot segment will be cut off. + +**Type**: `int` + +**Default**: `300` + +**Dynamic**: `false` + +**Category**: Server + +### delayedDeliveryMinIndexCountPerBucket +The delayed message index bucket min index count. When the index count of the current bucket is more than this value and all message indexes of current ledger have already been added to the tracker we will seal the bucket. + +**Type**: `long` + +**Default**: `50000` + +**Dynamic**: `false` + +**Category**: Server + +### delayedDeliveryTickTimeMillis +Control the tick time for when retrying on delayed delivery, affecting the accuracy of the delivery time compared to the scheduled time. Default is 1 second. Note that this time is used to configure the HashedWheelTimer's tick time. + +**Type**: `long` + +**Default**: `1000` + +**Dynamic**: `false` + +**Category**: Server + +### delayedDeliveryTrackerFactoryClassName +Class name of the factory that implements the delayed deliver tracker. +If value is "org.apache.pulsar.broker.delayed.BucketDelayedDeliveryTrackerFactory", will create bucket based delayed message index tracker. + + +**Type**: `java.lang.String` + +**Default**: `org.apache.pulsar.broker.delayed.InMemoryDelayedDeliveryTrackerFactory` + +**Dynamic**: `false` + +**Category**: Server + +### dispatchThrottlingForFilteredEntriesEnabled +Whether the broker should count filtered entries in dispatch rate limit calculations. When disabled, only messages sent to a consumer count towards a dispatch rate limit at the broker, topic, and subscription level. When enabled, messages filtered out due to entry filter logic are counted towards each relevant rate limit. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Server + +### dispatchThrottlingRateInByte +Default bytes per second dispatch throttling-limit for whole broker. Using a value of 0, is disabling default message-byte dispatch-throttling + +**Type**: `long` + +**Default**: `0` + +**Dynamic**: `true` + +**Category**: Server + +### dispatchThrottlingRateInMsg +Default messages per second dispatch throttling-limit for whole broker. Using a value of 0, is disabling default message-byte dispatch-throttling + +**Type**: `int` + +**Default**: `0` + +**Dynamic**: `true` + +**Category**: Server + +### dispatcherDispatchMessagesInSubscriptionThread +Dispatch messages and execute broker side filters in a per-subscription thread + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `true` + +**Category**: Server + +### dispatcherEntryFilterRescheduledMessageDelay +Time in milliseconds to delay the new delivery of a message when an EntryFilter returns RESCHEDULE. + +**Type**: `int` + +**Default**: `1000` + +**Dynamic**: `true` + +**Category**: Server + +### dispatcherMaxReadBatchSize +Max number of entries to read from bookkeeper. By default it is 100 entries. + +**Type**: `int` + +**Default**: `100` + +**Dynamic**: `true` + +**Category**: Server + +### dispatcherMaxReadSizeBytes +Max size in bytes of entries to read from bookkeeper. By default it is 5MB. + +**Type**: `int` + +**Default**: `5242880` + +**Dynamic**: `true` + +**Category**: Server + +### dispatcherMaxRoundRobinBatchSize +Max number of entries to dispatch for a shared subscription. By default it is 20 entries. + +**Type**: `int` + +**Default**: `20` + +**Dynamic**: `true` + +**Category**: Server + +### dispatcherMinReadBatchSize +Min number of entries to read from bookkeeper. By default it is 1 entries.When there is an error occurred on reading entries from bookkeeper, the broker will backoff the batch size to this minimum number. + +**Type**: `int` + +**Default**: `1` + +**Dynamic**: `true` + +**Category**: Server + +### dispatcherReadFailureBackoffInitialTimeInMs +The read failure backoff initial time in milliseconds. By default it is 15s. + +**Type**: `int` + +**Default**: `15000` + +**Dynamic**: `true` + +**Category**: Server + +### dispatcherReadFailureBackoffMandatoryStopTimeInMs +The read failure backoff mandatory stop time in milliseconds. By default it is 0s. + +**Type**: `int` + +**Default**: `0` + +**Dynamic**: `true` + +**Category**: Server + +### dispatcherReadFailureBackoffMaxTimeInMs +The read failure backoff max time in milliseconds. By default it is 60s. + +**Type**: `int` + +**Default**: `60000` + +**Dynamic**: `true` + +**Category**: Server + +### enableBusyWait +Option to enable busy-wait settings. Default is false. WARNING: This option will enable spin-waiting on executors and IO threads in order to reduce latency during context switches. The spinning will consume 100% CPU even when the broker is not doing any work. It is recommended to reduce the number of IO threads and BK client threads to only have few CPU cores busy. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Server + +### enableNamespaceIsolationUpdateOnTime +This config never takes effect and will be removed in the next release + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Server + +### enableNonPersistentTopics +Enable broker to load non-persistent topics + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `false` + +**Category**: Server + +### enablePersistentTopics +Enable broker to load persistent topics + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `false` + +**Category**: Server + +### enableReplicatedSubscriptions +Enable tracking of replicated subscriptions state across clusters. + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `false` + +**Category**: Server + +### enableRunBookieAutoRecoveryTogether +Enable to run bookie autorecovery along with broker + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Server + +### enableRunBookieTogether +Enable to run bookie along with broker + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Server + +### encryptionRequireOnProducer +Enforce producer to publish encrypted messages.(default disable). + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Server + +### entryFilterNames + Class name of pluggable entry filter that decides whether the entry needs to be filtered.You can use this class to decide which entries can be sent to consumers.Multiple names need to be separated by commas. + +**Type**: `java.util.List` + +**Default**: `[]` + +**Dynamic**: `true` + +**Category**: Server + +### entryFiltersDirectory + The directory for all the entry filter implementations. + +**Type**: `java.lang.String` + +**Default**: `` + +**Dynamic**: `true` + +**Category**: Server + +### exposingBrokerEntryMetadataToClientEnabled +Enable or disable exposing broker entry metadata to client. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Server + +### failureDomainsEnabled +Enable cluster's failure-domain which can distribute brokers into logical region + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `true` + +**Category**: Server + +### haProxyProtocolEnabled +Enable or disable the proxy protocol. If true, the real IP addresses of consumers and producers can be obtained when getting topic statistics data. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Server + +### httpServerAcceptQueueSize +Capacity for accept queue in the HTTP server Default is set to 8192. + +**Type**: `int` + +**Default**: `8192` + +**Dynamic**: `false` + +**Category**: Server + +### httpServerGzipCompressionExcludedPaths +Gzip compression is enabled by default. Specific paths can be excluded from compression. +There are 2 syntaxes supported, Servlet url-pattern based, and Regex based. +If the spec starts with '^' the spec is assumed to be a regex based path spec and will match with normal Java regex rules. +If the spec starts with '/' then spec is assumed to be a Servlet url-pattern rules path spec for either an exact match or prefix based match. +If the spec starts with '*.' then spec is assumed to be a Servlet url-pattern rules path spec for a suffix based match. +All other syntaxes are unsupported. +Disable all compression with ^.* or ^.*$ + +**Type**: `java.util.List` + +**Default**: `[]` + +**Dynamic**: `false` + +**Category**: Server + +### httpServerThreadPoolQueueSize +Capacity for thread pool queue in the HTTP server Default is set to 8192. + +**Type**: `int` + +**Default**: `8192` + +**Dynamic**: `false` + +**Category**: Server + +### internalListenerName +Used to specify the internal listener name for the broker.The listener name must contain in the advertisedListeners.The Default value is absent, the broker uses the first listener as the internal listener. + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Server + +### isDelayedDeliveryDeliverAtTimeStrict +Whether the deliverAt time is strictly followed. When false (default), messages may be sent to consumers before the deliverAt time by as much as the tickTimeMillis. This can reduce the overhead on the broker of maintaining the delayed index for a potentially very short time period. When true, messages will not be sent to consumer until the deliverAt time has passed, and they may be as late as the deliverAt time plus the tickTimeMillis for the topic plus the delayedDeliveryTickTimeMillis. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Server + +### keepAliveIntervalSeconds +How often to check pulsar connection is still alive + +**Type**: `int` + +**Default**: `30` + +**Dynamic**: `false` + +**Category**: Server + +### lazyCursorRecovery +Whether to recover cursors lazily when trying to recover a managed ledger backing a persistent topic. It can improve write availability of topics. +The caveat is now when recovered ledger is ready to write we're not sure if all old consumers last mark delete position can be recovered or not. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Server + +### lookupPropertyPrefix +The properties whose name starts with this prefix will be uploaded to the metadata store for the topic lookup + +**Type**: `java.lang.String` + +**Default**: `lookup.` + +**Dynamic**: `false` + +**Category**: Server + +### maxConcurrentHttpRequests +Max concurrent web requests + +**Type**: `int` + +**Default**: `1024` + +**Dynamic**: `false` + +**Category**: Server + +### maxConcurrentLookupRequest +Max number of concurrent lookup request broker allows to throttle heavy incoming lookup traffic + +**Type**: `int` + +**Default**: `50000` + +**Dynamic**: `true` + +**Category**: Server + +### maxConcurrentNonPersistentMessagePerConnection +Max concurrent non-persistent message can be processed per connection + +**Type**: `int` + +**Default**: `1000` + +**Dynamic**: `false` + +**Category**: Server + +### maxConcurrentTopicLoadRequest +Max number of concurrent topic loading request broker allows to control number of zk-operations + +**Type**: `int` + +**Default**: `5000` + +**Dynamic**: `true` + +**Category**: Server + +### maxConsumersPerSubscription +Max number of consumers allowed to connect to subscription. + +Once this limit reaches, Broker will reject new consumers until the number of connected consumers decrease. Using a value of 0, is disabling maxConsumersPerSubscription-limit check. + +**Type**: `int` + +**Default**: `0` + +**Dynamic**: `false` + +**Category**: Server + +### maxConsumersPerTopic +Max number of consumers allowed to connect to topic. + +Once this limit reaches, Broker will reject new consumers until the number of connected consumers decrease. Using a value of 0, is disabling maxConsumersPerTopic-limit check. + +**Type**: `int` + +**Default**: `0` + +**Dynamic**: `false` + +**Category**: Server + +### maxHttpServerConnections +Maximum number of inbound http connections. (0 to disable limiting) + +**Type**: `int` + +**Default**: `2048` + +**Dynamic**: `false` + +**Category**: Server + +### maxMessagePublishBufferSizeInMB +Max memory size for broker handling messages sending from producers. + + If the processing message size exceed this value, broker will stop read data from the connection. The processing messages means messages are sends to broker but broker have not send response to client, usually waiting to write to bookies. + + It's shared across all the topics running in the same broker. + + Use -1 to disable the memory limitation. Default is 1/2 of direct memory. + + + +**Type**: `int` + +**Default**: `4608` + +**Dynamic**: `true` + +**Category**: Server + +### maxMessageSize +Max size of messages. + +**Type**: `int` + +**Default**: `5242880` + +**Dynamic**: `false` + +**Category**: Server + +### maxNumPartitionsPerPartitionedTopic +The number of partitions per partitioned topic. +If try to create or update partitioned topics by exceeded number of partitions, then fail. +Use 0 or negative number to disable the check. + +**Type**: `int` + +**Default**: `0` + +**Dynamic**: `true` + +**Category**: Server + +### maxProducersPerTopic +Max number of producers allowed to connect to topic. + +Once this limit reaches, Broker will reject new producers until the number of connected producers decrease. Using a value of 0, is disabling maxProducersPerTopic-limit check. + +**Type**: `int` + +**Default**: `0` + +**Dynamic**: `false` + +**Category**: Server + +### maxPublishRatePerTopicInBytes +Max Rate(in 1 seconds) of Byte allowed to publish for a topic when topic publish rate limiting enabled. (Disable byte rate limit with value 0) + +**Type**: `long` + +**Default**: `0` + +**Dynamic**: `true` + +**Category**: Server + +### maxPublishRatePerTopicInMessages +Max Rate(in 1 seconds) of Message allowed to publish for a topic when topic publish rate limiting enabled. (Disable byte rate limit with value 0) + +**Type**: `int` + +**Default**: `0` + +**Dynamic**: `true` + +**Category**: Server + +### maxSameAddressConsumersPerTopic +Max number of consumers with the same IP address allowed to connect to topic. + +Once this limit reaches, Broker will reject new consumers until the number of connected consumers with the same IP address decrease. Using a value of 0, is disabling maxSameAddressConsumersPerTopic-limit check. + +**Type**: `int` + +**Default**: `0` + +**Dynamic**: `false` + +**Category**: Server + +### maxSameAddressProducersPerTopic +Max number of producers with the same IP address allowed to connect to topic. + +Once this limit reaches, Broker will reject new producers until the number of connected producers with the same IP address decrease. Using a value of 0, is disabling maxSameAddressProducersPerTopic-limit check. + +**Type**: `int` + +**Default**: `0` + +**Dynamic**: `false` + +**Category**: Server + +### maxSubscriptionsPerTopic +Max number of subscriptions allowed to subscribe to topic. + +Once this limit reaches, broker will reject new subscription until the number of subscribed subscriptions decrease. + Using a value of 0, is disabling maxSubscriptionsPerTopic limit check. + +**Type**: `int` + +**Default**: `0` + +**Dynamic**: `false` + +**Category**: Server + +### maxTenants +The maximum number of tenants that each pulsar cluster can create.This configuration is not precise control, in a concurrent scenario, the threshold will be exceeded. + +**Type**: `int` + +**Default**: `0` + +**Dynamic**: `true` + +**Category**: Server + +### messagePublishBufferCheckIntervalInMillis +Interval between checks to see if message publish buffer size is exceed the max message publish buffer size + +**Type**: `int` + +**Default**: `100` + +**Dynamic**: `false` + +**Category**: Server + +### metadataStoreAllowReadOnlyOperations +Is metadata store read-only operations. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Server + +### metadataStoreBatchingEnabled +Whether we should enable metadata operations batching + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `false` + +**Category**: Server + +### metadataStoreBatchingMaxDelayMillis +Maximum delay to impose on batching grouping + +**Type**: `int` + +**Default**: `5` + +**Dynamic**: `false` + +**Category**: Server + +### metadataStoreBatchingMaxOperations +Maximum number of operations to include in a singular batch + +**Type**: `int` + +**Default**: `1000` + +**Dynamic**: `false` + +**Category**: Server + +### metadataStoreBatchingMaxSizeKb +Maximum size of a batch + +**Type**: `int` + +**Default**: `128` + +**Dynamic**: `false` + +**Category**: Server + +### metadataStoreCacheExpirySeconds +Metadata store cache expiry time in seconds. + +**Type**: `int` + +**Default**: `300` + +**Dynamic**: `false` + +**Category**: Server + +### metadataStoreConfigPath +Configuration file path for local metadata store. + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Server + +### metadataStoreOperationTimeoutSeconds +Metadata store operation timeout in seconds. + +**Type**: `int` + +**Default**: `30` + +**Dynamic**: `false` + +**Category**: Server + +### metadataStoreSessionTimeoutMillis +Metadata store session timeout in milliseconds. + +**Type**: `long` + +**Default**: `30000` + +**Dynamic**: `false` + +**Category**: Server + +### metadataStoreUrl +The metadata store URL. + Examples: + * zk:my-zk-1:2181,my-zk-2:2181,my-zk-3:2181 + * my-zk-1:2181,my-zk-2:2181,my-zk-3:2181 (will default to ZooKeeper when the schema is not specified) + * zk:my-zk-1:2181,my-zk-2:2181,my-zk-3:2181/my-chroot-path (to add a ZK chroot path) + + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Server + +### metadataSyncEventTopic +Event topic to sync metadata between separate pulsar clusters on different cloud platforms. + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `true` + +**Category**: Server + +### numAcceptorThreads +Number of threads to use for Netty Acceptor. Default is set to `1` + +**Type**: `int` + +**Default**: `1` + +**Dynamic**: `false` + +**Category**: Server + +### numCacheExecutorThreadPoolSize +Number of thread pool size to use for pulsar zookeeper callback service.The cache executor thread pool is used for restarting global zookeeper session. Default is 10 + +**Type**: `int` + +**Default**: `10` + +**Dynamic**: `false` + +**Category**: Server + +### numExecutorThreadPoolSize +Number of threads to use for pulsar broker service. The executor in thread pool will do basic broker operation like load/unload bundle, update managedLedgerConfig, update topic/subscription/replicator message dispatch rate, do leader election etc. Default is set to 20 + +**Type**: `int` + +**Default**: `14` + +**Dynamic**: `false` + +**Category**: Server + +### numHttpServerThreads +Number of threads to use for HTTP requests processing Default is set to `2 * Runtime.getRuntime().availableProcessors()` + +**Type**: `int` + +**Default**: `28` + +**Dynamic**: `false` + +**Category**: Server + +### numIOThreads +Number of threads to use for Netty IO. Default is set to `2 * Runtime.getRuntime().availableProcessors()` + +**Type**: `int` + +**Default**: `28` + +**Dynamic**: `false` + +**Category**: Server + +### numOrderedExecutorThreads +Number of threads to use for orderedExecutor. The ordered executor is used to operate with zookeeper, such as init zookeeper client, get namespace policies from zookeeper etc. It also used to split bundle. Default is 8 + +**Type**: `int` + +**Default**: `8` + +**Dynamic**: `false` + +**Category**: Server + +### preciseDispatcherFlowControl +Precise dispatcher flow control according to history message number of each entry + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `true` + +**Category**: Server + +### preciseTopicPublishRateLimiterEnable +Enable precise rate limit for topic publish + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Server + +### preferLaterVersions +If true, (and ModularLoadManagerImpl is being used), the load manager will attempt to use only brokers running the latest software version (to minimize impact to bundles) + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `true` + +**Category**: Server + +### replicatedSubscriptionsSnapshotFrequencyMillis +Frequency of snapshots for replicated subscriptions tracking. + +**Type**: `int` + +**Default**: `1000` + +**Dynamic**: `false` + +**Category**: Server + +### replicatedSubscriptionsSnapshotMaxCachedPerSubscription +Max number of snapshot to be cached per subscription. + +**Type**: `int` + +**Default**: `10` + +**Dynamic**: `false` + +**Category**: Server + +### replicatedSubscriptionsSnapshotTimeoutSeconds +Timeout for building a consistent snapshot for tracking replicated subscriptions state. + +**Type**: `int` + +**Default**: `30` + +**Dynamic**: `false` + +**Category**: Server + +### replicationStartAt +The position that replication task start at, it can be set to earliest or latest (default). + +**Type**: `java.lang.String` + +**Default**: `latest` + +**Dynamic**: `true` + +**Category**: Server + +### retentionCheckIntervalInSeconds +Check between intervals to see if consumed ledgers need to be trimmed + +**Type**: `int` + +**Default**: `120` + +**Dynamic**: `false` + +**Category**: Server + +### skipBrokerShutdownOnOOM +Flag to skip broker shutdown when broker handles Out of memory error + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `true` + +**Category**: Server + +### statusFilePath +Path for the file used to determine the rotation status for the broker when responding to service discovery health checks + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Server + +### strictBookieAffinityEnabled +Enable or disable strict bookie affinity. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Server + +### strictTopicNameEnabled +# Enable strict topic name check. Which includes two parts as follows: +# 1. Mark `-partition-` as a keyword. +# E.g. + Create a non-partitioned topic. + No corresponding partitioned topic + - persistent://public/default/local-name (passed) + - persistent://public/default/local-name-partition-z (rejected by keyword) + - persistent://public/default/local-name-partition-0 (rejected by keyword) + Has corresponding partitioned topic, partitions=2 and topic partition name is persistent://public/default/local-name + - persistent://public/default/local-name-partition-0 (passed, Because it is the partition topic's sub-partition) + - persistent://public/default/local-name-partition-z (rejected by keyword) + - persistent://public/default/local-name-partition-4 (rejected, Because it exceeds the number of maximum partitions) + Create a partitioned topic(topic metadata) + - persistent://public/default/local-name (passed) + - persistent://public/default/local-name-partition-z (rejected by keyword) + - persistent://public/default/local-name-partition-0 (rejected by keyword) +# 2. Allowed alphanumeric (a-zA-Z_0-9) and these special chars -=:. for topic name. +# NOTE: This flag will be removed in some major releases in the future. + + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Server + +### systemTopicEnabled +Enable or disable system topic. + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `false` + +**Category**: Server + +### topicCompactionRetainNullKey +Whether retain null-key message during topic compaction. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Server + +### topicFencingTimeoutSeconds +If a topic remains fenced for this number of seconds, it will be closed forcefully. + If it is set to 0 or a negative number, the fenced topic will not be closed. + +**Type**: `int` + +**Default**: `0` + +**Dynamic**: `false` + +**Category**: Server + +### topicLevelPoliciesEnabled +Enable or disable topic level policies, topic level policies depends on the system topic, please enable the system topic first. + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `false` + +**Category**: Server + +### topicLoadTimeoutSeconds +Amount of seconds to timeout when loading a topic. In situations with many geo-replicated clusters, this may need raised. + +**Type**: `long` + +**Default**: `60` + +**Dynamic**: `false` + +**Category**: Server + +### topicOrderedExecutorThreadNum +Number of worker threads to serve topic ordered executor + +**Type**: `int` + +**Default**: `14` + +**Dynamic**: `false` + +**Category**: Server + +### topicPoliciesServiceClassName +The class name of the topic policies service. The default config only takes affect when the systemTopicEnable config is true + +**Type**: `java.lang.String` + +**Default**: `org.apache.pulsar.broker.service.SystemTopicBasedTopicPoliciesService` + +**Dynamic**: `false` + +**Category**: Server + +### transactionLogBatchedWriteEnabled +Provide a mechanism allowing the Transaction Log Store to aggregate multiple records into a batched record and persist into a single BK entry. This will make Pulsar transactions work more efficiently, aka batched log. see: https://github.com/apache/pulsar/issues/15370. Default false + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `true` + +**Category**: Server + +### transactionLogBatchedWriteMaxDelayInMillis +If enabled the feature that transaction log batch, this attribute means maximum wait time(in millis) for the first record in a batch, default 1 millisecond. + +**Type**: `int` + +**Default**: `1` + +**Dynamic**: `false` + +**Category**: Server + +### transactionLogBatchedWriteMaxRecords +If enabled the feature that transaction log batch, this attribute means maximum log records count in a batch, default 512. + +**Type**: `int` + +**Default**: `512` + +**Dynamic**: `false` + +**Category**: Server + +### transactionLogBatchedWriteMaxSize +If enabled the feature that transaction log batch, this attribute means bytes size in a batch, default 4m. + +**Type**: `int` + +**Default**: `4194304` + +**Dynamic**: `false` + +**Category**: Server + +### transactionPendingAckBatchedWriteEnabled +Provide a mechanism allowing the transaction pending ack Log Store to aggregate multiple records into a batched record and persist into a single BK entry. This will make Pulsar transactions work more efficiently, aka batched log. see: https://github.com/apache/pulsar/issues/15370. Default false. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `true` + +**Category**: Server + +### transactionPendingAckBatchedWriteMaxDelayInMillis +If enabled the feature that transaction pending ack log batch, this attribute means maximum wait time(in millis) for the first record in a batch, default 1 millisecond. + +**Type**: `int` + +**Default**: `1` + +**Dynamic**: `false` + +**Category**: Server + +### transactionPendingAckBatchedWriteMaxRecords +If enabled the feature that transaction log batch, this attribute means maximum log records count in a batch, default 512. + +**Type**: `int` + +**Default**: `512` + +**Dynamic**: `false` + +**Category**: Server + +### transactionPendingAckBatchedWriteMaxSize +If enabled the feature that transaction pending ack log batch, this attribute means bytes size in a batch, default 4m. + +**Type**: `int` + +**Default**: `4194304` + +**Dynamic**: `false` + +**Category**: Server + +### webServiceHaProxyProtocolEnabled +Enable or disable the use of HA proxy protocol for resolving the client IP for http/https requests. Default is false. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Server + +### webServiceLogDetailedAddresses +Add detailed client/remote and server/local addresses and ports to http/https request logging. +Defaults to true when either webServiceHaProxyProtocolEnabled or webServiceTrustXForwardedFor is enabled. + +**Type**: `java.lang.Boolean` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Server + +### webServicePort +The port for serving http requests + +**Type**: `java.util.Optional` + +**Default**: `Optional[8080]` + +**Dynamic**: `false` + +**Category**: Server + +### webServicePortTls +The port for serving https requests + +**Type**: `java.util.Optional` + +**Default**: `Optional.empty` + +**Dynamic**: `false` + +**Category**: Server + +### webServiceTlsProvider +Specify the TLS provider for the web service: SunJSSE, Conscrypt and etc. + +**Type**: `java.lang.String` + +**Default**: `Conscrypt` + +**Dynamic**: `false` + +**Category**: Server + +### webServiceTrustXForwardedFor +Trust X-Forwarded-For header for resolving the client IP for http/https requests. +Default is false. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Server + +### bookkeeperClientAuthenticationParameters +Parameters for bookkeeper auth plugin + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperClientAuthenticationParametersName +BookKeeper auth plugin implementation specifics parameters name and values + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperClientAuthenticationPlugin +Authentication plugin to use when connecting to bookies + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperClientEnforceMinNumRacksPerWriteQuorum +Enforces rack-aware bookie selection policy to pick bookies from 'bookkeeperClientMinNumRacksPerWriteQuorum' racks for a writeQuorum. + +If BK can't find bookie then it would throw BKNotEnoughBookiesException instead of picking random one. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperClientExposeStatsToPrometheus +whether expose managed ledger client stats to prometheus + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperClientGetBookieInfoIntervalSeconds +Set the interval to periodically check bookie info + +**Type**: `int` + +**Default**: `86400` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperClientGetBookieInfoRetryIntervalSeconds +Set the interval to retry a failed bookie info lookup + +**Type**: `int` + +**Default**: `60` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperClientHealthCheckEnabled +Enable bookies health check. + + Bookies that have more than the configured number of failure within the interval will be quarantined for some time. During this period, new ledgers won't be created on these bookies + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperClientHealthCheckErrorThresholdPerInterval +Bookies health check error threshold per check interval + +**Type**: `long` + +**Default**: `5` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperClientHealthCheckIntervalSeconds +Bookies health check interval in seconds + +**Type**: `long` + +**Default**: `60` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperClientHealthCheckQuarantineTimeInSeconds +Bookie health check quarantined time in seconds + +**Type**: `long` + +**Default**: `1800` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperClientIsolationGroups +Enable bookie isolation by specifying a list of bookie groups to choose from. + +Any bookie outside the specified groups will not be used by the broker + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperClientLimitStatsLogging +whether limit per_channel_bookie_client metrics of bookkeeper client stats + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperClientMinNumRacksPerWriteQuorum +Minimum number of racks per write quorum. + +BK rack-aware bookie selection policy will try to get bookies from at least 'bookkeeperClientMinNumRacksPerWriteQuorum' racks for a write quorum. + +**Type**: `int` + +**Default**: `2` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperClientNumIoThreads +Number of BookKeeper client IO threads. Default is Runtime.getRuntime().availableProcessors() * 2 + +**Type**: `int` + +**Default**: `28` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperClientNumWorkerThreads +Number of BookKeeper client worker threads. Default is Runtime.getRuntime().availableProcessors() + +**Type**: `int` + +**Default**: `14` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperClientQuarantineRatio +bookie quarantine ratio to avoid all clients quarantine the high pressure bookie servers at the same time + +**Type**: `double` + +**Default**: `1.0` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperClientRackawarePolicyEnabled +Enable rack-aware bookie selection policy. + +BK will chose bookies from different racks when forming a new bookie ensemble + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperClientRegionawarePolicyEnabled +Enable region-aware bookie selection policy. + +BK will chose bookies from different regions and racks when forming a new bookie ensemble + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperClientReorderReadSequenceEnabled +Enable/disable reordering read sequence on reading entries + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperClientSecondaryIsolationGroups +Enable bookie secondary-isolation group if bookkeeperClientIsolationGroups doesn't have enough bookie available. + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperClientSeparatedIoThreadsEnabled +Use separated IO threads for BookKeeper client. Default is false, which will use Pulsar IO threads + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperClientSpeculativeReadTimeoutInMillis +Speculative reads are initiated if a read request doesn't complete within a certain time Using a value of 0, is disabling the speculative reads + +**Type**: `int` + +**Default**: `0` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperClientThrottleValue +Throttle value for bookkeeper client + +**Type**: `int` + +**Default**: `0` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperClientTimeoutInSeconds +Timeout for BK add / read operations + +**Type**: `long` + +**Default**: `30` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperDiskWeightBasedPlacementEnabled +Enable/disable disk weight based placement. Default is false + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperEnableStickyReads +Enable/disable having read operations for a ledger to be sticky to a single bookie. +If this flag is enabled, the client will use one single bookie (by preference) to read all entries for a ledger. + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperExplicitLacIntervalInMills +Set the interval to check the need for sending an explicit LAC + +**Type**: `int` + +**Default**: `0` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperMetadataServiceUri +Metadata service uri that bookkeeper is used for loading corresponding metadata driver and resolving its metadata service location + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperNumberOfChannelsPerBookie +Number of channels per bookie + +**Type**: `int` + +**Default**: `16` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperTLSCertificateFilePath +Path for the TLS certificate file + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperTLSClientAuthentication +Enable tls authentication with bookie + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperTLSKeyFilePath +Path for the TLS private key file + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperTLSKeyFileType +Supported type: PEM, JKS, PKCS12. Default value: PEM + +**Type**: `java.lang.String` + +**Default**: `PEM` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperTLSKeyStorePasswordPath +Path to file containing keystore password, if the client keystore is password protected. + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperTLSProviderFactoryClass +Set the client security provider factory class name. Default: org.apache.bookkeeper.tls.TLSContextFactory + +**Type**: `java.lang.String` + +**Default**: `org.apache.bookkeeper.tls.TLSContextFactory` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperTLSTrustCertTypes +Supported type: PEM, JKS, PKCS12. Default value: PEM + +**Type**: `java.lang.String` + +**Default**: `PEM` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperTLSTrustCertsFilePath +Path for the trusted TLS certificate file + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperTLSTrustStorePasswordPath +Path to file containing truststore password, if the client truststore is password protected. + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperTlsCertFilesRefreshDurationSeconds +Tls cert refresh duration at bookKeeper-client in seconds (0 to disable check) + +**Type**: `int` + +**Default**: `300` + +**Dynamic**: `false` + +**Category**: Storage (BookKeeper) + +### bookkeeperUseV2WireProtocol +Use older Bookkeeper wire protocol with bookie + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `true` + +**Category**: Storage (BookKeeper) + +### managedLedgerOffloadAutoTriggerSizeThresholdBytes +The number of bytes before triggering automatic offload to long term storage + +**Type**: `long` + +**Default**: `-1` + +**Dynamic**: `false` + +**Category**: Storage (Ledger Offloading) + +### managedLedgerOffloadDeletionLagMs +Delay between a ledger being successfully offloaded to long term storage, and the ledger being deleted from bookkeeper + +**Type**: `long` + +**Default**: `14400000` + +**Dynamic**: `false` + +**Category**: Storage (Ledger Offloading) + +### managedLedgerOffloadDriver +Driver to use to offload old data to long term storage + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Storage (Ledger Offloading) + +### managedLedgerOffloadMaxThreads +Maximum number of thread pool threads for ledger offloading + +**Type**: `int` + +**Default**: `2` + +**Dynamic**: `false` + +**Category**: Storage (Ledger Offloading) + +### managedLedgerOffloadPrefetchRounds +Maximum prefetch rounds for ledger reading for offloading + +**Type**: `int` + +**Default**: `1` + +**Dynamic**: `false` + +**Category**: Storage (Ledger Offloading) + +### managedLedgerOffloadThresholdInSeconds +The threshold to triggering automatic offload to long term storage + +**Type**: `long` + +**Default**: `-1` + +**Dynamic**: `false` + +**Category**: Storage (Ledger Offloading) + +### managedLedgerUnackedRangesOpenCacheSetEnabled +Use Open Range-Set to cache unacked messages (it is memory efficient but it can take more cpu) + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `false` + +**Category**: Storage (Ledger Offloading) + +### narExtractionDirectory +The directory where nar Extraction of offloaders happens + +**Type**: `java.lang.String` + +**Default**: `/var/folders/gt/xywq0qwd4cvdqfhy7t7js7b00000gn/T/` + +**Dynamic**: `false` + +**Category**: Storage (Ledger Offloading) + +### offloadersDirectory +The directory to locate offloaders + +**Type**: `java.lang.String` + +**Default**: `./offloaders` + +**Dynamic**: `false` + +**Category**: Storage (Ledger Offloading) + +### triggerOffloadOnTopicLoad +Trigger offload on topic load or not. Default is false + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Storage (Ledger Offloading) + +### allowAutoSubscriptionCreation +Allow automated creation of subscriptions if set to true (default value). + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `true` + +**Category**: Storage (Managed Ledger) + +### allowAutoTopicCreation +Allow automated creation of topics if set to true (default value). + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `true` + +**Category**: Storage (Managed Ledger) + +### allowAutoTopicCreationType +The type of topic that is allowed to be automatically created.(partitioned/non-partitioned) + +**Type**: `org.apache.pulsar.common.policies.data.TopicType` + +**Default**: `non-partitioned` + +**Dynamic**: `true` + +**Category**: Storage (Managed Ledger) + +### autoSkipNonRecoverableData +Skip reading non-recoverable/unreadable data-ledger under managed-ledger's list. + + It helps when data-ledgers gets corrupted at bookkeeper and managed-cursor is stuck at that ledger. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `true` + +**Category**: Storage (Managed Ledger) + +### cacheEvictionByMarkDeletedPosition +Evicting cache data by the slowest markDeletedPosition or readPosition. The default is to evict through readPosition. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### defaultNumPartitions +The number of partitioned topics that is allowed to be automatically created if allowAutoTopicCreationType is partitioned. + +**Type**: `int` + +**Default**: `1` + +**Dynamic**: `true` + +**Category**: Storage (Managed Ledger) + +### dispatcherPauseOnAckStatePersistentEnabled +After enabling this feature, Pulsar will stop delivery messages to clients if the cursor metadata is too large to persist, it will help to reduce the duplicates caused by the ack state that can not be fully persistent. Default false. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `true` + +**Category**: Storage (Managed Ledger) + +### managedCursorInfoCompressionThresholdInBytes +ManagedCursorInfo compression size threshold (bytes), only compress metadata when origin size more then this value. +0 means compression will always apply. + + +**Type**: `long` + +**Default**: `16384` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### managedCursorInfoCompressionType +ManagedCursorInfo compression type, option values (NONE, LZ4, ZLIB, ZSTD, SNAPPY). +If value is NONE, then save the ManagedCursorInfo bytes data directly. + +**Type**: `java.lang.String` + +**Default**: `NONE` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### managedLedgerAddEntryTimeoutSeconds +Add entry timeout when broker tries to publish message to bookkeeper.(0 to disable it) + +**Type**: `long` + +**Default**: `0` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### managedLedgerCacheCopyEntries +Whether we should make a copy of the entry payloads when inserting in cache + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### managedLedgerCacheEvictionFrequency +Configure the cache eviction frequency for the managed ledger cache. + +**Type**: `double` + +**Default**: `0.0` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### managedLedgerCacheEvictionIntervalMs +Configure the cache eviction interval in milliseconds for the managed ledger cache, default is 10ms + +**Type**: `long` + +**Default**: `10` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### managedLedgerCacheEvictionTimeThresholdMillis +All entries that have stayed in cache for more than the configured time, will be evicted + +**Type**: `long` + +**Default**: `1000` + +**Dynamic**: `true` + +**Category**: Storage (Managed Ledger) + +### managedLedgerCacheEvictionWatermark +Threshold to which bring down the cache level when eviction is triggered + +**Type**: `double` + +**Default**: `0.9` + +**Dynamic**: `true` + +**Category**: Storage (Managed Ledger) + +### managedLedgerCacheSizeMB +Amount of memory to use for caching data payload in managed ledger. + +This memory is allocated from JVM direct memory and it's shared across all the topics running in the same broker. By default, uses 1/5th of available direct memory + +**Type**: `int` + +**Default**: `1843` + +**Dynamic**: `true` + +**Category**: Storage (Managed Ledger) + +### managedLedgerCursorBackloggedThreshold +Configure the threshold (in number of entries) from where a cursor should be considered 'backlogged' and thus should be set as inactive. + +**Type**: `long` + +**Default**: `1000` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### managedLedgerCursorMaxEntriesPerLedger +Max number of entries to append to a cursor ledger + +**Type**: `int` + +**Default**: `50000` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### managedLedgerCursorPositionFlushSeconds +How frequently to flush the cursor positions that were accumulated due to rate limiting. (seconds). Default is 60 seconds + +**Type**: `int` + +**Default**: `60` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### managedLedgerCursorRolloverTimeInSeconds +Max time before triggering a rollover on a cursor ledger + +**Type**: `int` + +**Default**: `14400` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### managedLedgerDataReadPriority +Read priority when ledgers exists in both bookkeeper and the second layer storage. + +**Type**: `java.lang.String` + +**Default**: `tiered-storage-first` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### managedLedgerDefaultAckQuorum +Ack quorum (Qa) size, Number of guaranteed copies (acks to wait for before a write is considered completed) + +**Type**: `int` + +**Default**: `2` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### managedLedgerDefaultEnsembleSize +Ensemble (E) size, Number of bookies to use for storing entries in a ledger. +Please notice that sticky reads enabled by bookkeeperEnableStickyReads=true aren’t used unless ensemble size (E) equals write quorum (Qw) size. + +**Type**: `int` + +**Default**: `2` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### managedLedgerDefaultMarkDeleteRateLimit +Rate limit the amount of writes per second generated by consumer acking the messages + +**Type**: `double` + +**Default**: `1.0` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### managedLedgerDefaultWriteQuorum +Write quorum (Qw) size, Replication factor for storing entries (messages) in a ledger. + +**Type**: `int` + +**Default**: `2` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### managedLedgerDigestType +Default type of checksum to use when writing to BookKeeper. + +Default is `CRC32C`. Other possible options are `CRC32`, `MAC` or `DUMMY` (no checksum). + +**Type**: `org.apache.bookkeeper.client.api.DigestType` + +**Default**: `CRC32C` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### managedLedgerForceRecovery +Skip managed ledger failure to forcefully recover managed ledger. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `true` + +**Category**: Storage (Managed Ledger) + +### managedLedgerInactiveLedgerRolloverTimeSeconds +Time to rollover ledger for inactive topic (duration without any publish on that topic). Disable rollover with value 0 (Default value 0) + +**Type**: `int` + +**Default**: `0` + +**Dynamic**: `true` + +**Category**: Storage (Managed Ledger) + +### managedLedgerInfoCompressionThresholdInBytes +ManagedLedgerInfo compression size threshold (bytes), only compress metadata when origin size more then this value. +0 means compression will always apply. + + +**Type**: `long` + +**Default**: `16384` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### managedLedgerInfoCompressionType +ManagedLedgerInfo compression type, option values (NONE, LZ4, ZLIB, ZSTD, SNAPPY). +If value is invalid or NONE, then save the ManagedLedgerInfo bytes data directly. + +**Type**: `java.lang.String` + +**Default**: `NONE` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### managedLedgerMaxAckQuorum +Max number of guaranteed copies (acks to wait before write is complete) + +**Type**: `int` + +**Default**: `5` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### managedLedgerMaxBacklogBetweenCursorsForCaching +Maximum backlog entry difference to prevent caching entries that can't be reused + +**Type**: `int` + +**Default**: `1000` + +**Dynamic**: `true` + +**Category**: Storage (Managed Ledger) + +### managedLedgerMaxEnsembleSize +Max number of bookies to use when creating a ledger + +**Type**: `int` + +**Default**: `5` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### managedLedgerMaxEntriesPerLedger +Max number of entries to append to a ledger before triggering a rollover. + +A ledger rollover is triggered after the min rollover time has passed and one of the following conditions is true: the max rollover time has been reached, the max entries have been written to the ledger, or the max ledger size has been written to the ledger + +**Type**: `int` + +**Default**: `50000` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### managedLedgerMaxLedgerRolloverTimeMinutes +Maximum time before forcing a ledger rollover for a topic + +**Type**: `int` + +**Default**: `240` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### managedLedgerMaxReadsInFlightSizeInMB +Maximum buffer size for bytes read from storage. This is the memory retained by data read from storage (or cache) until it has been delivered to the Consumer Netty channel. Use O to disable + +**Type**: `long` + +**Default**: `0` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### managedLedgerMaxSizePerLedgerMbytes +Maximum ledger size before triggering a rollover for a topic (MB) + +**Type**: `int` + +**Default**: `2048` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### managedLedgerMaxUnackedRangesToPersist +Max number of `acknowledgment holes` that are going to be persistently stored. + +When acknowledging out of order, a consumer will leave holes that are supposed to be quickly filled by acking all the messages. The information of which messages are acknowledged is persisted by compressing in `ranges` of messages that were acknowledged. After the max number of ranges is reached, the information will only be tracked in memory and messages will be redelivered in case of crashes. + +**Type**: `int` + +**Default**: `10000` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### managedLedgerMaxUnackedRangesToPersistInMetadataStore +Max number of `acknowledgment holes` that can be stored in MetadataStore. + +If number of unack message range is higher than this limit then broker will persist unacked ranges into bookkeeper to avoid additional data overhead into MetadataStore. + +**Type**: `int` + +**Default**: `1000` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### managedLedgerMaxWriteQuorum +Max number of copies to store for each message + +**Type**: `int` + +**Default**: `5` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### managedLedgerMetadataOperationsTimeoutSeconds +operation timeout while updating managed-ledger metadata. + +**Type**: `long` + +**Default**: `60` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### managedLedgerMinLedgerRolloverTimeMinutes +Minimum time between ledger rollover for a topic + +**Type**: `int` + +**Default**: `10` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### managedLedgerMinimumBacklogCursorsForCaching +Minimum cursors that must be in backlog state to cache and reuse the read entries.(Default =0 to disable backlog reach cache) + +**Type**: `int` + +**Default**: `0` + +**Dynamic**: `true` + +**Category**: Storage (Managed Ledger) + +### managedLedgerMinimumBacklogEntriesForCaching +Minimum backlog entries for any cursor before start caching reads + +**Type**: `int` + +**Default**: `1000` + +**Dynamic**: `true` + +**Category**: Storage (Managed Ledger) + +### managedLedgerNewEntriesCheckDelayInMillis +New entries check delay for the cursor under the managed ledger. +If no new messages in the topic, the cursor will try to check again after the delay time. +For consumption latency sensitive scenario, can set to a smaller value or set to 0. +Of course, this may degrade consumption throughput. Default is 10ms. + +**Type**: `int` + +**Default**: `10` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### managedLedgerNumSchedulerThreads +Number of threads to be used for managed ledger scheduled tasks + +**Type**: `int` + +**Default**: `14` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### managedLedgerPassword +Default password to use when writing to BookKeeper. + +Default is ``. + +**Type**: `java.lang.String` + +**Default**: `` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### managedLedgerPrometheusStatsLatencyRolloverSeconds +Managed ledger prometheus stats latency rollover seconds + +**Type**: `int` + +**Default**: `60` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### managedLedgerReadEntryTimeoutSeconds +Read entries timeout when broker tries to read messages from bookkeeper (0 to disable it) + +**Type**: `long` + +**Default**: `0` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### managedLedgerStatsPeriodSeconds +How frequently to refresh the stats. (seconds). Default is 60 seconds + +**Type**: `int` + +**Default**: `60` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### managedLedgerStorageClassName +The class of the managed ledger storage + +**Type**: `java.lang.String` + +**Default**: `org.apache.pulsar.broker.ManagedLedgerClientFactory` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### managedLedgerTraceTaskExecution +Whether trace managed ledger task execution time + +**Type**: `boolean` + +**Default**: `true` + +**Dynamic**: `true` + +**Category**: Storage (Managed Ledger) + +### persistentUnackedRangesWithMultipleEntriesEnabled +If enabled, the maximum "acknowledgment holes" will not be limited and "acknowledgment holes" are stored in multiple entries. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + +### schemaLedgerForceRecovery +Skip schema ledger failure to forcefully recover topic successfully. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `true` + +**Category**: Storage (Managed Ledger) + +### brokerClientSslFactoryPlugin +SSL Factory Plugin class used by internal client to provide SSLEngine and SSLContext objects. The default class used is DefaultSslFactory. + +**Type**: `java.lang.String` + +**Default**: `org.apache.pulsar.common.util.DefaultPulsarSslFactory` + +**Dynamic**: `false` + +**Category**: TLS + +### brokerClientSslFactoryPluginParams +SSL Factory plugin configuration parameters used by internal client. + +**Type**: `java.lang.String` + +**Default**: `` + +**Dynamic**: `false` + +**Category**: TLS + +### sslFactoryPlugin +SSL Factory Plugin class to provide SSLEngine and SSLContext objects. The default class used is DefaultSslFactory. + +**Type**: `java.lang.String` + +**Default**: `org.apache.pulsar.common.util.DefaultPulsarSslFactory` + +**Dynamic**: `false` + +**Category**: TLS + +### sslFactoryPluginParams +SSL Factory plugin configuration parameters. + +**Type**: `java.lang.String` + +**Default**: `` + +**Dynamic**: `false` + +**Category**: TLS + +### tlsAllowInsecureConnection +Accept untrusted TLS certificate from client + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: TLS + +### tlsCertRefreshCheckDurationSec +Tls cert refresh duration in seconds (set 0 to check on every new connection) + +**Type**: `long` + +**Default**: `300` + +**Dynamic**: `false` + +**Category**: TLS + +### tlsCertificateFilePath +Path for the TLS certificate file + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: TLS + +### tlsCiphers +Specify the tls cipher the broker will use to negotiate during TLS Handshake. + +Example:- [TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256] + +**Type**: `java.util.Set` + +**Default**: `[]` + +**Dynamic**: `false` + +**Category**: TLS + +### tlsEnabled +Enable TLS + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: TLS + +### tlsHostnameVerificationEnabled +Whether the hostname is validated when the broker creates a TLS connection with other brokers + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: TLS + +### tlsKeyFilePath +Path for the TLS private key file + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: TLS + +### tlsProtocols +Specify the tls protocols the broker will use to negotiate during TLS Handshake. + +Example:- [TLSv1.3, TLSv1.2] + +**Type**: `java.util.Set` + +**Default**: `[]` + +**Dynamic**: `false` + +**Category**: TLS + +### tlsRequireTrustedClientCertOnConnect +Specify whether Client certificates are required for TLS Reject. +the Connection if the Client Certificate is not trusted + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: TLS + +### tlsTrustCertsFilePath +Path for the trusted TLS certificate file + +**Type**: `java.lang.String` + +**Default**: `` + +**Dynamic**: `false` + +**Category**: TLS + +### webServiceTlsCiphers +Specify the tls cipher the proxy's web service will use to negotiate during TLS Handshake. + +Example:- [TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256] + +**Type**: `java.util.Set` + +**Default**: `[]` + +**Dynamic**: `false` + +**Category**: TLS + +### webServiceTlsProtocols +Specify the tls protocols the proxy's web service will use to negotiate during TLS Handshake. + +Example:- [TLSv1.3, TLSv1.2] + +**Type**: `java.util.Set` + +**Default**: `[]` + +**Dynamic**: `false` + +**Category**: TLS + +### maxActiveTransactionsPerCoordinator +The max active transactions per transaction coordinator, default value 0 indicates no limit. + +**Type**: `long` + +**Default**: `0` + +**Dynamic**: `false` + +**Category**: Transaction + +### numTransactionReplayThreadPoolSize +Number of threads to use for pulsar transaction replay PendingAckStore or TransactionBuffer.Default is 5 + +**Type**: `int` + +**Default**: `14` + +**Dynamic**: `false` + +**Category**: Transaction + +### transactionBufferClientMaxConcurrentRequests +The max concurrent requests for transaction buffer client. + +**Type**: `int` + +**Default**: `1000` + +**Dynamic**: `false` + +**Category**: Transaction + +### transactionBufferClientOperationTimeoutInMills +The transaction buffer client's operation timeout in milliseconds. + +**Type**: `long` + +**Default**: `3000` + +**Dynamic**: `false` + +**Category**: Transaction + +### transactionBufferProviderClassName +Class name for transaction buffer provider + +**Type**: `java.lang.String` + +**Default**: `org.apache.pulsar.broker.transaction.buffer.impl.TopicTransactionBufferProvider` + +**Dynamic**: `false` + +**Category**: Transaction + +### transactionBufferSegmentedSnapshotEnabled +Whether to enable segmented transaction buffer snapshot to handle a large number of aborted transactions. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Transaction + +### transactionBufferSnapshotMaxTransactionCount +Transaction buffer take snapshot transaction countIf transaction buffer enables snapshot segment, transaction buffer updates snapshot metadataafter the number of transaction operations reaches this value. + +**Type**: `int` + +**Default**: `1000` + +**Dynamic**: `false` + +**Category**: Transaction + +### transactionBufferSnapshotMinTimeInMillis +The interval time for transaction buffer to take snapshots.If transaction buffer enables snapshot segment, it is the interval time for transaction buffer to update snapshot metadata. + +**Type**: `int` + +**Default**: `5000` + +**Dynamic**: `false` + +**Category**: Transaction + +### transactionBufferSnapshotSegmentSize +Transaction buffer stores the transaction ID of aborted transactions and takes snapshots.This configuration determines the size of the snapshot segment. The default value is 256 KB (262144 bytes). + +**Type**: `int` + +**Default**: `262144` + +**Dynamic**: `false` + +**Category**: Transaction + +### transactionCoordinatorEnabled +Enable transaction coordinator in broker + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Transaction + +### transactionMetadataStoreProviderClassName +Class name for transaction metadata store provider + +**Type**: `java.lang.String` + +**Default**: `org.apache.pulsar.transaction.coordinator.impl.MLTransactionMetadataStoreProvider` + +**Dynamic**: `false` + +**Category**: Transaction + +### transactionPendingAckLogIndexMinLag +MLPendingAckStore maintain a ConcurrentSkipListMap pendingAckLogIndex`,it store the position in pendingAckStore as value and save a position used to determinewhether the previous data can be cleaned up as a key.transactionPendingAckLogIndexMinLag is used to configure the minimum lag between indexes + +**Type**: `long` + +**Default**: `500` + +**Dynamic**: `false` + +**Category**: Transaction + +### transactionPendingAckStoreProviderClassName +Class name for transaction pending ack store provider + +**Type**: `java.lang.String` + +**Default**: `org.apache.pulsar.broker.transaction.pendingack.impl.MLPendingAckStoreProvider` + +**Dynamic**: `false` + +**Category**: Transaction + +### isRunningStandalone +Flag indicates whether to run broker in standalone mode + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: WebSocket + +### webSocketConnectionsPerBroker +Number of connections per Broker in Pulsar Client used in WebSocket proxy + +**Type**: `int` + +**Default**: `14` + +**Dynamic**: `false` + +**Category**: WebSocket + +### webSocketMaxTextFrameSize +The maximum size of a text message during parsing in WebSocket proxy. + +**Type**: `int` + +**Default**: `1048576` + +**Dynamic**: `false` + +**Category**: WebSocket + +### webSocketNumIoThreads +Number of IO threads in Pulsar Client used in WebSocket proxy + +**Type**: `int` + +**Default**: `14` + +**Dynamic**: `false` + +**Category**: WebSocket + +### webSocketNumServiceThreads +Number of threads used by Websocket service + +**Type**: `int` + +**Default**: `20` + +**Dynamic**: `false` + +**Category**: WebSocket + +### webSocketPingDurationSeconds +Interval of time to sending the ping to keep alive in WebSocket proxy. This value greater than 0 means enabled + +**Type**: `int` + +**Default**: `-1` + +**Dynamic**: `false` + +**Category**: WebSocket + +### webSocketPulsarClientMemoryLimitInMB +Memory limit in MBs for direct memory in Pulsar Client used in WebSocket proxy + +**Type**: `int` + +**Default**: `0` + +**Dynamic**: `false` + +**Category**: WebSocket + +### webSocketServiceEnabled +Enable the WebSocket API service in broker + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: WebSocket + +### webSocketSessionIdleTimeoutMillis +Time in milliseconds that idle WebSocket session times out + +**Type**: `int` + +**Default**: `300000` + +**Dynamic**: `false` + +**Category**: WebSocket + +## Deprecated +### loadBalancerBrokerComfortLoadLevelPercentage +Usage threshold to determine a broker is having just right level of load (only used by SimpleLoadManagerImpl) + +**Type**: `int` + +**Default**: `65` + +**Dynamic**: `false` + +**Category**: Load Balancer + +### loadBalancerBrokerUnderloadedThresholdPercentage +Usage threshold to determine a broker as under-loaded (only used by SimpleLoadManagerImpl) + +**Type**: `int` + +**Default**: `50` + +**Dynamic**: `false` + +**Category**: Load Balancer + +### loadBalancerMemoryResourceWeight +Memory Resource Usage Weight. Deprecated: Memory is no longer used as a load balancing item. + +**Type**: `double` + +**Default**: `0.0` + +**Dynamic**: `true` + +**Category**: Load Balancer + +### loadBalancerPlacementStrategy +load placement strategy[weightedRandomSelection/leastLoadedServer] (only used by SimpleLoadManagerImpl) + +**Type**: `java.lang.String` + +**Default**: `leastLoadedServer` + +**Dynamic**: `false` + +**Category**: Load Balancer + +### brokerServicePurgeInactiveFrequencyInSeconds +How often broker checks for inactive topics to be deleted (topics with no subscriptions and no one connected) Deprecated in favor of using `brokerDeleteInactiveTopicsFrequencySeconds` +@deprecated - unused. + +**Type**: `int` + +**Default**: `60` + +**Dynamic**: `false` + +**Category**: Policies + +### replicationTlsEnabled +@deprecated - Use brokerClientTlsEnabled instead. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Replication + +### configurationStoreServers +Configuration store connection string (as a comma-separated list). Deprecated in favor of `configurationMetadataStoreUrl` + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Server + +### globalZookeeperServers +Global Zookeeper quorum connection string (as a comma-separated list). Deprecated in favor of using `configurationStoreServers` + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Server + +### numWorkerThreadsForNonPersistentTopic +Number of worker threads to serve non-persistent topic. +@deprecated - use topicOrderedExecutorThreadNum instead. + +**Type**: `int` + +**Default**: `-1` + +**Dynamic**: `false` + +**Category**: Server + +### zooKeeperAllowReadOnlyOperations +Is zookeeper allow read-only operations. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: Server + +### zooKeeperCacheExpirySeconds +ZooKeeper cache expiry time in seconds. @deprecated - Use metadataStoreCacheExpirySeconds instead. + +**Type**: `int` + +**Default**: `-1` + +**Dynamic**: `false` + +**Category**: Server + +### zooKeeperOperationTimeoutSeconds +ZooKeeper operation timeout in seconds. @deprecated - Use metadataStoreOperationTimeoutSeconds instead. + +**Type**: `int` + +**Default**: `-1` + +**Dynamic**: `false` + +**Category**: Server + +### zooKeeperSessionTimeoutMillis +ZooKeeper session timeout in milliseconds. @deprecated - Use metadataStoreSessionTimeoutMillis instead. + +**Type**: `long` + +**Default**: `-1` + +**Dynamic**: `false` + +**Category**: Server + +### zookeeperServers +The Zookeeper quorum connection string (as a comma-separated list). Deprecated in favour of metadataStoreUrl + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: Server + +### managedLedgerMaxUnackedRangesToPersistInZooKeeper +Max number of `acknowledgment holes` that can be stored in Zookeeper. + +If number of unack message range is higher than this limit then broker will persist unacked ranges into bookkeeper to avoid additional data overhead into zookeeper. +@deprecated - use managedLedgerMaxUnackedRangesToPersistInMetadataStore. + +**Type**: `int` + +**Default**: `-1` + +**Dynamic**: `false` + +**Category**: Storage (Managed Ledger) + + diff --git a/static/reference/4.0.x/config/reference-configuration-websocket.md b/static/reference/4.0.x/config/reference-configuration-websocket.md new file mode 100644 index 000000000000..4f1ed4571f01 --- /dev/null +++ b/static/reference/4.0.x/config/reference-configuration-websocket.md @@ -0,0 +1,683 @@ +# WebSocket + +## Required +### clusterName +Name of the cluster to which this broker belongs to + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: + +## Optional +### anonymousUserRole +When this parameter is not empty, unauthenticated users perform as anonymousUserRole + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: + +### authenticationEnabled +Enable authentication + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: + +### authenticationProviders +Authentication provider name list, which is a list of class names + +**Type**: `java.util.Set` + +**Default**: `[]` + +**Dynamic**: `false` + +**Category**: + +### authorizationAllowWildcardsMatching +Allow wildcard matching in authorization (wildcard matching only applicable if wildcard-char: presents at first or last position. For example: *.pulsar.service,pulsar.service.*) + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: + +### authorizationEnabled +Enforce authorization + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: + +### authorizationProvider +Authorization provider fully qualified class name + +**Type**: `java.lang.String` + +**Default**: `org.apache.pulsar.broker.authorization.PulsarAuthorizationProvider` + +**Dynamic**: `false` + +**Category**: + +### bindAddress +Hostname or IP address the service binds on, default is 0.0.0.0. + +**Type**: `java.lang.String` + +**Default**: `0.0.0.0` + +**Dynamic**: `false` + +**Category**: + +### brokerClientAuthenticationParameters +Proxy authentication parameters used to connect to brokers + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: + +### brokerClientAuthenticationPlugin +Proxy authentication settings used to connect to brokers + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: + +### brokerClientTlsEnabled +Enable TLS of broker client + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: + +### brokerClientTrustCertsFilePath +Path for the trusted TLS certificate file for outgoing connection to a server (broker) + +**Type**: `java.lang.String` + +**Default**: `` + +**Dynamic**: `false` + +**Category**: + +### brokerServiceUrl +The broker binary service URL (for produce and consume operations) + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: + +### brokerServiceUrlTls +The secured broker binary service URL (for produce and consume operations) + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: + +### configurationMetadataStoreUrl +Connection string of configuration metadata store servers + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: + +### cryptoKeyReaderFactoryClassName +CryptoKeyReader factory classname to support encryption at websocket. + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: + +### httpServerAcceptQueueSize +Capacity for accept queue in the HTTP server Default is set to 8192. + +**Type**: `int` + +**Default**: `8192` + +**Dynamic**: `false` + +**Category**: + +### httpServerThreadPoolQueueSize +Capacity for thread pool queue in the HTTP server Default is set to 8192. + +**Type**: `int` + +**Default**: `8192` + +**Dynamic**: `false` + +**Category**: + +### maxConcurrentHttpRequests +Max concurrent web requests + +**Type**: `int` + +**Default**: `1024` + +**Dynamic**: `false` + +**Category**: + +### maxHttpServerConnections +Maximum number of inbound http connections. (0 to disable limiting) + +**Type**: `int` + +**Default**: `2048` + +**Dynamic**: `false` + +**Category**: + +### metadataStoreCacheExpirySeconds +Metadata store cache expiry time in seconds. + +**Type**: `int` + +**Default**: `300` + +**Dynamic**: `false` + +**Category**: + +### metadataStoreSessionTimeoutMillis +Metadata store session timeout in milliseconds. + +**Type**: `long` + +**Default**: `30000` + +**Dynamic**: `false` + +**Category**: + +### numHttpServerThreads +Number of threads to used in HTTP server + +**Type**: `int` + +**Default**: `14` + +**Dynamic**: `false` + +**Category**: + +### properties +Key-value properties. Types are all String + +**Type**: `java.util.Properties` + +**Default**: `{}` + +**Dynamic**: `false` + +**Category**: + +### serviceUrl +The HTTPS REST service URL to connect to broker + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: + +### serviceUrlTls +The HTTPS REST service TLS URL + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: + +### statusFilePath +Path for the file used to determine the rotation status for the broker when responding to service discovery health checks + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: + +### superUserRoles +Role names that are treated as "super-user", which means they can do all admin operations and publish to or consume from all topics + +**Type**: `java.util.Set` + +**Default**: `[]` + +**Dynamic**: `false` + +**Category**: + +### tlsAllowInsecureConnection +Accept untrusted TLS certificate from client and broker + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: + +### tlsCertRefreshCheckDurationSec +TLS cert refresh duration (in seconds). 0 means checking every new connection. + +**Type**: `long` + +**Default**: `300` + +**Dynamic**: `false` + +**Category**: + +### tlsCertificateFilePath +Path for the TLS certificate file + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: + +### tlsEnabledWithKeyStore +Enable TLS with KeyStore type configuration for WebSocket + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: + +### tlsHostnameVerificationEnabled +Enable TLS hostname verification when connecting to broker + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: + +### tlsKeyFilePath +Path for the TLS private key file + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: + +### tlsKeyStore +TLS KeyStore path in WebSocket + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: + +### tlsKeyStorePassword +TLS KeyStore password for WebSocket + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: + +### tlsKeyStoreType +TLS KeyStore type configuration in WebSocket: JKS, PKCS12 + +**Type**: `java.lang.String` + +**Default**: `JKS` + +**Dynamic**: `false` + +**Category**: + +### tlsProvider +Specify the TLS provider for the WebSocket service: SunJSSE, Conscrypt and etc. + +**Type**: `java.lang.String` + +**Default**: `Conscrypt` + +**Dynamic**: `false` + +**Category**: + +### tlsRequireTrustedClientCertOnConnect +Specify whether client certificates are required for TLS rejecting the connection if the client certificate is not trusted + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: + +### tlsTrustCertsFilePath +Path for the trusted TLS certificate file + +**Type**: `java.lang.String` + +**Default**: `` + +**Dynamic**: `false` + +**Category**: + +### tlsTrustStore +TLS TrustStore path in WebSocket + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: + +### tlsTrustStorePassword +TLS TrustStore password for WebSocket, null means empty password. + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: + +### tlsTrustStoreType +TLS TrustStore type configuration in WebSocket: JKS, PKCS12 + +**Type**: `java.lang.String` + +**Default**: `JKS` + +**Dynamic**: `false` + +**Category**: + +### webServiceHaProxyProtocolEnabled +Enable or disable the use of HA proxy protocol for resolving the client IP for http/https requests. Default is false. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: + +### webServiceLogDetailedAddresses +Add detailed client/remote and server/local addresses and ports to http/https request logging. +Defaults to true when either webServiceHaProxyProtocolEnabled or webServiceTrustXForwardedFor is enabled. + +**Type**: `java.lang.Boolean` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: + +### webServicePort +Port to use to server HTTP request + +**Type**: `java.util.Optional` + +**Default**: `Optional[8080]` + +**Dynamic**: `false` + +**Category**: + +### webServicePortTls +Port to use to server HTTPS request + +**Type**: `java.util.Optional` + +**Default**: `Optional.empty` + +**Dynamic**: `false` + +**Category**: + +### webServiceTlsCiphers +Specify the tls cipher the proxy's web service will use to negotiate during TLS Handshake. + +Example:- [TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256] + +**Type**: `java.util.Set` + +**Default**: `[]` + +**Dynamic**: `false` + +**Category**: + +### webServiceTlsProtocols +Specify the tls protocols the proxy's web service will use to negotiate during TLS Handshake. + +Example:- [TLSv1.3, TLSv1.2] + +**Type**: `java.util.Set` + +**Default**: `[]` + +**Dynamic**: `false` + +**Category**: + +### webServiceTrustXForwardedFor +Trust X-Forwarded-For header for resolving the client IP for http/https requests. +Default is false. + +**Type**: `boolean` + +**Default**: `false` + +**Dynamic**: `false` + +**Category**: + +### webSocketConnectionsPerBroker +Number of connections per broker in Pulsar client used in WebSocket proxy + +**Type**: `int` + +**Default**: `14` + +**Dynamic**: `false` + +**Category**: + +### webSocketMaxTextFrameSize +Maximum size of a text message during parsing in WebSocket proxy + +**Type**: `int` + +**Default**: `1048576` + +**Dynamic**: `false` + +**Category**: + +### webSocketNumIoThreads +Number of IO threads in Pulsar client used in WebSocket proxy + +**Type**: `int` + +**Default**: `14` + +**Dynamic**: `false` + +**Category**: + +### webSocketNumServiceThreads +Number of threads used by Websocket service + +**Type**: `int` + +**Default**: `20` + +**Dynamic**: `false` + +**Category**: + +### webSocketPingDurationSeconds +Interval of time to sending the ping to keep alive. This value greater than 0 means enabled + +**Type**: `int` + +**Default**: `-1` + +**Dynamic**: `false` + +**Category**: + +### webSocketPulsarClientMemoryLimitInMB +Memory limit in MBs for direct memory in Pulsar Client used in WebSocket proxy + +**Type**: `int` + +**Default**: `0` + +**Dynamic**: `false` + +**Category**: + +### webSocketSessionIdleTimeoutMillis +Timeout of idling WebSocket session (in milliseconds) + +**Type**: `int` + +**Default**: `300000` + +**Dynamic**: `false` + +**Category**: + +## Deprecated +### configurationStoreServers +Configuration store connection string (as a comma-separated list). Deprecated in favor of `configurationMetadataStoreUrl` + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: + +### globalZookeeperServers +Configuration Store connection string + +**Type**: `java.lang.String` + +**Default**: `null` + +**Dynamic**: `false` + +**Category**: + +### zooKeeperCacheExpirySeconds +ZooKeeper cache expiry time in seconds. @deprecated - Use metadataStoreCacheExpirySeconds instead. + +**Type**: `int` + +**Default**: `-1` + +**Dynamic**: `false` + +**Category**: + +### zooKeeperSessionTimeoutMillis +ZooKeeper session timeout in milliseconds. @deprecated - Use metadataStoreSessionTimeoutMillis instead. + +**Type**: `long` + +**Default**: `-1` + +**Dynamic**: `false` + +**Category**: + + diff --git a/static/reference/4.0.x/config/reference-configuration-zookeeper.md b/static/reference/4.0.x/config/reference-configuration-zookeeper.md new file mode 100644 index 000000000000..0e4b6b43f54e --- /dev/null +++ b/static/reference/4.0.x/config/reference-configuration-zookeeper.md @@ -0,0 +1,83 @@ +# ZooKeeper + +ZooKeeper handles a broad range of essential configuration- and coordination-related tasks for Pulsar. The default configuration file for ZooKeeper is in the `conf/zookeeper.conf` file in your Pulsar installation. The following parameters are available: + +### tickTime + +The tick is the basic unit of time in ZooKeeper, measured in milliseconds and used to regulate things like heartbeats and timeouts. tickTime is the length of a single tick. + +**Default**: 2000 + +### initLimit + +The maximum time, in ticks, that the leader ZooKeeper server allows follower ZooKeeper servers to successfully connect and sync. The tick time is set in milliseconds using the tickTime parameter. + +**Default**: 10 + +### syncLimit + +The maximum time, in ticks, that a follower ZooKeeper server is allowed to sync with other ZooKeeper servers. The tick time is set in milliseconds using the tickTime parameter. + +**Default**: 5 + +### dataDir + +The location where ZooKeeper will store in-memory database snapshots as well as the transaction log of updates to the database. + +**Default**: data/zookeeper + +### clientPort + +The port on which the ZooKeeper server will listen for connections. + +**Default**: 2181 + +### admin.enableServer + +The port at which the admin listens. + +**Default**: true + +### admin.serverPort + +The port at which the admin listens. + +**Default**: 9990 + +### autopurge.snapRetainCount + +In ZooKeeper, auto purge determines how many recent snapshots of the database stored in dataDir to retain within the time interval specified by autopurge.purgeInterval (while deleting the rest). + +**Default**: 3 + +### autopurge.purgeInterval + +The time interval, in hours, by which the ZooKeeper database purge task is triggered. Setting to a non-zero number will enable auto purge; setting to 0 will disable. Read this guide before enabling auto purge. + +**Default**: 1 + +### forceSync + +Requires updates to be synced to media of the transaction log before finishing processing the update. If this option is set to 'no', ZooKeeper will not require updates to be synced to the media. WARNING: it's not recommended to run a production ZK cluster with `forceSync` disabled. + +**Default**: yes + +### maxClientCnxns + +The maximum number of client connections. Increase this if you need to handle more ZooKeeper clients. + +**Default**: 60 + +--- + +In addition to the parameters above, configuring ZooKeeper for Pulsar involves adding a `server.N` line to the `conf/zookeeper.conf` file for each node in the ZooKeeper cluster, where `N` is the number of the ZooKeeper node. Here's an example of a three-node ZooKeeper cluster: + +```properties + +server.1=zk1.us-west.example.com:2888:3888 +server.2=zk2.us-west.example.com:2888:3888 +server.3=zk3.us-west.example.com:2888:3888 + +``` + +> We strongly recommend consulting the [ZooKeeper Administrator's Guide](https://zookeeper.apache.org/doc/current/zookeeperAdmin.html) for a more thorough and comprehensive introduction to ZooKeeper configuration diff --git a/static/reference/4.0.x/pulsar-admin/README.md b/static/reference/4.0.x/pulsar-admin/README.md new file mode 100644 index 000000000000..63a4c92b5ad8 --- /dev/null +++ b/static/reference/4.0.x/pulsar-admin/README.md @@ -0,0 +1,16 @@ +`pulsar-admin` is a tool used to administer Pulsar entities. + +## Environment variables + +You can use the following environment variables to configure `pulsar-admin`. + +| Variable | Description | Default | +|--------------------------|------------------------------------|------------------| +| `PULSAR_LOG_CONF` | Log4j configuration file | conf/log4j2.yaml | +| `PULSAR_CLIENT_CONF` | Configuration file for the client | conf/client.conf | +| `PULSAR_EXTRA_OPTS` | Extra options passed to the JVM | N/A | +| `PULSAR_EXTRA_CLASSPATH` | Extra paths for Pulsar's classpath | N/A | + +## Related topics + +- [Pulsar admin API](docs/admin-api-overview) diff --git a/static/reference/4.0.x/pulsar-admin/bookies.md b/static/reference/4.0.x/pulsar-admin/bookies.md new file mode 100644 index 000000000000..4b1363207f79 --- /dev/null +++ b/static/reference/4.0.x/pulsar-admin/bookies.md @@ -0,0 +1,320 @@ +# bookies + +Operations about bookies rack placement + + +```shell +$ pulsar-admin bookies subcommand +``` + + + +## racks-placement + +Gets the rack placement information for all the bookies in the cluster + +**Command:** + +```shell +$ pulsar-admin bookies racks-placement options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# bookies + +Operations about bookies rack placement + + +```shell +$ pulsar-admin bookies subcommand +``` + + + +## racks-placement + +Gets the rack placement information for all the bookies in the cluster + +**Command:** + +```shell +$ pulsar-admin bookies racks-placement options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-bookies + +List bookies + +**Command:** + +```shell +$ pulsar-admin bookies list-bookies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# bookies + +Operations about bookies rack placement + + +```shell +$ pulsar-admin bookies subcommand +``` + + + +## racks-placement + +Gets the rack placement information for all the bookies in the cluster + +**Command:** + +```shell +$ pulsar-admin bookies racks-placement options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-bookies + +List bookies + +**Command:** + +```shell +$ pulsar-admin bookies list-bookies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-rack + +Gets the rack placement information for a specific bookie in the cluster + +**Command:** + +```shell +$ pulsar-admin bookies get-bookie-rack options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# bookies + +Operations about bookies rack placement + + +```shell +$ pulsar-admin bookies subcommand +``` + + + +## racks-placement + +Gets the rack placement information for all the bookies in the cluster + +**Command:** + +```shell +$ pulsar-admin bookies racks-placement options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-bookies + +List bookies + +**Command:** + +```shell +$ pulsar-admin bookies list-bookies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-rack + +Gets the rack placement information for a specific bookie in the cluster + +**Command:** + +```shell +$ pulsar-admin bookies get-bookie-rack options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-rack + +Remove rack placement information for a specific bookie in the cluster + +**Command:** + +```shell +$ pulsar-admin bookies delete-bookie-rack options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# bookies + +Operations about bookies rack placement + + +```shell +$ pulsar-admin bookies subcommand +``` + + + +## racks-placement + +Gets the rack placement information for all the bookies in the cluster + +**Command:** + +```shell +$ pulsar-admin bookies racks-placement options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-bookies + +List bookies + +**Command:** + +```shell +$ pulsar-admin bookies list-bookies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-rack + +Gets the rack placement information for a specific bookie in the cluster + +**Command:** + +```shell +$ pulsar-admin bookies get-bookie-rack options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-rack + +Remove rack placement information for a specific bookie in the cluster + +**Command:** + +```shell +$ pulsar-admin bookies delete-bookie-rack options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-rack + +Updates the rack placement information for a specific bookie in the cluster (note. bookie address format:`address:port`) + +**Command:** + +```shell +$ pulsar-admin bookies set-bookie-rack options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + diff --git a/static/reference/4.0.x/pulsar-admin/broker-stats.md b/static/reference/4.0.x/pulsar-admin/broker-stats.md new file mode 100644 index 000000000000..b3048d46fc74 --- /dev/null +++ b/static/reference/4.0.x/pulsar-admin/broker-stats.md @@ -0,0 +1,438 @@ +# broker-stats + +Operations to collect broker statistics + + +```shell +$ pulsar-admin broker-stats subcommand +``` + + + +## monitoring-metrics + +dump metrics for Monitoring + +**Command:** + +```shell +$ pulsar-admin broker-stats monitoring-metrics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# broker-stats + +Operations to collect broker statistics + + +```shell +$ pulsar-admin broker-stats subcommand +``` + + + +## monitoring-metrics + +dump metrics for Monitoring + +**Command:** + +```shell +$ pulsar-admin broker-stats monitoring-metrics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## mbeans + +dump mbean stats + +**Command:** + +```shell +$ pulsar-admin broker-stats mbeans options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# broker-stats + +Operations to collect broker statistics + + +```shell +$ pulsar-admin broker-stats subcommand +``` + + + +## monitoring-metrics + +dump metrics for Monitoring + +**Command:** + +```shell +$ pulsar-admin broker-stats monitoring-metrics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## mbeans + +dump mbean stats + +**Command:** + +```shell +$ pulsar-admin broker-stats mbeans options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +dump topics stats + +**Command:** + +```shell +$ pulsar-admin broker-stats topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# broker-stats + +Operations to collect broker statistics + + +```shell +$ pulsar-admin broker-stats subcommand +``` + + + +## monitoring-metrics + +dump metrics for Monitoring + +**Command:** + +```shell +$ pulsar-admin broker-stats monitoring-metrics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## mbeans + +dump mbean stats + +**Command:** + +```shell +$ pulsar-admin broker-stats mbeans options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +dump topics stats + +**Command:** + +```shell +$ pulsar-admin broker-stats topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +dump topics stats + +**Command:** + +```shell +$ pulsar-admin broker-stats destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# broker-stats + +Operations to collect broker statistics + + +```shell +$ pulsar-admin broker-stats subcommand +``` + + + +## monitoring-metrics + +dump metrics for Monitoring + +**Command:** + +```shell +$ pulsar-admin broker-stats monitoring-metrics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## mbeans + +dump mbean stats + +**Command:** + +```shell +$ pulsar-admin broker-stats mbeans options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +dump topics stats + +**Command:** + +```shell +$ pulsar-admin broker-stats topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +dump topics stats + +**Command:** + +```shell +$ pulsar-admin broker-stats destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## allocator-stats + +dump allocator stats + +**Command:** + +```shell +$ pulsar-admin broker-stats allocator-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# broker-stats + +Operations to collect broker statistics + + +```shell +$ pulsar-admin broker-stats subcommand +``` + + + +## monitoring-metrics + +dump metrics for Monitoring + +**Command:** + +```shell +$ pulsar-admin broker-stats monitoring-metrics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## mbeans + +dump mbean stats + +**Command:** + +```shell +$ pulsar-admin broker-stats mbeans options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +dump topics stats + +**Command:** + +```shell +$ pulsar-admin broker-stats topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +dump topics stats + +**Command:** + +```shell +$ pulsar-admin broker-stats destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## allocator-stats + +dump allocator stats + +**Command:** + +```shell +$ pulsar-admin broker-stats allocator-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## load-report + +dump broker load-report + +**Command:** + +```shell +$ pulsar-admin broker-stats load-report options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + diff --git a/static/reference/4.0.x/pulsar-admin/brokers.md b/static/reference/4.0.x/pulsar-admin/brokers.md new file mode 100644 index 000000000000..4243d950a76f --- /dev/null +++ b/static/reference/4.0.x/pulsar-admin/brokers.md @@ -0,0 +1,1768 @@ +# brokers + +Operations about brokers + + +```shell +$ pulsar-admin brokers subcommand +``` + + + +## list + +List active brokers of the cluster + +**Command:** + +```shell +$ pulsar-admin brokers list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# brokers + +Operations about brokers + + +```shell +$ pulsar-admin brokers subcommand +``` + + + +## list + +List active brokers of the cluster + +**Command:** + +```shell +$ pulsar-admin brokers list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## leader-broker + +Get the information of the leader broker + +**Command:** + +```shell +$ pulsar-admin brokers leader-broker options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# brokers + +Operations about brokers + + +```shell +$ pulsar-admin brokers subcommand +``` + + + +## list + +List active brokers of the cluster + +**Command:** + +```shell +$ pulsar-admin brokers list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## leader-broker + +Get the information of the leader broker + +**Command:** + +```shell +$ pulsar-admin brokers leader-broker options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## namespaces + +List namespaces owned by the broker + +**Command:** + +```shell +$ pulsar-admin brokers namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# brokers + +Operations about brokers + + +```shell +$ pulsar-admin brokers subcommand +``` + + + +## list + +List active brokers of the cluster + +**Command:** + +```shell +$ pulsar-admin brokers list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## leader-broker + +Get the information of the leader broker + +**Command:** + +```shell +$ pulsar-admin brokers leader-broker options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## namespaces + +List namespaces owned by the broker + +**Command:** + +```shell +$ pulsar-admin brokers namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-dynamic-config + +Update dynamic-serviceConfiguration of broker + +**Command:** + +```shell +$ pulsar-admin brokers update-dynamic-config options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# brokers + +Operations about brokers + + +```shell +$ pulsar-admin brokers subcommand +``` + + + +## list + +List active brokers of the cluster + +**Command:** + +```shell +$ pulsar-admin brokers list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## leader-broker + +Get the information of the leader broker + +**Command:** + +```shell +$ pulsar-admin brokers leader-broker options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## namespaces + +List namespaces owned by the broker + +**Command:** + +```shell +$ pulsar-admin brokers namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-dynamic-config + +Update dynamic-serviceConfiguration of broker + +**Command:** + +```shell +$ pulsar-admin brokers update-dynamic-config options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-dynamic-config + +Delete dynamic-serviceConfiguration of broker + +**Command:** + +```shell +$ pulsar-admin brokers delete-dynamic-config options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# brokers + +Operations about brokers + + +```shell +$ pulsar-admin brokers subcommand +``` + + + +## list + +List active brokers of the cluster + +**Command:** + +```shell +$ pulsar-admin brokers list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## leader-broker + +Get the information of the leader broker + +**Command:** + +```shell +$ pulsar-admin brokers leader-broker options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## namespaces + +List namespaces owned by the broker + +**Command:** + +```shell +$ pulsar-admin brokers namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-dynamic-config + +Update dynamic-serviceConfiguration of broker + +**Command:** + +```shell +$ pulsar-admin brokers update-dynamic-config options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-dynamic-config + +Delete dynamic-serviceConfiguration of broker + +**Command:** + +```shell +$ pulsar-admin brokers delete-dynamic-config options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-dynamic-config + +Get list of updatable configuration name + +**Command:** + +```shell +$ pulsar-admin brokers list-dynamic-config options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# brokers + +Operations about brokers + + +```shell +$ pulsar-admin brokers subcommand +``` + + + +## list + +List active brokers of the cluster + +**Command:** + +```shell +$ pulsar-admin brokers list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## leader-broker + +Get the information of the leader broker + +**Command:** + +```shell +$ pulsar-admin brokers leader-broker options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## namespaces + +List namespaces owned by the broker + +**Command:** + +```shell +$ pulsar-admin brokers namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-dynamic-config + +Update dynamic-serviceConfiguration of broker + +**Command:** + +```shell +$ pulsar-admin brokers update-dynamic-config options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-dynamic-config + +Delete dynamic-serviceConfiguration of broker + +**Command:** + +```shell +$ pulsar-admin brokers delete-dynamic-config options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-dynamic-config + +Get list of updatable configuration name + +**Command:** + +```shell +$ pulsar-admin brokers list-dynamic-config options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-all-dynamic-config + +Get all overridden dynamic-configuration values + +**Command:** + +```shell +$ pulsar-admin brokers get-all-dynamic-config options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# brokers + +Operations about brokers + + +```shell +$ pulsar-admin brokers subcommand +``` + + + +## list + +List active brokers of the cluster + +**Command:** + +```shell +$ pulsar-admin brokers list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## leader-broker + +Get the information of the leader broker + +**Command:** + +```shell +$ pulsar-admin brokers leader-broker options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## namespaces + +List namespaces owned by the broker + +**Command:** + +```shell +$ pulsar-admin brokers namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-dynamic-config + +Update dynamic-serviceConfiguration of broker + +**Command:** + +```shell +$ pulsar-admin brokers update-dynamic-config options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-dynamic-config + +Delete dynamic-serviceConfiguration of broker + +**Command:** + +```shell +$ pulsar-admin brokers delete-dynamic-config options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-dynamic-config + +Get list of updatable configuration name + +**Command:** + +```shell +$ pulsar-admin brokers list-dynamic-config options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-all-dynamic-config + +Get all overridden dynamic-configuration values + +**Command:** + +```shell +$ pulsar-admin brokers get-all-dynamic-config options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-internal-config + +Get internal configuration information + +**Command:** + +```shell +$ pulsar-admin brokers get-internal-config options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# brokers + +Operations about brokers + + +```shell +$ pulsar-admin brokers subcommand +``` + + + +## list + +List active brokers of the cluster + +**Command:** + +```shell +$ pulsar-admin brokers list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## leader-broker + +Get the information of the leader broker + +**Command:** + +```shell +$ pulsar-admin brokers leader-broker options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## namespaces + +List namespaces owned by the broker + +**Command:** + +```shell +$ pulsar-admin brokers namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-dynamic-config + +Update dynamic-serviceConfiguration of broker + +**Command:** + +```shell +$ pulsar-admin brokers update-dynamic-config options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-dynamic-config + +Delete dynamic-serviceConfiguration of broker + +**Command:** + +```shell +$ pulsar-admin brokers delete-dynamic-config options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-dynamic-config + +Get list of updatable configuration name + +**Command:** + +```shell +$ pulsar-admin brokers list-dynamic-config options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-all-dynamic-config + +Get all overridden dynamic-configuration values + +**Command:** + +```shell +$ pulsar-admin brokers get-all-dynamic-config options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-internal-config + +Get internal configuration information + +**Command:** + +```shell +$ pulsar-admin brokers get-internal-config options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-runtime-config + +Get runtime configuration values + +**Command:** + +```shell +$ pulsar-admin brokers get-runtime-config options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# brokers + +Operations about brokers + + +```shell +$ pulsar-admin brokers subcommand +``` + + + +## list + +List active brokers of the cluster + +**Command:** + +```shell +$ pulsar-admin brokers list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## leader-broker + +Get the information of the leader broker + +**Command:** + +```shell +$ pulsar-admin brokers leader-broker options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## namespaces + +List namespaces owned by the broker + +**Command:** + +```shell +$ pulsar-admin brokers namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-dynamic-config + +Update dynamic-serviceConfiguration of broker + +**Command:** + +```shell +$ pulsar-admin brokers update-dynamic-config options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-dynamic-config + +Delete dynamic-serviceConfiguration of broker + +**Command:** + +```shell +$ pulsar-admin brokers delete-dynamic-config options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-dynamic-config + +Get list of updatable configuration name + +**Command:** + +```shell +$ pulsar-admin brokers list-dynamic-config options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-all-dynamic-config + +Get all overridden dynamic-configuration values + +**Command:** + +```shell +$ pulsar-admin brokers get-all-dynamic-config options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-internal-config + +Get internal configuration information + +**Command:** + +```shell +$ pulsar-admin brokers get-internal-config options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-runtime-config + +Get runtime configuration values + +**Command:** + +```shell +$ pulsar-admin brokers get-runtime-config options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## healthcheck + +Run a health check against the broker + +**Command:** + +```shell +$ pulsar-admin brokers healthcheck options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# brokers + +Operations about brokers + + +```shell +$ pulsar-admin brokers subcommand +``` + + + +## list + +List active brokers of the cluster + +**Command:** + +```shell +$ pulsar-admin brokers list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## leader-broker + +Get the information of the leader broker + +**Command:** + +```shell +$ pulsar-admin brokers leader-broker options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## namespaces + +List namespaces owned by the broker + +**Command:** + +```shell +$ pulsar-admin brokers namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-dynamic-config + +Update dynamic-serviceConfiguration of broker + +**Command:** + +```shell +$ pulsar-admin brokers update-dynamic-config options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-dynamic-config + +Delete dynamic-serviceConfiguration of broker + +**Command:** + +```shell +$ pulsar-admin brokers delete-dynamic-config options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-dynamic-config + +Get list of updatable configuration name + +**Command:** + +```shell +$ pulsar-admin brokers list-dynamic-config options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-all-dynamic-config + +Get all overridden dynamic-configuration values + +**Command:** + +```shell +$ pulsar-admin brokers get-all-dynamic-config options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-internal-config + +Get internal configuration information + +**Command:** + +```shell +$ pulsar-admin brokers get-internal-config options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-runtime-config + +Get runtime configuration values + +**Command:** + +```shell +$ pulsar-admin brokers get-runtime-config options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## healthcheck + +Run a health check against the broker + +**Command:** + +```shell +$ pulsar-admin brokers healthcheck options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## backlog-quota-check + +Manually trigger backlogQuotaCheck + +**Command:** + +```shell +$ pulsar-admin brokers backlog-quota-check options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# brokers + +Operations about brokers + + +```shell +$ pulsar-admin brokers subcommand +``` + + + +## list + +List active brokers of the cluster + +**Command:** + +```shell +$ pulsar-admin brokers list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## leader-broker + +Get the information of the leader broker + +**Command:** + +```shell +$ pulsar-admin brokers leader-broker options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## namespaces + +List namespaces owned by the broker + +**Command:** + +```shell +$ pulsar-admin brokers namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-dynamic-config + +Update dynamic-serviceConfiguration of broker + +**Command:** + +```shell +$ pulsar-admin brokers update-dynamic-config options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-dynamic-config + +Delete dynamic-serviceConfiguration of broker + +**Command:** + +```shell +$ pulsar-admin brokers delete-dynamic-config options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-dynamic-config + +Get list of updatable configuration name + +**Command:** + +```shell +$ pulsar-admin brokers list-dynamic-config options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-all-dynamic-config + +Get all overridden dynamic-configuration values + +**Command:** + +```shell +$ pulsar-admin brokers get-all-dynamic-config options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-internal-config + +Get internal configuration information + +**Command:** + +```shell +$ pulsar-admin brokers get-internal-config options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-runtime-config + +Get runtime configuration values + +**Command:** + +```shell +$ pulsar-admin brokers get-runtime-config options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## healthcheck + +Run a health check against the broker + +**Command:** + +```shell +$ pulsar-admin brokers healthcheck options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## backlog-quota-check + +Manually trigger backlogQuotaCheck + +**Command:** + +```shell +$ pulsar-admin brokers backlog-quota-check options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## version + +Get the version of the currently connected broker + +**Command:** + +```shell +$ pulsar-admin brokers version options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# brokers + +Operations about brokers + + +```shell +$ pulsar-admin brokers subcommand +``` + + + +## list + +List active brokers of the cluster + +**Command:** + +```shell +$ pulsar-admin brokers list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## leader-broker + +Get the information of the leader broker + +**Command:** + +```shell +$ pulsar-admin brokers leader-broker options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## namespaces + +List namespaces owned by the broker + +**Command:** + +```shell +$ pulsar-admin brokers namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-dynamic-config + +Update dynamic-serviceConfiguration of broker + +**Command:** + +```shell +$ pulsar-admin brokers update-dynamic-config options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-dynamic-config + +Delete dynamic-serviceConfiguration of broker + +**Command:** + +```shell +$ pulsar-admin brokers delete-dynamic-config options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-dynamic-config + +Get list of updatable configuration name + +**Command:** + +```shell +$ pulsar-admin brokers list-dynamic-config options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-all-dynamic-config + +Get all overridden dynamic-configuration values + +**Command:** + +```shell +$ pulsar-admin brokers get-all-dynamic-config options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-internal-config + +Get internal configuration information + +**Command:** + +```shell +$ pulsar-admin brokers get-internal-config options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-runtime-config + +Get runtime configuration values + +**Command:** + +```shell +$ pulsar-admin brokers get-runtime-config options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## healthcheck + +Run a health check against the broker + +**Command:** + +```shell +$ pulsar-admin brokers healthcheck options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## backlog-quota-check + +Manually trigger backlogQuotaCheck + +**Command:** + +```shell +$ pulsar-admin brokers backlog-quota-check options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## version + +Get the version of the currently connected broker + +**Command:** + +```shell +$ pulsar-admin brokers version options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## shutdown + +Shutdown broker gracefully. + +**Command:** + +```shell +$ pulsar-admin brokers shutdown options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + diff --git a/static/reference/4.0.x/pulsar-admin/clusters.md b/static/reference/4.0.x/pulsar-admin/clusters.md new file mode 100644 index 000000000000..f6ba1d65622b --- /dev/null +++ b/static/reference/4.0.x/pulsar-admin/clusters.md @@ -0,0 +1,2030 @@ +# clusters + +Operations about clusters + + +```shell +$ pulsar-admin clusters subcommand +``` + + + +## get + +Get the configuration data for the specified cluster + +**Command:** + +```shell +$ pulsar-admin clusters get options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# clusters + +Operations about clusters + + +```shell +$ pulsar-admin clusters subcommand +``` + + + +## get + +Get the configuration data for the specified cluster + +**Command:** + +```shell +$ pulsar-admin clusters get options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Provisions a new cluster. This operation requires Pulsar super-user privileges + +**Command:** + +```shell +$ pulsar-admin clusters create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# clusters + +Operations about clusters + + +```shell +$ pulsar-admin clusters subcommand +``` + + + +## get + +Get the configuration data for the specified cluster + +**Command:** + +```shell +$ pulsar-admin clusters get options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Provisions a new cluster. This operation requires Pulsar super-user privileges + +**Command:** + +```shell +$ pulsar-admin clusters create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update + +Update the configuration for a cluster + +**Command:** + +```shell +$ pulsar-admin clusters update options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# clusters + +Operations about clusters + + +```shell +$ pulsar-admin clusters subcommand +``` + + + +## get + +Get the configuration data for the specified cluster + +**Command:** + +```shell +$ pulsar-admin clusters get options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Provisions a new cluster. This operation requires Pulsar super-user privileges + +**Command:** + +```shell +$ pulsar-admin clusters create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update + +Update the configuration for a cluster + +**Command:** + +```shell +$ pulsar-admin clusters update options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes an existing cluster + +**Command:** + +```shell +$ pulsar-admin clusters delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# clusters + +Operations about clusters + + +```shell +$ pulsar-admin clusters subcommand +``` + + + +## get + +Get the configuration data for the specified cluster + +**Command:** + +```shell +$ pulsar-admin clusters get options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Provisions a new cluster. This operation requires Pulsar super-user privileges + +**Command:** + +```shell +$ pulsar-admin clusters create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update + +Update the configuration for a cluster + +**Command:** + +```shell +$ pulsar-admin clusters update options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes an existing cluster + +**Command:** + +```shell +$ pulsar-admin clusters delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list + +List the existing clusters + +**Command:** + +```shell +$ pulsar-admin clusters list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# clusters + +Operations about clusters + + +```shell +$ pulsar-admin clusters subcommand +``` + + + +## get + +Get the configuration data for the specified cluster + +**Command:** + +```shell +$ pulsar-admin clusters get options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Provisions a new cluster. This operation requires Pulsar super-user privileges + +**Command:** + +```shell +$ pulsar-admin clusters create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update + +Update the configuration for a cluster + +**Command:** + +```shell +$ pulsar-admin clusters update options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes an existing cluster + +**Command:** + +```shell +$ pulsar-admin clusters delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list + +List the existing clusters + +**Command:** + +```shell +$ pulsar-admin clusters list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-peer-clusters + +Update peer cluster names + +**Command:** + +```shell +$ pulsar-admin clusters update-peer-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# clusters + +Operations about clusters + + +```shell +$ pulsar-admin clusters subcommand +``` + + + +## get + +Get the configuration data for the specified cluster + +**Command:** + +```shell +$ pulsar-admin clusters get options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Provisions a new cluster. This operation requires Pulsar super-user privileges + +**Command:** + +```shell +$ pulsar-admin clusters create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update + +Update the configuration for a cluster + +**Command:** + +```shell +$ pulsar-admin clusters update options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes an existing cluster + +**Command:** + +```shell +$ pulsar-admin clusters delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list + +List the existing clusters + +**Command:** + +```shell +$ pulsar-admin clusters list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-peer-clusters + +Update peer cluster names + +**Command:** + +```shell +$ pulsar-admin clusters update-peer-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-cluster-migration + +Get the cluster migration configuration data for the specified cluster + +**Command:** + +```shell +$ pulsar-admin clusters get-cluster-migration options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# clusters + +Operations about clusters + + +```shell +$ pulsar-admin clusters subcommand +``` + + + +## get + +Get the configuration data for the specified cluster + +**Command:** + +```shell +$ pulsar-admin clusters get options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Provisions a new cluster. This operation requires Pulsar super-user privileges + +**Command:** + +```shell +$ pulsar-admin clusters create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update + +Update the configuration for a cluster + +**Command:** + +```shell +$ pulsar-admin clusters update options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes an existing cluster + +**Command:** + +```shell +$ pulsar-admin clusters delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list + +List the existing clusters + +**Command:** + +```shell +$ pulsar-admin clusters list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-peer-clusters + +Update peer cluster names + +**Command:** + +```shell +$ pulsar-admin clusters update-peer-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-cluster-migration + +Get the cluster migration configuration data for the specified cluster + +**Command:** + +```shell +$ pulsar-admin clusters get-cluster-migration options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-cluster-migration + +Update cluster migration + +**Command:** + +```shell +$ pulsar-admin clusters update-cluster-migration options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# clusters + +Operations about clusters + + +```shell +$ pulsar-admin clusters subcommand +``` + + + +## get + +Get the configuration data for the specified cluster + +**Command:** + +```shell +$ pulsar-admin clusters get options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Provisions a new cluster. This operation requires Pulsar super-user privileges + +**Command:** + +```shell +$ pulsar-admin clusters create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update + +Update the configuration for a cluster + +**Command:** + +```shell +$ pulsar-admin clusters update options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes an existing cluster + +**Command:** + +```shell +$ pulsar-admin clusters delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list + +List the existing clusters + +**Command:** + +```shell +$ pulsar-admin clusters list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-peer-clusters + +Update peer cluster names + +**Command:** + +```shell +$ pulsar-admin clusters update-peer-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-cluster-migration + +Get the cluster migration configuration data for the specified cluster + +**Command:** + +```shell +$ pulsar-admin clusters get-cluster-migration options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-cluster-migration + +Update cluster migration + +**Command:** + +```shell +$ pulsar-admin clusters update-cluster-migration options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-peer-clusters + +Get list of peer-clusters + +**Command:** + +```shell +$ pulsar-admin clusters get-peer-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# clusters + +Operations about clusters + + +```shell +$ pulsar-admin clusters subcommand +``` + + + +## get + +Get the configuration data for the specified cluster + +**Command:** + +```shell +$ pulsar-admin clusters get options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Provisions a new cluster. This operation requires Pulsar super-user privileges + +**Command:** + +```shell +$ pulsar-admin clusters create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update + +Update the configuration for a cluster + +**Command:** + +```shell +$ pulsar-admin clusters update options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes an existing cluster + +**Command:** + +```shell +$ pulsar-admin clusters delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list + +List the existing clusters + +**Command:** + +```shell +$ pulsar-admin clusters list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-peer-clusters + +Update peer cluster names + +**Command:** + +```shell +$ pulsar-admin clusters update-peer-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-cluster-migration + +Get the cluster migration configuration data for the specified cluster + +**Command:** + +```shell +$ pulsar-admin clusters get-cluster-migration options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-cluster-migration + +Update cluster migration + +**Command:** + +```shell +$ pulsar-admin clusters update-cluster-migration options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-peer-clusters + +Get list of peer-clusters + +**Command:** + +```shell +$ pulsar-admin clusters get-peer-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-failure-domain + +Get the configuration brokers of a failure-domain + +**Command:** + +```shell +$ pulsar-admin clusters get-failure-domain options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# clusters + +Operations about clusters + + +```shell +$ pulsar-admin clusters subcommand +``` + + + +## get + +Get the configuration data for the specified cluster + +**Command:** + +```shell +$ pulsar-admin clusters get options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Provisions a new cluster. This operation requires Pulsar super-user privileges + +**Command:** + +```shell +$ pulsar-admin clusters create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update + +Update the configuration for a cluster + +**Command:** + +```shell +$ pulsar-admin clusters update options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes an existing cluster + +**Command:** + +```shell +$ pulsar-admin clusters delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list + +List the existing clusters + +**Command:** + +```shell +$ pulsar-admin clusters list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-peer-clusters + +Update peer cluster names + +**Command:** + +```shell +$ pulsar-admin clusters update-peer-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-cluster-migration + +Get the cluster migration configuration data for the specified cluster + +**Command:** + +```shell +$ pulsar-admin clusters get-cluster-migration options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-cluster-migration + +Update cluster migration + +**Command:** + +```shell +$ pulsar-admin clusters update-cluster-migration options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-peer-clusters + +Get list of peer-clusters + +**Command:** + +```shell +$ pulsar-admin clusters get-peer-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-failure-domain + +Get the configuration brokers of a failure-domain + +**Command:** + +```shell +$ pulsar-admin clusters get-failure-domain options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-failure-domain + +Create a new failure-domain for a cluster. updates it if already created. + +**Command:** + +```shell +$ pulsar-admin clusters create-failure-domain options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# clusters + +Operations about clusters + + +```shell +$ pulsar-admin clusters subcommand +``` + + + +## get + +Get the configuration data for the specified cluster + +**Command:** + +```shell +$ pulsar-admin clusters get options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Provisions a new cluster. This operation requires Pulsar super-user privileges + +**Command:** + +```shell +$ pulsar-admin clusters create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update + +Update the configuration for a cluster + +**Command:** + +```shell +$ pulsar-admin clusters update options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes an existing cluster + +**Command:** + +```shell +$ pulsar-admin clusters delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list + +List the existing clusters + +**Command:** + +```shell +$ pulsar-admin clusters list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-peer-clusters + +Update peer cluster names + +**Command:** + +```shell +$ pulsar-admin clusters update-peer-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-cluster-migration + +Get the cluster migration configuration data for the specified cluster + +**Command:** + +```shell +$ pulsar-admin clusters get-cluster-migration options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-cluster-migration + +Update cluster migration + +**Command:** + +```shell +$ pulsar-admin clusters update-cluster-migration options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-peer-clusters + +Get list of peer-clusters + +**Command:** + +```shell +$ pulsar-admin clusters get-peer-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-failure-domain + +Get the configuration brokers of a failure-domain + +**Command:** + +```shell +$ pulsar-admin clusters get-failure-domain options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-failure-domain + +Create a new failure-domain for a cluster. updates it if already created. + +**Command:** + +```shell +$ pulsar-admin clusters create-failure-domain options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-failure-domain + +Update failure-domain for a cluster. Creates a new one if not exist. + +**Command:** + +```shell +$ pulsar-admin clusters update-failure-domain options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# clusters + +Operations about clusters + + +```shell +$ pulsar-admin clusters subcommand +``` + + + +## get + +Get the configuration data for the specified cluster + +**Command:** + +```shell +$ pulsar-admin clusters get options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Provisions a new cluster. This operation requires Pulsar super-user privileges + +**Command:** + +```shell +$ pulsar-admin clusters create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update + +Update the configuration for a cluster + +**Command:** + +```shell +$ pulsar-admin clusters update options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes an existing cluster + +**Command:** + +```shell +$ pulsar-admin clusters delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list + +List the existing clusters + +**Command:** + +```shell +$ pulsar-admin clusters list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-peer-clusters + +Update peer cluster names + +**Command:** + +```shell +$ pulsar-admin clusters update-peer-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-cluster-migration + +Get the cluster migration configuration data for the specified cluster + +**Command:** + +```shell +$ pulsar-admin clusters get-cluster-migration options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-cluster-migration + +Update cluster migration + +**Command:** + +```shell +$ pulsar-admin clusters update-cluster-migration options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-peer-clusters + +Get list of peer-clusters + +**Command:** + +```shell +$ pulsar-admin clusters get-peer-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-failure-domain + +Get the configuration brokers of a failure-domain + +**Command:** + +```shell +$ pulsar-admin clusters get-failure-domain options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-failure-domain + +Create a new failure-domain for a cluster. updates it if already created. + +**Command:** + +```shell +$ pulsar-admin clusters create-failure-domain options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-failure-domain + +Update failure-domain for a cluster. Creates a new one if not exist. + +**Command:** + +```shell +$ pulsar-admin clusters update-failure-domain options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-failure-domain + +Deletes an existing failure-domain + +**Command:** + +```shell +$ pulsar-admin clusters delete-failure-domain options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# clusters + +Operations about clusters + + +```shell +$ pulsar-admin clusters subcommand +``` + + + +## get + +Get the configuration data for the specified cluster + +**Command:** + +```shell +$ pulsar-admin clusters get options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Provisions a new cluster. This operation requires Pulsar super-user privileges + +**Command:** + +```shell +$ pulsar-admin clusters create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update + +Update the configuration for a cluster + +**Command:** + +```shell +$ pulsar-admin clusters update options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes an existing cluster + +**Command:** + +```shell +$ pulsar-admin clusters delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list + +List the existing clusters + +**Command:** + +```shell +$ pulsar-admin clusters list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-peer-clusters + +Update peer cluster names + +**Command:** + +```shell +$ pulsar-admin clusters update-peer-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-cluster-migration + +Get the cluster migration configuration data for the specified cluster + +**Command:** + +```shell +$ pulsar-admin clusters get-cluster-migration options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-cluster-migration + +Update cluster migration + +**Command:** + +```shell +$ pulsar-admin clusters update-cluster-migration options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-peer-clusters + +Get list of peer-clusters + +**Command:** + +```shell +$ pulsar-admin clusters get-peer-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-failure-domain + +Get the configuration brokers of a failure-domain + +**Command:** + +```shell +$ pulsar-admin clusters get-failure-domain options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-failure-domain + +Create a new failure-domain for a cluster. updates it if already created. + +**Command:** + +```shell +$ pulsar-admin clusters create-failure-domain options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-failure-domain + +Update failure-domain for a cluster. Creates a new one if not exist. + +**Command:** + +```shell +$ pulsar-admin clusters update-failure-domain options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-failure-domain + +Deletes an existing failure-domain + +**Command:** + +```shell +$ pulsar-admin clusters delete-failure-domain options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-failure-domains + +List the existing failure-domains for a cluster + +**Command:** + +```shell +$ pulsar-admin clusters list-failure-domains options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + diff --git a/static/reference/4.0.x/pulsar-admin/functions-worker.md b/static/reference/4.0.x/pulsar-admin/functions-worker.md new file mode 100644 index 000000000000..208f48682a28 --- /dev/null +++ b/static/reference/4.0.x/pulsar-admin/functions-worker.md @@ -0,0 +1,438 @@ +# functions-worker + +Operations to collect function-worker statistics + + +```shell +$ pulsar-admin functions-worker subcommand +``` + + + +## function-stats + +Dump all functions stats running on this broker + +**Command:** + +```shell +$ pulsar-admin functions-worker function-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# functions-worker + +Operations to collect function-worker statistics + + +```shell +$ pulsar-admin functions-worker subcommand +``` + + + +## function-stats + +Dump all functions stats running on this broker + +**Command:** + +```shell +$ pulsar-admin functions-worker function-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## monitoring-metrics + +Dump metrics for Monitoring + +**Command:** + +```shell +$ pulsar-admin functions-worker monitoring-metrics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# functions-worker + +Operations to collect function-worker statistics + + +```shell +$ pulsar-admin functions-worker subcommand +``` + + + +## function-stats + +Dump all functions stats running on this broker + +**Command:** + +```shell +$ pulsar-admin functions-worker function-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## monitoring-metrics + +Dump metrics for Monitoring + +**Command:** + +```shell +$ pulsar-admin functions-worker monitoring-metrics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-cluster + +Get all workers belonging to this cluster + +**Command:** + +```shell +$ pulsar-admin functions-worker get-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# functions-worker + +Operations to collect function-worker statistics + + +```shell +$ pulsar-admin functions-worker subcommand +``` + + + +## function-stats + +Dump all functions stats running on this broker + +**Command:** + +```shell +$ pulsar-admin functions-worker function-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## monitoring-metrics + +Dump metrics for Monitoring + +**Command:** + +```shell +$ pulsar-admin functions-worker monitoring-metrics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-cluster + +Get all workers belonging to this cluster + +**Command:** + +```shell +$ pulsar-admin functions-worker get-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-cluster-leader + +Get the leader of the worker cluster + +**Command:** + +```shell +$ pulsar-admin functions-worker get-cluster-leader options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# functions-worker + +Operations to collect function-worker statistics + + +```shell +$ pulsar-admin functions-worker subcommand +``` + + + +## function-stats + +Dump all functions stats running on this broker + +**Command:** + +```shell +$ pulsar-admin functions-worker function-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## monitoring-metrics + +Dump metrics for Monitoring + +**Command:** + +```shell +$ pulsar-admin functions-worker monitoring-metrics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-cluster + +Get all workers belonging to this cluster + +**Command:** + +```shell +$ pulsar-admin functions-worker get-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-cluster-leader + +Get the leader of the worker cluster + +**Command:** + +```shell +$ pulsar-admin functions-worker get-cluster-leader options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-function-assignments + +Get the assignments of the functions across the worker cluster + +**Command:** + +```shell +$ pulsar-admin functions-worker get-function-assignments options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# functions-worker + +Operations to collect function-worker statistics + + +```shell +$ pulsar-admin functions-worker subcommand +``` + + + +## function-stats + +Dump all functions stats running on this broker + +**Command:** + +```shell +$ pulsar-admin functions-worker function-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## monitoring-metrics + +Dump metrics for Monitoring + +**Command:** + +```shell +$ pulsar-admin functions-worker monitoring-metrics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-cluster + +Get all workers belonging to this cluster + +**Command:** + +```shell +$ pulsar-admin functions-worker get-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-cluster-leader + +Get the leader of the worker cluster + +**Command:** + +```shell +$ pulsar-admin functions-worker get-cluster-leader options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-function-assignments + +Get the assignments of the functions across the worker cluster + +**Command:** + +```shell +$ pulsar-admin functions-worker get-function-assignments options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## rebalance + +Triggers a rebalance of functions to workers + +**Command:** + +```shell +$ pulsar-admin functions-worker rebalance options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + diff --git a/static/reference/4.0.x/pulsar-admin/functions.md b/static/reference/4.0.x/pulsar-admin/functions.md new file mode 100644 index 000000000000..d410f5e03ee9 --- /dev/null +++ b/static/reference/4.0.x/pulsar-admin/functions.md @@ -0,0 +1,3610 @@ +# functions + +Interface for managing Pulsar Functions (lightweight, Lambda-style compute processes that work with Pulsar) + + +```shell +$ pulsar-admin functions subcommand +``` + + + +## localrun + +Run a Pulsar Function locally, rather than deploy to a Pulsar cluster) + +**Command:** + +```shell +$ pulsar-admin functions localrun options +``` + +**Options:** + +|Flag|Description|Default|Support| +|---|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# functions + +Interface for managing Pulsar Functions (lightweight, Lambda-style compute processes that work with Pulsar) + + +```shell +$ pulsar-admin functions subcommand +``` + + + +## localrun + +Run a Pulsar Function locally, rather than deploy to a Pulsar cluster) + +**Command:** + +```shell +$ pulsar-admin functions localrun options +``` + +**Options:** + +|Flag|Description|Default|Support| +|---|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a Pulsar Function in cluster mode (deploy it on a Pulsar cluster) + +**Command:** + +```shell +$ pulsar-admin functions create options +``` + +**Options:** + +|Flag|Description|Default|Support| +|---|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# functions + +Interface for managing Pulsar Functions (lightweight, Lambda-style compute processes that work with Pulsar) + + +```shell +$ pulsar-admin functions subcommand +``` + + + +## localrun + +Run a Pulsar Function locally, rather than deploy to a Pulsar cluster) + +**Command:** + +```shell +$ pulsar-admin functions localrun options +``` + +**Options:** + +|Flag|Description|Default|Support| +|---|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a Pulsar Function in cluster mode (deploy it on a Pulsar cluster) + +**Command:** + +```shell +$ pulsar-admin functions create options +``` + +**Options:** + +|Flag|Description|Default|Support| +|---|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a Pulsar Function that is running on a Pulsar cluster + +**Command:** + +```shell +$ pulsar-admin functions delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# functions + +Interface for managing Pulsar Functions (lightweight, Lambda-style compute processes that work with Pulsar) + + +```shell +$ pulsar-admin functions subcommand +``` + + + +## localrun + +Run a Pulsar Function locally, rather than deploy to a Pulsar cluster) + +**Command:** + +```shell +$ pulsar-admin functions localrun options +``` + +**Options:** + +|Flag|Description|Default|Support| +|---|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a Pulsar Function in cluster mode (deploy it on a Pulsar cluster) + +**Command:** + +```shell +$ pulsar-admin functions create options +``` + +**Options:** + +|Flag|Description|Default|Support| +|---|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a Pulsar Function that is running on a Pulsar cluster + +**Command:** + +```shell +$ pulsar-admin functions delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update + +Update a Pulsar Function that has been deployed to a Pulsar cluster + +**Command:** + +```shell +$ pulsar-admin functions update options +``` + +**Options:** + +|Flag|Description|Default|Support| +|---|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# functions + +Interface for managing Pulsar Functions (lightweight, Lambda-style compute processes that work with Pulsar) + + +```shell +$ pulsar-admin functions subcommand +``` + + + +## localrun + +Run a Pulsar Function locally, rather than deploy to a Pulsar cluster) + +**Command:** + +```shell +$ pulsar-admin functions localrun options +``` + +**Options:** + +|Flag|Description|Default|Support| +|---|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a Pulsar Function in cluster mode (deploy it on a Pulsar cluster) + +**Command:** + +```shell +$ pulsar-admin functions create options +``` + +**Options:** + +|Flag|Description|Default|Support| +|---|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a Pulsar Function that is running on a Pulsar cluster + +**Command:** + +```shell +$ pulsar-admin functions delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update + +Update a Pulsar Function that has been deployed to a Pulsar cluster + +**Command:** + +```shell +$ pulsar-admin functions update options +``` + +**Options:** + +|Flag|Description|Default|Support| +|---|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get + +Fetch information about a Pulsar Function + +**Command:** + +```shell +$ pulsar-admin functions get options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# functions + +Interface for managing Pulsar Functions (lightweight, Lambda-style compute processes that work with Pulsar) + + +```shell +$ pulsar-admin functions subcommand +``` + + + +## localrun + +Run a Pulsar Function locally, rather than deploy to a Pulsar cluster) + +**Command:** + +```shell +$ pulsar-admin functions localrun options +``` + +**Options:** + +|Flag|Description|Default|Support| +|---|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a Pulsar Function in cluster mode (deploy it on a Pulsar cluster) + +**Command:** + +```shell +$ pulsar-admin functions create options +``` + +**Options:** + +|Flag|Description|Default|Support| +|---|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a Pulsar Function that is running on a Pulsar cluster + +**Command:** + +```shell +$ pulsar-admin functions delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update + +Update a Pulsar Function that has been deployed to a Pulsar cluster + +**Command:** + +```shell +$ pulsar-admin functions update options +``` + +**Options:** + +|Flag|Description|Default|Support| +|---|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get + +Fetch information about a Pulsar Function + +**Command:** + +```shell +$ pulsar-admin functions get options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## restart + +Restart function instance + +**Command:** + +```shell +$ pulsar-admin functions restart options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# functions + +Interface for managing Pulsar Functions (lightweight, Lambda-style compute processes that work with Pulsar) + + +```shell +$ pulsar-admin functions subcommand +``` + + + +## localrun + +Run a Pulsar Function locally, rather than deploy to a Pulsar cluster) + +**Command:** + +```shell +$ pulsar-admin functions localrun options +``` + +**Options:** + +|Flag|Description|Default|Support| +|---|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a Pulsar Function in cluster mode (deploy it on a Pulsar cluster) + +**Command:** + +```shell +$ pulsar-admin functions create options +``` + +**Options:** + +|Flag|Description|Default|Support| +|---|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a Pulsar Function that is running on a Pulsar cluster + +**Command:** + +```shell +$ pulsar-admin functions delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update + +Update a Pulsar Function that has been deployed to a Pulsar cluster + +**Command:** + +```shell +$ pulsar-admin functions update options +``` + +**Options:** + +|Flag|Description|Default|Support| +|---|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get + +Fetch information about a Pulsar Function + +**Command:** + +```shell +$ pulsar-admin functions get options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## restart + +Restart function instance + +**Command:** + +```shell +$ pulsar-admin functions restart options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stop + +Stops function instance + +**Command:** + +```shell +$ pulsar-admin functions stop options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# functions + +Interface for managing Pulsar Functions (lightweight, Lambda-style compute processes that work with Pulsar) + + +```shell +$ pulsar-admin functions subcommand +``` + + + +## localrun + +Run a Pulsar Function locally, rather than deploy to a Pulsar cluster) + +**Command:** + +```shell +$ pulsar-admin functions localrun options +``` + +**Options:** + +|Flag|Description|Default|Support| +|---|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a Pulsar Function in cluster mode (deploy it on a Pulsar cluster) + +**Command:** + +```shell +$ pulsar-admin functions create options +``` + +**Options:** + +|Flag|Description|Default|Support| +|---|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a Pulsar Function that is running on a Pulsar cluster + +**Command:** + +```shell +$ pulsar-admin functions delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update + +Update a Pulsar Function that has been deployed to a Pulsar cluster + +**Command:** + +```shell +$ pulsar-admin functions update options +``` + +**Options:** + +|Flag|Description|Default|Support| +|---|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get + +Fetch information about a Pulsar Function + +**Command:** + +```shell +$ pulsar-admin functions get options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## restart + +Restart function instance + +**Command:** + +```shell +$ pulsar-admin functions restart options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stop + +Stops function instance + +**Command:** + +```shell +$ pulsar-admin functions stop options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## start + +Starts a stopped function instance + +**Command:** + +```shell +$ pulsar-admin functions start options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# functions + +Interface for managing Pulsar Functions (lightweight, Lambda-style compute processes that work with Pulsar) + + +```shell +$ pulsar-admin functions subcommand +``` + + + +## localrun + +Run a Pulsar Function locally, rather than deploy to a Pulsar cluster) + +**Command:** + +```shell +$ pulsar-admin functions localrun options +``` + +**Options:** + +|Flag|Description|Default|Support| +|---|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a Pulsar Function in cluster mode (deploy it on a Pulsar cluster) + +**Command:** + +```shell +$ pulsar-admin functions create options +``` + +**Options:** + +|Flag|Description|Default|Support| +|---|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a Pulsar Function that is running on a Pulsar cluster + +**Command:** + +```shell +$ pulsar-admin functions delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update + +Update a Pulsar Function that has been deployed to a Pulsar cluster + +**Command:** + +```shell +$ pulsar-admin functions update options +``` + +**Options:** + +|Flag|Description|Default|Support| +|---|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get + +Fetch information about a Pulsar Function + +**Command:** + +```shell +$ pulsar-admin functions get options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## restart + +Restart function instance + +**Command:** + +```shell +$ pulsar-admin functions restart options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stop + +Stops function instance + +**Command:** + +```shell +$ pulsar-admin functions stop options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## start + +Starts a stopped function instance + +**Command:** + +```shell +$ pulsar-admin functions start options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## status + +Check the current status of a Pulsar Function + +**Command:** + +```shell +$ pulsar-admin functions status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# functions + +Interface for managing Pulsar Functions (lightweight, Lambda-style compute processes that work with Pulsar) + + +```shell +$ pulsar-admin functions subcommand +``` + + + +## localrun + +Run a Pulsar Function locally, rather than deploy to a Pulsar cluster) + +**Command:** + +```shell +$ pulsar-admin functions localrun options +``` + +**Options:** + +|Flag|Description|Default|Support| +|---|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a Pulsar Function in cluster mode (deploy it on a Pulsar cluster) + +**Command:** + +```shell +$ pulsar-admin functions create options +``` + +**Options:** + +|Flag|Description|Default|Support| +|---|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a Pulsar Function that is running on a Pulsar cluster + +**Command:** + +```shell +$ pulsar-admin functions delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update + +Update a Pulsar Function that has been deployed to a Pulsar cluster + +**Command:** + +```shell +$ pulsar-admin functions update options +``` + +**Options:** + +|Flag|Description|Default|Support| +|---|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get + +Fetch information about a Pulsar Function + +**Command:** + +```shell +$ pulsar-admin functions get options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## restart + +Restart function instance + +**Command:** + +```shell +$ pulsar-admin functions restart options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stop + +Stops function instance + +**Command:** + +```shell +$ pulsar-admin functions stop options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## start + +Starts a stopped function instance + +**Command:** + +```shell +$ pulsar-admin functions start options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## status + +Check the current status of a Pulsar Function + +**Command:** + +```shell +$ pulsar-admin functions status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## getstatus + +Check the current status of a Pulsar Function + +**Command:** + +```shell +$ pulsar-admin functions getstatus options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# functions + +Interface for managing Pulsar Functions (lightweight, Lambda-style compute processes that work with Pulsar) + + +```shell +$ pulsar-admin functions subcommand +``` + + + +## localrun + +Run a Pulsar Function locally, rather than deploy to a Pulsar cluster) + +**Command:** + +```shell +$ pulsar-admin functions localrun options +``` + +**Options:** + +|Flag|Description|Default|Support| +|---|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a Pulsar Function in cluster mode (deploy it on a Pulsar cluster) + +**Command:** + +```shell +$ pulsar-admin functions create options +``` + +**Options:** + +|Flag|Description|Default|Support| +|---|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a Pulsar Function that is running on a Pulsar cluster + +**Command:** + +```shell +$ pulsar-admin functions delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update + +Update a Pulsar Function that has been deployed to a Pulsar cluster + +**Command:** + +```shell +$ pulsar-admin functions update options +``` + +**Options:** + +|Flag|Description|Default|Support| +|---|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get + +Fetch information about a Pulsar Function + +**Command:** + +```shell +$ pulsar-admin functions get options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## restart + +Restart function instance + +**Command:** + +```shell +$ pulsar-admin functions restart options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stop + +Stops function instance + +**Command:** + +```shell +$ pulsar-admin functions stop options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## start + +Starts a stopped function instance + +**Command:** + +```shell +$ pulsar-admin functions start options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## status + +Check the current status of a Pulsar Function + +**Command:** + +```shell +$ pulsar-admin functions status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## getstatus + +Check the current status of a Pulsar Function + +**Command:** + +```shell +$ pulsar-admin functions getstatus options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the current stats of a Pulsar Function + +**Command:** + +```shell +$ pulsar-admin functions stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# functions + +Interface for managing Pulsar Functions (lightweight, Lambda-style compute processes that work with Pulsar) + + +```shell +$ pulsar-admin functions subcommand +``` + + + +## localrun + +Run a Pulsar Function locally, rather than deploy to a Pulsar cluster) + +**Command:** + +```shell +$ pulsar-admin functions localrun options +``` + +**Options:** + +|Flag|Description|Default|Support| +|---|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a Pulsar Function in cluster mode (deploy it on a Pulsar cluster) + +**Command:** + +```shell +$ pulsar-admin functions create options +``` + +**Options:** + +|Flag|Description|Default|Support| +|---|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a Pulsar Function that is running on a Pulsar cluster + +**Command:** + +```shell +$ pulsar-admin functions delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update + +Update a Pulsar Function that has been deployed to a Pulsar cluster + +**Command:** + +```shell +$ pulsar-admin functions update options +``` + +**Options:** + +|Flag|Description|Default|Support| +|---|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get + +Fetch information about a Pulsar Function + +**Command:** + +```shell +$ pulsar-admin functions get options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## restart + +Restart function instance + +**Command:** + +```shell +$ pulsar-admin functions restart options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stop + +Stops function instance + +**Command:** + +```shell +$ pulsar-admin functions stop options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## start + +Starts a stopped function instance + +**Command:** + +```shell +$ pulsar-admin functions start options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## status + +Check the current status of a Pulsar Function + +**Command:** + +```shell +$ pulsar-admin functions status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## getstatus + +Check the current status of a Pulsar Function + +**Command:** + +```shell +$ pulsar-admin functions getstatus options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the current stats of a Pulsar Function + +**Command:** + +```shell +$ pulsar-admin functions stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list + +List all Pulsar Functions running under a specific tenant and namespace + +**Command:** + +```shell +$ pulsar-admin functions list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# functions + +Interface for managing Pulsar Functions (lightweight, Lambda-style compute processes that work with Pulsar) + + +```shell +$ pulsar-admin functions subcommand +``` + + + +## localrun + +Run a Pulsar Function locally, rather than deploy to a Pulsar cluster) + +**Command:** + +```shell +$ pulsar-admin functions localrun options +``` + +**Options:** + +|Flag|Description|Default|Support| +|---|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a Pulsar Function in cluster mode (deploy it on a Pulsar cluster) + +**Command:** + +```shell +$ pulsar-admin functions create options +``` + +**Options:** + +|Flag|Description|Default|Support| +|---|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a Pulsar Function that is running on a Pulsar cluster + +**Command:** + +```shell +$ pulsar-admin functions delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update + +Update a Pulsar Function that has been deployed to a Pulsar cluster + +**Command:** + +```shell +$ pulsar-admin functions update options +``` + +**Options:** + +|Flag|Description|Default|Support| +|---|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get + +Fetch information about a Pulsar Function + +**Command:** + +```shell +$ pulsar-admin functions get options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## restart + +Restart function instance + +**Command:** + +```shell +$ pulsar-admin functions restart options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stop + +Stops function instance + +**Command:** + +```shell +$ pulsar-admin functions stop options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## start + +Starts a stopped function instance + +**Command:** + +```shell +$ pulsar-admin functions start options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## status + +Check the current status of a Pulsar Function + +**Command:** + +```shell +$ pulsar-admin functions status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## getstatus + +Check the current status of a Pulsar Function + +**Command:** + +```shell +$ pulsar-admin functions getstatus options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the current stats of a Pulsar Function + +**Command:** + +```shell +$ pulsar-admin functions stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list + +List all Pulsar Functions running under a specific tenant and namespace + +**Command:** + +```shell +$ pulsar-admin functions list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## querystate + +Fetch the current state associated with a Pulsar Function + +**Command:** + +```shell +$ pulsar-admin functions querystate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# functions + +Interface for managing Pulsar Functions (lightweight, Lambda-style compute processes that work with Pulsar) + + +```shell +$ pulsar-admin functions subcommand +``` + + + +## localrun + +Run a Pulsar Function locally, rather than deploy to a Pulsar cluster) + +**Command:** + +```shell +$ pulsar-admin functions localrun options +``` + +**Options:** + +|Flag|Description|Default|Support| +|---|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a Pulsar Function in cluster mode (deploy it on a Pulsar cluster) + +**Command:** + +```shell +$ pulsar-admin functions create options +``` + +**Options:** + +|Flag|Description|Default|Support| +|---|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a Pulsar Function that is running on a Pulsar cluster + +**Command:** + +```shell +$ pulsar-admin functions delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update + +Update a Pulsar Function that has been deployed to a Pulsar cluster + +**Command:** + +```shell +$ pulsar-admin functions update options +``` + +**Options:** + +|Flag|Description|Default|Support| +|---|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get + +Fetch information about a Pulsar Function + +**Command:** + +```shell +$ pulsar-admin functions get options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## restart + +Restart function instance + +**Command:** + +```shell +$ pulsar-admin functions restart options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stop + +Stops function instance + +**Command:** + +```shell +$ pulsar-admin functions stop options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## start + +Starts a stopped function instance + +**Command:** + +```shell +$ pulsar-admin functions start options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## status + +Check the current status of a Pulsar Function + +**Command:** + +```shell +$ pulsar-admin functions status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## getstatus + +Check the current status of a Pulsar Function + +**Command:** + +```shell +$ pulsar-admin functions getstatus options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the current stats of a Pulsar Function + +**Command:** + +```shell +$ pulsar-admin functions stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list + +List all Pulsar Functions running under a specific tenant and namespace + +**Command:** + +```shell +$ pulsar-admin functions list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## querystate + +Fetch the current state associated with a Pulsar Function + +**Command:** + +```shell +$ pulsar-admin functions querystate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## putstate + +Put the state associated with a Pulsar Function + +**Command:** + +```shell +$ pulsar-admin functions putstate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# functions + +Interface for managing Pulsar Functions (lightweight, Lambda-style compute processes that work with Pulsar) + + +```shell +$ pulsar-admin functions subcommand +``` + + + +## localrun + +Run a Pulsar Function locally, rather than deploy to a Pulsar cluster) + +**Command:** + +```shell +$ pulsar-admin functions localrun options +``` + +**Options:** + +|Flag|Description|Default|Support| +|---|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a Pulsar Function in cluster mode (deploy it on a Pulsar cluster) + +**Command:** + +```shell +$ pulsar-admin functions create options +``` + +**Options:** + +|Flag|Description|Default|Support| +|---|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a Pulsar Function that is running on a Pulsar cluster + +**Command:** + +```shell +$ pulsar-admin functions delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update + +Update a Pulsar Function that has been deployed to a Pulsar cluster + +**Command:** + +```shell +$ pulsar-admin functions update options +``` + +**Options:** + +|Flag|Description|Default|Support| +|---|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get + +Fetch information about a Pulsar Function + +**Command:** + +```shell +$ pulsar-admin functions get options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## restart + +Restart function instance + +**Command:** + +```shell +$ pulsar-admin functions restart options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stop + +Stops function instance + +**Command:** + +```shell +$ pulsar-admin functions stop options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## start + +Starts a stopped function instance + +**Command:** + +```shell +$ pulsar-admin functions start options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## status + +Check the current status of a Pulsar Function + +**Command:** + +```shell +$ pulsar-admin functions status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## getstatus + +Check the current status of a Pulsar Function + +**Command:** + +```shell +$ pulsar-admin functions getstatus options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the current stats of a Pulsar Function + +**Command:** + +```shell +$ pulsar-admin functions stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list + +List all Pulsar Functions running under a specific tenant and namespace + +**Command:** + +```shell +$ pulsar-admin functions list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## querystate + +Fetch the current state associated with a Pulsar Function + +**Command:** + +```shell +$ pulsar-admin functions querystate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## putstate + +Put the state associated with a Pulsar Function + +**Command:** + +```shell +$ pulsar-admin functions putstate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## trigger + +Trigger the specified Pulsar Function with a supplied value + +**Command:** + +```shell +$ pulsar-admin functions trigger options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# functions + +Interface for managing Pulsar Functions (lightweight, Lambda-style compute processes that work with Pulsar) + + +```shell +$ pulsar-admin functions subcommand +``` + + + +## localrun + +Run a Pulsar Function locally, rather than deploy to a Pulsar cluster) + +**Command:** + +```shell +$ pulsar-admin functions localrun options +``` + +**Options:** + +|Flag|Description|Default|Support| +|---|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a Pulsar Function in cluster mode (deploy it on a Pulsar cluster) + +**Command:** + +```shell +$ pulsar-admin functions create options +``` + +**Options:** + +|Flag|Description|Default|Support| +|---|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a Pulsar Function that is running on a Pulsar cluster + +**Command:** + +```shell +$ pulsar-admin functions delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update + +Update a Pulsar Function that has been deployed to a Pulsar cluster + +**Command:** + +```shell +$ pulsar-admin functions update options +``` + +**Options:** + +|Flag|Description|Default|Support| +|---|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get + +Fetch information about a Pulsar Function + +**Command:** + +```shell +$ pulsar-admin functions get options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## restart + +Restart function instance + +**Command:** + +```shell +$ pulsar-admin functions restart options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stop + +Stops function instance + +**Command:** + +```shell +$ pulsar-admin functions stop options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## start + +Starts a stopped function instance + +**Command:** + +```shell +$ pulsar-admin functions start options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## status + +Check the current status of a Pulsar Function + +**Command:** + +```shell +$ pulsar-admin functions status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## getstatus + +Check the current status of a Pulsar Function + +**Command:** + +```shell +$ pulsar-admin functions getstatus options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the current stats of a Pulsar Function + +**Command:** + +```shell +$ pulsar-admin functions stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list + +List all Pulsar Functions running under a specific tenant and namespace + +**Command:** + +```shell +$ pulsar-admin functions list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## querystate + +Fetch the current state associated with a Pulsar Function + +**Command:** + +```shell +$ pulsar-admin functions querystate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## putstate + +Put the state associated with a Pulsar Function + +**Command:** + +```shell +$ pulsar-admin functions putstate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## trigger + +Trigger the specified Pulsar Function with a supplied value + +**Command:** + +```shell +$ pulsar-admin functions trigger options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## upload + +Upload File Data to Pulsar + +**Command:** + +```shell +$ pulsar-admin functions upload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# functions + +Interface for managing Pulsar Functions (lightweight, Lambda-style compute processes that work with Pulsar) + + +```shell +$ pulsar-admin functions subcommand +``` + + + +## localrun + +Run a Pulsar Function locally, rather than deploy to a Pulsar cluster) + +**Command:** + +```shell +$ pulsar-admin functions localrun options +``` + +**Options:** + +|Flag|Description|Default|Support| +|---|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a Pulsar Function in cluster mode (deploy it on a Pulsar cluster) + +**Command:** + +```shell +$ pulsar-admin functions create options +``` + +**Options:** + +|Flag|Description|Default|Support| +|---|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a Pulsar Function that is running on a Pulsar cluster + +**Command:** + +```shell +$ pulsar-admin functions delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update + +Update a Pulsar Function that has been deployed to a Pulsar cluster + +**Command:** + +```shell +$ pulsar-admin functions update options +``` + +**Options:** + +|Flag|Description|Default|Support| +|---|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get + +Fetch information about a Pulsar Function + +**Command:** + +```shell +$ pulsar-admin functions get options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## restart + +Restart function instance + +**Command:** + +```shell +$ pulsar-admin functions restart options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stop + +Stops function instance + +**Command:** + +```shell +$ pulsar-admin functions stop options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## start + +Starts a stopped function instance + +**Command:** + +```shell +$ pulsar-admin functions start options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## status + +Check the current status of a Pulsar Function + +**Command:** + +```shell +$ pulsar-admin functions status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## getstatus + +Check the current status of a Pulsar Function + +**Command:** + +```shell +$ pulsar-admin functions getstatus options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the current stats of a Pulsar Function + +**Command:** + +```shell +$ pulsar-admin functions stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list + +List all Pulsar Functions running under a specific tenant and namespace + +**Command:** + +```shell +$ pulsar-admin functions list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## querystate + +Fetch the current state associated with a Pulsar Function + +**Command:** + +```shell +$ pulsar-admin functions querystate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## putstate + +Put the state associated with a Pulsar Function + +**Command:** + +```shell +$ pulsar-admin functions putstate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## trigger + +Trigger the specified Pulsar Function with a supplied value + +**Command:** + +```shell +$ pulsar-admin functions trigger options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## upload + +Upload File Data to Pulsar + +**Command:** + +```shell +$ pulsar-admin functions upload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## download + +Download File Data from Pulsar + +**Command:** + +```shell +$ pulsar-admin functions download options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# functions + +Interface for managing Pulsar Functions (lightweight, Lambda-style compute processes that work with Pulsar) + + +```shell +$ pulsar-admin functions subcommand +``` + + + +## localrun + +Run a Pulsar Function locally, rather than deploy to a Pulsar cluster) + +**Command:** + +```shell +$ pulsar-admin functions localrun options +``` + +**Options:** + +|Flag|Description|Default|Support| +|---|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a Pulsar Function in cluster mode (deploy it on a Pulsar cluster) + +**Command:** + +```shell +$ pulsar-admin functions create options +``` + +**Options:** + +|Flag|Description|Default|Support| +|---|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a Pulsar Function that is running on a Pulsar cluster + +**Command:** + +```shell +$ pulsar-admin functions delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update + +Update a Pulsar Function that has been deployed to a Pulsar cluster + +**Command:** + +```shell +$ pulsar-admin functions update options +``` + +**Options:** + +|Flag|Description|Default|Support| +|---|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get + +Fetch information about a Pulsar Function + +**Command:** + +```shell +$ pulsar-admin functions get options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## restart + +Restart function instance + +**Command:** + +```shell +$ pulsar-admin functions restart options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stop + +Stops function instance + +**Command:** + +```shell +$ pulsar-admin functions stop options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## start + +Starts a stopped function instance + +**Command:** + +```shell +$ pulsar-admin functions start options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## status + +Check the current status of a Pulsar Function + +**Command:** + +```shell +$ pulsar-admin functions status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## getstatus + +Check the current status of a Pulsar Function + +**Command:** + +```shell +$ pulsar-admin functions getstatus options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the current stats of a Pulsar Function + +**Command:** + +```shell +$ pulsar-admin functions stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list + +List all Pulsar Functions running under a specific tenant and namespace + +**Command:** + +```shell +$ pulsar-admin functions list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## querystate + +Fetch the current state associated with a Pulsar Function + +**Command:** + +```shell +$ pulsar-admin functions querystate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## putstate + +Put the state associated with a Pulsar Function + +**Command:** + +```shell +$ pulsar-admin functions putstate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## trigger + +Trigger the specified Pulsar Function with a supplied value + +**Command:** + +```shell +$ pulsar-admin functions trigger options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## upload + +Upload File Data to Pulsar + +**Command:** + +```shell +$ pulsar-admin functions upload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## download + +Download File Data from Pulsar + +**Command:** + +```shell +$ pulsar-admin functions download options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reload + +Reload the available built-in functions + +**Command:** + +```shell +$ pulsar-admin functions reload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# functions + +Interface for managing Pulsar Functions (lightweight, Lambda-style compute processes that work with Pulsar) + + +```shell +$ pulsar-admin functions subcommand +``` + + + +## localrun + +Run a Pulsar Function locally, rather than deploy to a Pulsar cluster) + +**Command:** + +```shell +$ pulsar-admin functions localrun options +``` + +**Options:** + +|Flag|Description|Default|Support| +|---|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a Pulsar Function in cluster mode (deploy it on a Pulsar cluster) + +**Command:** + +```shell +$ pulsar-admin functions create options +``` + +**Options:** + +|Flag|Description|Default|Support| +|---|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a Pulsar Function that is running on a Pulsar cluster + +**Command:** + +```shell +$ pulsar-admin functions delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update + +Update a Pulsar Function that has been deployed to a Pulsar cluster + +**Command:** + +```shell +$ pulsar-admin functions update options +``` + +**Options:** + +|Flag|Description|Default|Support| +|---|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get + +Fetch information about a Pulsar Function + +**Command:** + +```shell +$ pulsar-admin functions get options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## restart + +Restart function instance + +**Command:** + +```shell +$ pulsar-admin functions restart options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stop + +Stops function instance + +**Command:** + +```shell +$ pulsar-admin functions stop options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## start + +Starts a stopped function instance + +**Command:** + +```shell +$ pulsar-admin functions start options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## status + +Check the current status of a Pulsar Function + +**Command:** + +```shell +$ pulsar-admin functions status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## getstatus + +Check the current status of a Pulsar Function + +**Command:** + +```shell +$ pulsar-admin functions getstatus options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the current stats of a Pulsar Function + +**Command:** + +```shell +$ pulsar-admin functions stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list + +List all Pulsar Functions running under a specific tenant and namespace + +**Command:** + +```shell +$ pulsar-admin functions list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## querystate + +Fetch the current state associated with a Pulsar Function + +**Command:** + +```shell +$ pulsar-admin functions querystate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## putstate + +Put the state associated with a Pulsar Function + +**Command:** + +```shell +$ pulsar-admin functions putstate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## trigger + +Trigger the specified Pulsar Function with a supplied value + +**Command:** + +```shell +$ pulsar-admin functions trigger options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## upload + +Upload File Data to Pulsar + +**Command:** + +```shell +$ pulsar-admin functions upload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## download + +Download File Data from Pulsar + +**Command:** + +```shell +$ pulsar-admin functions download options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reload + +Reload the available built-in functions + +**Command:** + +```shell +$ pulsar-admin functions reload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## available-functions + +Get the list of Pulsar Functions supported by Pulsar cluster + +**Command:** + +```shell +$ pulsar-admin functions available-functions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + diff --git a/static/reference/4.0.x/pulsar-admin/namespaces.md b/static/reference/4.0.x/pulsar-admin/namespaces.md new file mode 100644 index 000000000000..1d8918cf9578 --- /dev/null +++ b/static/reference/4.0.x/pulsar-admin/namespaces.md @@ -0,0 +1,181608 @@ +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Clear backlog for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Clear backlog for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Unsubscribe the given subscription on all topics on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Clear backlog for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Unsubscribe the given subscription on all topics on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-encryption-required + +Enable or disable message encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Clear backlog for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Unsubscribe the given subscription on all topics on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-encryption-required + +Enable or disable message encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-encryption-required + +Get encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Clear backlog for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Unsubscribe the given subscription on all topics on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-encryption-required + +Enable or disable message encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-encryption-required + +Get encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-auth-mode + +Set subscription auth mode on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Clear backlog for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Unsubscribe the given subscription on all topics on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-encryption-required + +Enable or disable message encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-encryption-required + +Get encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-auth-mode + +Set subscription auth mode on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-auth-mode + +Get subscriptionAuthMod for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Clear backlog for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Unsubscribe the given subscription on all topics on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-encryption-required + +Enable or disable message encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-encryption-required + +Get encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-auth-mode + +Set subscription auth mode on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-auth-mode + +Get subscriptionAuthMod for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Clear backlog for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Unsubscribe the given subscription on all topics on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-encryption-required + +Enable or disable message encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-encryption-required + +Get encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-auth-mode + +Set subscription auth mode on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-auth-mode + +Get subscriptionAuthMod for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Clear backlog for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Unsubscribe the given subscription on all topics on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-encryption-required + +Enable or disable message encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-encryption-required + +Get encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-auth-mode + +Set subscription auth mode on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-auth-mode + +Get subscriptionAuthMod for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove delayed delivery policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Clear backlog for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Unsubscribe the given subscription on all topics on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-encryption-required + +Enable or disable message encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-encryption-required + +Get encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-auth-mode + +Set subscription auth mode on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-auth-mode + +Get subscriptionAuthMod for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove delayed delivery policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Clear backlog for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Unsubscribe the given subscription on all topics on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-encryption-required + +Enable or disable message encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-encryption-required + +Get encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-auth-mode + +Set subscription auth mode on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-auth-mode + +Get subscriptionAuthMod for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove delayed delivery policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Clear backlog for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Unsubscribe the given subscription on all topics on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-encryption-required + +Enable or disable message encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-encryption-required + +Get encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-auth-mode + +Set subscription auth mode on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-auth-mode + +Get subscriptionAuthMod for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove delayed delivery policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Clear backlog for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Unsubscribe the given subscription on all topics on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-encryption-required + +Enable or disable message encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-encryption-required + +Get encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-auth-mode + +Set subscription auth mode on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-auth-mode + +Get subscriptionAuthMod for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove delayed delivery policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers-per-topic + +Get maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Clear backlog for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Unsubscribe the given subscription on all topics on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-encryption-required + +Enable or disable message encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-encryption-required + +Get encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-auth-mode + +Set subscription auth mode on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-auth-mode + +Get subscriptionAuthMod for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove delayed delivery policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers-per-topic + +Get maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers-per-topic + +Set maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Clear backlog for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Unsubscribe the given subscription on all topics on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-encryption-required + +Enable or disable message encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-encryption-required + +Get encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-auth-mode + +Set subscription auth mode on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-auth-mode + +Get subscriptionAuthMod for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove delayed delivery policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers-per-topic + +Get maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers-per-topic + +Set maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers-per-topic + +Remove max producers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Clear backlog for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Unsubscribe the given subscription on all topics on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-encryption-required + +Enable or disable message encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-encryption-required + +Get encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-auth-mode + +Set subscription auth mode on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-auth-mode + +Get subscriptionAuthMod for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove delayed delivery policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers-per-topic + +Get maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers-per-topic + +Set maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers-per-topic + +Remove max producers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-topic + +Get maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Clear backlog for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Unsubscribe the given subscription on all topics on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-encryption-required + +Enable or disable message encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-encryption-required + +Get encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-auth-mode + +Set subscription auth mode on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-auth-mode + +Get subscriptionAuthMod for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove delayed delivery policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers-per-topic + +Get maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers-per-topic + +Set maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers-per-topic + +Remove max producers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-topic + +Get maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-topic + +Set maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Clear backlog for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Unsubscribe the given subscription on all topics on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-encryption-required + +Enable or disable message encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-encryption-required + +Get encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-auth-mode + +Set subscription auth mode on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-auth-mode + +Get subscriptionAuthMod for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove delayed delivery policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers-per-topic + +Get maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers-per-topic + +Set maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers-per-topic + +Remove max producers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-topic + +Get maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-topic + +Set maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-topic + +Remove max consumers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Clear backlog for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Unsubscribe the given subscription on all topics on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-encryption-required + +Enable or disable message encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-encryption-required + +Get encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-auth-mode + +Set subscription auth mode on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-auth-mode + +Get subscriptionAuthMod for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove delayed delivery policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers-per-topic + +Get maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers-per-topic + +Set maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers-per-topic + +Remove max producers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-topic + +Get maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-topic + +Set maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-topic + +Remove max consumers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Clear backlog for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Unsubscribe the given subscription on all topics on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-encryption-required + +Enable or disable message encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-encryption-required + +Get encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-auth-mode + +Set subscription auth mode on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-auth-mode + +Get subscriptionAuthMod for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove delayed delivery policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers-per-topic + +Get maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers-per-topic + +Set maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers-per-topic + +Remove max producers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-topic + +Get maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-topic + +Set maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-topic + +Remove max consumers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Clear backlog for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Unsubscribe the given subscription on all topics on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-encryption-required + +Enable or disable message encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-encryption-required + +Get encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-auth-mode + +Set subscription auth mode on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-auth-mode + +Get subscriptionAuthMod for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove delayed delivery policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers-per-topic + +Get maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers-per-topic + +Set maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers-per-topic + +Remove max producers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-topic + +Get maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-topic + +Set maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-topic + +Remove max consumers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Clear backlog for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Unsubscribe the given subscription on all topics on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-encryption-required + +Enable or disable message encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-encryption-required + +Get encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-auth-mode + +Set subscription auth mode on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-auth-mode + +Get subscriptionAuthMod for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove delayed delivery policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers-per-topic + +Get maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers-per-topic + +Set maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers-per-topic + +Remove max producers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-topic + +Get maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-topic + +Set maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-topic + +Remove max consumers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Clear backlog for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Unsubscribe the given subscription on all topics on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-encryption-required + +Enable or disable message encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-encryption-required + +Get encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-auth-mode + +Set subscription auth mode on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-auth-mode + +Get subscriptionAuthMod for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove delayed delivery policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers-per-topic + +Get maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers-per-topic + +Set maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers-per-topic + +Remove max producers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-topic + +Get maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-topic + +Set maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-topic + +Remove max consumers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Clear backlog for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Unsubscribe the given subscription on all topics on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-encryption-required + +Enable or disable message encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-encryption-required + +Get encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-auth-mode + +Set subscription auth mode on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-auth-mode + +Get subscriptionAuthMod for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove delayed delivery policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers-per-topic + +Get maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers-per-topic + +Set maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers-per-topic + +Remove max producers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-topic + +Get maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-topic + +Set maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-topic + +Remove max consumers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Clear backlog for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Unsubscribe the given subscription on all topics on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-encryption-required + +Enable or disable message encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-encryption-required + +Get encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-auth-mode + +Set subscription auth mode on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-auth-mode + +Get subscriptionAuthMod for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove delayed delivery policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers-per-topic + +Get maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers-per-topic + +Set maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers-per-topic + +Remove max producers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-topic + +Get maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-topic + +Set maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-topic + +Remove max consumers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Clear backlog for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Unsubscribe the given subscription on all topics on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-encryption-required + +Enable or disable message encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-encryption-required + +Get encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-auth-mode + +Set subscription auth mode on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-auth-mode + +Get subscriptionAuthMod for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove delayed delivery policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers-per-topic + +Get maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers-per-topic + +Set maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers-per-topic + +Remove max producers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-topic + +Get maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-topic + +Set maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-topic + +Remove max consumers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Clear backlog for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Unsubscribe the given subscription on all topics on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-encryption-required + +Enable or disable message encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-encryption-required + +Get encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-auth-mode + +Set subscription auth mode on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-auth-mode + +Get subscriptionAuthMod for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove delayed delivery policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers-per-topic + +Get maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers-per-topic + +Set maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers-per-topic + +Remove max producers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-topic + +Get maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-topic + +Set maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-topic + +Remove max consumers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Clear backlog for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Unsubscribe the given subscription on all topics on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-encryption-required + +Enable or disable message encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-encryption-required + +Get encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-auth-mode + +Set subscription auth mode on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-auth-mode + +Get subscriptionAuthMod for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove delayed delivery policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers-per-topic + +Get maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers-per-topic + +Set maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers-per-topic + +Remove max producers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-topic + +Get maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-topic + +Set maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-topic + +Remove max consumers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Clear backlog for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Unsubscribe the given subscription on all topics on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-encryption-required + +Enable or disable message encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-encryption-required + +Get encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-auth-mode + +Set subscription auth mode on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-auth-mode + +Get subscriptionAuthMod for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove delayed delivery policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers-per-topic + +Get maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers-per-topic + +Set maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers-per-topic + +Remove max producers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-topic + +Get maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-topic + +Set maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-topic + +Remove max consumers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Clear backlog for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Unsubscribe the given subscription on all topics on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-encryption-required + +Enable or disable message encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-encryption-required + +Get encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-auth-mode + +Set subscription auth mode on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-auth-mode + +Get subscriptionAuthMod for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove delayed delivery policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers-per-topic + +Get maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers-per-topic + +Set maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers-per-topic + +Remove max producers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-topic + +Get maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-topic + +Set maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-topic + +Remove max consumers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Clear backlog for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Unsubscribe the given subscription on all topics on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-encryption-required + +Enable or disable message encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-encryption-required + +Get encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-auth-mode + +Set subscription auth mode on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-auth-mode + +Get subscriptionAuthMod for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove delayed delivery policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers-per-topic + +Get maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers-per-topic + +Set maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers-per-topic + +Remove max producers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-topic + +Get maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-topic + +Set maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-topic + +Remove max consumers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-threshold + +Get offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Clear backlog for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Unsubscribe the given subscription on all topics on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-encryption-required + +Enable or disable message encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-encryption-required + +Get encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-auth-mode + +Set subscription auth mode on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-auth-mode + +Get subscriptionAuthMod for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove delayed delivery policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers-per-topic + +Get maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers-per-topic + +Set maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers-per-topic + +Remove max producers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-topic + +Get maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-topic + +Set maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-topic + +Remove max consumers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-threshold + +Get offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-threshold + +Set offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Clear backlog for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Unsubscribe the given subscription on all topics on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-encryption-required + +Enable or disable message encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-encryption-required + +Get encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-auth-mode + +Set subscription auth mode on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-auth-mode + +Get subscriptionAuthMod for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove delayed delivery policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers-per-topic + +Get maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers-per-topic + +Set maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers-per-topic + +Remove max producers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-topic + +Get maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-topic + +Set maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-topic + +Remove max consumers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-threshold + +Get offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-threshold + +Set offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-deletion-lag + +Get offloadDeletionLag, in minutes, for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Clear backlog for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Unsubscribe the given subscription on all topics on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-encryption-required + +Enable or disable message encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-encryption-required + +Get encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-auth-mode + +Set subscription auth mode on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-auth-mode + +Get subscriptionAuthMod for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove delayed delivery policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers-per-topic + +Get maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers-per-topic + +Set maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers-per-topic + +Remove max producers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-topic + +Get maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-topic + +Set maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-topic + +Remove max consumers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-threshold + +Get offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-threshold + +Set offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-deletion-lag + +Get offloadDeletionLag, in minutes, for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-deletion-lag + +Set offloadDeletionLag for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Clear backlog for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Unsubscribe the given subscription on all topics on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-encryption-required + +Enable or disable message encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-encryption-required + +Get encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-auth-mode + +Set subscription auth mode on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-auth-mode + +Get subscriptionAuthMod for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove delayed delivery policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers-per-topic + +Get maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers-per-topic + +Set maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers-per-topic + +Remove max producers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-topic + +Get maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-topic + +Set maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-topic + +Remove max consumers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-threshold + +Get offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-threshold + +Set offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-deletion-lag + +Get offloadDeletionLag, in minutes, for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-deletion-lag + +Set offloadDeletionLag for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-offload-deletion-lag + +Clear offloadDeletionLag for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Clear backlog for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Unsubscribe the given subscription on all topics on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-encryption-required + +Enable or disable message encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-encryption-required + +Get encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-auth-mode + +Set subscription auth mode on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-auth-mode + +Get subscriptionAuthMod for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove delayed delivery policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers-per-topic + +Get maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers-per-topic + +Set maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers-per-topic + +Remove max producers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-topic + +Get maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-topic + +Set maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-topic + +Remove max consumers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-threshold + +Get offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-threshold + +Set offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-deletion-lag + +Get offloadDeletionLag, in minutes, for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-deletion-lag + +Set offloadDeletionLag for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-offload-deletion-lag + +Clear offloadDeletionLag for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-autoupdate-strategy + +Get the schema auto-update strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-autoupdate-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Clear backlog for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Unsubscribe the given subscription on all topics on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-encryption-required + +Enable or disable message encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-encryption-required + +Get encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-auth-mode + +Set subscription auth mode on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-auth-mode + +Get subscriptionAuthMod for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove delayed delivery policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers-per-topic + +Get maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers-per-topic + +Set maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers-per-topic + +Remove max producers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-topic + +Get maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-topic + +Set maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-topic + +Remove max consumers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-threshold + +Get offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-threshold + +Set offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-deletion-lag + +Get offloadDeletionLag, in minutes, for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-deletion-lag + +Set offloadDeletionLag for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-offload-deletion-lag + +Clear offloadDeletionLag for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-autoupdate-strategy + +Get the schema auto-update strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-autoupdate-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-autoupdate-strategy + +Set the schema auto-update strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-autoupdate-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Clear backlog for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Unsubscribe the given subscription on all topics on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-encryption-required + +Enable or disable message encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-encryption-required + +Get encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-auth-mode + +Set subscription auth mode on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-auth-mode + +Get subscriptionAuthMod for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove delayed delivery policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers-per-topic + +Get maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers-per-topic + +Set maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers-per-topic + +Remove max producers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-topic + +Get maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-topic + +Set maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-topic + +Remove max consumers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-threshold + +Get offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-threshold + +Set offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-deletion-lag + +Get offloadDeletionLag, in minutes, for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-deletion-lag + +Set offloadDeletionLag for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-offload-deletion-lag + +Clear offloadDeletionLag for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-autoupdate-strategy + +Get the schema auto-update strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-autoupdate-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-autoupdate-strategy + +Set the schema auto-update strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-autoupdate-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-compatibility-strategy + +Get the schema compatibility strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Clear backlog for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Unsubscribe the given subscription on all topics on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-encryption-required + +Enable or disable message encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-encryption-required + +Get encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-auth-mode + +Set subscription auth mode on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-auth-mode + +Get subscriptionAuthMod for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove delayed delivery policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers-per-topic + +Get maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers-per-topic + +Set maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers-per-topic + +Remove max producers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-topic + +Get maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-topic + +Set maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-topic + +Remove max consumers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-threshold + +Get offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-threshold + +Set offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-deletion-lag + +Get offloadDeletionLag, in minutes, for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-deletion-lag + +Set offloadDeletionLag for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-offload-deletion-lag + +Clear offloadDeletionLag for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-autoupdate-strategy + +Get the schema auto-update strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-autoupdate-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-autoupdate-strategy + +Set the schema auto-update strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-autoupdate-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-compatibility-strategy + +Get the schema compatibility strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-compatibility-strategy + +Set the schema compatibility strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Clear backlog for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Unsubscribe the given subscription on all topics on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-encryption-required + +Enable or disable message encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-encryption-required + +Get encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-auth-mode + +Set subscription auth mode on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-auth-mode + +Get subscriptionAuthMod for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove delayed delivery policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers-per-topic + +Get maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers-per-topic + +Set maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers-per-topic + +Remove max producers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-topic + +Get maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-topic + +Set maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-topic + +Remove max consumers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-threshold + +Get offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-threshold + +Set offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-deletion-lag + +Get offloadDeletionLag, in minutes, for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-deletion-lag + +Set offloadDeletionLag for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-offload-deletion-lag + +Clear offloadDeletionLag for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-autoupdate-strategy + +Get the schema auto-update strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-autoupdate-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-autoupdate-strategy + +Set the schema auto-update strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-autoupdate-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-compatibility-strategy + +Get the schema compatibility strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-compatibility-strategy + +Set the schema compatibility strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-is-allow-auto-update-schema + +Get the namespace whether allow auto update schema + +**Command:** + +```shell +$ pulsar-admin namespaces get-is-allow-auto-update-schema options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Clear backlog for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Unsubscribe the given subscription on all topics on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-encryption-required + +Enable or disable message encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-encryption-required + +Get encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-auth-mode + +Set subscription auth mode on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-auth-mode + +Get subscriptionAuthMod for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove delayed delivery policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers-per-topic + +Get maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers-per-topic + +Set maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers-per-topic + +Remove max producers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-topic + +Get maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-topic + +Set maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-topic + +Remove max consumers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-threshold + +Get offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-threshold + +Set offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-deletion-lag + +Get offloadDeletionLag, in minutes, for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-deletion-lag + +Set offloadDeletionLag for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-offload-deletion-lag + +Clear offloadDeletionLag for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-autoupdate-strategy + +Get the schema auto-update strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-autoupdate-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-autoupdate-strategy + +Set the schema auto-update strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-autoupdate-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-compatibility-strategy + +Get the schema compatibility strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-compatibility-strategy + +Set the schema compatibility strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-is-allow-auto-update-schema + +Get the namespace whether allow auto update schema + +**Command:** + +```shell +$ pulsar-admin namespaces get-is-allow-auto-update-schema options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-is-allow-auto-update-schema + +Set the namespace whether allow auto update schema + +**Command:** + +```shell +$ pulsar-admin namespaces set-is-allow-auto-update-schema options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Clear backlog for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Unsubscribe the given subscription on all topics on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-encryption-required + +Enable or disable message encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-encryption-required + +Get encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-auth-mode + +Set subscription auth mode on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-auth-mode + +Get subscriptionAuthMod for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove delayed delivery policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers-per-topic + +Get maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers-per-topic + +Set maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers-per-topic + +Remove max producers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-topic + +Get maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-topic + +Set maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-topic + +Remove max consumers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-threshold + +Get offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-threshold + +Set offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-deletion-lag + +Get offloadDeletionLag, in minutes, for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-deletion-lag + +Set offloadDeletionLag for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-offload-deletion-lag + +Clear offloadDeletionLag for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-autoupdate-strategy + +Get the schema auto-update strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-autoupdate-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-autoupdate-strategy + +Set the schema auto-update strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-autoupdate-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-compatibility-strategy + +Get the schema compatibility strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-compatibility-strategy + +Set the schema compatibility strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-is-allow-auto-update-schema + +Get the namespace whether allow auto update schema + +**Command:** + +```shell +$ pulsar-admin namespaces get-is-allow-auto-update-schema options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-is-allow-auto-update-schema + +Set the namespace whether allow auto update schema + +**Command:** + +```shell +$ pulsar-admin namespaces set-is-allow-auto-update-schema options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-validation-enforce + +Get the schema validation enforced + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-validation-enforce options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Clear backlog for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Unsubscribe the given subscription on all topics on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-encryption-required + +Enable or disable message encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-encryption-required + +Get encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-auth-mode + +Set subscription auth mode on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-auth-mode + +Get subscriptionAuthMod for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove delayed delivery policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers-per-topic + +Get maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers-per-topic + +Set maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers-per-topic + +Remove max producers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-topic + +Get maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-topic + +Set maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-topic + +Remove max consumers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-threshold + +Get offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-threshold + +Set offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-deletion-lag + +Get offloadDeletionLag, in minutes, for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-deletion-lag + +Set offloadDeletionLag for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-offload-deletion-lag + +Clear offloadDeletionLag for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-autoupdate-strategy + +Get the schema auto-update strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-autoupdate-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-autoupdate-strategy + +Set the schema auto-update strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-autoupdate-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-compatibility-strategy + +Get the schema compatibility strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-compatibility-strategy + +Set the schema compatibility strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-is-allow-auto-update-schema + +Get the namespace whether allow auto update schema + +**Command:** + +```shell +$ pulsar-admin namespaces get-is-allow-auto-update-schema options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-is-allow-auto-update-schema + +Set the namespace whether allow auto update schema + +**Command:** + +```shell +$ pulsar-admin namespaces set-is-allow-auto-update-schema options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-validation-enforce + +Get the schema validation enforced + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-validation-enforce options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-validation-enforce + +Set the schema whether open schema validation enforced + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-validation-enforce options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Clear backlog for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Unsubscribe the given subscription on all topics on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-encryption-required + +Enable or disable message encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-encryption-required + +Get encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-auth-mode + +Set subscription auth mode on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-auth-mode + +Get subscriptionAuthMod for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove delayed delivery policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers-per-topic + +Get maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers-per-topic + +Set maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers-per-topic + +Remove max producers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-topic + +Get maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-topic + +Set maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-topic + +Remove max consumers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-threshold + +Get offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-threshold + +Set offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-deletion-lag + +Get offloadDeletionLag, in minutes, for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-deletion-lag + +Set offloadDeletionLag for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-offload-deletion-lag + +Clear offloadDeletionLag for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-autoupdate-strategy + +Get the schema auto-update strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-autoupdate-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-autoupdate-strategy + +Set the schema auto-update strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-autoupdate-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-compatibility-strategy + +Get the schema compatibility strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-compatibility-strategy + +Set the schema compatibility strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-is-allow-auto-update-schema + +Get the namespace whether allow auto update schema + +**Command:** + +```shell +$ pulsar-admin namespaces get-is-allow-auto-update-schema options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-is-allow-auto-update-schema + +Set the namespace whether allow auto update schema + +**Command:** + +```shell +$ pulsar-admin namespaces set-is-allow-auto-update-schema options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-validation-enforce + +Get the schema validation enforced + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-validation-enforce options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-validation-enforce + +Set the schema whether open schema validation enforced + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-validation-enforce options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Clear backlog for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Unsubscribe the given subscription on all topics on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-encryption-required + +Enable or disable message encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-encryption-required + +Get encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-auth-mode + +Set subscription auth mode on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-auth-mode + +Get subscriptionAuthMod for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove delayed delivery policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers-per-topic + +Get maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers-per-topic + +Set maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers-per-topic + +Remove max producers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-topic + +Get maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-topic + +Set maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-topic + +Remove max consumers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-threshold + +Get offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-threshold + +Set offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-deletion-lag + +Get offloadDeletionLag, in minutes, for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-deletion-lag + +Set offloadDeletionLag for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-offload-deletion-lag + +Clear offloadDeletionLag for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-autoupdate-strategy + +Get the schema auto-update strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-autoupdate-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-autoupdate-strategy + +Set the schema auto-update strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-autoupdate-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-compatibility-strategy + +Get the schema compatibility strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-compatibility-strategy + +Set the schema compatibility strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-is-allow-auto-update-schema + +Get the namespace whether allow auto update schema + +**Command:** + +```shell +$ pulsar-admin namespaces get-is-allow-auto-update-schema options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-is-allow-auto-update-schema + +Set the namespace whether allow auto update schema + +**Command:** + +```shell +$ pulsar-admin namespaces set-is-allow-auto-update-schema options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-validation-enforce + +Get the schema validation enforced + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-validation-enforce options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-validation-enforce + +Set the schema whether open schema validation enforced + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-validation-enforce options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Clear backlog for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Unsubscribe the given subscription on all topics on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-encryption-required + +Enable or disable message encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-encryption-required + +Get encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-auth-mode + +Set subscription auth mode on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-auth-mode + +Get subscriptionAuthMod for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove delayed delivery policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers-per-topic + +Get maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers-per-topic + +Set maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers-per-topic + +Remove max producers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-topic + +Get maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-topic + +Set maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-topic + +Remove max consumers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-threshold + +Get offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-threshold + +Set offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-deletion-lag + +Get offloadDeletionLag, in minutes, for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-deletion-lag + +Set offloadDeletionLag for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-offload-deletion-lag + +Clear offloadDeletionLag for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-autoupdate-strategy + +Get the schema auto-update strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-autoupdate-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-autoupdate-strategy + +Set the schema auto-update strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-autoupdate-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-compatibility-strategy + +Get the schema compatibility strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-compatibility-strategy + +Set the schema compatibility strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-is-allow-auto-update-schema + +Get the namespace whether allow auto update schema + +**Command:** + +```shell +$ pulsar-admin namespaces get-is-allow-auto-update-schema options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-is-allow-auto-update-schema + +Set the namespace whether allow auto update schema + +**Command:** + +```shell +$ pulsar-admin namespaces set-is-allow-auto-update-schema options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-validation-enforce + +Get the schema validation enforced + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-validation-enforce options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-validation-enforce + +Set the schema whether open schema validation enforced + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-validation-enforce options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Clear backlog for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Unsubscribe the given subscription on all topics on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-encryption-required + +Enable or disable message encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-encryption-required + +Get encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-auth-mode + +Set subscription auth mode on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-auth-mode + +Get subscriptionAuthMod for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove delayed delivery policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers-per-topic + +Get maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers-per-topic + +Set maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers-per-topic + +Remove max producers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-topic + +Get maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-topic + +Set maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-topic + +Remove max consumers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-threshold + +Get offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-threshold + +Set offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-deletion-lag + +Get offloadDeletionLag, in minutes, for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-deletion-lag + +Set offloadDeletionLag for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-offload-deletion-lag + +Clear offloadDeletionLag for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-autoupdate-strategy + +Get the schema auto-update strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-autoupdate-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-autoupdate-strategy + +Set the schema auto-update strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-autoupdate-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-compatibility-strategy + +Get the schema compatibility strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-compatibility-strategy + +Set the schema compatibility strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-is-allow-auto-update-schema + +Get the namespace whether allow auto update schema + +**Command:** + +```shell +$ pulsar-admin namespaces get-is-allow-auto-update-schema options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-is-allow-auto-update-schema + +Set the namespace whether allow auto update schema + +**Command:** + +```shell +$ pulsar-admin namespaces set-is-allow-auto-update-schema options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-validation-enforce + +Get the schema validation enforced + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-validation-enforce options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-validation-enforce + +Set the schema whether open schema validation enforced + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-validation-enforce options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplicationSnapshotInterval for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Clear backlog for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Unsubscribe the given subscription on all topics on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-encryption-required + +Enable or disable message encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-encryption-required + +Get encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-auth-mode + +Set subscription auth mode on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-auth-mode + +Get subscriptionAuthMod for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove delayed delivery policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers-per-topic + +Get maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers-per-topic + +Set maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers-per-topic + +Remove max producers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-topic + +Get maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-topic + +Set maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-topic + +Remove max consumers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-threshold + +Get offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-threshold + +Set offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-deletion-lag + +Get offloadDeletionLag, in minutes, for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-deletion-lag + +Set offloadDeletionLag for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-offload-deletion-lag + +Clear offloadDeletionLag for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-autoupdate-strategy + +Get the schema auto-update strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-autoupdate-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-autoupdate-strategy + +Set the schema auto-update strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-autoupdate-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-compatibility-strategy + +Get the schema compatibility strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-compatibility-strategy + +Set the schema compatibility strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-is-allow-auto-update-schema + +Get the namespace whether allow auto update schema + +**Command:** + +```shell +$ pulsar-admin namespaces get-is-allow-auto-update-schema options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-is-allow-auto-update-schema + +Set the namespace whether allow auto update schema + +**Command:** + +```shell +$ pulsar-admin namespaces set-is-allow-auto-update-schema options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-validation-enforce + +Get the schema validation enforced + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-validation-enforce options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-validation-enforce + +Set the schema whether open schema validation enforced + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-validation-enforce options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplicationSnapshotInterval for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplicationSnapshotInterval for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Clear backlog for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Unsubscribe the given subscription on all topics on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-encryption-required + +Enable or disable message encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-encryption-required + +Get encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-auth-mode + +Set subscription auth mode on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-auth-mode + +Get subscriptionAuthMod for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove delayed delivery policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers-per-topic + +Get maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers-per-topic + +Set maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers-per-topic + +Remove max producers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-topic + +Get maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-topic + +Set maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-topic + +Remove max consumers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-threshold + +Get offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-threshold + +Set offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-deletion-lag + +Get offloadDeletionLag, in minutes, for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-deletion-lag + +Set offloadDeletionLag for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-offload-deletion-lag + +Clear offloadDeletionLag for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-autoupdate-strategy + +Get the schema auto-update strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-autoupdate-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-autoupdate-strategy + +Set the schema auto-update strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-autoupdate-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-compatibility-strategy + +Get the schema compatibility strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-compatibility-strategy + +Set the schema compatibility strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-is-allow-auto-update-schema + +Get the namespace whether allow auto update schema + +**Command:** + +```shell +$ pulsar-admin namespaces get-is-allow-auto-update-schema options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-is-allow-auto-update-schema + +Set the namespace whether allow auto update schema + +**Command:** + +```shell +$ pulsar-admin namespaces set-is-allow-auto-update-schema options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-validation-enforce + +Get the schema validation enforced + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-validation-enforce options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-validation-enforce + +Set the schema whether open schema validation enforced + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-validation-enforce options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplicationSnapshotInterval for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplicationSnapshotInterval for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplicationSnapshotInterval for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Clear backlog for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Unsubscribe the given subscription on all topics on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-encryption-required + +Enable or disable message encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-encryption-required + +Get encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-auth-mode + +Set subscription auth mode on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-auth-mode + +Get subscriptionAuthMod for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove delayed delivery policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers-per-topic + +Get maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers-per-topic + +Set maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers-per-topic + +Remove max producers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-topic + +Get maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-topic + +Set maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-topic + +Remove max consumers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-threshold + +Get offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-threshold + +Set offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-deletion-lag + +Get offloadDeletionLag, in minutes, for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-deletion-lag + +Set offloadDeletionLag for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-offload-deletion-lag + +Clear offloadDeletionLag for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-autoupdate-strategy + +Get the schema auto-update strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-autoupdate-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-autoupdate-strategy + +Set the schema auto-update strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-autoupdate-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-compatibility-strategy + +Get the schema compatibility strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-compatibility-strategy + +Set the schema compatibility strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-is-allow-auto-update-schema + +Get the namespace whether allow auto update schema + +**Command:** + +```shell +$ pulsar-admin namespaces get-is-allow-auto-update-schema options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-is-allow-auto-update-schema + +Set the namespace whether allow auto update schema + +**Command:** + +```shell +$ pulsar-admin namespaces set-is-allow-auto-update-schema options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-validation-enforce + +Get the schema validation enforced + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-validation-enforce options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-validation-enforce + +Set the schema whether open schema validation enforced + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-validation-enforce options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplicationSnapshotInterval for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplicationSnapshotInterval for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplicationSnapshotInterval for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-topics-per-namespace + +Set max topics per namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-topics-per-namespace options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Clear backlog for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Unsubscribe the given subscription on all topics on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-encryption-required + +Enable or disable message encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-encryption-required + +Get encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-auth-mode + +Set subscription auth mode on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-auth-mode + +Get subscriptionAuthMod for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove delayed delivery policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers-per-topic + +Get maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers-per-topic + +Set maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers-per-topic + +Remove max producers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-topic + +Get maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-topic + +Set maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-topic + +Remove max consumers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-threshold + +Get offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-threshold + +Set offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-deletion-lag + +Get offloadDeletionLag, in minutes, for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-deletion-lag + +Set offloadDeletionLag for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-offload-deletion-lag + +Clear offloadDeletionLag for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-autoupdate-strategy + +Get the schema auto-update strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-autoupdate-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-autoupdate-strategy + +Set the schema auto-update strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-autoupdate-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-compatibility-strategy + +Get the schema compatibility strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-compatibility-strategy + +Set the schema compatibility strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-is-allow-auto-update-schema + +Get the namespace whether allow auto update schema + +**Command:** + +```shell +$ pulsar-admin namespaces get-is-allow-auto-update-schema options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-is-allow-auto-update-schema + +Set the namespace whether allow auto update schema + +**Command:** + +```shell +$ pulsar-admin namespaces set-is-allow-auto-update-schema options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-validation-enforce + +Get the schema validation enforced + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-validation-enforce options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-validation-enforce + +Set the schema whether open schema validation enforced + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-validation-enforce options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplicationSnapshotInterval for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplicationSnapshotInterval for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplicationSnapshotInterval for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-topics-per-namespace + +Set max topics per namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-topics-per-namespace options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-topics-per-namespace + +Get max topics per namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-topics-per-namespace options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Clear backlog for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Unsubscribe the given subscription on all topics on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-encryption-required + +Enable or disable message encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-encryption-required + +Get encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-auth-mode + +Set subscription auth mode on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-auth-mode + +Get subscriptionAuthMod for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove delayed delivery policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers-per-topic + +Get maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers-per-topic + +Set maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers-per-topic + +Remove max producers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-topic + +Get maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-topic + +Set maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-topic + +Remove max consumers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-threshold + +Get offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-threshold + +Set offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-deletion-lag + +Get offloadDeletionLag, in minutes, for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-deletion-lag + +Set offloadDeletionLag for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-offload-deletion-lag + +Clear offloadDeletionLag for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-autoupdate-strategy + +Get the schema auto-update strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-autoupdate-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-autoupdate-strategy + +Set the schema auto-update strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-autoupdate-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-compatibility-strategy + +Get the schema compatibility strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-compatibility-strategy + +Set the schema compatibility strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-is-allow-auto-update-schema + +Get the namespace whether allow auto update schema + +**Command:** + +```shell +$ pulsar-admin namespaces get-is-allow-auto-update-schema options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-is-allow-auto-update-schema + +Set the namespace whether allow auto update schema + +**Command:** + +```shell +$ pulsar-admin namespaces set-is-allow-auto-update-schema options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-validation-enforce + +Get the schema validation enforced + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-validation-enforce options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-validation-enforce + +Set the schema whether open schema validation enforced + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-validation-enforce options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplicationSnapshotInterval for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplicationSnapshotInterval for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplicationSnapshotInterval for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-topics-per-namespace + +Set max topics per namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-topics-per-namespace options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-topics-per-namespace + +Get max topics per namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-topics-per-namespace options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-topics-per-namespace + +Remove max topics per namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-topics-per-namespace options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Clear backlog for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Unsubscribe the given subscription on all topics on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-encryption-required + +Enable or disable message encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-encryption-required + +Get encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-auth-mode + +Set subscription auth mode on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-auth-mode + +Get subscriptionAuthMod for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove delayed delivery policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers-per-topic + +Get maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers-per-topic + +Set maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers-per-topic + +Remove max producers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-topic + +Get maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-topic + +Set maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-topic + +Remove max consumers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-threshold + +Get offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-threshold + +Set offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-deletion-lag + +Get offloadDeletionLag, in minutes, for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-deletion-lag + +Set offloadDeletionLag for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-offload-deletion-lag + +Clear offloadDeletionLag for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-autoupdate-strategy + +Get the schema auto-update strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-autoupdate-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-autoupdate-strategy + +Set the schema auto-update strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-autoupdate-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-compatibility-strategy + +Get the schema compatibility strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-compatibility-strategy + +Set the schema compatibility strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-is-allow-auto-update-schema + +Get the namespace whether allow auto update schema + +**Command:** + +```shell +$ pulsar-admin namespaces get-is-allow-auto-update-schema options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-is-allow-auto-update-schema + +Set the namespace whether allow auto update schema + +**Command:** + +```shell +$ pulsar-admin namespaces set-is-allow-auto-update-schema options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-validation-enforce + +Get the schema validation enforced + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-validation-enforce options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-validation-enforce + +Set the schema whether open schema validation enforced + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-validation-enforce options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplicationSnapshotInterval for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplicationSnapshotInterval for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplicationSnapshotInterval for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-topics-per-namespace + +Set max topics per namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-topics-per-namespace options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-topics-per-namespace + +Get max topics per namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-topics-per-namespace options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-topics-per-namespace + +Remove max topics per namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-topics-per-namespace options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-property + +Set property for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-property options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Clear backlog for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Unsubscribe the given subscription on all topics on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-encryption-required + +Enable or disable message encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-encryption-required + +Get encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-auth-mode + +Set subscription auth mode on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-auth-mode + +Get subscriptionAuthMod for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove delayed delivery policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers-per-topic + +Get maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers-per-topic + +Set maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers-per-topic + +Remove max producers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-topic + +Get maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-topic + +Set maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-topic + +Remove max consumers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-threshold + +Get offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-threshold + +Set offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-deletion-lag + +Get offloadDeletionLag, in minutes, for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-deletion-lag + +Set offloadDeletionLag for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-offload-deletion-lag + +Clear offloadDeletionLag for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-autoupdate-strategy + +Get the schema auto-update strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-autoupdate-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-autoupdate-strategy + +Set the schema auto-update strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-autoupdate-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-compatibility-strategy + +Get the schema compatibility strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-compatibility-strategy + +Set the schema compatibility strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-is-allow-auto-update-schema + +Get the namespace whether allow auto update schema + +**Command:** + +```shell +$ pulsar-admin namespaces get-is-allow-auto-update-schema options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-is-allow-auto-update-schema + +Set the namespace whether allow auto update schema + +**Command:** + +```shell +$ pulsar-admin namespaces set-is-allow-auto-update-schema options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-validation-enforce + +Get the schema validation enforced + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-validation-enforce options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-validation-enforce + +Set the schema whether open schema validation enforced + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-validation-enforce options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplicationSnapshotInterval for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplicationSnapshotInterval for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplicationSnapshotInterval for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-topics-per-namespace + +Set max topics per namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-topics-per-namespace options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-topics-per-namespace + +Get max topics per namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-topics-per-namespace options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-topics-per-namespace + +Remove max topics per namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-topics-per-namespace options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-property + +Set property for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-property options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-property + +Get property for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-property options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Clear backlog for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Unsubscribe the given subscription on all topics on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-encryption-required + +Enable or disable message encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-encryption-required + +Get encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-auth-mode + +Set subscription auth mode on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-auth-mode + +Get subscriptionAuthMod for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove delayed delivery policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers-per-topic + +Get maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers-per-topic + +Set maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers-per-topic + +Remove max producers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-topic + +Get maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-topic + +Set maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-topic + +Remove max consumers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-threshold + +Get offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-threshold + +Set offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-deletion-lag + +Get offloadDeletionLag, in minutes, for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-deletion-lag + +Set offloadDeletionLag for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-offload-deletion-lag + +Clear offloadDeletionLag for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-autoupdate-strategy + +Get the schema auto-update strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-autoupdate-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-autoupdate-strategy + +Set the schema auto-update strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-autoupdate-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-compatibility-strategy + +Get the schema compatibility strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-compatibility-strategy + +Set the schema compatibility strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-is-allow-auto-update-schema + +Get the namespace whether allow auto update schema + +**Command:** + +```shell +$ pulsar-admin namespaces get-is-allow-auto-update-schema options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-is-allow-auto-update-schema + +Set the namespace whether allow auto update schema + +**Command:** + +```shell +$ pulsar-admin namespaces set-is-allow-auto-update-schema options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-validation-enforce + +Get the schema validation enforced + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-validation-enforce options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-validation-enforce + +Set the schema whether open schema validation enforced + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-validation-enforce options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplicationSnapshotInterval for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplicationSnapshotInterval for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplicationSnapshotInterval for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-topics-per-namespace + +Set max topics per namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-topics-per-namespace options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-topics-per-namespace + +Get max topics per namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-topics-per-namespace options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-topics-per-namespace + +Remove max topics per namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-topics-per-namespace options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-property + +Set property for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-property options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-property + +Get property for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-property options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-property + +Remove property for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-property options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Clear backlog for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Unsubscribe the given subscription on all topics on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-encryption-required + +Enable or disable message encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-encryption-required + +Get encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-auth-mode + +Set subscription auth mode on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-auth-mode + +Get subscriptionAuthMod for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove delayed delivery policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers-per-topic + +Get maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers-per-topic + +Set maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers-per-topic + +Remove max producers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-topic + +Get maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-topic + +Set maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-topic + +Remove max consumers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-threshold + +Get offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-threshold + +Set offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-deletion-lag + +Get offloadDeletionLag, in minutes, for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-deletion-lag + +Set offloadDeletionLag for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-offload-deletion-lag + +Clear offloadDeletionLag for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-autoupdate-strategy + +Get the schema auto-update strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-autoupdate-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-autoupdate-strategy + +Set the schema auto-update strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-autoupdate-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-compatibility-strategy + +Get the schema compatibility strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-compatibility-strategy + +Set the schema compatibility strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-is-allow-auto-update-schema + +Get the namespace whether allow auto update schema + +**Command:** + +```shell +$ pulsar-admin namespaces get-is-allow-auto-update-schema options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-is-allow-auto-update-schema + +Set the namespace whether allow auto update schema + +**Command:** + +```shell +$ pulsar-admin namespaces set-is-allow-auto-update-schema options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-validation-enforce + +Get the schema validation enforced + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-validation-enforce options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-validation-enforce + +Set the schema whether open schema validation enforced + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-validation-enforce options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplicationSnapshotInterval for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplicationSnapshotInterval for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplicationSnapshotInterval for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-topics-per-namespace + +Set max topics per namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-topics-per-namespace options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-topics-per-namespace + +Get max topics per namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-topics-per-namespace options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-topics-per-namespace + +Remove max topics per namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-topics-per-namespace options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-property + +Set property for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-property options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-property + +Get property for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-property options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-property + +Remove property for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-property options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-properties + +Set properties of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Clear backlog for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Unsubscribe the given subscription on all topics on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-encryption-required + +Enable or disable message encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-encryption-required + +Get encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-auth-mode + +Set subscription auth mode on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-auth-mode + +Get subscriptionAuthMod for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove delayed delivery policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers-per-topic + +Get maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers-per-topic + +Set maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers-per-topic + +Remove max producers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-topic + +Get maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-topic + +Set maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-topic + +Remove max consumers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-threshold + +Get offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-threshold + +Set offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-deletion-lag + +Get offloadDeletionLag, in minutes, for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-deletion-lag + +Set offloadDeletionLag for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-offload-deletion-lag + +Clear offloadDeletionLag for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-autoupdate-strategy + +Get the schema auto-update strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-autoupdate-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-autoupdate-strategy + +Set the schema auto-update strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-autoupdate-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-compatibility-strategy + +Get the schema compatibility strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-compatibility-strategy + +Set the schema compatibility strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-is-allow-auto-update-schema + +Get the namespace whether allow auto update schema + +**Command:** + +```shell +$ pulsar-admin namespaces get-is-allow-auto-update-schema options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-is-allow-auto-update-schema + +Set the namespace whether allow auto update schema + +**Command:** + +```shell +$ pulsar-admin namespaces set-is-allow-auto-update-schema options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-validation-enforce + +Get the schema validation enforced + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-validation-enforce options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-validation-enforce + +Set the schema whether open schema validation enforced + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-validation-enforce options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplicationSnapshotInterval for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplicationSnapshotInterval for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplicationSnapshotInterval for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-topics-per-namespace + +Set max topics per namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-topics-per-namespace options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-topics-per-namespace + +Get max topics per namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-topics-per-namespace options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-topics-per-namespace + +Remove max topics per namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-topics-per-namespace options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-property + +Set property for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-property options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-property + +Get property for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-property options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-property + +Remove property for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-property options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-properties + +Set properties of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get properties of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Clear backlog for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Unsubscribe the given subscription on all topics on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-encryption-required + +Enable or disable message encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-encryption-required + +Get encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-auth-mode + +Set subscription auth mode on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-auth-mode + +Get subscriptionAuthMod for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove delayed delivery policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers-per-topic + +Get maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers-per-topic + +Set maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers-per-topic + +Remove max producers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-topic + +Get maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-topic + +Set maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-topic + +Remove max consumers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-threshold + +Get offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-threshold + +Set offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-deletion-lag + +Get offloadDeletionLag, in minutes, for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-deletion-lag + +Set offloadDeletionLag for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-offload-deletion-lag + +Clear offloadDeletionLag for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-autoupdate-strategy + +Get the schema auto-update strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-autoupdate-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-autoupdate-strategy + +Set the schema auto-update strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-autoupdate-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-compatibility-strategy + +Get the schema compatibility strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-compatibility-strategy + +Set the schema compatibility strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-is-allow-auto-update-schema + +Get the namespace whether allow auto update schema + +**Command:** + +```shell +$ pulsar-admin namespaces get-is-allow-auto-update-schema options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-is-allow-auto-update-schema + +Set the namespace whether allow auto update schema + +**Command:** + +```shell +$ pulsar-admin namespaces set-is-allow-auto-update-schema options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-validation-enforce + +Get the schema validation enforced + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-validation-enforce options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-validation-enforce + +Set the schema whether open schema validation enforced + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-validation-enforce options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplicationSnapshotInterval for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplicationSnapshotInterval for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplicationSnapshotInterval for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-topics-per-namespace + +Set max topics per namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-topics-per-namespace options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-topics-per-namespace + +Get max topics per namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-topics-per-namespace options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-topics-per-namespace + +Remove max topics per namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-topics-per-namespace options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-property + +Set property for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-property options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-property + +Get property for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-property options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-property + +Remove property for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-property options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-properties + +Set properties of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get properties of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-properties + +Clear all properties for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Clear backlog for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Unsubscribe the given subscription on all topics on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-encryption-required + +Enable or disable message encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-encryption-required + +Get encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-auth-mode + +Set subscription auth mode on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-auth-mode + +Get subscriptionAuthMod for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove delayed delivery policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers-per-topic + +Get maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers-per-topic + +Set maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers-per-topic + +Remove max producers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-topic + +Get maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-topic + +Set maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-topic + +Remove max consumers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-threshold + +Get offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-threshold + +Set offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-deletion-lag + +Get offloadDeletionLag, in minutes, for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-deletion-lag + +Set offloadDeletionLag for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-offload-deletion-lag + +Clear offloadDeletionLag for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-autoupdate-strategy + +Get the schema auto-update strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-autoupdate-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-autoupdate-strategy + +Set the schema auto-update strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-autoupdate-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-compatibility-strategy + +Get the schema compatibility strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-compatibility-strategy + +Set the schema compatibility strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-is-allow-auto-update-schema + +Get the namespace whether allow auto update schema + +**Command:** + +```shell +$ pulsar-admin namespaces get-is-allow-auto-update-schema options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-is-allow-auto-update-schema + +Set the namespace whether allow auto update schema + +**Command:** + +```shell +$ pulsar-admin namespaces set-is-allow-auto-update-schema options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-validation-enforce + +Get the schema validation enforced + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-validation-enforce options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-validation-enforce + +Set the schema whether open schema validation enforced + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-validation-enforce options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplicationSnapshotInterval for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplicationSnapshotInterval for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplicationSnapshotInterval for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-topics-per-namespace + +Set max topics per namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-topics-per-namespace options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-topics-per-namespace + +Get max topics per namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-topics-per-namespace options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-topics-per-namespace + +Remove max topics per namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-topics-per-namespace options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-property + +Set property for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-property options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-property + +Get property for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-property options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-property + +Remove property for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-property options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-properties + +Set properties of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get properties of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-properties + +Clear all properties for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-resource-group + +Get ResourceGroup for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-resource-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Clear backlog for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Unsubscribe the given subscription on all topics on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-encryption-required + +Enable or disable message encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-encryption-required + +Get encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-auth-mode + +Set subscription auth mode on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-auth-mode + +Get subscriptionAuthMod for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove delayed delivery policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers-per-topic + +Get maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers-per-topic + +Set maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers-per-topic + +Remove max producers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-topic + +Get maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-topic + +Set maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-topic + +Remove max consumers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-threshold + +Get offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-threshold + +Set offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-deletion-lag + +Get offloadDeletionLag, in minutes, for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-deletion-lag + +Set offloadDeletionLag for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-offload-deletion-lag + +Clear offloadDeletionLag for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-autoupdate-strategy + +Get the schema auto-update strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-autoupdate-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-autoupdate-strategy + +Set the schema auto-update strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-autoupdate-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-compatibility-strategy + +Get the schema compatibility strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-compatibility-strategy + +Set the schema compatibility strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-is-allow-auto-update-schema + +Get the namespace whether allow auto update schema + +**Command:** + +```shell +$ pulsar-admin namespaces get-is-allow-auto-update-schema options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-is-allow-auto-update-schema + +Set the namespace whether allow auto update schema + +**Command:** + +```shell +$ pulsar-admin namespaces set-is-allow-auto-update-schema options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-validation-enforce + +Get the schema validation enforced + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-validation-enforce options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-validation-enforce + +Set the schema whether open schema validation enforced + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-validation-enforce options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplicationSnapshotInterval for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplicationSnapshotInterval for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplicationSnapshotInterval for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-topics-per-namespace + +Set max topics per namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-topics-per-namespace options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-topics-per-namespace + +Get max topics per namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-topics-per-namespace options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-topics-per-namespace + +Remove max topics per namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-topics-per-namespace options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-property + +Set property for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-property options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-property + +Get property for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-property options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-property + +Remove property for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-property options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-properties + +Set properties of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get properties of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-properties + +Clear all properties for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-resource-group + +Get ResourceGroup for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-resource-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-resource-group + +Set ResourceGroup for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-resource-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Clear backlog for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Unsubscribe the given subscription on all topics on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-encryption-required + +Enable or disable message encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-encryption-required + +Get encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-auth-mode + +Set subscription auth mode on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-auth-mode + +Get subscriptionAuthMod for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove delayed delivery policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers-per-topic + +Get maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers-per-topic + +Set maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers-per-topic + +Remove max producers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-topic + +Get maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-topic + +Set maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-topic + +Remove max consumers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-threshold + +Get offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-threshold + +Set offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-deletion-lag + +Get offloadDeletionLag, in minutes, for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-deletion-lag + +Set offloadDeletionLag for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-offload-deletion-lag + +Clear offloadDeletionLag for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-autoupdate-strategy + +Get the schema auto-update strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-autoupdate-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-autoupdate-strategy + +Set the schema auto-update strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-autoupdate-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-compatibility-strategy + +Get the schema compatibility strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-compatibility-strategy + +Set the schema compatibility strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-is-allow-auto-update-schema + +Get the namespace whether allow auto update schema + +**Command:** + +```shell +$ pulsar-admin namespaces get-is-allow-auto-update-schema options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-is-allow-auto-update-schema + +Set the namespace whether allow auto update schema + +**Command:** + +```shell +$ pulsar-admin namespaces set-is-allow-auto-update-schema options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-validation-enforce + +Get the schema validation enforced + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-validation-enforce options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-validation-enforce + +Set the schema whether open schema validation enforced + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-validation-enforce options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplicationSnapshotInterval for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplicationSnapshotInterval for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplicationSnapshotInterval for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-topics-per-namespace + +Set max topics per namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-topics-per-namespace options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-topics-per-namespace + +Get max topics per namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-topics-per-namespace options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-topics-per-namespace + +Remove max topics per namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-topics-per-namespace options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-property + +Set property for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-property options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-property + +Get property for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-property options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-property + +Remove property for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-property options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-properties + +Set properties of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get properties of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-properties + +Clear all properties for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-resource-group + +Get ResourceGroup for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-resource-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-resource-group + +Set ResourceGroup for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-resource-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-resource-group + +Remove ResourceGroup from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-resource-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Clear backlog for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Unsubscribe the given subscription on all topics on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-encryption-required + +Enable or disable message encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-encryption-required + +Get encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-auth-mode + +Set subscription auth mode on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-auth-mode + +Get subscriptionAuthMod for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove delayed delivery policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers-per-topic + +Get maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers-per-topic + +Set maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers-per-topic + +Remove max producers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-topic + +Get maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-topic + +Set maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-topic + +Remove max consumers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-threshold + +Get offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-threshold + +Set offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-deletion-lag + +Get offloadDeletionLag, in minutes, for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-deletion-lag + +Set offloadDeletionLag for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-offload-deletion-lag + +Clear offloadDeletionLag for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-autoupdate-strategy + +Get the schema auto-update strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-autoupdate-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-autoupdate-strategy + +Set the schema auto-update strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-autoupdate-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-compatibility-strategy + +Get the schema compatibility strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-compatibility-strategy + +Set the schema compatibility strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-is-allow-auto-update-schema + +Get the namespace whether allow auto update schema + +**Command:** + +```shell +$ pulsar-admin namespaces get-is-allow-auto-update-schema options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-is-allow-auto-update-schema + +Set the namespace whether allow auto update schema + +**Command:** + +```shell +$ pulsar-admin namespaces set-is-allow-auto-update-schema options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-validation-enforce + +Get the schema validation enforced + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-validation-enforce options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-validation-enforce + +Set the schema whether open schema validation enforced + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-validation-enforce options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplicationSnapshotInterval for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplicationSnapshotInterval for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplicationSnapshotInterval for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-topics-per-namespace + +Set max topics per namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-topics-per-namespace options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-topics-per-namespace + +Get max topics per namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-topics-per-namespace options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-topics-per-namespace + +Remove max topics per namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-topics-per-namespace options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-property + +Set property for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-property options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-property + +Get property for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-property options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-property + +Remove property for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-property options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-properties + +Set properties of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get properties of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-properties + +Clear all properties for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-resource-group + +Get ResourceGroup for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-resource-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-resource-group + +Set ResourceGroup for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-resource-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-resource-group + +Remove ResourceGroup from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-resource-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-entry-filters + +Get entry filters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-entry-filters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Clear backlog for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Unsubscribe the given subscription on all topics on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-encryption-required + +Enable or disable message encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-encryption-required + +Get encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-auth-mode + +Set subscription auth mode on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-auth-mode + +Get subscriptionAuthMod for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove delayed delivery policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers-per-topic + +Get maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers-per-topic + +Set maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers-per-topic + +Remove max producers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-topic + +Get maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-topic + +Set maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-topic + +Remove max consumers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-threshold + +Get offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-threshold + +Set offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-deletion-lag + +Get offloadDeletionLag, in minutes, for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-deletion-lag + +Set offloadDeletionLag for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-offload-deletion-lag + +Clear offloadDeletionLag for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-autoupdate-strategy + +Get the schema auto-update strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-autoupdate-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-autoupdate-strategy + +Set the schema auto-update strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-autoupdate-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-compatibility-strategy + +Get the schema compatibility strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-compatibility-strategy + +Set the schema compatibility strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-is-allow-auto-update-schema + +Get the namespace whether allow auto update schema + +**Command:** + +```shell +$ pulsar-admin namespaces get-is-allow-auto-update-schema options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-is-allow-auto-update-schema + +Set the namespace whether allow auto update schema + +**Command:** + +```shell +$ pulsar-admin namespaces set-is-allow-auto-update-schema options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-validation-enforce + +Get the schema validation enforced + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-validation-enforce options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-validation-enforce + +Set the schema whether open schema validation enforced + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-validation-enforce options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplicationSnapshotInterval for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplicationSnapshotInterval for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplicationSnapshotInterval for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-topics-per-namespace + +Set max topics per namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-topics-per-namespace options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-topics-per-namespace + +Get max topics per namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-topics-per-namespace options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-topics-per-namespace + +Remove max topics per namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-topics-per-namespace options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-property + +Set property for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-property options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-property + +Get property for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-property options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-property + +Remove property for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-property options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-properties + +Set properties of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get properties of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-properties + +Clear all properties for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-resource-group + +Get ResourceGroup for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-resource-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-resource-group + +Set ResourceGroup for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-resource-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-resource-group + +Remove ResourceGroup from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-resource-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-entry-filters + +Get entry filters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-entry-filters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-entry-filters + +Set entry filters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-entry-filters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Clear backlog for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Unsubscribe the given subscription on all topics on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-encryption-required + +Enable or disable message encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-encryption-required + +Get encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-auth-mode + +Set subscription auth mode on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-auth-mode + +Get subscriptionAuthMod for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove delayed delivery policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers-per-topic + +Get maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers-per-topic + +Set maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers-per-topic + +Remove max producers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-topic + +Get maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-topic + +Set maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-topic + +Remove max consumers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-threshold + +Get offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-threshold + +Set offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-deletion-lag + +Get offloadDeletionLag, in minutes, for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-deletion-lag + +Set offloadDeletionLag for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-offload-deletion-lag + +Clear offloadDeletionLag for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-autoupdate-strategy + +Get the schema auto-update strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-autoupdate-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-autoupdate-strategy + +Set the schema auto-update strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-autoupdate-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-compatibility-strategy + +Get the schema compatibility strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-compatibility-strategy + +Set the schema compatibility strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-is-allow-auto-update-schema + +Get the namespace whether allow auto update schema + +**Command:** + +```shell +$ pulsar-admin namespaces get-is-allow-auto-update-schema options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-is-allow-auto-update-schema + +Set the namespace whether allow auto update schema + +**Command:** + +```shell +$ pulsar-admin namespaces set-is-allow-auto-update-schema options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-validation-enforce + +Get the schema validation enforced + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-validation-enforce options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-validation-enforce + +Set the schema whether open schema validation enforced + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-validation-enforce options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplicationSnapshotInterval for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplicationSnapshotInterval for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplicationSnapshotInterval for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-topics-per-namespace + +Set max topics per namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-topics-per-namespace options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-topics-per-namespace + +Get max topics per namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-topics-per-namespace options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-topics-per-namespace + +Remove max topics per namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-topics-per-namespace options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-property + +Set property for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-property options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-property + +Get property for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-property options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-property + +Remove property for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-property options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-properties + +Set properties of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get properties of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-properties + +Clear all properties for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-resource-group + +Get ResourceGroup for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-resource-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-resource-group + +Set ResourceGroup for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-resource-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-resource-group + +Remove ResourceGroup from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-resource-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-entry-filters + +Get entry filters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-entry-filters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-entry-filters + +Set entry filters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-entry-filters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-entry-filters + +Remove entry filters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-entry-filters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Clear backlog for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Unsubscribe the given subscription on all topics on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-encryption-required + +Enable or disable message encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-encryption-required + +Get encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-auth-mode + +Set subscription auth mode on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-auth-mode + +Get subscriptionAuthMod for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove delayed delivery policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers-per-topic + +Get maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers-per-topic + +Set maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers-per-topic + +Remove max producers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-topic + +Get maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-topic + +Set maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-topic + +Remove max consumers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-threshold + +Get offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-threshold + +Set offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-deletion-lag + +Get offloadDeletionLag, in minutes, for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-deletion-lag + +Set offloadDeletionLag for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-offload-deletion-lag + +Clear offloadDeletionLag for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-autoupdate-strategy + +Get the schema auto-update strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-autoupdate-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-autoupdate-strategy + +Set the schema auto-update strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-autoupdate-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-compatibility-strategy + +Get the schema compatibility strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-compatibility-strategy + +Set the schema compatibility strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-is-allow-auto-update-schema + +Get the namespace whether allow auto update schema + +**Command:** + +```shell +$ pulsar-admin namespaces get-is-allow-auto-update-schema options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-is-allow-auto-update-schema + +Set the namespace whether allow auto update schema + +**Command:** + +```shell +$ pulsar-admin namespaces set-is-allow-auto-update-schema options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-validation-enforce + +Get the schema validation enforced + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-validation-enforce options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-validation-enforce + +Set the schema whether open schema validation enforced + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-validation-enforce options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplicationSnapshotInterval for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplicationSnapshotInterval for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplicationSnapshotInterval for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-topics-per-namespace + +Set max topics per namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-topics-per-namespace options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-topics-per-namespace + +Get max topics per namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-topics-per-namespace options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-topics-per-namespace + +Remove max topics per namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-topics-per-namespace options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-property + +Set property for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-property options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-property + +Get property for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-property options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-property + +Remove property for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-property options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-properties + +Set properties of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get properties of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-properties + +Clear all properties for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-resource-group + +Get ResourceGroup for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-resource-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-resource-group + +Set ResourceGroup for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-resource-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-resource-group + +Remove ResourceGroup from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-resource-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-entry-filters + +Get entry filters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-entry-filters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-entry-filters + +Set entry filters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-entry-filters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-entry-filters + +Remove entry filters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-entry-filters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-migration-state + +Update migration state for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces update-migration-state options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Clear backlog for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Unsubscribe the given subscription on all topics on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-encryption-required + +Enable or disable message encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-encryption-required + +Get encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-auth-mode + +Set subscription auth mode on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-auth-mode + +Get subscriptionAuthMod for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove delayed delivery policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers-per-topic + +Get maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers-per-topic + +Set maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers-per-topic + +Remove max producers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-topic + +Get maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-topic + +Set maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-topic + +Remove max consumers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-threshold + +Get offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-threshold + +Set offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-deletion-lag + +Get offloadDeletionLag, in minutes, for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-deletion-lag + +Set offloadDeletionLag for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-offload-deletion-lag + +Clear offloadDeletionLag for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-autoupdate-strategy + +Get the schema auto-update strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-autoupdate-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-autoupdate-strategy + +Set the schema auto-update strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-autoupdate-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-compatibility-strategy + +Get the schema compatibility strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-compatibility-strategy + +Set the schema compatibility strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-is-allow-auto-update-schema + +Get the namespace whether allow auto update schema + +**Command:** + +```shell +$ pulsar-admin namespaces get-is-allow-auto-update-schema options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-is-allow-auto-update-schema + +Set the namespace whether allow auto update schema + +**Command:** + +```shell +$ pulsar-admin namespaces set-is-allow-auto-update-schema options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-validation-enforce + +Get the schema validation enforced + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-validation-enforce options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-validation-enforce + +Set the schema whether open schema validation enforced + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-validation-enforce options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplicationSnapshotInterval for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplicationSnapshotInterval for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplicationSnapshotInterval for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-topics-per-namespace + +Set max topics per namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-topics-per-namespace options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-topics-per-namespace + +Get max topics per namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-topics-per-namespace options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-topics-per-namespace + +Remove max topics per namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-topics-per-namespace options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-property + +Set property for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-property options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-property + +Get property for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-property options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-property + +Remove property for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-property options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-properties + +Set properties of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get properties of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-properties + +Clear all properties for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-resource-group + +Get ResourceGroup for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-resource-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-resource-group + +Set ResourceGroup for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-resource-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-resource-group + +Remove ResourceGroup from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-resource-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-entry-filters + +Get entry filters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-entry-filters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-entry-filters + +Set entry filters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-entry-filters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-entry-filters + +Remove entry filters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-entry-filters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-migration-state + +Update migration state for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces update-migration-state options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatcher-pause-on-ack-state-persistent + +Enable dispatcherPauseOnAckStatePersistent for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatcher-pause-on-ack-state-persistent options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Clear backlog for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Unsubscribe the given subscription on all topics on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-encryption-required + +Enable or disable message encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-encryption-required + +Get encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-auth-mode + +Set subscription auth mode on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-auth-mode + +Get subscriptionAuthMod for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove delayed delivery policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers-per-topic + +Get maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers-per-topic + +Set maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers-per-topic + +Remove max producers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-topic + +Get maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-topic + +Set maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-topic + +Remove max consumers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-threshold + +Get offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-threshold + +Set offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-deletion-lag + +Get offloadDeletionLag, in minutes, for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-deletion-lag + +Set offloadDeletionLag for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-offload-deletion-lag + +Clear offloadDeletionLag for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-autoupdate-strategy + +Get the schema auto-update strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-autoupdate-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-autoupdate-strategy + +Set the schema auto-update strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-autoupdate-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-compatibility-strategy + +Get the schema compatibility strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-compatibility-strategy + +Set the schema compatibility strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-is-allow-auto-update-schema + +Get the namespace whether allow auto update schema + +**Command:** + +```shell +$ pulsar-admin namespaces get-is-allow-auto-update-schema options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-is-allow-auto-update-schema + +Set the namespace whether allow auto update schema + +**Command:** + +```shell +$ pulsar-admin namespaces set-is-allow-auto-update-schema options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-validation-enforce + +Get the schema validation enforced + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-validation-enforce options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-validation-enforce + +Set the schema whether open schema validation enforced + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-validation-enforce options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplicationSnapshotInterval for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplicationSnapshotInterval for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplicationSnapshotInterval for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-topics-per-namespace + +Set max topics per namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-topics-per-namespace options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-topics-per-namespace + +Get max topics per namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-topics-per-namespace options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-topics-per-namespace + +Remove max topics per namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-topics-per-namespace options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-property + +Set property for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-property options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-property + +Get property for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-property options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-property + +Remove property for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-property options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-properties + +Set properties of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get properties of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-properties + +Clear all properties for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-resource-group + +Get ResourceGroup for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-resource-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-resource-group + +Set ResourceGroup for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-resource-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-resource-group + +Remove ResourceGroup from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-resource-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-entry-filters + +Get entry filters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-entry-filters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-entry-filters + +Set entry filters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-entry-filters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-entry-filters + +Remove entry filters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-entry-filters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-migration-state + +Update migration state for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces update-migration-state options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatcher-pause-on-ack-state-persistent + +Enable dispatcherPauseOnAckStatePersistent for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatcher-pause-on-ack-state-persistent options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatcher-pause-on-ack-state-persistent + +Get the dispatcherPauseOnAckStatePersistent for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatcher-pause-on-ack-state-persistent options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# namespaces + +Operations about namespaces + + +```shell +$ pulsar-admin namespaces subcommand +``` + + + +## list + +Get the namespaces for a tenant + +**Command:** + +```shell +$ pulsar-admin namespaces list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-cluster + +Get the namespaces for a tenant in a cluster + +**Command:** + +```shell +$ pulsar-admin namespaces list-cluster options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +Get the list of topics for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundles + +Get the list of bundles for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces bundles options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## destinations + +Get the list of destinations for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces destinations options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## policies + +Get the configuration policies of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new namespace + +**Command:** + +```shell +$ pulsar-admin namespaces create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes a namespace. + +**Command:** + +```shell +$ pulsar-admin namespaces delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscription-permission + +Get permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-subscription-permission + +Grant permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces grant-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-subscription-permission + +Revoke permissions to access subscription admin-api + +**Command:** + +```shell +$ pulsar-admin namespaces revoke-subscription-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-clusters + +Set replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-clusters + +Get replication clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-allowed-clusters + +Set allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-allowed-clusters + +Get allowed clusters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-allowed-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove Message TTL for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-expiration-time + +Get subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-expiration-time + +Set subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-expiration-time + +Remove subscription expiration time for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-expiration-time options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-group + +Get Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-anti-affinity-group + +Set Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-anti-affinity-namespaces + +Get Anti-affinity namespaces grouped with the given anti-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-anti-affinity-namespaces options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-anti-affinity-group + +Remove Anti-affinity group name for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces delete-anti-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove Deduplication for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-topic-creation + +Enable or disable autoTopicCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-topic-creation + +Get autoTopicCreation info for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-topic-creation + +Remove override of autoTopicCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-topic-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a namespace, overriding broker settings + +**Command:** + +```shell +$ pulsar-admin namespaces set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces set-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-bookie-affinity-group + +Get the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces get-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-bookie-affinity-group + +Set the bookie-affinity group name + +**Command:** + +```shell +$ pulsar-admin namespaces delete-bookie-affinity-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a namespace from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## split-bundle + +Split a namespace-bundle from the current serving broker + +**Command:** + +```shell +$ pulsar-admin namespaces split-bundle options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-topic-positions + +Get the positions for one or more topic(s) in a namespace bundle + +**Command:** + +```shell +$ pulsar-admin namespaces get-topic-positions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove configured subscribe-rate per consumer for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for all subscription of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0) + +**Command:** + +```shell +$ pulsar-admin namespaces get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator configured message-dispatch-rate for all topics of the namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Clear backlog for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Unsubscribe the given subscription on all topics on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-encryption-required + +Enable or disable message encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-encryption-required + +Get encryption required for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-encryption-required options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-auth-mode + +Set subscription auth mode on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-auth-mode + +Get subscriptionAuthMod for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-subscription-auth-mode options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove delayed delivery policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers-per-topic + +Get maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers-per-topic + +Set maxProducersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers-per-topic + +Remove max producers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-producers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-topic + +Get maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-topic + +Set maxConsumersPerTopic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-topic + +Remove max consumers per topic for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove maxConsumersPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove maxUnackedMessagesPerSubscription for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove maxUnackedMessagesPerConsumer for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compactionThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-threshold + +Get offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-threshold + +Set offloadThreshold for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-deletion-lag + +Get offloadDeletionLag, in minutes, for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-deletion-lag + +Set offloadDeletionLag for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-offload-deletion-lag + +Clear offloadDeletionLag for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-offload-deletion-lag options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-autoupdate-strategy + +Get the schema auto-update strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-autoupdate-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-autoupdate-strategy + +Set the schema auto-update strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-autoupdate-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-compatibility-strategy + +Get the schema compatibility strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-compatibility-strategy + +Set the schema compatibility strategy for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-is-allow-auto-update-schema + +Get the namespace whether allow auto update schema + +**Command:** + +```shell +$ pulsar-admin namespaces get-is-allow-auto-update-schema options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-is-allow-auto-update-schema + +Set the namespace whether allow auto update schema + +**Command:** + +```shell +$ pulsar-admin namespaces set-is-allow-auto-update-schema options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-validation-enforce + +Get the schema validation enforced + +**Command:** + +```shell +$ pulsar-admin namespaces get-schema-validation-enforce options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-validation-enforce + +Set the schema whether open schema validation enforced + +**Command:** + +```shell +$ pulsar-admin namespaces set-schema-validation-enforce options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplicationSnapshotInterval for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplicationSnapshotInterval for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplicationSnapshotInterval for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-topics-per-namespace + +Set max topics per namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-max-topics-per-namespace options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-topics-per-namespace + +Get max topics per namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-max-topics-per-namespace options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-topics-per-namespace + +Remove max topics per namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-max-topics-per-namespace options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-property + +Set property for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-property options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-property + +Get property for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-property options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-property + +Remove property for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-property options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-properties + +Set properties of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get properties of a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-properties + +Clear all properties for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces clear-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-resource-group + +Get ResourceGroup for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-resource-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-resource-group + +Set ResourceGroup for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-resource-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-resource-group + +Remove ResourceGroup from a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-resource-group options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-entry-filters + +Get entry filters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-entry-filters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-entry-filters + +Set entry filters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-entry-filters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-entry-filters + +Remove entry filters for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-entry-filters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-migration-state + +Update migration state for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces update-migration-state options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatcher-pause-on-ack-state-persistent + +Enable dispatcherPauseOnAckStatePersistent for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces set-dispatcher-pause-on-ack-state-persistent options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatcher-pause-on-ack-state-persistent + +Get the dispatcherPauseOnAckStatePersistent for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces get-dispatcher-pause-on-ack-state-persistent options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatcher-pause-on-ack-state-persistent + +Remove dispatcherPauseOnAckStatePersistent for a namespace + +**Command:** + +```shell +$ pulsar-admin namespaces remove-dispatcher-pause-on-ack-state-persistent options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + diff --git a/static/reference/4.0.x/pulsar-admin/ns-isolation-policy.md b/static/reference/4.0.x/pulsar-admin/ns-isolation-policy.md new file mode 100644 index 000000000000..fcfd0dea0d97 --- /dev/null +++ b/static/reference/4.0.x/pulsar-admin/ns-isolation-policy.md @@ -0,0 +1,438 @@ +# ns-isolation-policy + +Operations about namespace isolation policy + + +```shell +$ pulsar-admin ns-isolation-policy subcommand +``` + + + +## set + +Create/Update a namespace isolation policy for a cluster. This operation requires Pulsar super-user privileges + +**Command:** + +```shell +$ pulsar-admin ns-isolation-policy set options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# ns-isolation-policy + +Operations about namespace isolation policy + + +```shell +$ pulsar-admin ns-isolation-policy subcommand +``` + + + +## set + +Create/Update a namespace isolation policy for a cluster. This operation requires Pulsar super-user privileges + +**Command:** + +```shell +$ pulsar-admin ns-isolation-policy set options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get + +Get namespace isolation policy of a cluster. This operation requires Pulsar super-user privileges + +**Command:** + +```shell +$ pulsar-admin ns-isolation-policy get options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# ns-isolation-policy + +Operations about namespace isolation policy + + +```shell +$ pulsar-admin ns-isolation-policy subcommand +``` + + + +## set + +Create/Update a namespace isolation policy for a cluster. This operation requires Pulsar super-user privileges + +**Command:** + +```shell +$ pulsar-admin ns-isolation-policy set options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get + +Get namespace isolation policy of a cluster. This operation requires Pulsar super-user privileges + +**Command:** + +```shell +$ pulsar-admin ns-isolation-policy get options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list + +List all namespace isolation policies of a cluster. This operation requires Pulsar super-user privileges + +**Command:** + +```shell +$ pulsar-admin ns-isolation-policy list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# ns-isolation-policy + +Operations about namespace isolation policy + + +```shell +$ pulsar-admin ns-isolation-policy subcommand +``` + + + +## set + +Create/Update a namespace isolation policy for a cluster. This operation requires Pulsar super-user privileges + +**Command:** + +```shell +$ pulsar-admin ns-isolation-policy set options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get + +Get namespace isolation policy of a cluster. This operation requires Pulsar super-user privileges + +**Command:** + +```shell +$ pulsar-admin ns-isolation-policy get options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list + +List all namespace isolation policies of a cluster. This operation requires Pulsar super-user privileges + +**Command:** + +```shell +$ pulsar-admin ns-isolation-policy list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete namespace isolation policy of a cluster. This operation requires Pulsar super-user privileges + +**Command:** + +```shell +$ pulsar-admin ns-isolation-policy delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# ns-isolation-policy + +Operations about namespace isolation policy + + +```shell +$ pulsar-admin ns-isolation-policy subcommand +``` + + + +## set + +Create/Update a namespace isolation policy for a cluster. This operation requires Pulsar super-user privileges + +**Command:** + +```shell +$ pulsar-admin ns-isolation-policy set options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get + +Get namespace isolation policy of a cluster. This operation requires Pulsar super-user privileges + +**Command:** + +```shell +$ pulsar-admin ns-isolation-policy get options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list + +List all namespace isolation policies of a cluster. This operation requires Pulsar super-user privileges + +**Command:** + +```shell +$ pulsar-admin ns-isolation-policy list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete namespace isolation policy of a cluster. This operation requires Pulsar super-user privileges + +**Command:** + +```shell +$ pulsar-admin ns-isolation-policy delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## brokers + +List all brokers with namespace-isolation policies attached to it. This operation requires Pulsar super-user privileges + +**Command:** + +```shell +$ pulsar-admin ns-isolation-policy brokers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# ns-isolation-policy + +Operations about namespace isolation policy + + +```shell +$ pulsar-admin ns-isolation-policy subcommand +``` + + + +## set + +Create/Update a namespace isolation policy for a cluster. This operation requires Pulsar super-user privileges + +**Command:** + +```shell +$ pulsar-admin ns-isolation-policy set options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get + +Get namespace isolation policy of a cluster. This operation requires Pulsar super-user privileges + +**Command:** + +```shell +$ pulsar-admin ns-isolation-policy get options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list + +List all namespace isolation policies of a cluster. This operation requires Pulsar super-user privileges + +**Command:** + +```shell +$ pulsar-admin ns-isolation-policy list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete namespace isolation policy of a cluster. This operation requires Pulsar super-user privileges + +**Command:** + +```shell +$ pulsar-admin ns-isolation-policy delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## brokers + +List all brokers with namespace-isolation policies attached to it. This operation requires Pulsar super-user privileges + +**Command:** + +```shell +$ pulsar-admin ns-isolation-policy brokers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## broker + +Get broker with namespace-isolation policies attached to it. This operation requires Pulsar super-user privileges + +**Command:** + +```shell +$ pulsar-admin ns-isolation-policy broker options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + diff --git a/static/reference/4.0.x/pulsar-admin/packages.md b/static/reference/4.0.x/pulsar-admin/packages.md new file mode 100644 index 000000000000..627a4eab2fef --- /dev/null +++ b/static/reference/4.0.x/pulsar-admin/packages.md @@ -0,0 +1,574 @@ +# packages + +Operations about packages + + +```shell +$ pulsar-admin packages subcommand +``` + + + +## get-metadata + +Get a package metadata information. + +**Command:** + +```shell +$ pulsar-admin packages get-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# packages + +Operations about packages + + +```shell +$ pulsar-admin packages subcommand +``` + + + +## get-metadata + +Get a package metadata information. + +**Command:** + +```shell +$ pulsar-admin packages get-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-metadata + +Update a package metadata information. + +**Command:** + +```shell +$ pulsar-admin packages update-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# packages + +Operations about packages + + +```shell +$ pulsar-admin packages subcommand +``` + + + +## get-metadata + +Get a package metadata information. + +**Command:** + +```shell +$ pulsar-admin packages get-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-metadata + +Update a package metadata information. + +**Command:** + +```shell +$ pulsar-admin packages update-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## upload + +Upload a package + +**Command:** + +```shell +$ pulsar-admin packages upload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# packages + +Operations about packages + + +```shell +$ pulsar-admin packages subcommand +``` + + + +## get-metadata + +Get a package metadata information. + +**Command:** + +```shell +$ pulsar-admin packages get-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-metadata + +Update a package metadata information. + +**Command:** + +```shell +$ pulsar-admin packages update-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## upload + +Upload a package + +**Command:** + +```shell +$ pulsar-admin packages upload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## download + +Download a package + +**Command:** + +```shell +$ pulsar-admin packages download options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# packages + +Operations about packages + + +```shell +$ pulsar-admin packages subcommand +``` + + + +## get-metadata + +Get a package metadata information. + +**Command:** + +```shell +$ pulsar-admin packages get-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-metadata + +Update a package metadata information. + +**Command:** + +```shell +$ pulsar-admin packages update-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## upload + +Upload a package + +**Command:** + +```shell +$ pulsar-admin packages upload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## download + +Download a package + +**Command:** + +```shell +$ pulsar-admin packages download options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list + +List all packages with given type in the specified namespace + +**Command:** + +```shell +$ pulsar-admin packages list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# packages + +Operations about packages + + +```shell +$ pulsar-admin packages subcommand +``` + + + +## get-metadata + +Get a package metadata information. + +**Command:** + +```shell +$ pulsar-admin packages get-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-metadata + +Update a package metadata information. + +**Command:** + +```shell +$ pulsar-admin packages update-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## upload + +Upload a package + +**Command:** + +```shell +$ pulsar-admin packages upload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## download + +Download a package + +**Command:** + +```shell +$ pulsar-admin packages download options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list + +List all packages with given type in the specified namespace + +**Command:** + +```shell +$ pulsar-admin packages list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-versions + +List all versions of the given package + +**Command:** + +```shell +$ pulsar-admin packages list-versions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# packages + +Operations about packages + + +```shell +$ pulsar-admin packages subcommand +``` + + + +## get-metadata + +Get a package metadata information. + +**Command:** + +```shell +$ pulsar-admin packages get-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-metadata + +Update a package metadata information. + +**Command:** + +```shell +$ pulsar-admin packages update-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## upload + +Upload a package + +**Command:** + +```shell +$ pulsar-admin packages upload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## download + +Download a package + +**Command:** + +```shell +$ pulsar-admin packages download options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list + +List all packages with given type in the specified namespace + +**Command:** + +```shell +$ pulsar-admin packages list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-versions + +List all versions of the given package + +**Command:** + +```shell +$ pulsar-admin packages list-versions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a package + +**Command:** + +```shell +$ pulsar-admin packages delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + diff --git a/static/reference/4.0.x/pulsar-admin/proxy-stats.md b/static/reference/4.0.x/pulsar-admin/proxy-stats.md new file mode 100644 index 000000000000..aa5dc070b69a --- /dev/null +++ b/static/reference/4.0.x/pulsar-admin/proxy-stats.md @@ -0,0 +1,74 @@ +# proxy-stats + +Operations to collect Proxy statistics + + +```shell +$ pulsar-admin proxy-stats subcommand +``` + + + +## connections + +dump connections metrics for Monitoring + +**Command:** + +```shell +$ pulsar-admin proxy-stats connections options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# proxy-stats + +Operations to collect Proxy statistics + + +```shell +$ pulsar-admin proxy-stats subcommand +``` + + + +## connections + +dump connections metrics for Monitoring + +**Command:** + +```shell +$ pulsar-admin proxy-stats connections options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## topics + +dump topics metrics for Monitoring + +**Command:** + +```shell +$ pulsar-admin proxy-stats topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + diff --git a/static/reference/4.0.x/pulsar-admin/resource-quotas.md b/static/reference/4.0.x/pulsar-admin/resource-quotas.md new file mode 100644 index 000000000000..89a1aed99e48 --- /dev/null +++ b/static/reference/4.0.x/pulsar-admin/resource-quotas.md @@ -0,0 +1,138 @@ +# resource-quotas + +Operations about resource quotas + + +```shell +$ pulsar-admin resource-quotas subcommand +``` + + + +## get + +Get the resource quota for specified namespace bundle, or default quota if no namespace/bundle specified. + +**Command:** + +```shell +$ pulsar-admin resource-quotas get options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# resource-quotas + +Operations about resource quotas + + +```shell +$ pulsar-admin resource-quotas subcommand +``` + + + +## get + +Get the resource quota for specified namespace bundle, or default quota if no namespace/bundle specified. + +**Command:** + +```shell +$ pulsar-admin resource-quotas get options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set + +Set the resource quota for specified namespace bundle, or default quota if no namespace/bundle specified. + +**Command:** + +```shell +$ pulsar-admin resource-quotas set options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# resource-quotas + +Operations about resource quotas + + +```shell +$ pulsar-admin resource-quotas subcommand +``` + + + +## get + +Get the resource quota for specified namespace bundle, or default quota if no namespace/bundle specified. + +**Command:** + +```shell +$ pulsar-admin resource-quotas get options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set + +Set the resource quota for specified namespace bundle, or default quota if no namespace/bundle specified. + +**Command:** + +```shell +$ pulsar-admin resource-quotas set options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-namespace-bundle-quota + +Reset the specified namespace bundle's resource quota to default value. + +**Command:** + +```shell +$ pulsar-admin resource-quotas reset-namespace-bundle-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + diff --git a/static/reference/4.0.x/pulsar-admin/resourcegroups.md b/static/reference/4.0.x/pulsar-admin/resourcegroups.md new file mode 100644 index 000000000000..362ada13b2ea --- /dev/null +++ b/static/reference/4.0.x/pulsar-admin/resourcegroups.md @@ -0,0 +1,320 @@ +# resourcegroups + +Operations about ResourceGroups + + +```shell +$ pulsar-admin resourcegroups subcommand +``` + + + +## list + +List the existing resourcegroups + +**Command:** + +```shell +$ pulsar-admin resourcegroups list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# resourcegroups + +Operations about ResourceGroups + + +```shell +$ pulsar-admin resourcegroups subcommand +``` + + + +## list + +List the existing resourcegroups + +**Command:** + +```shell +$ pulsar-admin resourcegroups list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get + +Gets the configuration of a resourcegroup + +**Command:** + +```shell +$ pulsar-admin resourcegroups get options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# resourcegroups + +Operations about ResourceGroups + + +```shell +$ pulsar-admin resourcegroups subcommand +``` + + + +## list + +List the existing resourcegroups + +**Command:** + +```shell +$ pulsar-admin resourcegroups list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get + +Gets the configuration of a resourcegroup + +**Command:** + +```shell +$ pulsar-admin resourcegroups get options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new resourcegroup + +**Command:** + +```shell +$ pulsar-admin resourcegroups create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# resourcegroups + +Operations about ResourceGroups + + +```shell +$ pulsar-admin resourcegroups subcommand +``` + + + +## list + +List the existing resourcegroups + +**Command:** + +```shell +$ pulsar-admin resourcegroups list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get + +Gets the configuration of a resourcegroup + +**Command:** + +```shell +$ pulsar-admin resourcegroups get options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new resourcegroup + +**Command:** + +```shell +$ pulsar-admin resourcegroups create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update + +Updates a resourcegroup + +**Command:** + +```shell +$ pulsar-admin resourcegroups update options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# resourcegroups + +Operations about ResourceGroups + + +```shell +$ pulsar-admin resourcegroups subcommand +``` + + + +## list + +List the existing resourcegroups + +**Command:** + +```shell +$ pulsar-admin resourcegroups list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get + +Gets the configuration of a resourcegroup + +**Command:** + +```shell +$ pulsar-admin resourcegroups get options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new resourcegroup + +**Command:** + +```shell +$ pulsar-admin resourcegroups create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update + +Updates a resourcegroup + +**Command:** + +```shell +$ pulsar-admin resourcegroups update options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes an existing ResourceGroup + +**Command:** + +```shell +$ pulsar-admin resourcegroups delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + diff --git a/static/reference/4.0.x/pulsar-admin/schemas.md b/static/reference/4.0.x/pulsar-admin/schemas.md new file mode 100644 index 000000000000..045962d31bc9 --- /dev/null +++ b/static/reference/4.0.x/pulsar-admin/schemas.md @@ -0,0 +1,438 @@ +# schemas + +Operations about schemas + + +```shell +$ pulsar-admin schemas subcommand +``` + + + +## get + +Get the schema for a topic + +**Command:** + +```shell +$ pulsar-admin schemas get options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# schemas + +Operations about schemas + + +```shell +$ pulsar-admin schemas subcommand +``` + + + +## get + +Get the schema for a topic + +**Command:** + +```shell +$ pulsar-admin schemas get options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete all versions schema of a topic + +**Command:** + +```shell +$ pulsar-admin schemas delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# schemas + +Operations about schemas + + +```shell +$ pulsar-admin schemas subcommand +``` + + + +## get + +Get the schema for a topic + +**Command:** + +```shell +$ pulsar-admin schemas get options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete all versions schema of a topic + +**Command:** + +```shell +$ pulsar-admin schemas delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## upload + +Update the schema for a topic + +**Command:** + +```shell +$ pulsar-admin schemas upload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# schemas + +Operations about schemas + + +```shell +$ pulsar-admin schemas subcommand +``` + + + +## get + +Get the schema for a topic + +**Command:** + +```shell +$ pulsar-admin schemas get options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete all versions schema of a topic + +**Command:** + +```shell +$ pulsar-admin schemas delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## upload + +Update the schema for a topic + +**Command:** + +```shell +$ pulsar-admin schemas upload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## extract + +Provide the schema via a topic + +**Command:** + +```shell +$ pulsar-admin schemas extract options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# schemas + +Operations about schemas + + +```shell +$ pulsar-admin schemas subcommand +``` + + + +## get + +Get the schema for a topic + +**Command:** + +```shell +$ pulsar-admin schemas get options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete all versions schema of a topic + +**Command:** + +```shell +$ pulsar-admin schemas delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## upload + +Update the schema for a topic + +**Command:** + +```shell +$ pulsar-admin schemas upload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## extract + +Provide the schema via a topic + +**Command:** + +```shell +$ pulsar-admin schemas extract options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## metadata + +Get the schema for a topic + +**Command:** + +```shell +$ pulsar-admin schemas metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# schemas + +Operations about schemas + + +```shell +$ pulsar-admin schemas subcommand +``` + + + +## get + +Get the schema for a topic + +**Command:** + +```shell +$ pulsar-admin schemas get options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete all versions schema of a topic + +**Command:** + +```shell +$ pulsar-admin schemas delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## upload + +Update the schema for a topic + +**Command:** + +```shell +$ pulsar-admin schemas upload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## extract + +Provide the schema via a topic + +**Command:** + +```shell +$ pulsar-admin schemas extract options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## metadata + +Get the schema for a topic + +**Command:** + +```shell +$ pulsar-admin schemas metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compatibility + +Test schema compatibility + +**Command:** + +```shell +$ pulsar-admin schemas compatibility options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + diff --git a/static/reference/4.0.x/pulsar-admin/sinks.md b/static/reference/4.0.x/pulsar-admin/sinks.md new file mode 100644 index 000000000000..a0d6bb2ad5a3 --- /dev/null +++ b/static/reference/4.0.x/pulsar-admin/sinks.md @@ -0,0 +1,1768 @@ +# sinks + +Interface for managing Pulsar IO sinks (egress data from Pulsar) + + +```shell +$ pulsar-admin sinks subcommand +``` + + + +## create + +Submit a Pulsar IO sink connector to run in a Pulsar cluster + +**Command:** + +```shell +$ pulsar-admin sinks create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# sinks + +Interface for managing Pulsar IO sinks (egress data from Pulsar) + + +```shell +$ pulsar-admin sinks subcommand +``` + + + +## create + +Submit a Pulsar IO sink connector to run in a Pulsar cluster + +**Command:** + +```shell +$ pulsar-admin sinks create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update + +Update a Pulsar IO sink connector + +**Command:** + +```shell +$ pulsar-admin sinks update options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# sinks + +Interface for managing Pulsar IO sinks (egress data from Pulsar) + + +```shell +$ pulsar-admin sinks subcommand +``` + + + +## create + +Submit a Pulsar IO sink connector to run in a Pulsar cluster + +**Command:** + +```shell +$ pulsar-admin sinks create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update + +Update a Pulsar IO sink connector + +**Command:** + +```shell +$ pulsar-admin sinks update options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Stops a Pulsar IO sink connector + +**Command:** + +```shell +$ pulsar-admin sinks delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# sinks + +Interface for managing Pulsar IO sinks (egress data from Pulsar) + + +```shell +$ pulsar-admin sinks subcommand +``` + + + +## create + +Submit a Pulsar IO sink connector to run in a Pulsar cluster + +**Command:** + +```shell +$ pulsar-admin sinks create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update + +Update a Pulsar IO sink connector + +**Command:** + +```shell +$ pulsar-admin sinks update options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Stops a Pulsar IO sink connector + +**Command:** + +```shell +$ pulsar-admin sinks delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list + +List all running Pulsar IO sink connectors + +**Command:** + +```shell +$ pulsar-admin sinks list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# sinks + +Interface for managing Pulsar IO sinks (egress data from Pulsar) + + +```shell +$ pulsar-admin sinks subcommand +``` + + + +## create + +Submit a Pulsar IO sink connector to run in a Pulsar cluster + +**Command:** + +```shell +$ pulsar-admin sinks create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update + +Update a Pulsar IO sink connector + +**Command:** + +```shell +$ pulsar-admin sinks update options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Stops a Pulsar IO sink connector + +**Command:** + +```shell +$ pulsar-admin sinks delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list + +List all running Pulsar IO sink connectors + +**Command:** + +```shell +$ pulsar-admin sinks list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get + +Gets the information about a Pulsar IO sink connector + +**Command:** + +```shell +$ pulsar-admin sinks get options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# sinks + +Interface for managing Pulsar IO sinks (egress data from Pulsar) + + +```shell +$ pulsar-admin sinks subcommand +``` + + + +## create + +Submit a Pulsar IO sink connector to run in a Pulsar cluster + +**Command:** + +```shell +$ pulsar-admin sinks create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update + +Update a Pulsar IO sink connector + +**Command:** + +```shell +$ pulsar-admin sinks update options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Stops a Pulsar IO sink connector + +**Command:** + +```shell +$ pulsar-admin sinks delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list + +List all running Pulsar IO sink connectors + +**Command:** + +```shell +$ pulsar-admin sinks list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get + +Gets the information about a Pulsar IO sink connector + +**Command:** + +```shell +$ pulsar-admin sinks get options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## status + +Check the current status of a Pulsar Sink + +**Command:** + +```shell +$ pulsar-admin sinks status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# sinks + +Interface for managing Pulsar IO sinks (egress data from Pulsar) + + +```shell +$ pulsar-admin sinks subcommand +``` + + + +## create + +Submit a Pulsar IO sink connector to run in a Pulsar cluster + +**Command:** + +```shell +$ pulsar-admin sinks create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update + +Update a Pulsar IO sink connector + +**Command:** + +```shell +$ pulsar-admin sinks update options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Stops a Pulsar IO sink connector + +**Command:** + +```shell +$ pulsar-admin sinks delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list + +List all running Pulsar IO sink connectors + +**Command:** + +```shell +$ pulsar-admin sinks list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get + +Gets the information about a Pulsar IO sink connector + +**Command:** + +```shell +$ pulsar-admin sinks get options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## status + +Check the current status of a Pulsar Sink + +**Command:** + +```shell +$ pulsar-admin sinks status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## getstatus + +Check the current status of a Pulsar Sink + +**Command:** + +```shell +$ pulsar-admin sinks getstatus options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# sinks + +Interface for managing Pulsar IO sinks (egress data from Pulsar) + + +```shell +$ pulsar-admin sinks subcommand +``` + + + +## create + +Submit a Pulsar IO sink connector to run in a Pulsar cluster + +**Command:** + +```shell +$ pulsar-admin sinks create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update + +Update a Pulsar IO sink connector + +**Command:** + +```shell +$ pulsar-admin sinks update options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Stops a Pulsar IO sink connector + +**Command:** + +```shell +$ pulsar-admin sinks delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list + +List all running Pulsar IO sink connectors + +**Command:** + +```shell +$ pulsar-admin sinks list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get + +Gets the information about a Pulsar IO sink connector + +**Command:** + +```shell +$ pulsar-admin sinks get options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## status + +Check the current status of a Pulsar Sink + +**Command:** + +```shell +$ pulsar-admin sinks status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## getstatus + +Check the current status of a Pulsar Sink + +**Command:** + +```shell +$ pulsar-admin sinks getstatus options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stop + +Stops sink instance + +**Command:** + +```shell +$ pulsar-admin sinks stop options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# sinks + +Interface for managing Pulsar IO sinks (egress data from Pulsar) + + +```shell +$ pulsar-admin sinks subcommand +``` + + + +## create + +Submit a Pulsar IO sink connector to run in a Pulsar cluster + +**Command:** + +```shell +$ pulsar-admin sinks create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update + +Update a Pulsar IO sink connector + +**Command:** + +```shell +$ pulsar-admin sinks update options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Stops a Pulsar IO sink connector + +**Command:** + +```shell +$ pulsar-admin sinks delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list + +List all running Pulsar IO sink connectors + +**Command:** + +```shell +$ pulsar-admin sinks list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get + +Gets the information about a Pulsar IO sink connector + +**Command:** + +```shell +$ pulsar-admin sinks get options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## status + +Check the current status of a Pulsar Sink + +**Command:** + +```shell +$ pulsar-admin sinks status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## getstatus + +Check the current status of a Pulsar Sink + +**Command:** + +```shell +$ pulsar-admin sinks getstatus options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stop + +Stops sink instance + +**Command:** + +```shell +$ pulsar-admin sinks stop options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## start + +Starts sink instance + +**Command:** + +```shell +$ pulsar-admin sinks start options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# sinks + +Interface for managing Pulsar IO sinks (egress data from Pulsar) + + +```shell +$ pulsar-admin sinks subcommand +``` + + + +## create + +Submit a Pulsar IO sink connector to run in a Pulsar cluster + +**Command:** + +```shell +$ pulsar-admin sinks create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update + +Update a Pulsar IO sink connector + +**Command:** + +```shell +$ pulsar-admin sinks update options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Stops a Pulsar IO sink connector + +**Command:** + +```shell +$ pulsar-admin sinks delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list + +List all running Pulsar IO sink connectors + +**Command:** + +```shell +$ pulsar-admin sinks list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get + +Gets the information about a Pulsar IO sink connector + +**Command:** + +```shell +$ pulsar-admin sinks get options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## status + +Check the current status of a Pulsar Sink + +**Command:** + +```shell +$ pulsar-admin sinks status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## getstatus + +Check the current status of a Pulsar Sink + +**Command:** + +```shell +$ pulsar-admin sinks getstatus options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stop + +Stops sink instance + +**Command:** + +```shell +$ pulsar-admin sinks stop options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## start + +Starts sink instance + +**Command:** + +```shell +$ pulsar-admin sinks start options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## restart + +Restart sink instance + +**Command:** + +```shell +$ pulsar-admin sinks restart options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# sinks + +Interface for managing Pulsar IO sinks (egress data from Pulsar) + + +```shell +$ pulsar-admin sinks subcommand +``` + + + +## create + +Submit a Pulsar IO sink connector to run in a Pulsar cluster + +**Command:** + +```shell +$ pulsar-admin sinks create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update + +Update a Pulsar IO sink connector + +**Command:** + +```shell +$ pulsar-admin sinks update options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Stops a Pulsar IO sink connector + +**Command:** + +```shell +$ pulsar-admin sinks delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list + +List all running Pulsar IO sink connectors + +**Command:** + +```shell +$ pulsar-admin sinks list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get + +Gets the information about a Pulsar IO sink connector + +**Command:** + +```shell +$ pulsar-admin sinks get options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## status + +Check the current status of a Pulsar Sink + +**Command:** + +```shell +$ pulsar-admin sinks status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## getstatus + +Check the current status of a Pulsar Sink + +**Command:** + +```shell +$ pulsar-admin sinks getstatus options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stop + +Stops sink instance + +**Command:** + +```shell +$ pulsar-admin sinks stop options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## start + +Starts sink instance + +**Command:** + +```shell +$ pulsar-admin sinks start options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## restart + +Restart sink instance + +**Command:** + +```shell +$ pulsar-admin sinks restart options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## localrun + +Run a Pulsar IO sink connector locally (rather than deploying it to the Pulsar cluster) + +**Command:** + +```shell +$ pulsar-admin sinks localrun options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# sinks + +Interface for managing Pulsar IO sinks (egress data from Pulsar) + + +```shell +$ pulsar-admin sinks subcommand +``` + + + +## create + +Submit a Pulsar IO sink connector to run in a Pulsar cluster + +**Command:** + +```shell +$ pulsar-admin sinks create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update + +Update a Pulsar IO sink connector + +**Command:** + +```shell +$ pulsar-admin sinks update options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Stops a Pulsar IO sink connector + +**Command:** + +```shell +$ pulsar-admin sinks delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list + +List all running Pulsar IO sink connectors + +**Command:** + +```shell +$ pulsar-admin sinks list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get + +Gets the information about a Pulsar IO sink connector + +**Command:** + +```shell +$ pulsar-admin sinks get options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## status + +Check the current status of a Pulsar Sink + +**Command:** + +```shell +$ pulsar-admin sinks status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## getstatus + +Check the current status of a Pulsar Sink + +**Command:** + +```shell +$ pulsar-admin sinks getstatus options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stop + +Stops sink instance + +**Command:** + +```shell +$ pulsar-admin sinks stop options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## start + +Starts sink instance + +**Command:** + +```shell +$ pulsar-admin sinks start options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## restart + +Restart sink instance + +**Command:** + +```shell +$ pulsar-admin sinks restart options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## localrun + +Run a Pulsar IO sink connector locally (rather than deploying it to the Pulsar cluster) + +**Command:** + +```shell +$ pulsar-admin sinks localrun options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## available-sinks + +Get the list of Pulsar IO connector sinks supported by Pulsar cluster + +**Command:** + +```shell +$ pulsar-admin sinks available-sinks options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# sinks + +Interface for managing Pulsar IO sinks (egress data from Pulsar) + + +```shell +$ pulsar-admin sinks subcommand +``` + + + +## create + +Submit a Pulsar IO sink connector to run in a Pulsar cluster + +**Command:** + +```shell +$ pulsar-admin sinks create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update + +Update a Pulsar IO sink connector + +**Command:** + +```shell +$ pulsar-admin sinks update options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Stops a Pulsar IO sink connector + +**Command:** + +```shell +$ pulsar-admin sinks delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list + +List all running Pulsar IO sink connectors + +**Command:** + +```shell +$ pulsar-admin sinks list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get + +Gets the information about a Pulsar IO sink connector + +**Command:** + +```shell +$ pulsar-admin sinks get options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## status + +Check the current status of a Pulsar Sink + +**Command:** + +```shell +$ pulsar-admin sinks status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## getstatus + +Check the current status of a Pulsar Sink + +**Command:** + +```shell +$ pulsar-admin sinks getstatus options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stop + +Stops sink instance + +**Command:** + +```shell +$ pulsar-admin sinks stop options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## start + +Starts sink instance + +**Command:** + +```shell +$ pulsar-admin sinks start options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## restart + +Restart sink instance + +**Command:** + +```shell +$ pulsar-admin sinks restart options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## localrun + +Run a Pulsar IO sink connector locally (rather than deploying it to the Pulsar cluster) + +**Command:** + +```shell +$ pulsar-admin sinks localrun options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## available-sinks + +Get the list of Pulsar IO connector sinks supported by Pulsar cluster + +**Command:** + +```shell +$ pulsar-admin sinks available-sinks options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reload + +Reload the available built-in connectors + +**Command:** + +```shell +$ pulsar-admin sinks reload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + diff --git a/static/reference/4.0.x/pulsar-admin/sources.md b/static/reference/4.0.x/pulsar-admin/sources.md new file mode 100644 index 000000000000..4b1b7d2c213a --- /dev/null +++ b/static/reference/4.0.x/pulsar-admin/sources.md @@ -0,0 +1,1768 @@ +# sources + +Interface for managing Pulsar IO Sources (ingress data into Pulsar) + + +```shell +$ pulsar-admin sources subcommand +``` + + + +## create + +Submit a Pulsar IO source connector to run in a Pulsar cluster + +**Command:** + +```shell +$ pulsar-admin sources create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# sources + +Interface for managing Pulsar IO Sources (ingress data into Pulsar) + + +```shell +$ pulsar-admin sources subcommand +``` + + + +## create + +Submit a Pulsar IO source connector to run in a Pulsar cluster + +**Command:** + +```shell +$ pulsar-admin sources create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update + +Update a Pulsar IO source connector + +**Command:** + +```shell +$ pulsar-admin sources update options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# sources + +Interface for managing Pulsar IO Sources (ingress data into Pulsar) + + +```shell +$ pulsar-admin sources subcommand +``` + + + +## create + +Submit a Pulsar IO source connector to run in a Pulsar cluster + +**Command:** + +```shell +$ pulsar-admin sources create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update + +Update a Pulsar IO source connector + +**Command:** + +```shell +$ pulsar-admin sources update options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Stops a Pulsar IO source connector + +**Command:** + +```shell +$ pulsar-admin sources delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# sources + +Interface for managing Pulsar IO Sources (ingress data into Pulsar) + + +```shell +$ pulsar-admin sources subcommand +``` + + + +## create + +Submit a Pulsar IO source connector to run in a Pulsar cluster + +**Command:** + +```shell +$ pulsar-admin sources create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update + +Update a Pulsar IO source connector + +**Command:** + +```shell +$ pulsar-admin sources update options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Stops a Pulsar IO source connector + +**Command:** + +```shell +$ pulsar-admin sources delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get + +Gets the information about a Pulsar IO source connector + +**Command:** + +```shell +$ pulsar-admin sources get options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# sources + +Interface for managing Pulsar IO Sources (ingress data into Pulsar) + + +```shell +$ pulsar-admin sources subcommand +``` + + + +## create + +Submit a Pulsar IO source connector to run in a Pulsar cluster + +**Command:** + +```shell +$ pulsar-admin sources create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update + +Update a Pulsar IO source connector + +**Command:** + +```shell +$ pulsar-admin sources update options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Stops a Pulsar IO source connector + +**Command:** + +```shell +$ pulsar-admin sources delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get + +Gets the information about a Pulsar IO source connector + +**Command:** + +```shell +$ pulsar-admin sources get options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## status + +Check the current status of a Pulsar Source + +**Command:** + +```shell +$ pulsar-admin sources status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# sources + +Interface for managing Pulsar IO Sources (ingress data into Pulsar) + + +```shell +$ pulsar-admin sources subcommand +``` + + + +## create + +Submit a Pulsar IO source connector to run in a Pulsar cluster + +**Command:** + +```shell +$ pulsar-admin sources create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update + +Update a Pulsar IO source connector + +**Command:** + +```shell +$ pulsar-admin sources update options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Stops a Pulsar IO source connector + +**Command:** + +```shell +$ pulsar-admin sources delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get + +Gets the information about a Pulsar IO source connector + +**Command:** + +```shell +$ pulsar-admin sources get options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## status + +Check the current status of a Pulsar Source + +**Command:** + +```shell +$ pulsar-admin sources status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## getstatus + +Check the current status of a Pulsar Source + +**Command:** + +```shell +$ pulsar-admin sources getstatus options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# sources + +Interface for managing Pulsar IO Sources (ingress data into Pulsar) + + +```shell +$ pulsar-admin sources subcommand +``` + + + +## create + +Submit a Pulsar IO source connector to run in a Pulsar cluster + +**Command:** + +```shell +$ pulsar-admin sources create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update + +Update a Pulsar IO source connector + +**Command:** + +```shell +$ pulsar-admin sources update options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Stops a Pulsar IO source connector + +**Command:** + +```shell +$ pulsar-admin sources delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get + +Gets the information about a Pulsar IO source connector + +**Command:** + +```shell +$ pulsar-admin sources get options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## status + +Check the current status of a Pulsar Source + +**Command:** + +```shell +$ pulsar-admin sources status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## getstatus + +Check the current status of a Pulsar Source + +**Command:** + +```shell +$ pulsar-admin sources getstatus options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list + +List all running Pulsar IO source connectors + +**Command:** + +```shell +$ pulsar-admin sources list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# sources + +Interface for managing Pulsar IO Sources (ingress data into Pulsar) + + +```shell +$ pulsar-admin sources subcommand +``` + + + +## create + +Submit a Pulsar IO source connector to run in a Pulsar cluster + +**Command:** + +```shell +$ pulsar-admin sources create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update + +Update a Pulsar IO source connector + +**Command:** + +```shell +$ pulsar-admin sources update options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Stops a Pulsar IO source connector + +**Command:** + +```shell +$ pulsar-admin sources delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get + +Gets the information about a Pulsar IO source connector + +**Command:** + +```shell +$ pulsar-admin sources get options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## status + +Check the current status of a Pulsar Source + +**Command:** + +```shell +$ pulsar-admin sources status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## getstatus + +Check the current status of a Pulsar Source + +**Command:** + +```shell +$ pulsar-admin sources getstatus options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list + +List all running Pulsar IO source connectors + +**Command:** + +```shell +$ pulsar-admin sources list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stop + +Stop source instance + +**Command:** + +```shell +$ pulsar-admin sources stop options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# sources + +Interface for managing Pulsar IO Sources (ingress data into Pulsar) + + +```shell +$ pulsar-admin sources subcommand +``` + + + +## create + +Submit a Pulsar IO source connector to run in a Pulsar cluster + +**Command:** + +```shell +$ pulsar-admin sources create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update + +Update a Pulsar IO source connector + +**Command:** + +```shell +$ pulsar-admin sources update options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Stops a Pulsar IO source connector + +**Command:** + +```shell +$ pulsar-admin sources delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get + +Gets the information about a Pulsar IO source connector + +**Command:** + +```shell +$ pulsar-admin sources get options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## status + +Check the current status of a Pulsar Source + +**Command:** + +```shell +$ pulsar-admin sources status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## getstatus + +Check the current status of a Pulsar Source + +**Command:** + +```shell +$ pulsar-admin sources getstatus options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list + +List all running Pulsar IO source connectors + +**Command:** + +```shell +$ pulsar-admin sources list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stop + +Stop source instance + +**Command:** + +```shell +$ pulsar-admin sources stop options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## start + +Start source instance + +**Command:** + +```shell +$ pulsar-admin sources start options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# sources + +Interface for managing Pulsar IO Sources (ingress data into Pulsar) + + +```shell +$ pulsar-admin sources subcommand +``` + + + +## create + +Submit a Pulsar IO source connector to run in a Pulsar cluster + +**Command:** + +```shell +$ pulsar-admin sources create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update + +Update a Pulsar IO source connector + +**Command:** + +```shell +$ pulsar-admin sources update options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Stops a Pulsar IO source connector + +**Command:** + +```shell +$ pulsar-admin sources delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get + +Gets the information about a Pulsar IO source connector + +**Command:** + +```shell +$ pulsar-admin sources get options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## status + +Check the current status of a Pulsar Source + +**Command:** + +```shell +$ pulsar-admin sources status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## getstatus + +Check the current status of a Pulsar Source + +**Command:** + +```shell +$ pulsar-admin sources getstatus options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list + +List all running Pulsar IO source connectors + +**Command:** + +```shell +$ pulsar-admin sources list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stop + +Stop source instance + +**Command:** + +```shell +$ pulsar-admin sources stop options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## start + +Start source instance + +**Command:** + +```shell +$ pulsar-admin sources start options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## restart + +Restart source instance + +**Command:** + +```shell +$ pulsar-admin sources restart options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# sources + +Interface for managing Pulsar IO Sources (ingress data into Pulsar) + + +```shell +$ pulsar-admin sources subcommand +``` + + + +## create + +Submit a Pulsar IO source connector to run in a Pulsar cluster + +**Command:** + +```shell +$ pulsar-admin sources create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update + +Update a Pulsar IO source connector + +**Command:** + +```shell +$ pulsar-admin sources update options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Stops a Pulsar IO source connector + +**Command:** + +```shell +$ pulsar-admin sources delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get + +Gets the information about a Pulsar IO source connector + +**Command:** + +```shell +$ pulsar-admin sources get options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## status + +Check the current status of a Pulsar Source + +**Command:** + +```shell +$ pulsar-admin sources status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## getstatus + +Check the current status of a Pulsar Source + +**Command:** + +```shell +$ pulsar-admin sources getstatus options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list + +List all running Pulsar IO source connectors + +**Command:** + +```shell +$ pulsar-admin sources list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stop + +Stop source instance + +**Command:** + +```shell +$ pulsar-admin sources stop options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## start + +Start source instance + +**Command:** + +```shell +$ pulsar-admin sources start options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## restart + +Restart source instance + +**Command:** + +```shell +$ pulsar-admin sources restart options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## localrun + +Run a Pulsar IO source connector locally (rather than deploying it to the Pulsar cluster) + +**Command:** + +```shell +$ pulsar-admin sources localrun options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# sources + +Interface for managing Pulsar IO Sources (ingress data into Pulsar) + + +```shell +$ pulsar-admin sources subcommand +``` + + + +## create + +Submit a Pulsar IO source connector to run in a Pulsar cluster + +**Command:** + +```shell +$ pulsar-admin sources create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update + +Update a Pulsar IO source connector + +**Command:** + +```shell +$ pulsar-admin sources update options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Stops a Pulsar IO source connector + +**Command:** + +```shell +$ pulsar-admin sources delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get + +Gets the information about a Pulsar IO source connector + +**Command:** + +```shell +$ pulsar-admin sources get options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## status + +Check the current status of a Pulsar Source + +**Command:** + +```shell +$ pulsar-admin sources status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## getstatus + +Check the current status of a Pulsar Source + +**Command:** + +```shell +$ pulsar-admin sources getstatus options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list + +List all running Pulsar IO source connectors + +**Command:** + +```shell +$ pulsar-admin sources list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stop + +Stop source instance + +**Command:** + +```shell +$ pulsar-admin sources stop options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## start + +Start source instance + +**Command:** + +```shell +$ pulsar-admin sources start options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## restart + +Restart source instance + +**Command:** + +```shell +$ pulsar-admin sources restart options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## localrun + +Run a Pulsar IO source connector locally (rather than deploying it to the Pulsar cluster) + +**Command:** + +```shell +$ pulsar-admin sources localrun options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## available-sources + +Get the list of Pulsar IO connector sources supported by Pulsar cluster + +**Command:** + +```shell +$ pulsar-admin sources available-sources options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# sources + +Interface for managing Pulsar IO Sources (ingress data into Pulsar) + + +```shell +$ pulsar-admin sources subcommand +``` + + + +## create + +Submit a Pulsar IO source connector to run in a Pulsar cluster + +**Command:** + +```shell +$ pulsar-admin sources create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update + +Update a Pulsar IO source connector + +**Command:** + +```shell +$ pulsar-admin sources update options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Stops a Pulsar IO source connector + +**Command:** + +```shell +$ pulsar-admin sources delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get + +Gets the information about a Pulsar IO source connector + +**Command:** + +```shell +$ pulsar-admin sources get options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## status + +Check the current status of a Pulsar Source + +**Command:** + +```shell +$ pulsar-admin sources status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## getstatus + +Check the current status of a Pulsar Source + +**Command:** + +```shell +$ pulsar-admin sources getstatus options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list + +List all running Pulsar IO source connectors + +**Command:** + +```shell +$ pulsar-admin sources list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stop + +Stop source instance + +**Command:** + +```shell +$ pulsar-admin sources stop options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## start + +Start source instance + +**Command:** + +```shell +$ pulsar-admin sources start options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## restart + +Restart source instance + +**Command:** + +```shell +$ pulsar-admin sources restart options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## localrun + +Run a Pulsar IO source connector locally (rather than deploying it to the Pulsar cluster) + +**Command:** + +```shell +$ pulsar-admin sources localrun options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## available-sources + +Get the list of Pulsar IO connector sources supported by Pulsar cluster + +**Command:** + +```shell +$ pulsar-admin sources available-sources options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reload + +Reload the available built-in connectors + +**Command:** + +```shell +$ pulsar-admin sources reload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + diff --git a/static/reference/4.0.x/pulsar-admin/tenants.md b/static/reference/4.0.x/pulsar-admin/tenants.md new file mode 100644 index 000000000000..bcdbff85d4aa --- /dev/null +++ b/static/reference/4.0.x/pulsar-admin/tenants.md @@ -0,0 +1,320 @@ +# tenants + +Operations about tenants + + +```shell +$ pulsar-admin tenants subcommand +``` + + + +## list + +List the existing tenants + +**Command:** + +```shell +$ pulsar-admin tenants list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# tenants + +Operations about tenants + + +```shell +$ pulsar-admin tenants subcommand +``` + + + +## list + +List the existing tenants + +**Command:** + +```shell +$ pulsar-admin tenants list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get + +Gets the configuration of a tenant + +**Command:** + +```shell +$ pulsar-admin tenants get options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# tenants + +Operations about tenants + + +```shell +$ pulsar-admin tenants subcommand +``` + + + +## list + +List the existing tenants + +**Command:** + +```shell +$ pulsar-admin tenants list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get + +Gets the configuration of a tenant + +**Command:** + +```shell +$ pulsar-admin tenants get options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new tenant + +**Command:** + +```shell +$ pulsar-admin tenants create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# tenants + +Operations about tenants + + +```shell +$ pulsar-admin tenants subcommand +``` + + + +## list + +List the existing tenants + +**Command:** + +```shell +$ pulsar-admin tenants list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get + +Gets the configuration of a tenant + +**Command:** + +```shell +$ pulsar-admin tenants get options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new tenant + +**Command:** + +```shell +$ pulsar-admin tenants create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update + +Updates the configuration for a tenant + +**Command:** + +```shell +$ pulsar-admin tenants update options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# tenants + +Operations about tenants + + +```shell +$ pulsar-admin tenants subcommand +``` + + + +## list + +List the existing tenants + +**Command:** + +```shell +$ pulsar-admin tenants list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get + +Gets the configuration of a tenant + +**Command:** + +```shell +$ pulsar-admin tenants get options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Creates a new tenant + +**Command:** + +```shell +$ pulsar-admin tenants create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update + +Updates the configuration for a tenant + +**Command:** + +```shell +$ pulsar-admin tenants update options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Deletes an existing tenant + +**Command:** + +```shell +$ pulsar-admin tenants delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + diff --git a/static/reference/4.0.x/pulsar-admin/topicPolicies.md b/static/reference/4.0.x/pulsar-admin/topicPolicies.md new file mode 100644 index 000000000000..07bc8ca0ecf5 --- /dev/null +++ b/static/reference/4.0.x/pulsar-admin/topicPolicies.md @@ -0,0 +1,60588 @@ +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quota + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quota + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quota + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quota + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quota + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quota + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quota + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quota + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quota + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quota + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quota + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quota + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quota + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quota + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quota + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quota + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quota + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quota + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quota + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quota + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quota + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quota + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quota + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quota + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quota + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quota + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quota + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quota + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quota + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quota + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quota + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quota + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quota + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quota + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers + +Get max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quota + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers + +Get max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers + +Set max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quota + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers + +Get max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers + +Set max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers + +Remove max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quota + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers + +Get max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers + +Set max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers + +Remove max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quota + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers + +Get max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers + +Set max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers + +Remove max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quota + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers + +Get max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers + +Set max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers + +Remove max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quota + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers + +Get max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers + +Set max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers + +Remove max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quota + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers + +Get max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers + +Set max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers + +Remove max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quota + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers + +Get max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers + +Set max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers + +Remove max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quota + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers + +Get max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers + +Set max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers + +Remove max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quota + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers + +Get max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers + +Set max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers + +Remove max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quota + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers + +Get max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers + +Set max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers + +Remove max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quota + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers + +Get max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers + +Set max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers + +Remove max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get max unacked messages policy per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quota + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers + +Get max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers + +Set max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers + +Remove max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get max unacked messages policy per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quota + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers + +Get max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers + +Set max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers + +Remove max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get max unacked messages policy per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove max unacked messages policy per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quota + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers + +Get max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers + +Set max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers + +Remove max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get max unacked messages policy per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove max unacked messages policy per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quota + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers + +Get max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers + +Set max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers + +Remove max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get max unacked messages policy per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove max unacked messages policy per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quota + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers + +Get max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers + +Set max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers + +Remove max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get max unacked messages policy per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove max unacked messages policy per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quota + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers + +Get max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers + +Set max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers + +Remove max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get max unacked messages policy per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove max unacked messages policy per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quota + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers + +Get max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers + +Set max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers + +Remove max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get max unacked messages policy per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove max unacked messages policy per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quota + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers + +Get max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers + +Set max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers + +Remove max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get max unacked messages policy per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove max unacked messages policy per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quota + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers + +Get max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers + +Set max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers + +Remove max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get max unacked messages policy per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove max unacked messages policy per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-schema-compatibility-strategy + +Remove schema compatibility strategy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quota + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers + +Get max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers + +Set max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers + +Remove max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get max unacked messages policy per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove max unacked messages policy per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-schema-compatibility-strategy + +Remove schema compatibility strategy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-compatibility-strategy + +Set schema compatibility strategy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quota + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers + +Get max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers + +Set max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers + +Remove max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get max unacked messages policy per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove max unacked messages policy per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-schema-compatibility-strategy + +Remove schema compatibility strategy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-compatibility-strategy + +Set schema compatibility strategy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-compatibility-strategy + +Get schema compatibility strategy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quota + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers + +Get max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers + +Set max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers + +Remove max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get max unacked messages policy per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove max unacked messages policy per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-schema-compatibility-strategy + +Remove schema compatibility strategy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-compatibility-strategy + +Set schema compatibility strategy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-compatibility-strategy + +Get schema compatibility strategy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-entry-filters-per-topic + +Get entry filters for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-entry-filters-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quota + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers + +Get max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers + +Set max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers + +Remove max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get max unacked messages policy per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove max unacked messages policy per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-schema-compatibility-strategy + +Remove schema compatibility strategy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-compatibility-strategy + +Set schema compatibility strategy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-compatibility-strategy + +Get schema compatibility strategy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-entry-filters-per-topic + +Get entry filters for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-entry-filters-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-entry-filters-per-topic + +Set entry filters for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-entry-filters-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quota + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers + +Get max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers + +Set max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers + +Remove max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get max unacked messages policy per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove max unacked messages policy per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-schema-compatibility-strategy + +Remove schema compatibility strategy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-compatibility-strategy + +Set schema compatibility strategy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-compatibility-strategy + +Get schema compatibility strategy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-entry-filters-per-topic + +Get entry filters for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-entry-filters-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-entry-filters-per-topic + +Set entry filters for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-entry-filters-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-entry-filters-per-topic + +Remove entry filters for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-entry-filters-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quota + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers + +Get max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers + +Set max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers + +Remove max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get max unacked messages policy per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove max unacked messages policy per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-schema-compatibility-strategy + +Remove schema compatibility strategy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-compatibility-strategy + +Set schema compatibility strategy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-compatibility-strategy + +Get schema compatibility strategy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-entry-filters-per-topic + +Get entry filters for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-entry-filters-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-entry-filters-per-topic + +Set entry filters for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-entry-filters-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-entry-filters-per-topic + +Remove entry filters for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-entry-filters-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quota + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers + +Get max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers + +Set max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers + +Remove max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get max unacked messages policy per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove max unacked messages policy per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-schema-compatibility-strategy + +Remove schema compatibility strategy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-compatibility-strategy + +Set schema compatibility strategy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-compatibility-strategy + +Get schema compatibility strategy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-entry-filters-per-topic + +Get entry filters for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-entry-filters-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-entry-filters-per-topic + +Set entry filters for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-entry-filters-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-entry-filters-per-topic + +Remove entry filters for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-entry-filters-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quota + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers + +Get max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers + +Set max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers + +Remove max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get max unacked messages policy per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove max unacked messages policy per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-schema-compatibility-strategy + +Remove schema compatibility strategy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-compatibility-strategy + +Set schema compatibility strategy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-compatibility-strategy + +Get schema compatibility strategy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-entry-filters-per-topic + +Get entry filters for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-entry-filters-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-entry-filters-per-topic + +Set entry filters for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-entry-filters-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-entry-filters-per-topic + +Remove entry filters for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-entry-filters-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quota + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers + +Get max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers + +Set max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers + +Remove max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get max unacked messages policy per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove max unacked messages policy per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-schema-compatibility-strategy + +Remove schema compatibility strategy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-compatibility-strategy + +Set schema compatibility strategy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-compatibility-strategy + +Get schema compatibility strategy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-entry-filters-per-topic + +Get entry filters for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-entry-filters-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-entry-filters-per-topic + +Set entry filters for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-entry-filters-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-entry-filters-per-topic + +Remove entry filters for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-entry-filters-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatcher-pause-on-ack-state-persistent + +Enable dispatcherPauseOnAckStatePersistent for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-dispatcher-pause-on-ack-state-persistent options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quota + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers + +Get max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers + +Set max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers + +Remove max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get max unacked messages policy per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove max unacked messages policy per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-schema-compatibility-strategy + +Remove schema compatibility strategy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-compatibility-strategy + +Set schema compatibility strategy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-compatibility-strategy + +Get schema compatibility strategy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-entry-filters-per-topic + +Get entry filters for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-entry-filters-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-entry-filters-per-topic + +Set entry filters for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-entry-filters-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-entry-filters-per-topic + +Remove entry filters for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-entry-filters-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatcher-pause-on-ack-state-persistent + +Enable dispatcherPauseOnAckStatePersistent for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-dispatcher-pause-on-ack-state-persistent options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatcher-pause-on-ack-state-persistent + +Get the dispatcherPauseOnAckStatePersistent for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-dispatcher-pause-on-ack-state-persistent options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topicPolicies + +Operations on persistent topics + + +```shell +$ pulsar-admin topicPolicies subcommand +``` + + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy per consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quota + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication status for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers + +Get max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers + +Set max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers + +Remove max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get max unacked messages policy per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove max unacked messages policy per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions-per-topic + +Get max subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions-per-topic + +Set max subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions-per-topic + +Remove max subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-max-subscriptions-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-schema-compatibility-strategy + +Remove schema compatibility strategy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-compatibility-strategy + +Set schema compatibility strategy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-compatibility-strategy + +Get schema compatibility strategy on a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-schema-compatibility-strategy options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-entry-filters-per-topic + +Get entry filters for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-entry-filters-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-entry-filters-per-topic + +Set entry filters for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-entry-filters-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-entry-filters-per-topic + +Remove entry filters for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-entry-filters-per-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-auto-subscription-creation + +Enable autoSubscriptionCreation for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-auto-subscription-creation + +Get the autoSubscriptionCreation for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-auto-subscription-creation + +Remove override of autoSubscriptionCreation for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-auto-subscription-creation options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatcher-pause-on-ack-state-persistent + +Enable dispatcherPauseOnAckStatePersistent for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies set-dispatcher-pause-on-ack-state-persistent options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatcher-pause-on-ack-state-persistent + +Get the dispatcherPauseOnAckStatePersistent for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies get-dispatcher-pause-on-ack-state-persistent options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatcher-pause-on-ack-state-persistent + +Remove dispatcherPauseOnAckStatePersistent for a topic + +**Command:** + +```shell +$ pulsar-admin topicPolicies remove-dispatcher-pause-on-ack-state-persistent options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + diff --git a/static/reference/4.0.x/pulsar-admin/topics.md b/static/reference/4.0.x/pulsar-admin/topics.md new file mode 100644 index 000000000000..bae1dc68aa90 --- /dev/null +++ b/static/reference/4.0.x/pulsar-admin/topics.md @@ -0,0 +1,184307 @@ +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-maxProducers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-maxProducers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-maxProducers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-maxProducers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-maxProducers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-maxProducers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-maxProducers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-maxProducers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-maxProducers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-maxProducers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-maxProducers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-maxProducers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-maxProducers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-maxProducers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-maxProducers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-maxProducers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-maxProducers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-maxProducers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions + +Get max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-maxProducers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-maxProducers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-maxProducers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions + +Get max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions + +Set max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-maxProducers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-maxProducers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-maxProducers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions + +Get max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions + +Set max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions + +Remove max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-maxProducers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-maxProducers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-maxProducers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions + +Get max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions + +Set max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions + +Remove max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-maxProducers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-maxProducers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-maxProducers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions + +Get max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions + +Set max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions + +Remove max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-maxProducers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-maxProducers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-maxProducers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions + +Get max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions + +Set max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions + +Remove max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-maxProducers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-maxProducers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-maxProducers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions + +Get max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions + +Set max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions + +Remove max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-maxProducers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-maxProducers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-maxProducers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions + +Get max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions + +Set max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions + +Remove max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-maxProducers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-maxProducers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-maxProducers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions + +Get max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions + +Set max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions + +Remove max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-maxProducers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-maxProducers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-maxProducers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions + +Get max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions + +Set max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions + +Remove max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-maxProducers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-maxProducers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-maxProducers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions + +Get max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions + +Set max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions + +Remove max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-maxProducers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-maxProducers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-maxProducers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions + +Get max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions + +Set max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions + +Remove max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-maxProducers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-maxProducers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-maxProducers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions + +Get max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions + +Set max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions + +Remove max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers + +Get max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-maxProducers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-maxProducers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-maxProducers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions + +Get max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions + +Set max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions + +Remove max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers + +Get max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers + +Set max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-maxProducers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-maxProducers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-maxProducers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions + +Get max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions + +Set max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions + +Remove max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers + +Get max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers + +Set max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers + +Remove max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-maxProducers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-maxProducers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-maxProducers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions + +Get max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions + +Set max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions + +Remove max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers + +Get max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers + +Set max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers + +Remove max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-maxProducers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-maxProducers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-maxProducers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions + +Get max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions + +Set max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions + +Remove max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers + +Get max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers + +Set max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers + +Remove max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-maxProducers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-maxProducers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-maxProducers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions + +Get max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions + +Set max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions + +Remove max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers + +Get max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers + +Set max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers + +Remove max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-maxProducers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-maxProducers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-maxProducers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions + +Get max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions + +Set max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions + +Remove max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers + +Get max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers + +Set max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers + +Remove max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicated-subscription-status + +Enable or disable a replicated subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicated-subscription-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-maxProducers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-maxProducers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-maxProducers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions + +Get max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions + +Set max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions + +Remove max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers + +Get max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers + +Set max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers + +Remove max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicated-subscription-status + +Enable or disable a replicated subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicated-subscription-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicated-subscription-status + +Get replicated subscription status on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicated-subscription-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-maxProducers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-maxProducers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-maxProducers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions + +Get max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions + +Set max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions + +Remove max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers + +Get max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers + +Set max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers + +Remove max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicated-subscription-status + +Enable or disable a replicated subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicated-subscription-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicated-subscription-status + +Get replicated subscription status on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicated-subscription-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-size + +Calculate backlog size by a message ID (in bytes). + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-maxProducers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-maxProducers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-maxProducers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions + +Get max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions + +Set max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions + +Remove max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers + +Get max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers + +Set max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers + +Remove max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicated-subscription-status + +Enable or disable a replicated subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicated-subscription-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicated-subscription-status + +Get replicated subscription status on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicated-subscription-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-size + +Calculate backlog size by a message ID (in bytes). + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## analyze-backlog + +Analyze the backlog of a subscription. + +**Command:** + +```shell +$ pulsar-admin topics analyze-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-maxProducers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-maxProducers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-maxProducers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions + +Get max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions + +Set max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions + +Remove max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers + +Get max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers + +Set max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers + +Remove max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicated-subscription-status + +Enable or disable a replicated subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicated-subscription-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicated-subscription-status + +Get replicated subscription status on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicated-subscription-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-size + +Calculate backlog size by a message ID (in bytes). + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## analyze-backlog + +Analyze the backlog of a subscription. + +**Command:** + +```shell +$ pulsar-admin topics analyze-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replication-clusters + +Get the replication clusters for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replication-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-maxProducers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-maxProducers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-maxProducers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions + +Get max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions + +Set max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions + +Remove max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers + +Get max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers + +Set max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers + +Remove max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicated-subscription-status + +Enable or disable a replicated subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicated-subscription-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicated-subscription-status + +Get replicated subscription status on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicated-subscription-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-size + +Calculate backlog size by a message ID (in bytes). + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## analyze-backlog + +Analyze the backlog of a subscription. + +**Command:** + +```shell +$ pulsar-admin topics analyze-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replication-clusters + +Get the replication clusters for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replication-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replication-clusters + +Set the replication clusters for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replication-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-maxProducers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-maxProducers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-maxProducers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions + +Get max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions + +Set max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions + +Remove max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers + +Get max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers + +Set max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers + +Remove max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicated-subscription-status + +Enable or disable a replicated subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicated-subscription-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicated-subscription-status + +Get replicated subscription status on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicated-subscription-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-size + +Calculate backlog size by a message ID (in bytes). + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## analyze-backlog + +Analyze the backlog of a subscription. + +**Command:** + +```shell +$ pulsar-admin topics analyze-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replication-clusters + +Get the replication clusters for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replication-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replication-clusters + +Set the replication clusters for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replication-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replication-clusters + +Remove the replication clusters for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-replication-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-maxProducers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-maxProducers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-maxProducers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions + +Get max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions + +Set max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions + +Remove max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers + +Get max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers + +Set max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers + +Remove max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicated-subscription-status + +Enable or disable a replicated subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicated-subscription-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicated-subscription-status + +Get replicated subscription status on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicated-subscription-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-size + +Calculate backlog size by a message ID (in bytes). + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## analyze-backlog + +Analyze the backlog of a subscription. + +**Command:** + +```shell +$ pulsar-admin topics analyze-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replication-clusters + +Get the replication clusters for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replication-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replication-clusters + +Set the replication clusters for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replication-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replication-clusters + +Remove the replication clusters for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-replication-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-shadow-topics + +Get the shadow topics for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-shadow-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-maxProducers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-maxProducers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-maxProducers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions + +Get max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions + +Set max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions + +Remove max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers + +Get max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers + +Set max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers + +Remove max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicated-subscription-status + +Enable or disable a replicated subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicated-subscription-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicated-subscription-status + +Get replicated subscription status on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicated-subscription-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-size + +Calculate backlog size by a message ID (in bytes). + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## analyze-backlog + +Analyze the backlog of a subscription. + +**Command:** + +```shell +$ pulsar-admin topics analyze-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replication-clusters + +Get the replication clusters for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replication-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replication-clusters + +Set the replication clusters for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replication-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replication-clusters + +Remove the replication clusters for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-replication-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-shadow-topics + +Get the shadow topics for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-shadow-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-shadow-topics + +Set the shadow topics for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-shadow-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-maxProducers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-maxProducers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-maxProducers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions + +Get max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions + +Set max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions + +Remove max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers + +Get max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers + +Set max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers + +Remove max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicated-subscription-status + +Enable or disable a replicated subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicated-subscription-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicated-subscription-status + +Get replicated subscription status on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicated-subscription-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-size + +Calculate backlog size by a message ID (in bytes). + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## analyze-backlog + +Analyze the backlog of a subscription. + +**Command:** + +```shell +$ pulsar-admin topics analyze-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replication-clusters + +Get the replication clusters for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replication-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replication-clusters + +Set the replication clusters for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replication-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replication-clusters + +Remove the replication clusters for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-replication-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-shadow-topics + +Get the shadow topics for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-shadow-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-shadow-topics + +Set the shadow topics for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-shadow-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-shadow-topics + +Remove the shadow topics for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-shadow-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-maxProducers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-maxProducers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-maxProducers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions + +Get max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions + +Set max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions + +Remove max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers + +Get max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers + +Set max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers + +Remove max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicated-subscription-status + +Enable or disable a replicated subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicated-subscription-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicated-subscription-status + +Get replicated subscription status on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicated-subscription-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-size + +Calculate backlog size by a message ID (in bytes). + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## analyze-backlog + +Analyze the backlog of a subscription. + +**Command:** + +```shell +$ pulsar-admin topics analyze-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replication-clusters + +Get the replication clusters for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replication-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replication-clusters + +Set the replication clusters for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replication-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replication-clusters + +Remove the replication clusters for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-replication-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-shadow-topics + +Get the shadow topics for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-shadow-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-shadow-topics + +Set the shadow topics for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-shadow-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-shadow-topics + +Remove the shadow topics for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-shadow-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-shadow-topic + +Create a shadow topic for an existing source topic. + +**Command:** + +```shell +$ pulsar-admin topics create-shadow-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-maxProducers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-maxProducers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-maxProducers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions + +Get max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions + +Set max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions + +Remove max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers + +Get max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers + +Set max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers + +Remove max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicated-subscription-status + +Enable or disable a replicated subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicated-subscription-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicated-subscription-status + +Get replicated subscription status on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicated-subscription-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-size + +Calculate backlog size by a message ID (in bytes). + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## analyze-backlog + +Analyze the backlog of a subscription. + +**Command:** + +```shell +$ pulsar-admin topics analyze-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replication-clusters + +Get the replication clusters for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replication-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replication-clusters + +Set the replication clusters for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replication-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replication-clusters + +Remove the replication clusters for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-replication-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-shadow-topics + +Get the shadow topics for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-shadow-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-shadow-topics + +Set the shadow topics for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-shadow-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-shadow-topics + +Remove the shadow topics for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-shadow-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-shadow-topic + +Create a shadow topic for an existing source topic. + +**Command:** + +```shell +$ pulsar-admin topics create-shadow-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-shadow-source + +Get the source topic for a shadow topic + +**Command:** + +```shell +$ pulsar-admin topics get-shadow-source options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-maxProducers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-maxProducers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-maxProducers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions + +Get max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions + +Set max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions + +Remove max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers + +Get max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers + +Set max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers + +Remove max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicated-subscription-status + +Enable or disable a replicated subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicated-subscription-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicated-subscription-status + +Get replicated subscription status on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicated-subscription-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-size + +Calculate backlog size by a message ID (in bytes). + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## analyze-backlog + +Analyze the backlog of a subscription. + +**Command:** + +```shell +$ pulsar-admin topics analyze-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replication-clusters + +Get the replication clusters for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replication-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replication-clusters + +Set the replication clusters for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replication-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replication-clusters + +Remove the replication clusters for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-replication-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-shadow-topics + +Get the shadow topics for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-shadow-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-shadow-topics + +Set the shadow topics for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-shadow-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-shadow-topics + +Remove the shadow topics for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-shadow-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-shadow-topic + +Create a shadow topic for an existing source topic. + +**Command:** + +```shell +$ pulsar-admin topics create-shadow-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-shadow-source + +Get the source topic for a shadow topic + +**Command:** + +```shell +$ pulsar-admin topics get-shadow-source options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-validation-enforce + +Get the schema validation enforced + +**Command:** + +```shell +$ pulsar-admin topics get-schema-validation-enforce options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-maxProducers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-maxProducers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-maxProducers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions + +Get max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions + +Set max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions + +Remove max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers + +Get max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers + +Set max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers + +Remove max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicated-subscription-status + +Enable or disable a replicated subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicated-subscription-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicated-subscription-status + +Get replicated subscription status on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicated-subscription-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-size + +Calculate backlog size by a message ID (in bytes). + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## analyze-backlog + +Analyze the backlog of a subscription. + +**Command:** + +```shell +$ pulsar-admin topics analyze-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replication-clusters + +Get the replication clusters for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replication-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replication-clusters + +Set the replication clusters for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replication-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replication-clusters + +Remove the replication clusters for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-replication-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-shadow-topics + +Get the shadow topics for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-shadow-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-shadow-topics + +Set the shadow topics for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-shadow-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-shadow-topics + +Remove the shadow topics for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-shadow-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-shadow-topic + +Create a shadow topic for an existing source topic. + +**Command:** + +```shell +$ pulsar-admin topics create-shadow-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-shadow-source + +Get the source topic for a shadow topic + +**Command:** + +```shell +$ pulsar-admin topics get-shadow-source options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-validation-enforce + +Get the schema validation enforced + +**Command:** + +```shell +$ pulsar-admin topics get-schema-validation-enforce options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-validation-enforce + +Set the schema whether open schema validation enforced + +**Command:** + +```shell +$ pulsar-admin topics set-schema-validation-enforce options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# topics + +Operations on persistent topics + + +```shell +$ pulsar-admin topics subcommand +``` + + + +## list + +Get the list of topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## list-partitioned-topics + +Get the list of partitioned topics under a namespace. + +**Command:** + +```shell +$ pulsar-admin topics list-partitioned-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## permissions + +Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. + +**Command:** + +```shell +$ pulsar-admin topics permissions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## grant-permission + +Grant a new permission to a client role on a single topic. + +**Command:** + +```shell +$ pulsar-admin topics grant-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## revoke-permission + +Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412). + +**Command:** + +```shell +$ pulsar-admin topics revoke-permission options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## lookup + +Lookup a topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-lookup + +Lookup a partitioned topic from the current serving broker + +**Command:** + +```shell +$ pulsar-admin topics partitioned-lookup options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## bundle-range + +Get Namespace bundle range of a topic + +**Command:** + +```shell +$ pulsar-admin topics bundle-range options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete + +Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## truncate + +Truncate a topic. + The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers. + +**Command:** + +```shell +$ pulsar-admin topics truncate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unload + +Unload a topic. + +**Command:** + +```shell +$ pulsar-admin topics unload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## subscriptions + +Get the list of subscriptions on the topic + +**Command:** + +```shell +$ pulsar-admin topics subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## unsubscribe + +Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it + +**Command:** + +```shell +$ pulsar-admin topics unsubscribe options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-subscription + +Create a new subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics create-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-subscription-properties + +Update the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-properties + +Get the properties of a subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats + +Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## stats-internal + +Get the internal stats for the topic + +**Command:** + +```shell +$ pulsar-admin topics stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## info-internal + +Get the internal metadata info for the topic + +**Command:** + +```shell +$ pulsar-admin topics info-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats + +Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-stats-internal + +Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period. + +**Command:** + +```shell +$ pulsar-admin topics partitioned-stats-internal options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## skip + +Skip some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics skip options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## clear-backlog + +Skip all the messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics clear-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages + +Expire messages that older than given expiry time (in seconds) for the subscription + +**Command:** + +```shell +$ pulsar-admin topics expire-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## expire-messages-all-subscriptions + +Expire messages that older than given expiry time (in seconds) for all subscriptions + +**Command:** + +```shell +$ pulsar-admin topics expire-messages-all-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-partitioned-topic + +Create a partitioned topic. The partitioned topic has to be created before creating a producer on it. + +**Command:** + +```shell +$ pulsar-admin topics create-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-missed-partitions + +Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled + +**Command:** + +```shell +$ pulsar-admin topics create-missed-partitions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create + +Create a non-partitioned topic. + +**Command:** + +```shell +$ pulsar-admin topics create options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-partitioned-topic + +Update existing partitioned topic. New updating number of partitions must be greater than existing number of partitions. + +**Command:** + +```shell +$ pulsar-admin topics update-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-partitioned-topic-metadata + +Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions + +**Command:** + +```shell +$ pulsar-admin topics get-partitioned-topic-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-properties + +Get the topic properties. + +**Command:** + +```shell +$ pulsar-admin topics get-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## update-properties + +Update the properties of on a topic + +**Command:** + +```shell +$ pulsar-admin topics update-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-properties + +Remove the key in properties of a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-properties options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## delete-partitioned-topic + +Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later. + +**Command:** + +```shell +$ pulsar-admin topics delete-partitioned-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## peek-messages + +Peek some messages for the subscription + +**Command:** + +```shell +$ pulsar-admin topics peek-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## examine-messages + +Examine a specific message on a topic by position relative to the earliest or the latest message. + +**Command:** + +```shell +$ pulsar-admin topics examine-messages options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-by-id + +Get message by its ledgerId and entryId + +**Command:** + +```shell +$ pulsar-admin topics get-message-by-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-id + +Get message ID + +**Command:** + +```shell +$ pulsar-admin topics get-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## reset-cursor + +Reset position for subscription to a position that is closest to timestamp or messageId. + +**Command:** + +```shell +$ pulsar-admin topics reset-cursor options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## terminate + +Terminate a topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## partitioned-terminate + +Terminate a partitioned topic and don't allow any more messages to be published + +**Command:** + +```shell +$ pulsar-admin topics partitioned-terminate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compact + +Compact a topic + +**Command:** + +```shell +$ pulsar-admin topics compact options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## compaction-status + +Status of compaction on a topic + +**Command:** + +```shell +$ pulsar-admin topics compaction-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload + +Trigger offload of data from a topic to long-term storage (e.g. Amazon S3) + +**Command:** + +```shell +$ pulsar-admin topics offload options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## offload-status + +Check the status of data offloading from a topic to long-term storage + +**Command:** + +```shell +$ pulsar-admin topics offload-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## last-message-id + +get the last commit message id of topic + +**Command:** + +```shell +$ pulsar-admin topics last-message-id options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-quotas + +Get the backlog quota policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-quotas options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-backlog-quota + +Set a backlog quota policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-backlog-quota + +Remove a backlog quota policy from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-backlog-quota options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-message-ttl + +Get the message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-message-ttl + +Set message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-message-ttl + +Remove message TTL for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-message-ttl options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-retention + +Get the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-retention + +Set the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-retention + +Remove the retention policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-retention options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## enable-deduplication + +Enable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics enable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## disable-deduplication + +Disable the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics disable-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-enabled + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication + +Enable or disable deduplication for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication + +Get the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication + +Remove the deduplication policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-deduplication-snapshot-interval + +Get deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-deduplication-snapshot-interval + +Set deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-deduplication-snapshot-interval + +Remove deduplication snapshot interval for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-deduplication-snapshot-interval options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-delayed-delivery + +Get the delayed delivery policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-delayed-delivery + +Set the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-delayed-delivery + +Remove the delayed delivery policy on a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-delayed-delivery options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-persistence + +Get the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-persistence + +Set the persistence policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-persistence + +Remove the persistence policy for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-persistence options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-offload-policies + +Get the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-offload-policies + +Set the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-offload-policies + +Remove the offload policies for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-offload-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-dispatch-rate + +Get message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-dispatch-rate + +Set message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-dispatch-rate + +Remove message dispatch rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-dispatch-rate + +Get subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-dispatch-rate + +Set subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-dispatch-rate + +Remove subscription message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicator-dispatch-rate + +Get replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicator-dispatch-rate + +Set replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replicator-dispatch-rate + +Remove replicator message-dispatch-rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-replicator-dispatch-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-compaction-threshold + +Get compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-compaction-threshold + +Set compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-compaction-threshold + +Remove compaction threshold for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-compaction-threshold options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-on-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-on-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-on-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-on-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-consumer + +Get max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-consumer + +Set max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-consumer + +Remove max unacked messages policy on consumer for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-consumer options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-unacked-messages-per-subscription + +Get max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-unacked-messages-per-subscription + +Set max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-unacked-messages-per-subscription + +Remove max unacked messages policy on subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-unacked-messages-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-publish-rate + +Get publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-publish-rate + +Set publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-publish-rate + +Remove publish rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-publish-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscription-types-enabled + +Set subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscription-types-enabled + +Get subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscription-types-enabled + +Remove subscription types enabled for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscription-types-enabled options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-maxProducers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-maxProducers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-maxProducers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-maxProducers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-producers + +Get max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-producers + +Set max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-producers + +Remove max number of producers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-producers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-subscriptions + +Get max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-subscriptions + +Set max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-subscriptions + +Remove max number of subscriptions for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-subscriptions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-message-size + +Get max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-message-size + +Set max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-message-size + +Remove max message size for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-message-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers-per-subscription + +Get max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers-per-subscription + +Set max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers-per-subscription + +Remove max consumers per subscription for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-consumers-per-subscription options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-inactive-topic-policies + +Get the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-inactive-topic-policies + +Set the inactive topic policies on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-inactive-topic-policies + +Remove inactive topic policies from a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-inactive-topic-policies options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-max-consumers + +Get max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-max-consumers + +Set max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-max-consumers + +Remove max number of consumers for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-max-consumers options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-subscribe-rate + +Get consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-subscribe-rate + +Set consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-subscribe-rate + +Remove consumer subscribe rate for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-subscribe-rate options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replicated-subscription-status + +Enable or disable a replicated subscription on a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replicated-subscription-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replicated-subscription-status + +Get replicated subscription status on a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replicated-subscription-status options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-backlog-size + +Calculate backlog size by a message ID (in bytes). + +**Command:** + +```shell +$ pulsar-admin topics get-backlog-size options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## analyze-backlog + +Analyze the backlog of a subscription. + +**Command:** + +```shell +$ pulsar-admin topics analyze-backlog options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-replication-clusters + +Get the replication clusters for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-replication-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-replication-clusters + +Set the replication clusters for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-replication-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-replication-clusters + +Remove the replication clusters for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-replication-clusters options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-shadow-topics + +Get the shadow topics for a topic + +**Command:** + +```shell +$ pulsar-admin topics get-shadow-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-shadow-topics + +Set the shadow topics for a topic + +**Command:** + +```shell +$ pulsar-admin topics set-shadow-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## remove-shadow-topics + +Remove the shadow topics for a topic + +**Command:** + +```shell +$ pulsar-admin topics remove-shadow-topics options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## create-shadow-topic + +Create a shadow topic for an existing source topic. + +**Command:** + +```shell +$ pulsar-admin topics create-shadow-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-shadow-source + +Get the source topic for a shadow topic + +**Command:** + +```shell +$ pulsar-admin topics get-shadow-source options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## get-schema-validation-enforce + +Get the schema validation enforced + +**Command:** + +```shell +$ pulsar-admin topics get-schema-validation-enforce options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## set-schema-validation-enforce + +Set the schema whether open schema validation enforced + +**Command:** + +```shell +$ pulsar-admin topics set-schema-validation-enforce options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## trim-topic + +Trim a topic + +**Command:** + +```shell +$ pulsar-admin topics trim-topic options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + diff --git a/static/reference/4.0.x/pulsar-admin/transactions.md b/static/reference/4.0.x/pulsar-admin/transactions.md new file mode 100644 index 000000000000..1a075eefaa34 --- /dev/null +++ b/static/reference/4.0.x/pulsar-admin/transactions.md @@ -0,0 +1,2030 @@ +# transactions + +Operations on transactions + + +```shell +$ pulsar-admin transactions subcommand +``` + + + +## coordinator-internal-stats + +Get transaction coordinator internal stats + +**Command:** + +```shell +$ pulsar-admin transactions coordinator-internal-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# transactions + +Operations on transactions + + +```shell +$ pulsar-admin transactions subcommand +``` + + + +## coordinator-internal-stats + +Get transaction coordinator internal stats + +**Command:** + +```shell +$ pulsar-admin transactions coordinator-internal-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## pending-ack-internal-stats + +Get pending ack internal stats + +**Command:** + +```shell +$ pulsar-admin transactions pending-ack-internal-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# transactions + +Operations on transactions + + +```shell +$ pulsar-admin transactions subcommand +``` + + + +## coordinator-internal-stats + +Get transaction coordinator internal stats + +**Command:** + +```shell +$ pulsar-admin transactions coordinator-internal-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## pending-ack-internal-stats + +Get pending ack internal stats + +**Command:** + +```shell +$ pulsar-admin transactions pending-ack-internal-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## buffer-snapshot-internal-stats + +Get transaction buffer internal stats + +**Command:** + +```shell +$ pulsar-admin transactions buffer-snapshot-internal-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# transactions + +Operations on transactions + + +```shell +$ pulsar-admin transactions subcommand +``` + + + +## coordinator-internal-stats + +Get transaction coordinator internal stats + +**Command:** + +```shell +$ pulsar-admin transactions coordinator-internal-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## pending-ack-internal-stats + +Get pending ack internal stats + +**Command:** + +```shell +$ pulsar-admin transactions pending-ack-internal-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## buffer-snapshot-internal-stats + +Get transaction buffer internal stats + +**Command:** + +```shell +$ pulsar-admin transactions buffer-snapshot-internal-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## coordinator-stats + +Get transaction coordinator stats + +**Command:** + +```shell +$ pulsar-admin transactions coordinator-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# transactions + +Operations on transactions + + +```shell +$ pulsar-admin transactions subcommand +``` + + + +## coordinator-internal-stats + +Get transaction coordinator internal stats + +**Command:** + +```shell +$ pulsar-admin transactions coordinator-internal-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## pending-ack-internal-stats + +Get pending ack internal stats + +**Command:** + +```shell +$ pulsar-admin transactions pending-ack-internal-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## buffer-snapshot-internal-stats + +Get transaction buffer internal stats + +**Command:** + +```shell +$ pulsar-admin transactions buffer-snapshot-internal-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## coordinator-stats + +Get transaction coordinator stats + +**Command:** + +```shell +$ pulsar-admin transactions coordinator-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## transaction-buffer-stats + +Get transaction buffer stats + +**Command:** + +```shell +$ pulsar-admin transactions transaction-buffer-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# transactions + +Operations on transactions + + +```shell +$ pulsar-admin transactions subcommand +``` + + + +## coordinator-internal-stats + +Get transaction coordinator internal stats + +**Command:** + +```shell +$ pulsar-admin transactions coordinator-internal-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## pending-ack-internal-stats + +Get pending ack internal stats + +**Command:** + +```shell +$ pulsar-admin transactions pending-ack-internal-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## buffer-snapshot-internal-stats + +Get transaction buffer internal stats + +**Command:** + +```shell +$ pulsar-admin transactions buffer-snapshot-internal-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## coordinator-stats + +Get transaction coordinator stats + +**Command:** + +```shell +$ pulsar-admin transactions coordinator-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## transaction-buffer-stats + +Get transaction buffer stats + +**Command:** + +```shell +$ pulsar-admin transactions transaction-buffer-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## pending-ack-stats + +Get transaction pending ack stats + +**Command:** + +```shell +$ pulsar-admin transactions pending-ack-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# transactions + +Operations on transactions + + +```shell +$ pulsar-admin transactions subcommand +``` + + + +## coordinator-internal-stats + +Get transaction coordinator internal stats + +**Command:** + +```shell +$ pulsar-admin transactions coordinator-internal-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## pending-ack-internal-stats + +Get pending ack internal stats + +**Command:** + +```shell +$ pulsar-admin transactions pending-ack-internal-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## buffer-snapshot-internal-stats + +Get transaction buffer internal stats + +**Command:** + +```shell +$ pulsar-admin transactions buffer-snapshot-internal-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## coordinator-stats + +Get transaction coordinator stats + +**Command:** + +```shell +$ pulsar-admin transactions coordinator-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## transaction-buffer-stats + +Get transaction buffer stats + +**Command:** + +```shell +$ pulsar-admin transactions transaction-buffer-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## pending-ack-stats + +Get transaction pending ack stats + +**Command:** + +```shell +$ pulsar-admin transactions pending-ack-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## transaction-in-buffer-stats + +Get transaction in buffer stats + +**Command:** + +```shell +$ pulsar-admin transactions transaction-in-buffer-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# transactions + +Operations on transactions + + +```shell +$ pulsar-admin transactions subcommand +``` + + + +## coordinator-internal-stats + +Get transaction coordinator internal stats + +**Command:** + +```shell +$ pulsar-admin transactions coordinator-internal-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## pending-ack-internal-stats + +Get pending ack internal stats + +**Command:** + +```shell +$ pulsar-admin transactions pending-ack-internal-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## buffer-snapshot-internal-stats + +Get transaction buffer internal stats + +**Command:** + +```shell +$ pulsar-admin transactions buffer-snapshot-internal-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## coordinator-stats + +Get transaction coordinator stats + +**Command:** + +```shell +$ pulsar-admin transactions coordinator-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## transaction-buffer-stats + +Get transaction buffer stats + +**Command:** + +```shell +$ pulsar-admin transactions transaction-buffer-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## pending-ack-stats + +Get transaction pending ack stats + +**Command:** + +```shell +$ pulsar-admin transactions pending-ack-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## transaction-in-buffer-stats + +Get transaction in buffer stats + +**Command:** + +```shell +$ pulsar-admin transactions transaction-in-buffer-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## transaction-in-pending-ack-stats + +Get transaction in pending ack stats + +**Command:** + +```shell +$ pulsar-admin transactions transaction-in-pending-ack-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# transactions + +Operations on transactions + + +```shell +$ pulsar-admin transactions subcommand +``` + + + +## coordinator-internal-stats + +Get transaction coordinator internal stats + +**Command:** + +```shell +$ pulsar-admin transactions coordinator-internal-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## pending-ack-internal-stats + +Get pending ack internal stats + +**Command:** + +```shell +$ pulsar-admin transactions pending-ack-internal-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## buffer-snapshot-internal-stats + +Get transaction buffer internal stats + +**Command:** + +```shell +$ pulsar-admin transactions buffer-snapshot-internal-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## coordinator-stats + +Get transaction coordinator stats + +**Command:** + +```shell +$ pulsar-admin transactions coordinator-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## transaction-buffer-stats + +Get transaction buffer stats + +**Command:** + +```shell +$ pulsar-admin transactions transaction-buffer-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## pending-ack-stats + +Get transaction pending ack stats + +**Command:** + +```shell +$ pulsar-admin transactions pending-ack-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## transaction-in-buffer-stats + +Get transaction in buffer stats + +**Command:** + +```shell +$ pulsar-admin transactions transaction-in-buffer-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## transaction-in-pending-ack-stats + +Get transaction in pending ack stats + +**Command:** + +```shell +$ pulsar-admin transactions transaction-in-pending-ack-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## transaction-metadata + +Get transaction metadata + +**Command:** + +```shell +$ pulsar-admin transactions transaction-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# transactions + +Operations on transactions + + +```shell +$ pulsar-admin transactions subcommand +``` + + + +## coordinator-internal-stats + +Get transaction coordinator internal stats + +**Command:** + +```shell +$ pulsar-admin transactions coordinator-internal-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## pending-ack-internal-stats + +Get pending ack internal stats + +**Command:** + +```shell +$ pulsar-admin transactions pending-ack-internal-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## buffer-snapshot-internal-stats + +Get transaction buffer internal stats + +**Command:** + +```shell +$ pulsar-admin transactions buffer-snapshot-internal-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## coordinator-stats + +Get transaction coordinator stats + +**Command:** + +```shell +$ pulsar-admin transactions coordinator-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## transaction-buffer-stats + +Get transaction buffer stats + +**Command:** + +```shell +$ pulsar-admin transactions transaction-buffer-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## pending-ack-stats + +Get transaction pending ack stats + +**Command:** + +```shell +$ pulsar-admin transactions pending-ack-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## transaction-in-buffer-stats + +Get transaction in buffer stats + +**Command:** + +```shell +$ pulsar-admin transactions transaction-in-buffer-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## transaction-in-pending-ack-stats + +Get transaction in pending ack stats + +**Command:** + +```shell +$ pulsar-admin transactions transaction-in-pending-ack-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## transaction-metadata + +Get transaction metadata + +**Command:** + +```shell +$ pulsar-admin transactions transaction-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## slow-transactions + +Get slow transactions. + +**Command:** + +```shell +$ pulsar-admin transactions slow-transactions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# transactions + +Operations on transactions + + +```shell +$ pulsar-admin transactions subcommand +``` + + + +## coordinator-internal-stats + +Get transaction coordinator internal stats + +**Command:** + +```shell +$ pulsar-admin transactions coordinator-internal-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## pending-ack-internal-stats + +Get pending ack internal stats + +**Command:** + +```shell +$ pulsar-admin transactions pending-ack-internal-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## buffer-snapshot-internal-stats + +Get transaction buffer internal stats + +**Command:** + +```shell +$ pulsar-admin transactions buffer-snapshot-internal-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## coordinator-stats + +Get transaction coordinator stats + +**Command:** + +```shell +$ pulsar-admin transactions coordinator-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## transaction-buffer-stats + +Get transaction buffer stats + +**Command:** + +```shell +$ pulsar-admin transactions transaction-buffer-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## pending-ack-stats + +Get transaction pending ack stats + +**Command:** + +```shell +$ pulsar-admin transactions pending-ack-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## transaction-in-buffer-stats + +Get transaction in buffer stats + +**Command:** + +```shell +$ pulsar-admin transactions transaction-in-buffer-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## transaction-in-pending-ack-stats + +Get transaction in pending ack stats + +**Command:** + +```shell +$ pulsar-admin transactions transaction-in-pending-ack-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## transaction-metadata + +Get transaction metadata + +**Command:** + +```shell +$ pulsar-admin transactions transaction-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## slow-transactions + +Get slow transactions. + +**Command:** + +```shell +$ pulsar-admin transactions slow-transactions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## scale-transactionCoordinators + +Update the scale of transaction coordinators + +**Command:** + +```shell +$ pulsar-admin transactions scale-transactionCoordinators options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# transactions + +Operations on transactions + + +```shell +$ pulsar-admin transactions subcommand +``` + + + +## coordinator-internal-stats + +Get transaction coordinator internal stats + +**Command:** + +```shell +$ pulsar-admin transactions coordinator-internal-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## pending-ack-internal-stats + +Get pending ack internal stats + +**Command:** + +```shell +$ pulsar-admin transactions pending-ack-internal-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## buffer-snapshot-internal-stats + +Get transaction buffer internal stats + +**Command:** + +```shell +$ pulsar-admin transactions buffer-snapshot-internal-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## coordinator-stats + +Get transaction coordinator stats + +**Command:** + +```shell +$ pulsar-admin transactions coordinator-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## transaction-buffer-stats + +Get transaction buffer stats + +**Command:** + +```shell +$ pulsar-admin transactions transaction-buffer-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## pending-ack-stats + +Get transaction pending ack stats + +**Command:** + +```shell +$ pulsar-admin transactions pending-ack-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## transaction-in-buffer-stats + +Get transaction in buffer stats + +**Command:** + +```shell +$ pulsar-admin transactions transaction-in-buffer-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## transaction-in-pending-ack-stats + +Get transaction in pending ack stats + +**Command:** + +```shell +$ pulsar-admin transactions transaction-in-pending-ack-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## transaction-metadata + +Get transaction metadata + +**Command:** + +```shell +$ pulsar-admin transactions transaction-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## slow-transactions + +Get slow transactions. + +**Command:** + +```shell +$ pulsar-admin transactions slow-transactions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## scale-transactionCoordinators + +Update the scale of transaction coordinators + +**Command:** + +```shell +$ pulsar-admin transactions scale-transactionCoordinators options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## position-stats-in-pending-ack + +Get the position stats in transaction pending ack + +**Command:** + +```shell +$ pulsar-admin transactions position-stats-in-pending-ack options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# transactions + +Operations on transactions + + +```shell +$ pulsar-admin transactions subcommand +``` + + + +## coordinator-internal-stats + +Get transaction coordinator internal stats + +**Command:** + +```shell +$ pulsar-admin transactions coordinator-internal-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## pending-ack-internal-stats + +Get pending ack internal stats + +**Command:** + +```shell +$ pulsar-admin transactions pending-ack-internal-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## buffer-snapshot-internal-stats + +Get transaction buffer internal stats + +**Command:** + +```shell +$ pulsar-admin transactions buffer-snapshot-internal-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## coordinator-stats + +Get transaction coordinator stats + +**Command:** + +```shell +$ pulsar-admin transactions coordinator-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## transaction-buffer-stats + +Get transaction buffer stats + +**Command:** + +```shell +$ pulsar-admin transactions transaction-buffer-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## pending-ack-stats + +Get transaction pending ack stats + +**Command:** + +```shell +$ pulsar-admin transactions pending-ack-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## transaction-in-buffer-stats + +Get transaction in buffer stats + +**Command:** + +```shell +$ pulsar-admin transactions transaction-in-buffer-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## transaction-in-pending-ack-stats + +Get transaction in pending ack stats + +**Command:** + +```shell +$ pulsar-admin transactions transaction-in-pending-ack-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## transaction-metadata + +Get transaction metadata + +**Command:** + +```shell +$ pulsar-admin transactions transaction-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## slow-transactions + +Get slow transactions. + +**Command:** + +```shell +$ pulsar-admin transactions slow-transactions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## scale-transactionCoordinators + +Update the scale of transaction coordinators + +**Command:** + +```shell +$ pulsar-admin transactions scale-transactionCoordinators options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## position-stats-in-pending-ack + +Get the position stats in transaction pending ack + +**Command:** + +```shell +$ pulsar-admin transactions position-stats-in-pending-ack options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## coordinators-list + +List transaction coordinators + +**Command:** + +```shell +$ pulsar-admin transactions coordinators-list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + +# transactions + +Operations on transactions + + +```shell +$ pulsar-admin transactions subcommand +``` + + + +## coordinator-internal-stats + +Get transaction coordinator internal stats + +**Command:** + +```shell +$ pulsar-admin transactions coordinator-internal-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## pending-ack-internal-stats + +Get pending ack internal stats + +**Command:** + +```shell +$ pulsar-admin transactions pending-ack-internal-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## buffer-snapshot-internal-stats + +Get transaction buffer internal stats + +**Command:** + +```shell +$ pulsar-admin transactions buffer-snapshot-internal-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## coordinator-stats + +Get transaction coordinator stats + +**Command:** + +```shell +$ pulsar-admin transactions coordinator-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## transaction-buffer-stats + +Get transaction buffer stats + +**Command:** + +```shell +$ pulsar-admin transactions transaction-buffer-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## pending-ack-stats + +Get transaction pending ack stats + +**Command:** + +```shell +$ pulsar-admin transactions pending-ack-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## transaction-in-buffer-stats + +Get transaction in buffer stats + +**Command:** + +```shell +$ pulsar-admin transactions transaction-in-buffer-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## transaction-in-pending-ack-stats + +Get transaction in pending ack stats + +**Command:** + +```shell +$ pulsar-admin transactions transaction-in-pending-ack-stats options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## transaction-metadata + +Get transaction metadata + +**Command:** + +```shell +$ pulsar-admin transactions transaction-metadata options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## slow-transactions + +Get slow transactions. + +**Command:** + +```shell +$ pulsar-admin transactions slow-transactions options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## scale-transactionCoordinators + +Update the scale of transaction coordinators + +**Command:** + +```shell +$ pulsar-admin transactions scale-transactionCoordinators options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## position-stats-in-pending-ack + +Get the position stats in transaction pending ack + +**Command:** + +```shell +$ pulsar-admin transactions position-stats-in-pending-ack options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## coordinators-list + +List transaction coordinators + +**Command:** + +```shell +$ pulsar-admin transactions coordinators-list options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + + +## abort-transaction + +Abort transaction + +**Command:** + +```shell +$ pulsar-admin transactions abort-transaction options +``` + +**Options:** + +|Flag|Description|Default| +|---|---|---| +| `[-h, --help]` | Show this help message and exit.|null|| +| `[-v, --version]` | Print version information and exit.|null|| + diff --git a/static/reference/4.0.x/pulsar-client/README.md b/static/reference/4.0.x/pulsar-client/README.md new file mode 100644 index 000000000000..d25591d2d24e --- /dev/null +++ b/static/reference/4.0.x/pulsar-client/README.md @@ -0,0 +1,12 @@ +`pulsar-client` is a tool used to produce and consume messages. + +## Environment variables + +You can use the following environment variables to configure `pulsar-client`. + +| Variable | Description | Default | +|--------------------------|------------------------------------|------------------| +| `PULSAR_LOG_CONF` | Log4j configuration file | conf/log4j2.yaml | +| `PULSAR_CLIENT_CONF` | Configuration file for the client | conf/client.conf | +| `PULSAR_EXTRA_OPTS` | Extra options passed to the JVM | N/A | +| `PULSAR_EXTRA_CLASSPATH` | Extra paths for Pulsar's classpath | N/A | diff --git a/static/reference/4.0.x/pulsar-client/pulsar-client.md b/static/reference/4.0.x/pulsar-client/pulsar-client.md new file mode 100644 index 000000000000..416204462e13 --- /dev/null +++ b/static/reference/4.0.x/pulsar-client/pulsar-client.md @@ -0,0 +1,146 @@ +## produce + +Produce messages to a specified topic + + +```shell +$ pulsar-client produce [options] +``` + +|Flag|Description|Default| +|---|---|---| +| `[-m, --messages]` | Messages to send, either -m or -f must be specified. Specify -m for each message.|null| +| +| `[-f, --files]` | Comma separated file paths to send, either -m or -f must be specified.|null| +| +| `[-n, --num-produce]` | Number of times to send message(s), the count of messages/files * num-produce should below than 1000.|null| +| +| `[-r, --rate]` | Rate (in msg/sec) at which to produce, value 0 means to produce messages as fast as possible.|null| +| +| `[-db, --disable-batching]` | Disable batch sending of messages|null| +| +| `[-c, --chunking]` | Should split the message and publish in chunks if message size is larger than allowed max size|null| +| +| `[-s, --separator]` | Character to split messages string on default is comma|null| +| +| `[-p, --properties]` | Properties to add, Comma separated key=value string, like k1=v1,k2=v2.|null| +| +| `[-k, --key]` | Partitioning key to add to each message|null| +| +| `[-kvk, --key-value-key]` | Value to add as message key in KeyValue schema|null| +| +| `[-kvkf, --key-value-key-file]` | Path to file containing the value to add as message key in KeyValue schema. JSON and AVRO files are supported.|null| +| +| `[-vs, --value-schema]` | Schema type (can be bytes,avro,json,string...)|null| +| +| `[-ks, --key-schema]` | Schema type (can be bytes,avro,json,string...)|null| +| +| `[-kvet, --key-value-encoding-type]` | Key Value Encoding Type (it can be separated or inline)|null| +| +| `[-ekn, --encryption-key-name]` | The public key name to encrypt payload|null| +| +| `[-ekv, --encryption-key-value]` | The URI of public key to encrypt payload, for example file:///path/to/public.key or data:application/x-pem-file;base64,*****|null| +| +| `[-dr, --disable-replication]` | Disable geo-replication for messages.|null| +| +| `[-h, --help]` | Show this help message and exit.|null| +| +| `[-v, --version]` | Print version information and exit.|null| +| + +## consume + +Consume messages from a specified topic + + +```shell +$ pulsar-client consume [options] +``` + +|Flag|Description|Default| +|---|---|---| +| `[-t, --subscription-type]` | Subscription type.|null| +| +| `[-m, --subscription-mode]` | Subscription mode.|null| +| +| `[-p, --subscription-position]` | Subscription position.|null| +| +| `[-s, --subscription-name]` | Subscription name.|null| +| +| `[-n, --num-messages]` | Number of messages to consume, 0 means to consume forever.|null| +| +| `[--hex]` | Display binary messages in hex.|null| +| +| `[--hide-content]` | Do not write the message to console.|null| +| +| `[-r, --rate]` | Rate (in msg/sec) at which to consume, value 0 means to consume messages as fast as possible.|null| +| +| `[--regex]` | Indicate the topic name is a regex pattern|null| +| +| `[-q, --queue-size]` | Consumer receiver queue size.|null| +| +| `[-mc, --max_chunked_msg]` | Max pending chunk messages|null| +| +| `[-ac, --auto_ack_chunk_q_full]` | Auto ack for oldest message on queue is full|null| +| +| `[-ekv, --encryption-key-value]` | The URI of private key to decrypt payload, for example file:///path/to/private.key or data:application/x-pem-file;base64,*****|null| +| +| `[-st, --schema-type]` | Set a schema type on the consumer, it can be 'bytes' or 'auto_consume'|null| +| +| `[-pm, --pool-messages]` | Use the pooled message|null| +| +| `[-rs, --replicated]` | Whether the subscription status should be replicated|null| +| +| `[-ca, --crypto-failure-action]` | Crypto Failure Action|null| +| +| `[-mp, --print-metadata]` | Message metadata|null| +| +| `[-h, --help]` | Show this help message and exit.|null| +| +| `[-v, --version]` | Print version information and exit.|null| +| + +## read + +Read messages from a specified topic + + +```shell +$ pulsar-client read [options] +``` + +|Flag|Description|Default| +|---|---|---| +| `[-m, --start-message-id]` | Initial reader position, it can be 'latest', 'earliest' or ':'|null| +| +| `[-i, --start-message-id-inclusive]` | Whether to include the position specified by -m option.|null| +| +| `[-n, --num-messages]` | Number of messages to read, 0 means to read forever.|null| +| +| `[--hex]` | Display binary messages in hex.|null| +| +| `[--hide-content]` | Do not write the message to console.|null| +| +| `[-r, --rate]` | Rate (in msg/sec) at which to read, value 0 means to read messages as fast as possible.|null| +| +| `[-q, --queue-size]` | Reader receiver queue size.|null| +| +| `[-mc, --max_chunked_msg]` | Max pending chunk messages|null| +| +| `[-ac, --auto_ack_chunk_q_full]` | Auto ack for oldest message on queue is full|null| +| +| `[-ekv, --encryption-key-value]` | The URI of private key to decrypt payload, for example file:///path/to/private.key or data:application/x-pem-file;base64,*****|null| +| +| `[-st, --schema-type]` | Set a schema type on the reader, it can be 'bytes' or 'auto_consume'|null| +| +| `[-pm, --pool-messages]` | Use the pooled message|null| +| +| `[-ca, --crypto-failure-action]` | Crypto Failure Action|null| +| +| `[-mp, --print-metadata]` | Message metadata|null| +| +| `[-h, --help]` | Show this help message and exit.|null| +| +| `[-v, --version]` | Print version information and exit.|null| +| + diff --git a/static/reference/4.0.x/pulsar-daemon/README.md b/static/reference/4.0.x/pulsar-daemon/README.md new file mode 100644 index 000000000000..c83ef25d4515 --- /dev/null +++ b/static/reference/4.0.x/pulsar-daemon/README.md @@ -0,0 +1 @@ +> Docs for `pulsar-daemon`. diff --git a/static/reference/4.0.x/pulsar-daemon/pulsar-daemon.md b/static/reference/4.0.x/pulsar-daemon/pulsar-daemon.md new file mode 100644 index 000000000000..990441f54f1c --- /dev/null +++ b/static/reference/4.0.x/pulsar-daemon/pulsar-daemon.md @@ -0,0 +1,40 @@ +# pulsar-daemon + +A wrapper around the pulsar tool that’s used to start and stop processes, such as ZooKeeper, bookies, and Pulsar brokers, in the background using nohup. + +pulsar-daemon has a similar interface to the pulsar command but adds start and stop commands for various services. For a listing of those services, run pulsar-daemon to see the help output or see the documentation for the pulsar command. + +### start +Start a service in the background using nohup. + +**Tip** + +> You can use flags to perform more tasks. For example, `pulsar-daemon start standalone -nfw -nss` can start Pulsar faster in the background (without function workers and stream storage). `pulsar-daemon start standalone` flags are the same as `pulsar standalone` flags. For the complete flag list, see flags of the `pulsar standalone` command on the [Pulsar Reference Site](https://pulsar.apache.org/reference). + +Usage + +```bash +pulsar-daemon start service +``` + +### stop +Stop a service that’s already been started using start. + +Usage + +```bash +pulsar-daemon stop service options +``` + +Options + +|Flag|Description|Default| +|---|---|---| +|-force|Stop the service forcefully if not stopped by normal shutdown.|false| + +### restart +Restart a service that has already been started. + +```bash +pulsar-daemon restart service +``` diff --git a/static/reference/4.0.x/pulsar-perf/README.md b/static/reference/4.0.x/pulsar-perf/README.md new file mode 100644 index 000000000000..3a9ee62e2ef8 --- /dev/null +++ b/static/reference/4.0.x/pulsar-perf/README.md @@ -0,0 +1,12 @@ +`pulsar-perf` is a tool used to test the performance of Pulsar brokers. + +## Environment variables + +You can use the following environment variables to configure `pulsar-perf`. + +| Variable | Description | Default | +|--------------------------|------------------------------------|------------------| +| `PULSAR_LOG_CONF` | Log4j configuration file | conf/log4j2.yaml | +| `PULSAR_CLIENT_CONF` | Configuration file for the client | conf/client.conf | +| `PULSAR_EXTRA_OPTS` | Extra options passed to the JVM | N/A | +| `PULSAR_EXTRA_CLASSPATH` | Extra paths for Pulsar's classpath | N/A | diff --git a/static/reference/4.0.x/pulsar-perf/pulsar-perf.md b/static/reference/4.0.x/pulsar-perf/pulsar-perf.md new file mode 100644 index 000000000000..29fd041fc61b --- /dev/null +++ b/static/reference/4.0.x/pulsar-perf/pulsar-perf.md @@ -0,0 +1,323 @@ +## produce + +Test pulsar producer performance. + + +```shell +$ pulsar-perf produce [options] +``` + +|Flag|Description|Default| +|---|---|---| +| `-u, --service-url` | Pulsar Service URL|pulsar://localhost:6650/| +| `--auth-plugin` | Authentication plugin class name|| +| `--auth-params` | Authentication parameters, whose format is determined by the implementation of method `configure` in authentication plugin class, for example "key1:val1,key2:val2" or "{"key1":"val1","key2":"val2"}".|| +| `--ssl-factory-plugin` | Pulsar SSL Factory plugin class name|null| +| `--ssl-factory-plugin-params` | Pulsar SSL Factory Plugin parameters in the format: "{"key1":"val1","key2":"val2"}".|null| +| `--trust-cert-file` | Path for the trusted TLS certificate file|| +| `--tls-allow-insecure` | Allow insecure TLS connection|false| +| `--tls-enable-hostname-verification` | Enable TLS hostname verification|false| +| `-c, --max-connections` | Max number of TCP connections to a single broker|1| +| `-i, --stats-interval-seconds` | Statistics Interval Seconds. If 0, statistics will be disabled|0| +| `-ioThreads, --num-io-threads` | Set the number of threads to be used for handling connections to brokers. The default value is 1.|1| +| `-bw, --busy-wait` | Enable Busy-Wait on the Pulsar client|false| +| `--listener-name` | Listener name for the broker.|null| +| `-lt, --num-listener-threads` | Set the number of threads to be used for message listeners|1| +| `-mlr, --max-lookup-request` | Maximum number of lookup requests allowed on each broker connection to prevent overloading a broker|50000| +| `--proxy-url` | Proxy-server URL to which to connect.|| +| `--proxy-protocol` | Proxy protocol to select type of routing at proxy.|| +| `-ml, --memory-limit` | Configure the Pulsar client memory limit (eg: 32M, 64M)|0| +| `-t, --num-topics, --num-topic` | Number of topics. Must matchthe given number of topic arguments.|1| +| `-threads, --num-test-threads` | Number of test threads|1| +| `-r, --rate` | Publish rate msg/s across topics|100| +| `-s, --size` | Message size (bytes)|1024| +| `-n, --num-producers` | Number of producers (per topic)|1| +| `--separator` | Separator between the topic and topic number|-| +| `--send-timeout` | Set the sendTimeout value default 0 to keep compatibility with previous version of pulsar-perf|0| +| `-pn, --producer-name` | Producer Name|null| +| `-au, --admin-url` | Pulsar Admin URL|http://localhost:8080/| +| `-ch, --chunking` | Should split the message and publish in chunks if message size is larger than allowed max size|false| +| `-o, --max-outstanding` | Max number of outstanding messages|0| +| `-p, --max-outstanding-across-partitions` | Max number of outstanding messages across partitions|0| +| `-np, --partitions` | Create partitioned topics with the given number of partitions, set 0 to not try to create the topic|null| +| `-m, --num-messages` | Number of messages to publish in total. If <= 0, it will keep publishing|0| +| `-z, --compression` | Compress messages payload|NONE| +| `-f, --payload-file` | Use payload from an UTF-8 encoded text file and a payload will be randomly selected when publishing messages|null| +| `-e, --payload-delimiter` | The delimiter used to split lines when using payload from a file|\n| +| `-b, --batch-time-window` | Batch messages in 'x' ms window (Default: 1ms)|1.0| +| `-db, --disable-batching` | Disable batching if true|false| +| `-bm, --batch-max-messages` | Maximum number of messages per batch|1000| +| `-bb, --batch-max-bytes` | Maximum number of bytes per batch|4194304| +| `-time, --test-duration` | Test duration in secs. If <= 0, it will keep publishing|0| +| `--warmup-time` | Warm-up time in seconds (Default: 1 sec)|1.0| +| `-k, --encryption-key-name` | The public key name to encrypt payload|null| +| `-v, --encryption-key-value-file` | The file which contains the public key to encrypt payload|null| +| `-d, --delay` | Mark messages with a given delay in seconds|0| +| `-dr, --delay-range` | Mark messages with a given delay by a random number of seconds. this value between the specified origin (inclusive) and the specified bound (exclusive). e.g. 1,300|null| +| `-set, --set-event-time` | Set the eventTime on messages|false| +| `-ef, --exit-on-failure` | Exit from the process on publish failure (default: disable)|false| +| `-mk, --message-key-generation-mode` | The generation mode of message key, valid options are: [autoIncrement, random]|null| +| `-am, --access-mode` | Producer access mode|Shared| +| `-fp, --format-payload` | Format %i as a message index in the stream from producer and/or %t as the timestamp nanoseconds.|false| +| `-fc, --format-class` | Custom Formatter class name|org.apache.pulsar.testclient.DefaultMessageFormatter| +| `-tto, --txn-timeout` | Set the time value of transaction timeout, and the time unit is second. (After --txn-enable setting to true, --txn-timeout takes effect)|10| +| `-nmt, --numMessage-perTransaction` | The number of messages sent by a transaction. (After --txn-enable setting to true, -nmt takes effect)|50| +| `-txn, --txn-enable` | Enable or disable the transaction|false| +| `-abort` | Abort the transaction. (After --txn-enable setting to true, -abort takes effect)|false| +| `--histogram-file` | HdrHistogram output file|null| +| `-h, --help` | Show this help message and exit.|false| +| `-V, --version` | Print version information and exit.|false| + +## consume + +Test pulsar consumer performance. + + +```shell +$ pulsar-perf consume [options] +``` + +|Flag|Description|Default| +|---|---|---| +| `-u, --service-url` | Pulsar Service URL|pulsar://localhost:6650/| +| `--auth-plugin` | Authentication plugin class name|| +| `--auth-params` | Authentication parameters, whose format is determined by the implementation of method `configure` in authentication plugin class, for example "key1:val1,key2:val2" or "{"key1":"val1","key2":"val2"}".|| +| `--ssl-factory-plugin` | Pulsar SSL Factory plugin class name|null| +| `--ssl-factory-plugin-params` | Pulsar SSL Factory Plugin parameters in the format: "{"key1":"val1","key2":"val2"}".|null| +| `--trust-cert-file` | Path for the trusted TLS certificate file|| +| `--tls-allow-insecure` | Allow insecure TLS connection|false| +| `--tls-enable-hostname-verification` | Enable TLS hostname verification|false| +| `-c, --max-connections` | Max number of TCP connections to a single broker|1| +| `-i, --stats-interval-seconds` | Statistics Interval Seconds. If 0, statistics will be disabled|0| +| `-ioThreads, --num-io-threads` | Set the number of threads to be used for handling connections to brokers. The default value is 1.|1| +| `-bw, --busy-wait` | Enable Busy-Wait on the Pulsar client|false| +| `--listener-name` | Listener name for the broker.|null| +| `-lt, --num-listener-threads` | Set the number of threads to be used for message listeners|1| +| `-mlr, --max-lookup-request` | Maximum number of lookup requests allowed on each broker connection to prevent overloading a broker|50000| +| `--proxy-url` | Proxy-server URL to which to connect.|| +| `--proxy-protocol` | Proxy protocol to select type of routing at proxy.|| +| `-ml, --memory-limit` | Configure the Pulsar client memory limit (eg: 32M, 64M)|0| +| `-t, --num-topics, --num-topic` | Number of topics. Must matchthe given number of topic arguments.|1| +| `-n, --num-consumers` | Number of consumers (per subscription), only one consumer is allowed when subscriptionType is Exclusive|1| +| `-ns, --num-subscriptions` | Number of subscriptions (per topic)|1| +| `-ss, --subscriptions` | A list of subscriptions to consume (for example, sub1,sub2)|[sub]| +| `-st, --subscription-type` | Subscription type|Exclusive| +| `-sp, --subscription-position` | Subscription position|Latest| +| `-r, --rate` | Simulate a slow message consumer (rate in msg/s)|0.0| +| `-q, --receiver-queue-size` | Size of the receiver queue|1000| +| `-p, --receiver-queue-size-across-partitions` | Max total size of the receiver queue across partitions|50000| +| `-aq, --auto-scaled-receiver-queue-size` | Enable autoScaledReceiverQueueSize|false| +| `-rs, --replicated` | Whether the subscription status should be replicated|false| +| `--acks-delay-millis` | Acknowledgements grouping delay in millis|100| +| `-m, --num-messages` | Number of messages to consume in total. If <= 0, it will keep consuming|0| +| `-mc, --max_chunked_msg` | Max pending chunk messages|0| +| `-ac, --auto_ack_chunk_q_full` | Auto ack for oldest message on queue is full|false| +| `-e, --expire_time_incomplete_chunked_messages` | Expire time in ms for incomplete chunk messages|0| +| `-v, --encryption-key-value-file` | The file which contains the private key to decrypt payload|null| +| `-time, --test-duration` | Test duration in secs. If <= 0, it will keep consuming|0| +| `--batch-index-ack` | Enable or disable the batch index acknowledgment|false| +| `-pm, --pool-messages` | Use the pooled message|true| +| `-tto, --txn-timeout` | Set the time value of transaction timeout, and the time unit is second. (After --txn-enable setting to true, --txn-timeout takes effect)|10| +| `-nmt, --numMessage-perTransaction` | The number of messages acknowledged by a transaction. (After --txn-enable setting to true, -numMessage-perTransaction takes effect|50| +| `-txn, --txn-enable` | Enable or disable the transaction|false| +| `-ntxn` | The number of opened transactions, 0 means keeping open.(After --txn-enable setting to true, -ntxn takes effect.)|0| +| `-abort` | Abort the transaction. (After --txn-enable setting to true, -abort takes effect)|false| +| `--histogram-file` | HdrHistogram output file|null| +| `-h, --help` | Show this help message and exit.|false| +| `-V, --version` | Print version information and exit.|false| + +## transaction + +Test pulsar transaction performance. + + +```shell +$ pulsar-perf transaction [options] +``` + +|Flag|Description|Default| +|---|---|---| +| `-u, --service-url` | Pulsar Service URL|pulsar://localhost:6650/| +| `--auth-plugin` | Authentication plugin class name|| +| `--auth-params` | Authentication parameters, whose format is determined by the implementation of method `configure` in authentication plugin class, for example "key1:val1,key2:val2" or "{"key1":"val1","key2":"val2"}".|| +| `--ssl-factory-plugin` | Pulsar SSL Factory plugin class name|null| +| `--ssl-factory-plugin-params` | Pulsar SSL Factory Plugin parameters in the format: "{"key1":"val1","key2":"val2"}".|null| +| `--trust-cert-file` | Path for the trusted TLS certificate file|| +| `--tls-allow-insecure` | Allow insecure TLS connection|false| +| `--tls-enable-hostname-verification` | Enable TLS hostname verification|false| +| `-c, --max-connections` | Max number of TCP connections to a single broker|1| +| `-i, --stats-interval-seconds` | Statistics Interval Seconds. If 0, statistics will be disabled|0| +| `-ioThreads, --num-io-threads` | Set the number of threads to be used for handling connections to brokers. The default value is 1.|1| +| `-bw, --busy-wait` | Enable Busy-Wait on the Pulsar client|false| +| `--listener-name` | Listener name for the broker.|null| +| `-lt, --num-listener-threads` | Set the number of threads to be used for message listeners|1| +| `-mlr, --max-lookup-request` | Maximum number of lookup requests allowed on each broker connection to prevent overloading a broker|50000| +| `--proxy-url` | Proxy-server URL to which to connect.|| +| `--proxy-protocol` | Proxy protocol to select type of routing at proxy.|| +| `-ml, --memory-limit` | Configure the Pulsar client memory limit (eg: 32M, 64M)|0| +| `--topics-c` | All topics that need ack for a transaction|[test-consume]| +| `--topics-p` | All topics that need produce for a transaction|[test-produce]| +| `-threads, --num-test-threads` | Number of test threads.This thread is for a new transaction to ack messages from consumer topics and produce message to producer topics, and then commit or abort this transaction. Increasing the number of threads increases the parallelism of the performance test, thereby increasing the intensity of the stress test.|1| +| `-au, --admin-url` | Pulsar Admin URL|http://localhost:8080/| +| `-np, --partitions` | Create partitioned topics with a given number of partitions, 0 meansnot trying to create a topic|null| +| `-time, --test-duration` | Test duration (in second). 0 means keeping publishing|0| +| `-ss, --subscriptions` | A list of subscriptions to consume (for example, sub1,sub2)|[sub]| +| `-ns, --num-subscriptions` | Number of subscriptions (per topic)|1| +| `-sp, --subscription-position` | Subscription position|Earliest| +| `-st, --subscription-type` | Subscription type|Shared| +| `-rs, --replicated` | Whether the subscription status should be replicated|false| +| `-q, --receiver-queue-size` | Size of the receiver queue|1000| +| `-tto, --txn-timeout` | Set the time value of transaction timeout, and the time unit is second. (After --txn-enable setting to true, --txn-timeout takes effect)|5| +| `-ntxn, --number-txn` | Set the number of transaction. 0 means keeping open.If transaction disabled, it means the number of tasks. The task or transaction produces or consumes a specified number of messages.|0| +| `-nmp, --numMessage-perTransaction-produce` | Set the number of messages produced in a transaction.If transaction disabled, it means the number of messages produced in a task.|1| +| `-nmc, --numMessage-perTransaction-consume` | Set the number of messages consumed in a transaction.If transaction disabled, it means the number of messages consumed in a task.|1| +| `--txn-disable` | Disable transaction|false| +| `-abort` | Abort the transaction. (After --txn-disEnable setting to false, -abort takes effect)|false| +| `-txnRate` | Set the rate of opened transaction or task. 0 means no limit|0| +| `-h, --help` | Show this help message and exit.|false| +| `-V, --version` | Print version information and exit.|false| + +## read + +Test pulsar reader performance. + + +```shell +$ pulsar-perf read [options] +``` + +|Flag|Description|Default| +|---|---|---| +| `-u, --service-url` | Pulsar Service URL|pulsar://localhost:6650/| +| `--auth-plugin` | Authentication plugin class name|| +| `--auth-params` | Authentication parameters, whose format is determined by the implementation of method `configure` in authentication plugin class, for example "key1:val1,key2:val2" or "{"key1":"val1","key2":"val2"}".|| +| `--ssl-factory-plugin` | Pulsar SSL Factory plugin class name|null| +| `--ssl-factory-plugin-params` | Pulsar SSL Factory Plugin parameters in the format: "{"key1":"val1","key2":"val2"}".|null| +| `--trust-cert-file` | Path for the trusted TLS certificate file|| +| `--tls-allow-insecure` | Allow insecure TLS connection|false| +| `--tls-enable-hostname-verification` | Enable TLS hostname verification|false| +| `-c, --max-connections` | Max number of TCP connections to a single broker|1| +| `-i, --stats-interval-seconds` | Statistics Interval Seconds. If 0, statistics will be disabled|0| +| `-ioThreads, --num-io-threads` | Set the number of threads to be used for handling connections to brokers. The default value is 1.|1| +| `-bw, --busy-wait` | Enable Busy-Wait on the Pulsar client|false| +| `--listener-name` | Listener name for the broker.|null| +| `-lt, --num-listener-threads` | Set the number of threads to be used for message listeners|1| +| `-mlr, --max-lookup-request` | Maximum number of lookup requests allowed on each broker connection to prevent overloading a broker|50000| +| `--proxy-url` | Proxy-server URL to which to connect.|| +| `--proxy-protocol` | Proxy protocol to select type of routing at proxy.|| +| `-ml, --memory-limit` | Configure the Pulsar client memory limit (eg: 32M, 64M)|0| +| `-t, --num-topics, --num-topic` | Number of topics. Must matchthe given number of topic arguments.|1| +| `-r, --rate` | Simulate a slow message reader (rate in msg/s)|0.0| +| `-m, --start-message-id` | Start message id. This can be either 'earliest', 'latest' or a specific message id by using 'lid:eid'|earliest| +| `-q, --receiver-queue-size` | Size of the receiver queue|1000| +| `-n, --num-messages` | Number of messages to consume in total. If <= 0, it will keep consuming|0| +| `--use-tls` | Use TLS encryption on the connection|false| +| `-time, --test-duration` | Test duration in secs. If <= 0, it will keep consuming|0| +| `-h, --help` | Show this help message and exit.|false| +| `-V, --version` | Print version information and exit.|false| + +## monitor-brokers + +Monitors brokers and prints to the console information about their system resource usages, +their topic and bundle counts, their message rates, and other metrics. + + +```shell +$ pulsar-perf monitor-brokers [options] +``` + +|Flag|Description|Default| +|---|---|---| +| `--connect-string` | Zookeeper or broker connect string|null| +| `--extensions` | true to monitor Load Balance Extensions.|false| +| `-h, --help` | Show this help message and exit.|false| +| `-V, --version` | Print version information and exit.|false| + +## simulation-client + +Simulate client load by maintaining producers and consumers for topics. + + +```shell +$ pulsar-perf simulation-client [options] +``` + +|Flag|Description|Default| +|---|---|---| +| `--port` | Port to listen on for controller|0| +| `--service-url` | Pulsar Service URL|null| +| `-ml, --memory-limit` | Configure the Pulsar client memory limit (eg: 32M, 64M)|0| +| `-h, --help` | Show this help message and exit.|false| +| `-V, --version` | Print version information and exit.|false| + +## simulation-controller + +Provides a shell for the user to dictate how simulation clients should incur load. + + +```shell +$ pulsar-perf simulation-controller [options] +``` + +|Flag|Description|Default| +|---|---|---| +| `--cluster` | Cluster to test on|null| +| `--clients` | Comma separated list of client hostnames|null| +| `--client-port` | Port that the clients are listening on|0| +| `-h, --help` | Show this help message and exit.|false| +| `-V, --version` | Print version information and exit.|false| + +## websocket-producer + +Test pulsar websocket producer performance. + + +```shell +$ pulsar-perf websocket-producer [options] +``` + +|Flag|Description|Default| +|---|---|---| +| `-cf, --conf-file` | Configuration file|null| +| `-u, --proxy-url` | Pulsar Proxy URL, e.g., "ws://localhost:8080/"|null| +| `-r, --rate` | Publish rate msg/s across topics|100| +| `-s, --size` | Message size in byte|1024| +| `-t, --num-topic` | Number of topics|1| +| `--auth-plugin` | Authentication plugin class name|null| +| `--auth-params` | Authentication parameters, whose format is determined by the implementation of method `configure` in authentication plugin class, for example "key1:val1,key2:val2" or "{"key1":"val1","key2":"val2"}".|null| +| `-m, --num-messages` | Number of messages to publish in total. If <= 0, it will keep publishing|0| +| `-f, --payload-file` | Use payload from a file instead of empty buffer|null| +| `-e, --payload-delimiter` | The delimiter used to split lines when using payload from a file|\n| +| `-fp, --format-payload` | Format %i as a message index in the stream from producer and/or %t as the timestamp nanoseconds|false| +| `-fc, --format-class` | Custom Formatter class name|org.apache.pulsar.testclient.DefaultMessageFormatter| +| `-time, --test-duration` | Test duration in secs. If <= 0, it will keep publishing|0| +| `-h, --help` | Show this help message and exit.|false| +| `-V, --version` | Print version information and exit.|false| + +## managed-ledger + +Write directly on managed-ledgers + + +```shell +$ pulsar-perf managed-ledger [options] +``` + +|Flag|Description|Default| +|---|---|---| +| `-r, --rate` | Write rate msg/s across managed ledgers|100| +| `-s, --size` | Message size|1024| +| `-t, --num-topic` | Number of managed ledgers|1| +| `--threads` | Number of threads writing|1| +| `-md, --metadata-store` | Metadata store service URL. For example: zk:my-zk:2181|null| +| `-o, --max-outstanding` | Max number of outstanding requests|1000| +| `-c, --max-connections` | Max number of TCP connections to a single bookie|1| +| `-m, --num-messages` | Number of messages to publish in total. If <= 0, it will keep publishing|0| +| `-e, --ensemble-size` | Ledger ensemble size|1| +| `-w, --write-quorum` | Ledger write quorum|1| +| `-a, --ack-quorum` | Ledger ack quorum|1| +| `-dt, --digest-type` | BookKeeper digest type|CRC32C| +| `-time, --test-duration` | Test duration in secs. If <= 0, it will keep publishing|0| +| `-h, --help` | Show this help message and exit.|false| +| `-V, --version` | Print version information and exit.|false| + diff --git a/static/reference/4.0.x/pulsar-shell/README.md b/static/reference/4.0.x/pulsar-shell/README.md new file mode 100644 index 000000000000..dec5a0e95bab --- /dev/null +++ b/static/reference/4.0.x/pulsar-shell/README.md @@ -0,0 +1 @@ +> Docs for `pulsar-shell`. diff --git a/static/reference/4.0.x/pulsar-shell/pulsar-shell.md b/static/reference/4.0.x/pulsar-shell/pulsar-shell.md new file mode 100644 index 000000000000..c7d6e227a09a --- /dev/null +++ b/static/reference/4.0.x/pulsar-shell/pulsar-shell.md @@ -0,0 +1,144 @@ +# pulsar-shell + +[Pulsar shell](pathname:///docs/@pulsar:version@/administration-pulsar-shell) tool. + +### Interactive mode + +Usage + +```bash +pulsar-shell +``` + +| Flag | Description | Default | +|-------------------|-----------------------------------------------------------------------|------------------| +| `-c`, `--config` | Client configuration file. It is used as a `default` config. | conf/client.conf | +| `--fail-on-error` | If true, the shell is interrupted when a command throws an exception. | false | +| `-h`, `--help` | Show this help. | | + +### Non-interactive mode + +Usage + +```bash +pulsar-shell -f [FILE] +pulsar-shell -e [COMMAND] +echo "[COMMAND]" | pulsar-shell - +``` + +| Flag | Description | Default | +|---------------------------|-----------------------------------------------------------------------------------------------------|------------------| +| `-c`, `--config` | Client configuration file. It is used as a `default` config. | conf/client.conf | +| `--fail-on-error` | If true, the shell is interrupted when a command throws an exception. | false | +| `-np`, `--no-progress` | Display raw output of the commands without the fancy progress visualization. | false | +| `-f`, `--filename` | Input filename with a list of commands to be executed. Each command must be separated by a newline. | | +| `-e`, `--execute-command` | Execute this command and exit. | | +| `-` | Read commands from the standard input. | | +| `-h`, `--help` | Show this help. | | + +Commands + +* `admin` - See [Admin API](pathname:///docs/@pulsar:version@/admin-api-overview) +* `client` - See [pulsar-client](../pulsar-client/README.md) +* `config` + +### config + +Manage shell configurations. + +#### use + +Use a specific configuration for next commands. + +```bash +default(localhost)> config use mycluster +``` + +#### create + +Create a new configuration. + +```bash +default(localhost)> config create --file ./conf/client.conf mycluster +``` + +| Flag | Description | Default | +|-----------|------------------------------------------------------------------------------------------|---------| +| `--file` | File path of the config. | | +| `--url` | URL of the config. | | +| `--value` | Inline value of the config. Base64-encoded value is supported with the prefix `base64:`. | | + +#### clone + +Create a new configuration cloning an existing one. + +```bash +default(localhost)> config clone mycluster --name mycluster2 +``` + +| Flag | Description | Default | +|----------|-------------------------|---------| +| `--name` | Name of the new config. | | + +#### update + +Update an existing configuration. + +```bash +default(localhost)> config update --file ./conf/client.conf mycluster +``` + +| Flag | Description | Default | +|-----------|------------------------------------------------------------------------------------------|---------| +| `--file` | File path of the config. | | +| `--url` | URL of the config. | | +| `--value` | Inline value of the config. Base64-encoded value is supported with the prefix `base64:`. | | + +#### set-property + +Set a value for a specified configuration property. + +```bash +default(localhost)> config set-property -p webServiceUrl -v http:// mycluster +``` + +| Flag | Description | Default | +|--------------------|-----------------------------|---------| +| `-p`, `--property` | Property name to update. | | +| `-v`, `--value` | New value for the property. | | + +#### get-property + +Get the value for a specified configuration property. + +```bash +default(localhost)> config get-property -p webServiceUrl mycluster +``` + +| Flag | Description | Default | +|--------------------|--------------------------|---------| +| `-p`, `--property` | Property name to update. | | + +#### view + +View details of a config. + +```bash +default(localhost)> config view mycluster +``` + +#### delete + +Delete a config. You can't delete a config if it's currently used. + +```bash +default(localhost)> config delete mycluster +``` + +#### list + +List all the configuration names. + +```bash +default(localhost)> config list +``` diff --git a/static/reference/4.0.x/pulsar/README.md b/static/reference/4.0.x/pulsar/README.md new file mode 100644 index 000000000000..bf2c5426160a --- /dev/null +++ b/static/reference/4.0.x/pulsar/README.md @@ -0,0 +1 @@ +> Docs for `pulsar`. diff --git a/static/reference/4.0.x/pulsar/broker-tool.md b/static/reference/4.0.x/pulsar/broker-tool.md new file mode 100644 index 000000000000..1a96b7ef6b4f --- /dev/null +++ b/static/reference/4.0.x/pulsar/broker-tool.md @@ -0,0 +1,22 @@ +# broker-tool + +broker-tool is used for operations on a specific broker + + +```shell +$ pulsar broker-tool subcommand +``` + + + +## load-report + +Collect the load report of a specific broker +```shell +$ pulsar broker-tool load-report options +``` + +|Flag|Description|Default| +|---|---|---| +| `-i, --interval-ms` | Interval to collect load report, in milliseconds|100| + diff --git a/static/reference/4.0.x/pulsar/broker.md b/static/reference/4.0.x/pulsar/broker.md new file mode 100644 index 000000000000..86c987fe34a6 --- /dev/null +++ b/static/reference/4.0.x/pulsar/broker.md @@ -0,0 +1,19 @@ +# broker + + + +```shell +$ pulsar broker options +``` + +|Flag|Description|Default| +|---|---|---| +| `-c, --broker-conf` | Configuration file for Broker|conf/broker.conf| +| `-rb, --run-bookie` | Run Bookie together with Broker|false| +| `-ra, --run-bookie-autorecovery` | Run Bookie Autorecovery together with broker|false| +| `-bc, --bookie-conf` | Configuration file for Bookie|conf/bookkeeper.conf| +| `-rfw, --run-functions-worker` | Run functions worker with Broker|false| +| `-fwc, --functions-worker-conf` | Configuration file for Functions Worker|conf/functions_worker.yml| +| `-h, --help` | Show this help message|false| +| `-g, --generate-docs` | Generate docs|false| + diff --git a/static/reference/4.0.x/pulsar/compact-topic.md b/static/reference/4.0.x/pulsar/compact-topic.md new file mode 100644 index 000000000000..0549b9e40117 --- /dev/null +++ b/static/reference/4.0.x/pulsar/compact-topic.md @@ -0,0 +1,16 @@ +# compact-topic + + + +```shell +$ pulsar compact-topic options +``` + +|Flag|Description|Default| +|---|---|---| +| `-c, --broker-conf` | Configuration file for Broker|conf/broker.conf| +| `-t, --topic` | Topic to compact|tmp| +| `-h, --help` | Show this help message|false| +| `-g, --generate-docs` | Generate docs|true| +| `-ct, --compactor-type` | Choose compactor type, valid types are [PUBLISHING, EVENT_TIME]|PUBLISHING| + diff --git a/static/reference/4.0.x/pulsar/delete-cluster-metadata.md b/static/reference/4.0.x/pulsar/delete-cluster-metadata.md new file mode 100644 index 000000000000..0957b96c6c81 --- /dev/null +++ b/static/reference/4.0.x/pulsar/delete-cluster-metadata.md @@ -0,0 +1,18 @@ +# delete-cluster-metadata + + + +```shell +$ pulsar delete-cluster-metadata options +``` + +|Flag|Description|Default| +|---|---|---| +| `-zk, --zookeeper` | Local ZooKeeper quorum connection string|null| +| `--zookeeper-session-timeout-ms` | Local zookeeper session timeout ms|30000| +| `-c, -cluster, --cluster` | Cluster name|null| +| `-cs, --configuration-store` | Configuration Store connection string|null| +| `--bookkeeper-metadata-service-uri` | Metadata service uri of BookKeeper|null| +| `-h, --help` | Show this help message|false| +| `-g, --generate-docs` | Generate docs|false| + diff --git a/static/reference/4.0.x/pulsar/functions-worker.md b/static/reference/4.0.x/pulsar/functions-worker.md new file mode 100644 index 000000000000..bd72b43a1dc3 --- /dev/null +++ b/static/reference/4.0.x/pulsar/functions-worker.md @@ -0,0 +1,14 @@ +# functions-worker + + + +```shell +$ pulsar FunctionWorkerStarter options +``` + +|Flag|Description|Default| +|---|---|---| +| `-c, --conf` | Configuration File for Function Worker|null| +| `-h, --help` | Show this help message|false| +| `-g, --generate-docs` | Generate docs|false| + diff --git a/static/reference/4.0.x/pulsar/initialize-cluster-metadata.md b/static/reference/4.0.x/pulsar/initialize-cluster-metadata.md new file mode 100644 index 000000000000..4f099799d157 --- /dev/null +++ b/static/reference/4.0.x/pulsar/initialize-cluster-metadata.md @@ -0,0 +1,32 @@ +# initialize-cluster-metadata + + + +```shell +$ pulsar initialize-cluster-metadata options +``` + +|Flag|Description|Default| +|---|---|---| +| `-c, --cluster` | Cluster name|null| +| `-bn, --default-namespace-bundle-number` | The bundle numbers for the default namespaces(public/default), default is 16|0| +| `-uw, --web-service-url` | Web-service URL for new cluster|null| +| `-tw, --web-service-url-tls` | Web-service URL for new cluster with TLS encryption|null| +| `-ub, --broker-service-url` | Broker-service URL for new cluster|null| +| `-tb, --broker-service-url-tls` | Broker-service URL for new cluster with TLS encryption|null| +| `-te, --tls-enable` | Enable TLS connection for new cluster|null| +| `--auth-plugin` | The authentication plugin for new cluster|null| +| `--auth-parameters` | The authentication parameters for new cluster|null| +| `-md, --metadata-store` | Metadata Store service url. eg: zk:my-zk:2181|null| +| `--zookeeper-session-timeout-ms` | Local zookeeper session timeout ms|30000| +| `-cms, --configuration-metadata-store` | Configuration Metadata Store connection string|null| +| `-mscp, --metadata-store-config-path` | Metadata Store config path|null| +| `-cmscp, --configuration-metadata-store-config-path` | Configuration Metadata Store config path|null| +| `--initial-num-stream-storage-containers` | Num storage containers of BookKeeper stream storage|16| +| `--initial-num-transaction-coordinators` | Num transaction coordinators will assigned in cluster|16| +| `--existing-bk-metadata-service-uri` | The metadata service URI of the existing BookKeeper cluster that you want to use|null| +| `-pp, --proxy-protocol` | Proxy protocol to select type of routing at proxy. Possible Values: [SNI]|null| +| `-pu, --proxy-url` | Proxy-server URL to which to connect.|null| +| `-h, --help` | Show this help message|false| +| `-g, --generate-docs` | Generate docs|false| + diff --git a/static/reference/4.0.x/pulsar/initialize-namespace.md b/static/reference/4.0.x/pulsar/initialize-namespace.md new file mode 100644 index 000000000000..dfc6e9ee422f --- /dev/null +++ b/static/reference/4.0.x/pulsar/initialize-namespace.md @@ -0,0 +1,17 @@ +# initialize-namespace + + + +```shell +$ pulsar initialize-namespace options +``` + +|Flag|Description|Default| +|---|---|---| +| `-c, --cluster` | Cluster name|null| +| `-cs, --configuration-store` | Configuration Store connection string|null| +| `-cmscp, --configuration-metadata-store-config-path` | Configuration Metadata Store config path|null| +| `--zookeeper-session-timeout-ms` | Local zookeeper session timeout ms|30000| +| `-h, --help` | Show this help message|false| +| `-g, --generate-docs` | Generate docs|false| + diff --git a/static/reference/4.0.x/pulsar/initialize-transaction-coordinator-metadata.md b/static/reference/4.0.x/pulsar/initialize-transaction-coordinator-metadata.md new file mode 100644 index 000000000000..d2a77353216a --- /dev/null +++ b/static/reference/4.0.x/pulsar/initialize-transaction-coordinator-metadata.md @@ -0,0 +1,18 @@ +# initialize-transaction-coordinator-metadata + + + +```shell +$ pulsar initialize-transaction-coordinator-metadata options +``` + +|Flag|Description|Default| +|---|---|---| +| `-c, --cluster` | Cluster name|null| +| `-cs, --configuration-store` | Configuration Store connection string|null| +| `-cmscp, --configuration-metadata-store-config-path` | Configuration Metadata Store config path|null| +| `--zookeeper-session-timeout-ms` | Local zookeeper session timeout ms|30000| +| `--initial-num-transaction-coordinators` | Num transaction coordinators will assigned in cluster|16| +| `-h, --help` | Show this help message|false| +| `-g, --generate-docs` | Generate docs|false| + diff --git a/static/reference/4.0.x/pulsar/proxy.md b/static/reference/4.0.x/pulsar/proxy.md new file mode 100644 index 000000000000..7b30291e1134 --- /dev/null +++ b/static/reference/4.0.x/pulsar/proxy.md @@ -0,0 +1,19 @@ +# proxy + + + +```shell +$ pulsar proxy options +``` + +|Flag|Description|Default| +|---|---|---| +| `-c, --config` | Configuration file path|null| +| `-zk, --zookeeper-servers` | Local zookeeper connection string, please use --metadata-store instead|| +| `-md, --metadata-store` | Metadata Store service url. eg: zk:my-zk:2181|| +| `-gzk, --global-zookeeper-servers` | Global zookeeper connection string, please use --configuration-metadata-store instead|| +| `-cs, --configuration-store-servers` | Configuration store connection string, please use --configuration-metadata-store instead|| +| `-cms, --configuration-metadata-store` | The metadata store URL for the configuration data|| +| `-h, --help` | Show this help message|false| +| `-g, --generate-docs` | Generate docs|false| + diff --git a/static/reference/4.0.x/pulsar/standalone.md b/static/reference/4.0.x/pulsar/standalone.md new file mode 100644 index 000000000000..ed6cea9d6c43 --- /dev/null +++ b/static/reference/4.0.x/pulsar/standalone.md @@ -0,0 +1,27 @@ +# standalone + + + +```shell +$ pulsar standalone options +``` + +|Flag|Description|Default| +|---|---|---| +| `-c, --config` | Configuration file path|conf/standalone.conf| +| `--wipe-data` | Clean up previous ZK/BK data|false| +| `--num-bookies` | Number of local Bookies|1| +| `--metadata-dir` | Directory for storing metadata|data/metadata| +| `--metadata-url` | Metadata store url|| +| `--bookkeeper-port` | Local bookies base port|3181| +| `--bookkeeper-dir` | Local bookies base data directory|data/standalone/bookkeeper| +| `--no-broker` | Only start ZK and BK services, no broker|false| +| `--only-broker` | Only start Pulsar broker service (no ZK, BK)|false| +| `-nfw, --no-functions-worker` | Run functions worker with Broker|false| +| `-fwc, --functions-worker-conf` | Configuration file for Functions Worker|conf/functions_worker.yml| +| `-nss, --no-stream-storage` | Disable stream storage|false| +| `--stream-storage-port` | Local bookies stream storage port|4181| +| `-a, --advertised-address` | Standalone broker advertised address|null| +| `-h, --help` | Show this help message|false| +| `-g, --generate-docs` | Generate docs|true| + diff --git a/static/reference/4.0.x/pulsar/tokens.md b/static/reference/4.0.x/pulsar/tokens.md new file mode 100644 index 000000000000..c551fabbb793 --- /dev/null +++ b/static/reference/4.0.x/pulsar/tokens.md @@ -0,0 +1,83 @@ +# tokens + + + +```shell +$ pulsar tokens subcommand +``` + + + +## create-secret-key + +Create a new secret key +```shell +$ pulsar tokens create-secret-key options +``` + +|Flag|Description|Default| +|---|---|---| +| `-a, --signature-algorithm` | The signature algorithm for the new secret key.|HS256| +| `-o, --output` | Write the secret key to a file instead of stdout|null| +| `-b, --base64` | Encode the key in base64|false| + + +## create-key-pair + +Create a new or pair of keys public/private +```shell +$ pulsar tokens create-key-pair options +``` + +|Flag|Description|Default| +|---|---|---| +| `-a, --signature-algorithm` | The signature algorithm for the new key pair.|RS256| +| `--output-private-key` | File where to write the private key|null| +| `--output-public-key` | File where to write the public key|null| + + +## create + +Create a new token +```shell +$ pulsar tokens create options +``` + +|Flag|Description|Default| +|---|---|---| +| `-a, --signature-algorithm` | The signature algorithm for the new key pair.|RS256| +| `-s, --subject` | Specify the 'subject' or 'principal' associate with this token|null| +| `-e, --expiry-time` | Relative expiry time for the token (eg: 1h, 3d, 10y). (m=minutes) Default: no expiration|null| +| `-sk, --secret-key` | Pass the secret key for signing the token. This can either be: data:, file:, etc..|null| +| `-pk, --private-key` | Pass the private key for signing the token. This can either be: data:, file:, etc..|null| +| `-hs, --headers` | Additional headers to token. Format: --headers key1=value1|null| + + +## show + +Show the content of token +```shell +$ pulsar tokens show options +``` + +|Flag|Description|Default| +|---|---|---| +| `-i, --stdin` | Read token from standard input|false| +| `-f, --token-file` | Read token from a file|null| + + +## validate + +Validate a token against a key +```shell +$ pulsar tokens validate options +``` + +|Flag|Description|Default| +|---|---|---| +| `-a, --signature-algorithm` | The signature algorithm for the key pair if using public key.|RS256| +| `-i, --stdin` | Read token from standard input|false| +| `-f, --token-file` | Read token from a file|null| +| `-sk, --secret-key` | Pass the secret key for validating the token. This can either be: data:, file:, etc..|null| +| `-pk, --public-key` | Pass the public key for validating the token. This can either be: data:, file:, etc..|null| + diff --git a/static/reference/4.0.x/pulsar/version.md b/static/reference/4.0.x/pulsar/version.md new file mode 100644 index 000000000000..110a5ca84f93 --- /dev/null +++ b/static/reference/4.0.x/pulsar/version.md @@ -0,0 +1,13 @@ +# version + + + +```shell +$ pulsar version options +``` + +|Flag|Description|Default| +|---|---|---| +| `-h, --help` | Show this help message|false| +| `-g, --generate-docs` | Generate docs|false| + diff --git a/static/reference/4.0.x/pulsar/websocket.md b/static/reference/4.0.x/pulsar/websocket.md new file mode 100644 index 000000000000..b2ab4447f158 --- /dev/null +++ b/static/reference/4.0.x/pulsar/websocket.md @@ -0,0 +1,13 @@ +# websocket + + + +```shell +$ pulsar websocket options +``` + +|Flag|Description|Default| +|---|---|---| +| `-h, --help` | Show this help message|false| +| `-g, --generate-docs` | Generate docs|false| + From 3a43b6d9cc46d15358fb26fc48044b81eae28f6b Mon Sep 17 00:00:00 2001 From: Lari Hotari Date: Mon, 14 Oct 2024 20:50:13 +0300 Subject: [PATCH 4/9] Update /docs redirect --- static/.htaccess | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/static/.htaccess b/static/.htaccess index 1f0ee674fcad..d862cf738285 100755 --- a/static/.htaccess +++ b/static/.htaccess @@ -16,7 +16,7 @@ RewriteCond expr "%{REQUEST_URI} !~ m|^/docs/\d+\.\d+\.\d+|" RewriteCond expr "%{REQUEST_URI} !~ m|^/docs/\d+\.\d+\.\d+/.*|" RewriteCond expr "%{REQUEST_URI} !~ m|^/docs/\d+\.\d+\.x|" RewriteCond expr "%{REQUEST_URI} !~ m|^/docs/\d+\.\d+\.x/.*|" -RewriteRule "^docs/(.*)$" "/docs/3.3.x/$1" [R=301,DPI,L] +RewriteRule "^docs/(.*)$" "/docs/4.0.x/$1" [R=301,DPI,L] RewriteRule "^docs/(.+/)?deploy-dcos/?$" "/docs/$1install-deploy-upgrade-landing" [R=301,DPI,L] RewriteRule "^docs/(.+/)?develop-binary-protocol/?$" "/docs/$1developing-binary-protocol" [R=301,DPI,L] From c4b9629e90401ffd1c31d78a869e45748acfe29a Mon Sep 17 00:00:00 2001 From: Lari Hotari Date: Mon, 14 Oct 2024 20:54:39 +0300 Subject: [PATCH 5/9] Update DocsVersionDropdownNavbarItem.js for 4.0.x LTS --- src/theme/DocsVersionDropdownNavbarItem.js | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/src/theme/DocsVersionDropdownNavbarItem.js b/src/theme/DocsVersionDropdownNavbarItem.js index 20ddfa89dab9..052d9f085111 100644 --- a/src/theme/DocsVersionDropdownNavbarItem.js +++ b/src/theme/DocsVersionDropdownNavbarItem.js @@ -17,16 +17,16 @@ const versions = [ label: "Next", path: "/docs/next" }, + { + label: '4.0.x LTS', + name: '4.0.x', + path: `/docs/4.0.x`, + }, { label: '3.3.x', name: '3.3.x', path: `/docs/3.3.x`, }, - { - label: '3.2.x', - name: '3.2.x', - path: `/docs/3.2.x`, - }, { label: '3.0.x LTS', name: '3.0.x', From c7f10e4c91d285cc376c16fe5be0167cbe68cf90 Mon Sep 17 00:00:00 2001 From: Lari Hotari Date: Mon, 14 Oct 2024 21:14:08 +0300 Subject: [PATCH 6/9] Register release --- data/release-java.js | 7 +++++++ data/release-pulsar.js | 9 +++++++++ releases.json | 1 + 3 files changed, 17 insertions(+) diff --git a/data/release-java.js b/data/release-java.js index e6da1b9a3130..39619c5a2692 100644 --- a/data/release-java.js +++ b/data/release-java.js @@ -1,4 +1,11 @@ module.exports = [ + { + "tagName": "v4.0.0", + "vtag": "4.0.x", + "releaseNotes": "/release-notes/versioned/client-java-4.0.0/", + "doc": "/docs/4.0.x/client-libraries-java", + "version": "v4.0.x" + }, { "tagName": "v3.3.2", "vtag": "3.3.x", diff --git a/data/release-pulsar.js b/data/release-pulsar.js index f41098ab582c..b76cf7130cef 100644 --- a/data/release-pulsar.js +++ b/data/release-pulsar.js @@ -1,4 +1,13 @@ module.exports = [ + { + "author": "lhotari", + "tagName": "v4.0.0", + "publishedAt": "2024-10-14T17:03:07+03:00", + "vtag": "4.0.x", + "releaseNotes": "/release-notes/versioned/pulsar-4.0.0/", + "doc": "/docs/4.0.x", + "version": "v4.0.x" + }, { "author": "lhotari", "tagName": "v3.3.2", diff --git a/releases.json b/releases.json index 981ac26d8ca3..9e54a2549171 100644 --- a/releases.json +++ b/releases.json @@ -1,4 +1,5 @@ [ + "4.0.0", "3.3.2", "3.3.1", "3.3.0", From cd5c929e9da740fd8bbfcfd94c89a43c54dd42ed Mon Sep 17 00:00:00 2001 From: Lari Hotari Date: Mon, 14 Oct 2024 21:29:52 +0300 Subject: [PATCH 7/9] Add release notes --- release-notes/versioned/client-java-4.0.0.md | 37 ++ release-notes/versioned/pulsar-4.0.0.md | 464 +++++++++++++++++++ 2 files changed, 501 insertions(+) create mode 100644 release-notes/versioned/client-java-4.0.0.md create mode 100644 release-notes/versioned/pulsar-4.0.0.md diff --git a/release-notes/versioned/client-java-4.0.0.md b/release-notes/versioned/client-java-4.0.0.md new file mode 100644 index 000000000000..0bb128cb08f4 --- /dev/null +++ b/release-notes/versioned/client-java-4.0.0.md @@ -0,0 +1,37 @@ +--- +id: client-java-4.0.0 +title: Client Java 4.0.0 +sidebar_label: Client Java 4.0.0 +--- + +- [cleanup][client] Remove unneeded sync scope in TransactionImpl ([#22932](https://github.com/apache/pulsar/pull/22932)) +- [fix] DLQ to handle bytes key properly ([#23172](https://github.com/apache/pulsar/pull/23172)) +- [fix][client] Add more info while throwing reader creation exception ([#23401](https://github.com/apache/pulsar/pull/23401)) +- [fix][client] Copy orderingKey to retry letter topic and DLQ messages and fix bug in copying ([#23182](https://github.com/apache/pulsar/pull/23182)) +- [fix][client] Create the retry producer async ([#23157](https://github.com/apache/pulsar/pull/23157)) +- [fix][client] Fix ReaderBuilder doest not give illegalArgument on connection failure retry ([#22639](https://github.com/apache/pulsar/pull/22639)) +- [fix][client] Fix broker/Client CPU reaching 100% during retriable connection failure ([#23251](https://github.com/apache/pulsar/pull/23251)) +- [fix][client] Fix client handle unknown exception during message-decryption and apply decryption action accordingly ([#23256](https://github.com/apache/pulsar/pull/23256)) +- [fix][client] Fix client to handle permits for discarded and failed decrypt batch-message ([#23068](https://github.com/apache/pulsar/pull/23068)) +- [fix][client] Fix concurrent lookup with properties might have different results ([#23260](https://github.com/apache/pulsar/pull/23260)) +- [fix][client] Fix failover consumer-listener stuck with cumulative ack and epoch time ([#23345](https://github.com/apache/pulsar/pull/23345)) +- [fix][client] Fix for early hit `beforeConsume` for MultiTopicConsumer ([#23141](https://github.com/apache/pulsar/pull/23141)) +- [fix][client] Fix negative acknowledgement by messageId ([#23060](https://github.com/apache/pulsar/pull/23060)) +- [fix][client] Fix orphan consumer when reconnection and closing are concurrency executing ([#22958](https://github.com/apache/pulsar/pull/22958)) +- [fix][client] Fix pattern consumer create crash if a part of partitions of a topic have been deleted ([#22854](https://github.com/apache/pulsar/pull/22854)) +- [fix][client] Fix resource leak in Pulsar Client since HttpLookupService doesn't get closed ([#22858](https://github.com/apache/pulsar/pull/22858)) +- [fix][client] Fix the javadoc for ConsumerBuilder.isAckReceiptEnabled ([#23452](https://github.com/apache/pulsar/pull/23452)) +- [fix][client] Fix timeout handling in Pulsar Admin client ([#23128](https://github.com/apache/pulsar/pull/23128)) +- [fix][client] PIP-344 Do not create partitioned metadata when calling pulsarClient.getPartitionsForTopic(topicName) ([#22206](https://github.com/apache/pulsar/pull/22206)) +- [fix][client] TransactionCoordinatorClient support retry ([#23081](https://github.com/apache/pulsar/pull/23081)) +- [fix][client] the nullValue in msgMetadata should be true by default ([#22372](https://github.com/apache/pulsar/pull/22372)) +- [improve][client] Add exception handle for client send error ([#23038](https://github.com/apache/pulsar/pull/23038)) +- [improve][client] Add log when can't add message to the container ([#21924](https://github.com/apache/pulsar/pull/21924)) +- [improve][client] Add maxConnectionsPerHost and connectionMaxIdleSeconds to PulsarAdminBuilder ([#22541](https://github.com/apache/pulsar/pull/22541)) +- [improve][client] Deprecate `MessageIdUtils.getOffset` and `MessageIdUtils.getMessageId` ([#22747](https://github.com/apache/pulsar/pull/22747)) +- [improve][client] Don't print info logs for each schema loaded by client ([#23206](https://github.com/apache/pulsar/pull/23206)) +- [improve][client] Increase default Java client connectionMaxIdleSeconds to 60 seconds ([#23430](https://github.com/apache/pulsar/pull/23430)) +- [improve][client] PIP-344 support feature flag supportsGetPartitionedMetadataWithoutAutoCreation ([#22773](https://github.com/apache/pulsar/pull/22773)) +- [improve][client] improve the class GetTopicsResult ([#22766](https://github.com/apache/pulsar/pull/22766)) +- [improve][client] Add new ServiceUrlProvider implementation: SameAuthParamsAutoClusterFailover ([#23129](https://github.com/apache/pulsar/pull/23129)) +- [improve][client] PIP-359:Support custom message listener executor for specific subscription ([#22861](https://github.com/apache/pulsar/pull/22861)) \ No newline at end of file diff --git a/release-notes/versioned/pulsar-4.0.0.md b/release-notes/versioned/pulsar-4.0.0.md new file mode 100644 index 000000000000..d1739dae51d7 --- /dev/null +++ b/release-notes/versioned/pulsar-4.0.0.md @@ -0,0 +1,464 @@ +--- +id: pulsar-4.0.0 +title: Apache Pulsar 4.0.0 +sidebar_label: Apache Pulsar 4.0.0 +--- + +#### 2024-10-14 + +Changes in 4.0.0 release since 3.3.0 release preparation was started. +For the complete list, check the [full changelog](https://github.com/apache/pulsar/compare/188355b...v4.0.0) and [full PR list](https://github.com/apache/pulsar/pulls?q=is%3Apr+is%3Amerged+milestone%3A4.0.0+sort%3Acreated-asc). + +### PIPs + +- [improve][pip] Improve PIP process and voting timeline ([#23387](https://github.com/apache/pulsar/pull/23387)) +- [improve][pip] PIP-327: Support force topic loading for unrecoverable errors ([#21752](https://github.com/apache/pulsar/pull/21752)) +- [improve][pip] PIP-337: SSL Factory Plugin to customize SSL Context and SSL Engine generation ([#22016](https://github.com/apache/pulsar/pull/22016)) +- [improve][pip] PIP-347: add role field in consumer's stat ([#22564](https://github.com/apache/pulsar/pull/22564)) +- [improve][pip] PIP-348: Trigger offload on topic load stage ([#22650](https://github.com/apache/pulsar/pull/22650)) +- [improve][pip] PIP-349: Add additionalSystemCursorNames ignore list for TTL check ([#22651](https://github.com/apache/pulsar/pull/22651)) +- [improve][pip] PIP-350: Allow to disable the managedLedgerOffloadDeletionLagInMillis ([#22688](https://github.com/apache/pulsar/pull/22688)) +- [improve][pip] PIP-351: Additional options for Pulsar-Test client to support KeyStore based TLS ([#22694](https://github.com/apache/pulsar/pull/22694)) +- [improve][pip] PIP-352: Event time based topic compactor ([#22710](https://github.com/apache/pulsar/pull/22710)) +- [improve][PIP] PIP-353: Improve transaction message visibility for peek-messages ([#22746](https://github.com/apache/pulsar/pull/22746)) +- [improve][pip] PIP-354: apply topK mechanism to ModularLoadManagerImpl ([#22765](https://github.com/apache/pulsar/pull/22765)) +- [improve][pip] PIP-355: Enhancing Broker-Level Metrics for Pulsar ([#22778](https://github.com/apache/pulsar/pull/22778)) +- [improve][pip] PIP-356: Support Geo-Replication starts at earliest position ([#22806](https://github.com/apache/pulsar/pull/22806)) +- [improve][pip] PIP-357: Correct the conf name in load balance module. ([#22823](https://github.com/apache/pulsar/pull/22823)) +- [improve][pip] PIP-358: let resource weight work for OverloadShedder, LeastLongTermMessageRate, ModularLoadManagerImpl. ([#22889](https://github.com/apache/pulsar/pull/22889)) +- [improve][pip] PIP-359: Support custom message listener executor for specific subscription ([#22902](https://github.com/apache/pulsar/pull/22902)) +- [improve][pip] PIP-360 Add admin API to display Schema metadata ([#22913](https://github.com/apache/pulsar/pull/22913)) +- [improve][pip] PIP-363: Add callback parameters to the method: org.apache.pulsar.client.impl.SendCallback.sendComplete. ([#22940](https://github.com/apache/pulsar/pull/22940)) +- [improve][pip] PIP-364: Introduce a new load balance algorithm AvgShedder ([#22946](https://github.com/apache/pulsar/pull/22946)) +- [improve][pip] PIP-366: Support to specify different config for Configuration and Local Metadata Store ([#23033](https://github.com/apache/pulsar/pull/23033)) +- [improve][pip] PIP-367: Propose a Contributor Repository for Pulsar ([#23061](https://github.com/apache/pulsar/pull/23061)) +- [improve][pip] PIP-368: Support lookup based on the lookup properties ([#23075](https://github.com/apache/pulsar/pull/23075)) +- [improve][pip] PIP-369: Flag based selective unload on changing ns-isolation-policy ([#23116](https://github.com/apache/pulsar/pull/23116)) +- [improve][pip] PIP-370: configurable remote topic creation in geo-replication ([#23124](https://github.com/apache/pulsar/pull/23124)) +- [improve][pip] PIP-374: Visibility of messages in receiverQueue for the consumers ([#23235](https://github.com/apache/pulsar/pull/23235)) +- [improve][pip] PIP-376: Make topic policies service pluggable ([#23248](https://github.com/apache/pulsar/pull/23248)) +- [improve][pip] PIP-378 Add ServiceUnitStateTableView abstraction (ExtensibleLoadMangerImpl only) ([#23300](https://github.com/apache/pulsar/pull/23300)) +- [improve][pip] PIP-379: Key_Shared Draining Hashes for Improved Message Ordering ([#23309](https://github.com/apache/pulsar/pull/23309)) +- [improve][pip] PIP-381: Handle large PositionInfo state ([#23328](https://github.com/apache/pulsar/pull/23328)) +- [improve][PIP] PIP-383: Support granting/revoking permissions for multiple topics ([#23355](https://github.com/apache/pulsar/pull/23355)) + +### Library updates and dependency changes + +- [cleanup][misc] Remove classifier from netty-transport-native-unix-common dependency ([#22951](https://github.com/apache/pulsar/pull/22951)) +- [fix] Upgrade Alpine packages at build time to fix CVE-2023-4236 ([#22763](https://github.com/apache/pulsar/pull/22763)) +- [improve] Upgrade to Oxia client 0.3.0 ([#22807](https://github.com/apache/pulsar/pull/22807)) +- [fix] Upgrade to Oxia 0.3.1 ([#23048](https://github.com/apache/pulsar/pull/23048)) +- [fix][metadata] Upgrade Oxia to 0.3.2 ([#23140](https://github.com/apache/pulsar/pull/23140)) +- [feat][meta] Bump oxia java version from 0.3.2 to 0.4.5 ([#23277](https://github.com/apache/pulsar/pull/23277)) +- [fix] Bump commons-io:commons-io from 2.8.0 to 2.14.0 ([#23393](https://github.com/apache/pulsar/pull/23393)) +- [fix] Bump google.golang.org/protobuf from 1.32.0 to 1.33.0 in /pulsar-function-go ([#22261](https://github.com/apache/pulsar/pull/22261)) +- [fix] Bump io.airlift:aircompressor from 0.20 to 0.27 ([#22819](https://github.com/apache/pulsar/pull/22819)) +- [fix] Bump io.grpc from 1.56.0 to 1.56.1 ([#23276](https://github.com/apache/pulsar/pull/23276)) +- [fix][sec] Drop hdfs2 support, Upgrade hadoop3 to 3.4.0 and dnsjava to 3.6.2 to address CVE-2024-25638 ([#23411](https://github.com/apache/pulsar/pull/23411)) +- [fix][sec] Upgrade Avro to 1.11.4 to address CVE-2024-47561 ([#23394](https://github.com/apache/pulsar/pull/23394)) +- [fix][sec] Upgrade Bouncycastle libraries to address CVEs ([#22826](https://github.com/apache/pulsar/pull/22826)) +- [fix][sec] Upgrade postgresql version to avoid CVE-2024-1597 ([#22635](https://github.com/apache/pulsar/pull/22635)) +- [fix][sec] Upgrade protobuf-java to 3.25.5 ([#23356](https://github.com/apache/pulsar/pull/23356)) +- [fix][sec] Upgrade vertx to 4.5.10 to address CVE-2024-8391 ([#23338](https://github.com/apache/pulsar/pull/23338)) +- [fix][sec] Upgrade jackson to 2.17.2 ([#23174](https://github.com/apache/pulsar/pull/23174)) +- [improve] Upgrade IPAddress to 5.5.0 ([#22886](https://github.com/apache/pulsar/pull/22886)) +- [improve] Upgrade Jetcd to 0.7.7 and VertX to 4.5.8 ([#22835](https://github.com/apache/pulsar/pull/22835)) +- [improve] Upgrade Pulsar Python client in docker image to 3.5.0 ([#23377](https://github.com/apache/pulsar/pull/23377)) +- [improve] Upgrade opensearch sink to client 2.16 and tests to use server 2.16.0 ([#23312](https://github.com/apache/pulsar/pull/23312)) +- [improve] Use Google re2/j library for user provided regexes ([#22829](https://github.com/apache/pulsar/pull/22829)) +- [improve] Install openssl in the docker image to fix compatibility with Apache Pulsar Helm chart ([#23362](https://github.com/apache/pulsar/pull/23362)) +- [improve][misc] Set Alpine base image to 3.20 instead of 3.19.1 ([#22941](https://github.com/apache/pulsar/pull/22941)) +- [improve][misc] Upgrade Bookkeeper to 4.17.1 ([#22962](https://github.com/apache/pulsar/pull/22962)) +- [improve][misc] Upgrade Jetty to 9.4.56.v20240826 ([#23405](https://github.com/apache/pulsar/pull/23405)) +- [improve][misc] Upgrade Netty to 4.1.113 and netty-tcnative to 2.0.66 ([#23255](https://github.com/apache/pulsar/pull/23255)) +- [improve][misc] Upgrade OTel library to 1.38.0 version ([#22825](https://github.com/apache/pulsar/pull/22825)) +- [improve][misc] Upgrade to Netty 4.1.111.Final and switch to use grpc-netty-shaded ([#22892](https://github.com/apache/pulsar/pull/22892)) +- [improve][misc] Bump RoaringBitmap version to 1.0.6 ([#22920](https://github.com/apache/pulsar/pull/22920)) + +### Broker + +- [feat] PIP-352: Event time based compaction ([#22517](https://github.com/apache/pulsar/pull/22517)) +- [feat][broker] PIP-264: Add OpenTelemetry broker connection metrics ([#22931](https://github.com/apache/pulsar/pull/22931)) +- [feat][broker] PIP-264: Add OpenTelemetry broker replicator metrics ([#22972](https://github.com/apache/pulsar/pull/22972)) +- [feat][broker] PIP-264: Add OpenTelemetry consumer metrics ([#22693](https://github.com/apache/pulsar/pull/22693)) +- [feat][broker] PIP-264: Add OpenTelemetry managed cursor metrics ([#23000](https://github.com/apache/pulsar/pull/23000)) +- [feat][broker] PIP-264: Add OpenTelemetry managed ledger metrics ([#22987](https://github.com/apache/pulsar/pull/22987)) +- [feat][broker] PIP-264: Add OpenTelemetry metadata store stats ([#22952](https://github.com/apache/pulsar/pull/22952)) +- [feat][broker] PIP-264: Add OpenTelemetry producer metrics ([#22882](https://github.com/apache/pulsar/pull/22882)) +- [feat][broker] PIP-264: Add broker web executor metrics ([#22816](https://github.com/apache/pulsar/pull/22816)) +- [feat][broker] PIP-264: Add managed ledger cache metrics ([#22898](https://github.com/apache/pulsar/pull/22898)) +- [feat][broker] PIP-264: Add replication subscription stats ([#23026](https://github.com/apache/pulsar/pull/23026)) +- [feat][broker] PIP-264: Add schema registry metrics ([#22624](https://github.com/apache/pulsar/pull/22624)) +- [feat][broker] PIP-264: Add transaction metrics ([#22970](https://github.com/apache/pulsar/pull/22970)) +- [feat][broker] PIP-264: Enable OpenTelemetry reusable data memory mode ([#22914](https://github.com/apache/pulsar/pull/22914)) +- [feat][broker] PIP-321 Introduce allowed-cluster at the namespace level ([#22378](https://github.com/apache/pulsar/pull/22378)) +- [feat][broker] PIP-368: Support lookup based on the lookup properties ([#23223](https://github.com/apache/pulsar/pull/23223)) +- [feat][client] PIP-374: Visibility of messages in receiverQueue for the consumers ([#23303](https://github.com/apache/pulsar/pull/23303)) +- [feat][misc] PIP-264: Add OpenTelemetry HTTP rate limiting filter metric ([#23042](https://github.com/apache/pulsar/pull/23042)) +- [feat][misc] PIP-264: Add OpenTelemetry authentication and token metrics ([#23016](https://github.com/apache/pulsar/pull/23016)) +- [feat][misc] PIP-264: Add OpenTelemetry messaging rate limit metrics ([#23035](https://github.com/apache/pulsar/pull/23035)) +- [feat][misc] PIP-264: Copy OpenTelemetry resource attributes to Prometheus labels ([#23005](https://github.com/apache/pulsar/pull/23005)) +- [improve] PIP-384: ManagedLedger interface decoupling ([#23363](https://github.com/apache/pulsar/pull/23363)) +- [improve][broker] PIP-327: Support force topic loading for unrecoverable errors ([#21759](https://github.com/apache/pulsar/pull/21759)) +- [improve][broker] PIP-347: Add role field in consumer's stat ([#22562](https://github.com/apache/pulsar/pull/22562)) +- [improve][broker] PIP-355: Enhancing Broker-Level Metrics for Pulsar ([#22779](https://github.com/apache/pulsar/pull/22779)) +- [improve][broker] PIP-356 Support Geo-Replication starts at earliest position ([#22856](https://github.com/apache/pulsar/pull/22856)) +- [improve][broker] PIP-357: Correct the conf name in load balance module. ([#22824](https://github.com/apache/pulsar/pull/22824)) +- [improve][broker] PIP-358: let resource weight work for OverloadShedder, LeastLongTermMessageRate, ModularLoadManagerImpl. ([#22888](https://github.com/apache/pulsar/pull/22888)) +- [improve][broker] PIP-360 Add admin API to display Schema metadata ([#22938](https://github.com/apache/pulsar/pull/22938)) +- [improve][broker] PIP-364: Introduce a new load balance algorithm AvgShedder ([#22949](https://github.com/apache/pulsar/pull/22949)) +- [improve][broker] PIP-366: Support to specify different config for Configuration and Local Metadata Store ([#23041](https://github.com/apache/pulsar/pull/23041)) +- [improve][broker] PIP-376: Make topic policies service pluggable ([#23319](https://github.com/apache/pulsar/pull/23319)) +- [improve][broker] PIP-379: Enable the use of the classic implementation of Key_Shared / Shared with feature flag ([#23424](https://github.com/apache/pulsar/pull/23424)) +- [improve][broker] PIP-379: Key_Shared Draining Hashes for Improved Message Ordering ([#23352](https://github.com/apache/pulsar/pull/23352)) +- [improve][broker] PIP-379: Snapshot hash range assignments only in AUTO_SPLIT ordered mode ([#23423](https://github.com/apache/pulsar/pull/23423)) +- [improve][broker] PIP-383: Support granting/revoking permissions for multiple topics ([#23372](https://github.com/apache/pulsar/pull/23372)) +- [improve][broker] Phase 1 of PIP-370 support disable create topics on remote cluster through replication ([#23169](https://github.com/apache/pulsar/pull/23169)) +- [improve][broker] Part 2 of PIP-370: add metrics "pulsar_replication_disconnected_count" ([#23213](https://github.com/apache/pulsar/pull/23213)) +- [improve][broker] PIP-354: apply topK mechanism to ModularLoadManagerImpl ([#22753](https://github.com/apache/pulsar/pull/22753)) +- [Fix][broker] Limit replication rate based on bytes ([#22674](https://github.com/apache/pulsar/pull/22674)) +- [feat] Use producer name and sequence number as fallback key in Key_Shared implementation ([#23219](https://github.com/apache/pulsar/pull/23219)) +- [fix] Key_Shared mode consumption latency when low traffic ([#23340](https://github.com/apache/pulsar/pull/23340)) +- [fix] Make operations on `individualDeletedMessages` in lock scope ([#22966](https://github.com/apache/pulsar/pull/22966)) +- [fix] Remove blocking calls from BookieRackAffinityMapping ([#22846](https://github.com/apache/pulsar/pull/22846)) +- [fix] Removing out of the box option for Java serde in functions ([#22832](https://github.com/apache/pulsar/pull/22832)) +- [fix] StatsOutputStream: add string write function (#308) ([#23227](https://github.com/apache/pulsar/pull/23227)) +- [fix][admin] Fix half deletion when attempt to topic with a incorrect API ([#23002](https://github.com/apache/pulsar/pull/23002)) +- [fix][admin] Tenant AdminRoles can not contains whitespace in the beginning or end. ([#22450](https://github.com/apache/pulsar/pull/22450)) +- [fix][admin][part-1] Clearly define REST API on Open API ([#22774](https://github.com/apache/pulsar/pull/22774)) +- [fix][admin][part-2] Clearly define REST API on Open API for Namespaces@v2 ([#22775](https://github.com/apache/pulsar/pull/22775)) +- [fix][admin][part-3]Clearly define REST API on Open API for Topics ([#22782](https://github.com/apache/pulsar/pull/22782)) +- [fix][admin][part-4] Clearly define REST API on Open API ([#22783](https://github.com/apache/pulsar/pull/22783)) +- [fix][broker] Add principal name into info log to enhance analysis and troubleshooting ([#23257](https://github.com/apache/pulsar/pull/23257)) +- [fix][broker] Allow broker to handle non-recoverable schema error only if SchemaLedgerForceRecovery flag is enabled ([#23428](https://github.com/apache/pulsar/pull/23428)) +- [fix][broker] Asynchronously return brokerRegistry.lookupAsync when checking if broker is active(ExtensibleLoadManagerImpl only) ([#22899](https://github.com/apache/pulsar/pull/22899)) +- [fix][broker] Avoid introducing delay when there are delayed messages or marker messages ([#23343](https://github.com/apache/pulsar/pull/23343)) +- [fix][broker] Avoid orphan ledgers in BucketDelayedDeliveryTracker ([#22802](https://github.com/apache/pulsar/pull/22802)) +- [fix][broker] Can't connecte to non-persist topic when enable broker client tls ([#22991](https://github.com/apache/pulsar/pull/22991)) +- [fix][broker] Cancel possible pending replay read in cancelPendingRead ([#23384](https://github.com/apache/pulsar/pull/23384)) +- [fix][broker] Check the markDeletePosition and calculate the backlog ([#22947](https://github.com/apache/pulsar/pull/22947)) +- [fix][broker] Do not try to clean owned bundles from inactive source brokers (ExtensibleLoadManagerImpl only) ([#23064](https://github.com/apache/pulsar/pull/23064)) +- [fix][broker] Ensure that PulsarService is ready for serving incoming requests ([#22977](https://github.com/apache/pulsar/pull/22977)) +- [fix][broker] EntryFilters fix NoClassDefFoundError due to closed classloader ([#22767](https://github.com/apache/pulsar/pull/22767)) +- [fix][broker] Execute the pending callbacks in order before ready for incoming requests ([#23266](https://github.com/apache/pulsar/pull/23266)) +- [fix][broker] Fail fast if the extensible load manager failed to start ([#23297](https://github.com/apache/pulsar/pull/23297)) +- [fix][broker] Fix 'Disabled replicated subscriptions controller' logic and logging ([#23142](https://github.com/apache/pulsar/pull/23142)) +- [fix][broker] Fix AvgShedder strategy check ([#23156](https://github.com/apache/pulsar/pull/23156)) +- [fix][broker] Fix Broker was failing to create producer with broken schema ledger ([#23395](https://github.com/apache/pulsar/pull/23395)) +- [fix][broker] Fix Broker was failing to load stats-internal with broken schema ledger ([#22845](https://github.com/apache/pulsar/pull/22845)) +- [fix][broker] Fix MessageDeduplication replay timeout cause topic loading stuck ([#23004](https://github.com/apache/pulsar/pull/23004)) +- [fix][broker] Fix NPE after publishing a tombstone to the service unit channel ([#22859](https://github.com/apache/pulsar/pull/22859)) +- [fix][broker] Fix ProducerBusy issue due to incorrect userCreatedProducerCount on non-persistent topic ([#22685](https://github.com/apache/pulsar/pull/22685)) +- [fix][broker] Fix ack hole in cursor for geo-replication ([#20931](https://github.com/apache/pulsar/pull/20931)) +- [fix][broker] Fix authenticate order in AuthenticationProviderList ([#23111](https://github.com/apache/pulsar/pull/23111)) +- [fix][broker] Fix broker OOM when upload a large package. ([#22989](https://github.com/apache/pulsar/pull/22989)) +- [fix][broker] Fix brokers still retry start replication after closed the topic ([#23237](https://github.com/apache/pulsar/pull/23237)) +- [fix][broker] Fix compatibility issues for PIP-344 ([#23136](https://github.com/apache/pulsar/pull/23136)) +- [fix][broker] Fix configurationMetadataSyncEventTopic is marked supporting dynamic setting, but not implemented ([#22684](https://github.com/apache/pulsar/pull/22684)) +- [fix][broker] Fix cursor should use latest ledger config ([#22644](https://github.com/apache/pulsar/pull/22644)) +- [fix][broker] Fix delivery-test with unnecessary invocation-count ([#23399](https://github.com/apache/pulsar/pull/23399)) +- [fix][broker] Fix doc of ThresholdShedder and remove useless method. ([#22798](https://github.com/apache/pulsar/pull/22798)) +- [fix][broker] Fix geo-replication admin client url ([#22584](https://github.com/apache/pulsar/pull/22584)) +- [fix][broker] Fix incomplete NAR file extraction which prevents broker from starting ([#23274](https://github.com/apache/pulsar/pull/23274)) +- [fix][broker] Fix namespace unload might be blocked too long with extensible load manager ([#23433](https://github.com/apache/pulsar/pull/23433)) +- [fix][broker] Fix nothing changed after removing dynamic configs ([#22673](https://github.com/apache/pulsar/pull/22673)) +- [fix][broker] Fix out-of-order issues with ConsistentHashingStickyKeyConsumerSelector ([#23327](https://github.com/apache/pulsar/pull/23327)) +- [fix][broker] Fix retry backoff for PersistentDispatcherMultipleConsumers ([#23284](https://github.com/apache/pulsar/pull/23284)) +- [fix][broker] Fix shadow topics cannot be consumed when the entry is not cached ([#23147](https://github.com/apache/pulsar/pull/23147)) +- [fix][broker] Fix stuck when enable topic level replication and build remote admin fails ([#23028](https://github.com/apache/pulsar/pull/23028)) +- [fix][broker] Fix system topic can not be loaded up if it contains data offloaded ([#23279](https://github.com/apache/pulsar/pull/23279)) +- [fix][broker] Fix the broker registering might be blocked for long time ([#23371](https://github.com/apache/pulsar/pull/23371)) +- [fix][broker] Fix the broker registery cannot recover from the metadata node deletion ([#23359](https://github.com/apache/pulsar/pull/23359)) +- [fix][broker] Fix the bug that elected leader thinks it's a follower ([#23138](https://github.com/apache/pulsar/pull/23138)) +- [fix][broker] Fix thread unsafe access on the bundle range cache for load manager ([#23217](https://github.com/apache/pulsar/pull/23217)) +- [fix][broker] Fix topic policies cannot be queried with extensible load manager ([#23326](https://github.com/apache/pulsar/pull/23326)) +- [fix][broker] Fix topic status for oldestBacklogMessageAgeSeconds continuously increases even when there is no backlog. ([#22907](https://github.com/apache/pulsar/pull/22907)) +- [fix][broker] Fix typo in PersistentTopicsBase ([#22904](https://github.com/apache/pulsar/pull/22904)) +- [fix][broker] Fix typos in pulsar-broker and tiered-storage. ([#23415](https://github.com/apache/pulsar/pull/23415)) +- [fix][broker] Fix unloadNamespaceBundlesGracefully can be stuck with extensible load manager ([#23349](https://github.com/apache/pulsar/pull/23349)) +- [fix][broker] Fix updatePartitionedTopic when replication at ns level and topic policy is set ([#22971](https://github.com/apache/pulsar/pull/22971)) +- [fix][broker] Handle BucketDelayedDeliveryTracker recover failed ([#22735](https://github.com/apache/pulsar/pull/22735)) +- [fix][broker] Handle the case when `getOwnedServiceUnits` fails gracefully ([#23119](https://github.com/apache/pulsar/pull/23119)) +- [fix][broker] Immediately tombstone Deleted and Free state bundles ([#22743](https://github.com/apache/pulsar/pull/22743)) +- [fix][broker] Internal reader of __change_events can not started after metadata store session rebuilt ([#23018](https://github.com/apache/pulsar/pull/23018)) +- [fix][broker] Introduce the last sent position to fix message ordering issues in Key_Shared (PIP-282) ([#21953](https://github.com/apache/pulsar/pull/21953)) +- [fix][broker] Let Pending ack handler can retry to init when encounters a metadata store error ([#23153](https://github.com/apache/pulsar/pull/23153)) +- [fix][broker] Make ExtensibleLoadManagerImpl.getOwnedServiceUnits async ([#22727](https://github.com/apache/pulsar/pull/22727)) +- [fix][broker] Messages lost on the remote cluster when using topic level replication ([#22890](https://github.com/apache/pulsar/pull/22890)) +- [fix][broker] Partitioned shadow topic not work properly ([#22797](https://github.com/apache/pulsar/pull/22797)) +- [fix][broker] PulsarStandalone started with error if --stream-storage-port is not 4181 ([#22993](https://github.com/apache/pulsar/pull/22993)) +- [fix][broker] Remove blocking calls from Subscription.getStats ([#23088](https://github.com/apache/pulsar/pull/23088)) +- [fix][broker] Replication stuck when partitions count between two clusters is not the same ([#22983](https://github.com/apache/pulsar/pull/22983)) +- [fix][broker] Skip reading entries from closed cursor. ([#22751](https://github.com/apache/pulsar/pull/22751)) +- [fix][broker] Support advertised listeners when gracefully transferring topics (ExtensibleLoadManagerImpl only) ([#22862](https://github.com/apache/pulsar/pull/22862)) +- [fix][broker] Support large number of unack message store for cursor recovery ([#9292](https://github.com/apache/pulsar/pull/9292)) +- [fix][broker] The topic might reference a closed ledger ([#22860](https://github.com/apache/pulsar/pull/22860)) +- [fix][broker] Topic can never be loaded up due to broker maintains a failed topic creation future ([#23184](https://github.com/apache/pulsar/pull/23184)) +- [fix][broker] Update init and shutdown time and other minor logic (ExtensibleLoadManagerImpl only) ([#22930](https://github.com/apache/pulsar/pull/22930)) +- [fix][broker] broker log a full thread dump when a deadlock is detected in healthcheck every time ([#22916](https://github.com/apache/pulsar/pull/22916)) +- [fix][broker] disable loadBalancerDirectMemoryResourceWeight by default ([#22821](https://github.com/apache/pulsar/pull/22821)) +- [fix][broker] disable loadBalancerMemoryResourceWeight by default ([#22820](https://github.com/apache/pulsar/pull/22820)) +- [fix][broker] fix can not cleanup heartbeat data if scaling down broker ([#22750](https://github.com/apache/pulsar/pull/22750)) +- [fix][broker] fix compile error for PersistentStickyKeyDispatcherMultipleConsumers ([#23055](https://github.com/apache/pulsar/pull/23055)) +- [fix][broker] fix deadlock when disable topic level Geo-Replication ([#22738](https://github.com/apache/pulsar/pull/22738)) +- [fix][broker] fix exception may hidden and result in stuck when topic loading ([#23102](https://github.com/apache/pulsar/pull/23102)) +- [fix][broker] fix pulsar-admin topics stats-internal caused a BK client thread a deadlock ([#23258](https://github.com/apache/pulsar/pull/23258)) +- [fix][broker] fix replicated namespaces filter in filterAndUnloadMatchedNamespaceAsync ([#23100](https://github.com/apache/pulsar/pull/23100)) +- [fix][broker] fix replicated subscriptions for transactional messages ([#22452](https://github.com/apache/pulsar/pull/22452)) +- [fix][broker] fix the log format error in the AdminResource ([#23278](https://github.com/apache/pulsar/pull/23278)) +- [fix][broker] fix topic partitions was expanded even if disabled topic level replication ([#22769](https://github.com/apache/pulsar/pull/22769)) +- [fix][broker] fix typo and useless local variable. ([#22704](https://github.com/apache/pulsar/pull/22704)) +- [fix][broker] fix unload bundle count metric. ([#22895](https://github.com/apache/pulsar/pull/22895)) +- [fix][broker] maintain last active info in memory only. ([#22794](https://github.com/apache/pulsar/pull/22794)) +- [fix][broker] normalize path ([#23438](https://github.com/apache/pulsar/pull/23438)) +- [fix][broker] rename to changeMaxReadPositionCount ([#22656](https://github.com/apache/pulsar/pull/22656)) +- [fix][broker] replace loadSheddingPipeline with loadSheddingStrategy. ([#22786](https://github.com/apache/pulsar/pull/22786)) +- [fix][broker] response not-found error if topic does not exist when calling getPartitionedTopicMetadata ([#22838](https://github.com/apache/pulsar/pull/22838)) +- [fix][broker] support peek-message for compressed and encrypted messages ([#23234](https://github.com/apache/pulsar/pull/23234)) +- [fix][broker] timeout when broker registry hangs and monitor broker registry (ExtensibleLoadManagerImpl only) ([#23382](https://github.com/apache/pulsar/pull/23382)) +- [fix][broker] topics failed to delete after remove cluster from replicated clusters set and caused OOM ([#23360](https://github.com/apache/pulsar/pull/23360)) +- [fix][broker] type cast on exceptions in exceptionally can lead to lost calls ([#23117](https://github.com/apache/pulsar/pull/23117)) +- [fix][broker] usedLocallySinceLastReport should always be reset ([#22672](https://github.com/apache/pulsar/pull/22672)) +- [fix][broker] fix irregular method name ([#23108](https://github.com/apache/pulsar/pull/23108)) +- [fix][broker] A failed consumer/producer future in ServerCnx can never be removed ([#23123](https://github.com/apache/pulsar/pull/23123)) +- [fix][broker] Fix lookupService.getTopicsUnderNamespace can not work with a quote pattern ([#23014](https://github.com/apache/pulsar/pull/23014)) +- [fix][meta] Check if metadata store is closed in RocksdbMetadataStore ([#22852](https://github.com/apache/pulsar/pull/22852)) +- [fix][meta] Oxia metadta store: Convert error to MetadataStoreException if operation failed ([#23154](https://github.com/apache/pulsar/pull/23154)) +- [fix][ml] Add entry fail due to race condition about add entry failed/timeout and switch ledger ([#22221](https://github.com/apache/pulsar/pull/22221)) +- [fix][ml] Fix race conditions in RangeCache ([#22789](https://github.com/apache/pulsar/pull/22789)) +- [fix][ml] Managed ledger should recover after open ledger failed ([#23368](https://github.com/apache/pulsar/pull/23368)) +- [fix][ml] Remove duplicated field initialization of ML ([#22676](https://github.com/apache/pulsar/pull/22676)) +- [fix][ml] Remove unnecessary return in ManagedLedgerImpl ([#23418](https://github.com/apache/pulsar/pull/23418)) +- [fix][ml]Fix subscription props could be lost in case of missing ledger during recovery ([#22637](https://github.com/apache/pulsar/pull/22637)) +- [fix][ml][PIP-327] fix recover from ledger when ledgerForceRecovery is true ([#23426](https://github.com/apache/pulsar/pull/23426)) +- [fix][offload] Break the fillbuffer loop when met EOF ([#22722](https://github.com/apache/pulsar/pull/22722)) +- [fix][offload] Fix OOM in tiered storage, caused by unbounded offsets cache ([#22679](https://github.com/apache/pulsar/pull/22679)) +- [fix][schema] Error checking schema compatibility on a schema-less topic via REST API ([#22720](https://github.com/apache/pulsar/pull/22720)) +- [improve][admin] PIP-369 Change default value of `unload-scope` in `ns-isolation-policy set` ([#23253](https://github.com/apache/pulsar/pull/23253)) +- [improve][admin] PIP-369 Introduce `unload` flag in `ns-isolation-policy set` call ([#23120](https://github.com/apache/pulsar/pull/23120)) +- [improve][broker] Add ServiceUnitStateTableView (ExtensibleLoadManagerImpl only) ([#23301](https://github.com/apache/pulsar/pull/23301)) +- [improve][broker] Add additionalSystemCursorNames ignore list for TTL check ([#22614](https://github.com/apache/pulsar/pull/22614)) +- [improve][broker] Add callback parameters to the SendCallback.sendComplete ([#23196](https://github.com/apache/pulsar/pull/23196)) +- [improve][broker] Add limits for Key_Shared Subscription look ahead in dispatching ([#23231](https://github.com/apache/pulsar/pull/23231)) +- [improve][broker] Add log to track issue when `handleGetTopicsOfNamespace` ([#23434](https://github.com/apache/pulsar/pull/23434)) + +- [improve][broker] Add retry for start service unit state channel (ExtensibleLoadManagerImpl only) ([#23230](https://github.com/apache/pulsar/pull/23230)) +- [improve][broker] Add subscription prefix for internal reader ([#23044](https://github.com/apache/pulsar/pull/23044)) +- [improve][broker] Avoid subscription fenced error with consumer.seek whenever possible ([#23163](https://github.com/apache/pulsar/pull/23163)) +- [improve][broker] Check max producers/consumers limitation first before other ops to save resources ([#23074](https://github.com/apache/pulsar/pull/23074)) +- [improve][broker] Clear thread local BrokerEntryMetadata instance before reuse ([#22752](https://github.com/apache/pulsar/pull/22752)) +- [improve][broker] Close protocol handlers before unloading namespace bundles ([#22728](https://github.com/apache/pulsar/pull/22728)) +- [improve][broker] Decouple ManagedLedger interfaces from the current implementation ([#23311](https://github.com/apache/pulsar/pull/23311)) +- [improve][broker] Do not call cursor.isCursorDataFullyPersistable if disabled dispatcherPauseOnAckStatePersistentEnabled ([#22729](https://github.com/apache/pulsar/pull/22729)) +- [improve][broker] Don't use "recently joined consumers" rules for Key_Shared in STICKY mode ([#23275](https://github.com/apache/pulsar/pull/23275)) +- [improve][broker] Explicitly close LB internal topics when playing a follower (ExtensibleLoadManagerImpl only) ([#23144](https://github.com/apache/pulsar/pull/23144)) +- [improve][broker] Fail fast when it failed to create LoadSheddingStrategy instance ([#22827](https://github.com/apache/pulsar/pull/22827)) +- [improve][broker] GetPartitionMetadata fail also can produce messages ([#23050](https://github.com/apache/pulsar/pull/23050)) +- [improve][broker] Improve CPU resources usege of TopicName Cache ([#23052](https://github.com/apache/pulsar/pull/23052)) +- [improve][broker] Improve exception for topic does not have schema to check ([#22974](https://github.com/apache/pulsar/pull/22974)) +- [improve][broker] Improve pulsar_topic_load_failed metric to record correct failed time ([#23199](https://github.com/apache/pulsar/pull/23199)) +- [improve][broker] Make cluster metadata init command support metadata config path ([#23269](https://github.com/apache/pulsar/pull/23269)) +- [improve][broker] Optimize PersistentTopic.getLastDispatchablePosition ([#22707](https://github.com/apache/pulsar/pull/22707)) +- [improve][broker] Optimize high CPU usage when consuming from topics with ongoing txn ([#23189](https://github.com/apache/pulsar/pull/23189)) +- [improve][broker] Optimize message payload traffic for ShadowReplicator ([#23236](https://github.com/apache/pulsar/pull/23236)) +- [improve][broker] Optimize performance for checking max topics when the topic is a system topic ([#23185](https://github.com/apache/pulsar/pull/23185)) +- [improve][broker] Optimize the performance of individual acknowledgments ([#23072](https://github.com/apache/pulsar/pull/23072)) +- [improve][broker] Reduce number of OpenTelemetry consumer attributes ([#22837](https://github.com/apache/pulsar/pull/22837)) +- [improve][broker] Reduce the CPU pressure from the transaction buffer in rolling restarts ([#23062](https://github.com/apache/pulsar/pull/23062)) +- [improve][broker] Reducing the parse of MessageMetadata in compaction ([#23285](https://github.com/apache/pulsar/pull/23285)) +- [improve][broker] Register the broker to metadata store without version id compare ([#23298](https://github.com/apache/pulsar/pull/23298)) +- [improve][broker] Remove ClassLoaderSwitcher to avoid objects allocations and consistent the codestyle ([#22796](https://github.com/apache/pulsar/pull/22796)) +- [improve][broker] Remove ConcurrentOpenHashMap and ConcurrentOpenHashSet ([#23329](https://github.com/apache/pulsar/pull/23329)) +- [improve][broker] Remove unused method CompactionRecord.reset ([#22670](https://github.com/apache/pulsar/pull/22670)) +- [improve][broker] Replace ConcurrentOpenHashMap with ConcurrentHashMap in BrokerService ([#23320](https://github.com/apache/pulsar/pull/23320)) +- [improve][broker] Replace ConcurrentOpenHashMap with ConcurrentHashMap in Topic classes ([#23322](https://github.com/apache/pulsar/pull/23322)) +- [improve][broker] Reschedule reads with increasing backoff when no messages are dispatched ([#23226](https://github.com/apache/pulsar/pull/23226)) +- [improve][broker] Reuse topic OpenTelemetry attributes ([#22876](https://github.com/apache/pulsar/pull/22876)) +- [improve][broker] Should notify bundle ownership listener onLoad event when ServiceUnitState start (ExtensibleLoadManagerImpl only) ([#23152](https://github.com/apache/pulsar/pull/23152)) +- [improve][broker] Support customized shadow managed ledger implementation ([#23179](https://github.com/apache/pulsar/pull/23179)) +- [improve][broker] Support to specify auth-plugin, auth-parameters and tls-enable arguments when init cluster metadata ([#23087](https://github.com/apache/pulsar/pull/23087)) +- [improve][broker] Trigger offload on topic load ([#22652](https://github.com/apache/pulsar/pull/22652)) +- [improve][broker] Use RoaringBitmap in tracking individual acks to reduce memory usage ([#23006](https://github.com/apache/pulsar/pull/23006)) +- [improve][broker] avoid creating new objects when intercepting ([#22790](https://github.com/apache/pulsar/pull/22790)) +- [improve][broker] check system topic is used before configuring system topic (ExtensibleLoadManagerImpl only) ([#23381](https://github.com/apache/pulsar/pull/23381)) +- [improve][broker] don't do load shedding when metadata service not available ([#23040](https://github.com/apache/pulsar/pull/23040)) +- [improve][broker] high CPU usage caused by list topics under namespace ([#23049](https://github.com/apache/pulsar/pull/23049)) +- [improve][broker] log exception in MessageDeduplication#takeSnapshot ([#22994](https://github.com/apache/pulsar/pull/22994)) +- [improve][broker] make system topic distribute evenly. ([#22953](https://github.com/apache/pulsar/pull/22953)) +- [improve][broker] Change the log level to reduce repeated error logs ([#23192](https://github.com/apache/pulsar/pull/23192)) +- [improve][broker] Ensure namespace deletion doesn't fail ([#22627](https://github.com/apache/pulsar/pull/22627)) +- [improve][broker]Reuse method getAvailableBrokersAsync ([#23099](https://github.com/apache/pulsar/pull/23099)) +- [improve][broker][PIP-379] Add observability stats for "draining hashes" ([#23429](https://github.com/apache/pulsar/pull/23429)) +- [improve][broker][PIP-379] Don't replace a consumer when there's a collision ([#23441](https://github.com/apache/pulsar/pull/23441)) +- [improve][broker][PIP-379] Improve hash collision handling by restoring consumer when other leaves ([#23447](https://github.com/apache/pulsar/pull/23447)) +- [improve][misc] Replace dependencies on PositionImpl with Position interface ([#22891](https://github.com/apache/pulsar/pull/22891)) +- [improve][broker][PIP-384] Decouple Bookkeeper client from ManagedLedgerStorage and enable multiple ManagedLedgerFactory instances ([#23313](https://github.com/apache/pulsar/pull/23313)) +- [improve][broker][break change] Do not create partitioned DLQ/Retry topic automatically ([#22705](https://github.com/apache/pulsar/pull/22705)) +- [cleanup][broker] Remove PersistentSubscription.getStats ([#23095](https://github.com/apache/pulsar/pull/23095)) +- [cleanup][broker] Remove warn logs when changing the state from Owned to Free (Extensible LB) ([#22708](https://github.com/apache/pulsar/pull/22708)) +- [cleanup][broker] delete ConcurrentSortedLongPairSet. ([#23202](https://github.com/apache/pulsar/pull/23202)) +- [cleanup][broker] remove DeviationShedder. ([#22800](https://github.com/apache/pulsar/pull/22800)) +- [improve] Allow to construct Oxia metadata-store directly from a client instance ([#22756](https://github.com/apache/pulsar/pull/22756)) +- [improve] Refactored BK ClientFactory to return futures ([#22853](https://github.com/apache/pulsar/pull/22853)) +- [improve][meta] Fix invalid use of drain API and race condition in closing metadata store ([#22585](https://github.com/apache/pulsar/pull/22585)) +- [improve][ml] RangeCache refactoring follow-up: use StampedLock instead of synchronized ([#22818](https://github.com/apache/pulsar/pull/22818)) +- [improve][ml] RangeCache refactoring: test race conditions and prevent endless loops ([#22814](https://github.com/apache/pulsar/pull/22814)) +- [improve][offload] Allow to disable the managedLedgerOffloadDeletionLagInMillis ([#22689](https://github.com/apache/pulsar/pull/22689)) +- [improve][offload] Replace usage of shaded class in OffsetsCache ([#22683](https://github.com/apache/pulsar/pull/22683)) +- [improve][schema] Improve Incompatible Schema Exception error message in ServerCnx.java ([#23344](https://github.com/apache/pulsar/pull/23344)) +- [improve][txn] Take first snapshot before persisting the first transactional message ([#21406](https://github.com/apache/pulsar/pull/21406)) + +### Observability + +- [Enhancement] Added a metric for geo replication for tracking replicated subscriptions snapshot timeouts ([#22381](https://github.com/apache/pulsar/pull/22381)) +- [feat][broker] Add broker health check status into prometheus metrics ([#20147](https://github.com/apache/pulsar/pull/20147)) +- [improve][admin] Improve BrokerStats.allocatorStats ([#23242](https://github.com/apache/pulsar/pull/23242)) +- [improve][broker] Add msgInReplay subscription stat and metric to improve Key_Shared observability ([#23224](https://github.com/apache/pulsar/pull/23224)) +- [improve][log] Print source client addr when enabled haProxyProtocolEnabled ([#22686](https://github.com/apache/pulsar/pull/22686)) + +### Client + +- [cleanup][client] Remove unneeded sync scope in TransactionImpl ([#22932](https://github.com/apache/pulsar/pull/22932)) +- [fix] DLQ to handle bytes key properly ([#23172](https://github.com/apache/pulsar/pull/23172)) +- [fix][client] Add more info while throwing reader creation exception ([#23401](https://github.com/apache/pulsar/pull/23401)) +- [fix][client] Copy orderingKey to retry letter topic and DLQ messages and fix bug in copying ([#23182](https://github.com/apache/pulsar/pull/23182)) +- [fix][client] Create the retry producer async ([#23157](https://github.com/apache/pulsar/pull/23157)) +- [fix][client] Fix ReaderBuilder doest not give illegalArgument on connection failure retry ([#22639](https://github.com/apache/pulsar/pull/22639)) +- [fix][client] Fix broker/Client CPU reaching 100% during retriable connection failure ([#23251](https://github.com/apache/pulsar/pull/23251)) +- [fix][client] Fix client handle unknown exception during message-decryption and apply decryption action accordingly ([#23256](https://github.com/apache/pulsar/pull/23256)) +- [fix][client] Fix client to handle permits for discarded and failed decrypt batch-message ([#23068](https://github.com/apache/pulsar/pull/23068)) +- [fix][client] Fix concurrent lookup with properties might have different results ([#23260](https://github.com/apache/pulsar/pull/23260)) +- [fix][client] Fix failover consumer-listener stuck with cumulative ack and epoch time ([#23345](https://github.com/apache/pulsar/pull/23345)) +- [fix][client] Fix for early hit `beforeConsume` for MultiTopicConsumer ([#23141](https://github.com/apache/pulsar/pull/23141)) +- [fix][client] Fix negative acknowledgement by messageId ([#23060](https://github.com/apache/pulsar/pull/23060)) +- [fix][client] Fix orphan consumer when reconnection and closing are concurrency executing ([#22958](https://github.com/apache/pulsar/pull/22958)) +- [fix][client] Fix pattern consumer create crash if a part of partitions of a topic have been deleted ([#22854](https://github.com/apache/pulsar/pull/22854)) +- [fix][client] Fix resource leak in Pulsar Client since HttpLookupService doesn't get closed ([#22858](https://github.com/apache/pulsar/pull/22858)) +- [fix][client] Fix the javadoc for ConsumerBuilder.isAckReceiptEnabled ([#23452](https://github.com/apache/pulsar/pull/23452)) +- [fix][client] Fix timeout handling in Pulsar Admin client ([#23128](https://github.com/apache/pulsar/pull/23128)) +- [fix][client] PIP-344 Do not create partitioned metadata when calling pulsarClient.getPartitionsForTopic(topicName) ([#22206](https://github.com/apache/pulsar/pull/22206)) +- [fix][client] TransactionCoordinatorClient support retry ([#23081](https://github.com/apache/pulsar/pull/23081)) +- [fix][client] the nullValue in msgMetadata should be true by default ([#22372](https://github.com/apache/pulsar/pull/22372)) +- [improve][client] Add exception handle for client send error ([#23038](https://github.com/apache/pulsar/pull/23038)) +- [improve][client] Add log when can't add message to the container ([#21924](https://github.com/apache/pulsar/pull/21924)) +- [improve][client] Add maxConnectionsPerHost and connectionMaxIdleSeconds to PulsarAdminBuilder ([#22541](https://github.com/apache/pulsar/pull/22541)) +- [improve][client] Deprecate `MessageIdUtils.getOffset` and `MessageIdUtils.getMessageId` ([#22747](https://github.com/apache/pulsar/pull/22747)) +- [improve][client] Don't print info logs for each schema loaded by client ([#23206](https://github.com/apache/pulsar/pull/23206)) +- [improve][client] Increase default Java client connectionMaxIdleSeconds to 60 seconds ([#23430](https://github.com/apache/pulsar/pull/23430)) +- [improve][client] PIP-344 support feature flag supportsGetPartitionedMetadataWithoutAutoCreation ([#22773](https://github.com/apache/pulsar/pull/22773)) +- [improve][client] improve the class GetTopicsResult ([#22766](https://github.com/apache/pulsar/pull/22766)) +- [improve][client] Add new ServiceUrlProvider implementation: SameAuthParamsAutoClusterFailover ([#23129](https://github.com/apache/pulsar/pull/23129)) +- [improve][client] PIP-359:Support custom message listener executor for specific subscription ([#22861](https://github.com/apache/pulsar/pull/22861)) + +### Pulsar IO and Pulsar Functions + +- [fix][fn] Enable optimized Netty direct byte buffer support for Pulsar Function runtimes ([#22910](https://github.com/apache/pulsar/pull/22910)) +- [fix][fn] Support compression type and crypto config for all producers in Functions and Connectors ([#22950](https://github.com/apache/pulsar/pull/22950)) +- [fix][io] Upgrade mssql server docker tag in DebeziumMsSqlContainer ([#23318](https://github.com/apache/pulsar/pull/23318)) +- [improve] Validate user paths in Functions utils ([#22833](https://github.com/apache/pulsar/pull/22833)) +- [improve][fn] Add support for overriding additionalJavaRuntimeArguments with PF_additionalJavaRuntimeArguments env ([#23130](https://github.com/apache/pulsar/pull/23130)) +- [improve][fn] Make producer cache bounded and expiring in Functions/Connectors ([#22945](https://github.com/apache/pulsar/pull/22945)) +- [improve][io] The JDBC connector supports JSON substructure schema ([#23043](https://github.com/apache/pulsar/pull/23043)) + +### Others + +- [improve] PIP-337: Implement SSL Factory Plugin to customize SSL Context and SSL Engine generation ([#23110](https://github.com/apache/pulsar/pull/23110)) +- [improve][misc] Improve AES-GCM cipher performance ([#23122](https://github.com/apache/pulsar/pull/23122)) +- [improve][misc] Optimize TLS performance by omitting extra buffer copies ([#23115](https://github.com/apache/pulsar/pull/23115)) +- [improve][misc] Set format_version=5, checksum=kxxHash in Bookkeeper RocksDB configs ([#23175](https://github.com/apache/pulsar/pull/23175)) +- [improve][proxy] Add debug logs for proxy cnx management ([#23037](https://github.com/apache/pulsar/pull/23037)) +- [improve][proxy] Reuse authentication instance in pulsar-proxy ([#23113](https://github.com/apache/pulsar/pull/23113)) +- [feat] Add scripts for updating BK RocksDB ini files ([#23178](https://github.com/apache/pulsar/pull/23178)) +- [feat][ws] Add support for initialSubscriptionPosition in Websocket Consumer ([#23013](https://github.com/apache/pulsar/pull/23013)) +- [fix] Reapply shell script parameter passthrough fix #22867 reverted in #22921 ([#22923](https://github.com/apache/pulsar/pull/22923)) +- [fix][cli] Fix Pulsar standalone "--wipe-data" ([#22885](https://github.com/apache/pulsar/pull/22885)) +- [fix][cli] Fix Pulsar standalone shutdown - bkCluster wasn't closed ([#22868](https://github.com/apache/pulsar/pull/22868)) +- [fix][cli] Fix Pulsar-Client CLI to print metadata of message including encryption metadata ([#23347](https://github.com/apache/pulsar/pull/23347)) +- [fix][cli] Fix Pulsar-Client to allow consume encrypted messages with appropriate crypto-failure-action ([#23346](https://github.com/apache/pulsar/pull/23346)) +- [fix][cli] Fix expiration of tokens created with "pulsar tokens create" ([#22815](https://github.com/apache/pulsar/pull/22815)) +- [fix][cli] Fix healthcheck script pulsar-zookeeper-ruok.sh ([#22873](https://github.com/apache/pulsar/pull/22873)) +- [fix][cli] Fix the pulsar-daemon parameter passthrough syntax ([#22905](https://github.com/apache/pulsar/pull/22905)) +- [fix][cli] Refactor scripts to detect major Java version and pass correct add-opens parameters ([#22927](https://github.com/apache/pulsar/pull/22927)) +- [fix][cli] Remove defaultValue of tenant/namespace for CmdFunctions ([#22764](https://github.com/apache/pulsar/pull/22764)) +- [fix][cli] Remove deprecated "-client" JVM arg ([#23370](https://github.com/apache/pulsar/pull/23370)) +- [improve][cli] Add compactor type option for compaction tool ([#23446](https://github.com/apache/pulsar/pull/23446)) +- [improve][cli] PIP-353: Improve transaction message visibility for peek-message ([#22762](https://github.com/apache/pulsar/pull/22762)) +- [improve][cli] Supports creating tokens with additional headers ([#22690](https://github.com/apache/pulsar/pull/22690)) +- [improve][cli] Use LoadManagerReport instead of Object ([#22850](https://github.com/apache/pulsar/pull/22850)) +- [fix][conf] fix configuration name and typo. ([#22822](https://github.com/apache/pulsar/pull/22822)) +- [fix][conf] fix typo for TransferShedder. ([#22757](https://github.com/apache/pulsar/pull/22757)) +- [fix][doc] Fix some typos in pip ([#23288](https://github.com/apache/pulsar/pull/23288)) +- [fix][doc] Fix the doc for the message redelivery backoff ([#22855](https://github.com/apache/pulsar/pull/22855)) +- [fix][doc] fix the class name of transaction exception. ([#22687](https://github.com/apache/pulsar/pull/22687)) +- [fix][log] Do not print error log if tenant/namespace does not exist when calling get topic metadata ([#23291](https://github.com/apache/pulsar/pull/23291)) +- [fix][log] Do not print warn log when concurrently publishing and switching ledgers ([#23209](https://github.com/apache/pulsar/pull/23209)) +- [fix][misc] Add proper nslookup (included in bind-tools) to docker image ([#22878](https://github.com/apache/pulsar/pull/22878)) +- [fix][misc] Correct the comment of tlsAllowInsecureConnection in ClusterDataImpl class. ([#22919](https://github.com/apache/pulsar/pull/22919)) +- [fix][misc] Correct the description of patternAutoDiscoveryPeriod ([#22615](https://github.com/apache/pulsar/pull/22615)) +- [fix][misc] Disable JFR based telemetry collection since it's not used ([#22869](https://github.com/apache/pulsar/pull/22869)) +- [fix][misc] Log Conscrypt security provider initialization warnings at debug level ([#23364](https://github.com/apache/pulsar/pull/23364)) +- [fix][misc] Remove RoaringBitmap dependency from pulsar-common ([#23008](https://github.com/apache/pulsar/pull/23008)) +- [fix][misc] Rename netty native libraries in pulsar-client-admin-shaded ([#22954](https://github.com/apache/pulsar/pull/22954)) +- [fix][misc] Topic name from persistence name should decode local name ([#22879](https://github.com/apache/pulsar/pull/22879)) +- [improve][doc] Add Pulsar Geo-Replication considerations to the PIP template ([#23145](https://github.com/apache/pulsar/pull/23145)) +- [improve] Configure Rocksdb to use musl libc flavor of the native library ([#23375](https://github.com/apache/pulsar/pull/23375)) +- [improve] Validate range of argument before long -> int conversion ([#22830](https://github.com/apache/pulsar/pull/22830)) +- [cleanup] Cleanup some duplicated code ([#23204](https://github.com/apache/pulsar/pull/23204)) + +### Tests, Build & CI + +- [fix][test] Address flaky GetPartitionMetadataMultiBrokerTest ([#23456](https://github.com/apache/pulsar/pull/23456)) +- [fix][test] Fix ReplicatorRateLimiterTest ([#23369](https://github.com/apache/pulsar/pull/23369)) +- [fix][test] Fix TableViewBuilderImplTest NPE and infinite loop ([#22924](https://github.com/apache/pulsar/pull/22924)) +- [fix][test] Fix flaky AuthorizationTest.testGetListWithGetBundleOp ([#22713](https://github.com/apache/pulsar/pull/22713)) +- [fix][test] Fix flaky GetPartitionMetadataMultiBrokerTest.testCompatibilityDifferentBrokersForNonPersistentTopic ([#23259](https://github.com/apache/pulsar/pull/23259)) +- [fix][test] Fix flaky SubscriptionSeekTest.testSeekIsByReceive ([#23170](https://github.com/apache/pulsar/pull/23170)) +- [fix][test] Fix flaky UnloadSubscriptionTest.testMultiConsumer ([#23243](https://github.com/apache/pulsar/pull/23243)) +- [fix][test] Fix flaky test LeaderElectionTest.revalidateLeaderWithinSameSession ([#22383](https://github.com/apache/pulsar/pull/22383)) +- [fix][test] Fix flaky test ManagedLedgerTest.testDeleteCurrentLedgerWhenItIsClosed ([#23437](https://github.com/apache/pulsar/pull/23437)) +- [fix][test] Fix flaky test testShadowWrites ([#22745](https://github.com/apache/pulsar/pull/22745)) +- [fix][test] Fixed many tests of pulsar-proxy are not running ([#23118](https://github.com/apache/pulsar/pull/23118)) +- [fix][test] Revert the modification to NonDurableSubscriptionTest caused by a mistake in the PR#23129 ([#23168](https://github.com/apache/pulsar/pull/23168)) +- [fix][test] Update OpenTelemetry receiver endpoint in integration test ([#22998](https://github.com/apache/pulsar/pull/22998)) +- [fix][test] fix testGetMetrics in ExtensibleLoadManagerImplTest. ([#22864](https://github.com/apache/pulsar/pull/22864)) +- [fix][test] Fix flaky test increase the delay time ([#23046](https://github.com/apache/pulsar/pull/23046)) +- [cleanup][test] delete invalid method in PrometheusMetricsTest ([#23218](https://github.com/apache/pulsar/pull/23218)) +- [fix] Fix compile failing ([#23070](https://github.com/apache/pulsar/pull/23070)) +- [fix] JWT CLI util should force the token validation ([#22831](https://github.com/apache/pulsar/pull/22831)) +- [fix][build] Add basic support for vscode-java and Eclipse IDE ([#23448](https://github.com/apache/pulsar/pull/23448)) +- [fix][build] Add curl command for pulsar image ([#22732](https://github.com/apache/pulsar/pull/22732)) +- [fix][build] Add re2/j dependency to pulsar-common and client shading ([#22884](https://github.com/apache/pulsar/pull/22884)) +- [fix][build] Disable flaky test BrokerRegistryIntegrationTest ([#23367](https://github.com/apache/pulsar/pull/23367)) +- [fix][build] Fix CVE-2024-2511 by upgrading to OpenSSL in docker image ([#22731](https://github.com/apache/pulsar/pull/22731)) +- [fix][build] Fix problem where git.commit.id.abbrev is missing in image tagging ([#23337](https://github.com/apache/pulsar/pull/23337)) +- [fix][build] Fix pulsar-client-python installation on ARM arch ([#22733](https://github.com/apache/pulsar/pull/22733)) +- [fix][build] Fixed creation of `packages-storage` directory in docker image ([#22730](https://github.com/apache/pulsar/pull/22730)) +- [fix][build] Remove duplicate dependencies in pom.xml ([#23440](https://github.com/apache/pulsar/pull/23440)) +- [fix][build] Remove unnecessary Oracle maven repository from pom.xml ([#23132](https://github.com/apache/pulsar/pull/23132)) +- [fix][ci] Fix OWASP Dependency Check download by using NVD API key ([#22999](https://github.com/apache/pulsar/pull/22999)) +- [fix][ci] Fix jacoco code coverage report aggregation ([#22964](https://github.com/apache/pulsar/pull/22964)) +- [fix][ci] Fix snappy-java native lib fails to load in x86 alpine ([#22804](https://github.com/apache/pulsar/pull/22804)) +- [fix][ci] Pin aquasecurity/trivy-action@0.26.0 since master is broken ([#23431](https://github.com/apache/pulsar/pull/23431)) +- [fix][ci] Replace removed macos-11 with macos-latest in GitHub Actions ([#22965](https://github.com/apache/pulsar/pull/22965)) +- [improve][build] Drop deprecated pulsar-client-1x and pulsar-client-2x-shaded modules ([#23450](https://github.com/apache/pulsar/pull/23450)) +- [improve][build] Improve docker-push ([#22702](https://github.com/apache/pulsar/pull/22702)) +- [improve][build] Move docker-push profile to submodule ([#23093](https://github.com/apache/pulsar/pull/23093)) +- [improve][build] Remove invalid relativePath definitions in pom.xml files ([#22741](https://github.com/apache/pulsar/pull/22741)) +- [improve][build] Require Java 17 or Java 21 for building Pulsar ([#22875](https://github.com/apache/pulsar/pull/22875)) +- [improve][build] Support custom image and label names ([#22703](https://github.com/apache/pulsar/pull/22703)) +- [improve][build] Support git worktree working directory while building docker images ([#22851](https://github.com/apache/pulsar/pull/22851)) +- [improve][build] Update maven-wrapper (mvnw) to recent stable version 3.3.2 ([#23410](https://github.com/apache/pulsar/pull/23410)) +- [improve][build] Upgrade dependency-check-maven-plugin to 10.0.2 ([#23012](https://github.com/apache/pulsar/pull/23012)) +- [improve][build] Upgrade docker-maven-plugin to 0.45.0 ([#23091](https://github.com/apache/pulsar/pull/23091)) +- [improve][build] Use amazoncorretto:21-alpine image instead of apk installation ([#22973](https://github.com/apache/pulsar/pull/22973)) +- [improve][misc] Replace rename-netty-native-libs.sh script with renaming with maven-shade-plugin ([#22957](https://github.com/apache/pulsar/pull/22957)) +- [improve][ci] Add arm64 image build ([#22755](https://github.com/apache/pulsar/pull/22755)) +- [improve][ci] Continue Pulsar CI build even when Trivy scanner fails ([#23397](https://github.com/apache/pulsar/pull/23397)) +- [improve][ci] Migrate from Gradle Enterprise to Develocity ([#22880](https://github.com/apache/pulsar/pull/22880)) +- [improve][ci] Move some flaky ExtensibleLoadManager tests to flaky group until they are fixed ([#23414](https://github.com/apache/pulsar/pull/23414)) +- [improve][ci] Switch to Java 21 as default JVM version for CI ([#23373](https://github.com/apache/pulsar/pull/23373)) +- [improve][ci] Switch to use DEVELOCITY_ACCESS_KEY from GRADLE_ENTERPRISE_ACCESS_KEY ([#23090](https://github.com/apache/pulsar/pull/23090)) +- [improve][ci] Upgrade/Downgrade test ([#22988](https://github.com/apache/pulsar/pull/22988)) +- [improve][test] Add a test to guarantee the TNX topics will not be replicated ([#22721](https://github.com/apache/pulsar/pull/22721)) +- [improve][test] Restart broker in SimpleProducerConsumerTest if ns deletion times out ([#22734](https://github.com/apache/pulsar/pull/22734)) + From 0a5e71b3fe9ff60d45a0b1b8673854a76922c066 Mon Sep 17 00:00:00 2001 From: Lari Hotari Date: Mon, 14 Oct 2024 23:01:28 +0300 Subject: [PATCH 8/9] Improve formatting of PIPs --- release-notes/versioned/pulsar-4.0.0.md | 62 ++++++++++++------------- 1 file changed, 31 insertions(+), 31 deletions(-) diff --git a/release-notes/versioned/pulsar-4.0.0.md b/release-notes/versioned/pulsar-4.0.0.md index d1739dae51d7..2b699abf84e2 100644 --- a/release-notes/versioned/pulsar-4.0.0.md +++ b/release-notes/versioned/pulsar-4.0.0.md @@ -9,38 +9,37 @@ sidebar_label: Apache Pulsar 4.0.0 Changes in 4.0.0 release since 3.3.0 release preparation was started. For the complete list, check the [full changelog](https://github.com/apache/pulsar/compare/188355b...v4.0.0) and [full PR list](https://github.com/apache/pulsar/pulls?q=is%3Apr+is%3Amerged+milestone%3A4.0.0+sort%3Acreated-asc). -### PIPs +### PIPs since 3.3.0 release -- [improve][pip] Improve PIP process and voting timeline ([#23387](https://github.com/apache/pulsar/pull/23387)) -- [improve][pip] PIP-327: Support force topic loading for unrecoverable errors ([#21752](https://github.com/apache/pulsar/pull/21752)) -- [improve][pip] PIP-337: SSL Factory Plugin to customize SSL Context and SSL Engine generation ([#22016](https://github.com/apache/pulsar/pull/22016)) -- [improve][pip] PIP-347: add role field in consumer's stat ([#22564](https://github.com/apache/pulsar/pull/22564)) -- [improve][pip] PIP-348: Trigger offload on topic load stage ([#22650](https://github.com/apache/pulsar/pull/22650)) -- [improve][pip] PIP-349: Add additionalSystemCursorNames ignore list for TTL check ([#22651](https://github.com/apache/pulsar/pull/22651)) -- [improve][pip] PIP-350: Allow to disable the managedLedgerOffloadDeletionLagInMillis ([#22688](https://github.com/apache/pulsar/pull/22688)) -- [improve][pip] PIP-351: Additional options for Pulsar-Test client to support KeyStore based TLS ([#22694](https://github.com/apache/pulsar/pull/22694)) -- [improve][pip] PIP-352: Event time based topic compactor ([#22710](https://github.com/apache/pulsar/pull/22710)) -- [improve][PIP] PIP-353: Improve transaction message visibility for peek-messages ([#22746](https://github.com/apache/pulsar/pull/22746)) -- [improve][pip] PIP-354: apply topK mechanism to ModularLoadManagerImpl ([#22765](https://github.com/apache/pulsar/pull/22765)) -- [improve][pip] PIP-355: Enhancing Broker-Level Metrics for Pulsar ([#22778](https://github.com/apache/pulsar/pull/22778)) -- [improve][pip] PIP-356: Support Geo-Replication starts at earliest position ([#22806](https://github.com/apache/pulsar/pull/22806)) -- [improve][pip] PIP-357: Correct the conf name in load balance module. ([#22823](https://github.com/apache/pulsar/pull/22823)) -- [improve][pip] PIP-358: let resource weight work for OverloadShedder, LeastLongTermMessageRate, ModularLoadManagerImpl. ([#22889](https://github.com/apache/pulsar/pull/22889)) -- [improve][pip] PIP-359: Support custom message listener executor for specific subscription ([#22902](https://github.com/apache/pulsar/pull/22902)) -- [improve][pip] PIP-360 Add admin API to display Schema metadata ([#22913](https://github.com/apache/pulsar/pull/22913)) -- [improve][pip] PIP-363: Add callback parameters to the method: org.apache.pulsar.client.impl.SendCallback.sendComplete. ([#22940](https://github.com/apache/pulsar/pull/22940)) -- [improve][pip] PIP-364: Introduce a new load balance algorithm AvgShedder ([#22946](https://github.com/apache/pulsar/pull/22946)) -- [improve][pip] PIP-366: Support to specify different config for Configuration and Local Metadata Store ([#23033](https://github.com/apache/pulsar/pull/23033)) -- [improve][pip] PIP-367: Propose a Contributor Repository for Pulsar ([#23061](https://github.com/apache/pulsar/pull/23061)) -- [improve][pip] PIP-368: Support lookup based on the lookup properties ([#23075](https://github.com/apache/pulsar/pull/23075)) -- [improve][pip] PIP-369: Flag based selective unload on changing ns-isolation-policy ([#23116](https://github.com/apache/pulsar/pull/23116)) -- [improve][pip] PIP-370: configurable remote topic creation in geo-replication ([#23124](https://github.com/apache/pulsar/pull/23124)) -- [improve][pip] PIP-374: Visibility of messages in receiverQueue for the consumers ([#23235](https://github.com/apache/pulsar/pull/23235)) -- [improve][pip] PIP-376: Make topic policies service pluggable ([#23248](https://github.com/apache/pulsar/pull/23248)) -- [improve][pip] PIP-378 Add ServiceUnitStateTableView abstraction (ExtensibleLoadMangerImpl only) ([#23300](https://github.com/apache/pulsar/pull/23300)) -- [improve][pip] PIP-379: Key_Shared Draining Hashes for Improved Message Ordering ([#23309](https://github.com/apache/pulsar/pull/23309)) -- [improve][pip] PIP-381: Handle large PositionInfo state ([#23328](https://github.com/apache/pulsar/pull/23328)) -- [improve][PIP] PIP-383: Support granting/revoking permissions for multiple topics ([#23355](https://github.com/apache/pulsar/pull/23355)) +- [PIP-327](https://github.com/apache/pulsar/blob/master/pip/pip-327.md): Support force topic loading for unrecoverable errors ([#21752](https://github.com/apache/pulsar/pull/21752)) +- [PIP-337](https://github.com/apache/pulsar/blob/master/pip/pip-337.md): SSL Factory Plugin to customize SSL Context and SSL Engine generation ([#22016](https://github.com/apache/pulsar/pull/22016)) +- [PIP-347](https://github.com/apache/pulsar/blob/master/pip/pip-347.md): add role field in consumer's stat ([#22564](https://github.com/apache/pulsar/pull/22564)) +- [PIP-348](https://github.com/apache/pulsar/blob/master/pip/pip-348.md): Trigger offload on topic load stage ([#22650](https://github.com/apache/pulsar/pull/22650)) +- [PIP-349](https://github.com/apache/pulsar/blob/master/pip/pip-349.md): Add additionalSystemCursorNames ignore list for TTL check ([#22651](https://github.com/apache/pulsar/pull/22651)) +- [PIP-350](https://github.com/apache/pulsar/blob/master/pip/pip-350.md): Allow to disable the managedLedgerOffloadDeletionLagInMillis ([#22688](https://github.com/apache/pulsar/pull/22688)) +- [PIP-351](https://github.com/apache/pulsar/blob/master/pip/pip-351.md): Additional options for Pulsar-Test client to support KeyStore based TLS ([#22694](https://github.com/apache/pulsar/pull/22694)) +- [PIP-352](https://github.com/apache/pulsar/blob/master/pip/pip-352.md): Event time based topic compactor ([#22710](https://github.com/apache/pulsar/pull/22710)) +- [PIP-353](https://github.com/apache/pulsar/blob/master/pip/pip-353.md): Improve transaction message visibility for peek-messages ([#22746](https://github.com/apache/pulsar/pull/22746)) +- [PIP-354](https://github.com/apache/pulsar/blob/master/pip/pip-354.md): apply topK mechanism to ModularLoadManagerImpl ([#22765](https://github.com/apache/pulsar/pull/22765)) +- [PIP-355](https://github.com/apache/pulsar/blob/master/pip/pip-355.md): Enhancing Broker-Level Metrics for Pulsar ([#22778](https://github.com/apache/pulsar/pull/22778)) +- [PIP-356](https://github.com/apache/pulsar/blob/master/pip/pip-356.md): Support Geo-Replication starts at earliest position ([#22806](https://github.com/apache/pulsar/pull/22806)) +- [PIP-357](https://github.com/apache/pulsar/blob/master/pip/pip-357.md): Correct the conf name in load balance module. ([#22823](https://github.com/apache/pulsar/pull/22823)) +- [PIP-358](https://github.com/apache/pulsar/blob/master/pip/pip-358.md): let resource weight work for OverloadShedder, LeastLongTermMessageRate, ModularLoadManagerImpl. ([#22889](https://github.com/apache/pulsar/pull/22889)) +- [PIP-359](https://github.com/apache/pulsar/blob/master/pip/pip-359.md): Support custom message listener executor for specific subscription ([#22902](https://github.com/apache/pulsar/pull/22902)) +- [PIP-360](https://github.com/apache/pulsar/blob/master/pip/pip-360.md): Add admin API to display Schema metadata ([#22913](https://github.com/apache/pulsar/pull/22913)) +- [PIP-363](https://github.com/apache/pulsar/blob/master/pip/pip-363.md): Add callback parameters to the method: org.apache.pulsar.client.impl.SendCallback.sendComplete. ([#22940](https://github.com/apache/pulsar/pull/22940)) +- [PIP-364](https://github.com/apache/pulsar/blob/master/pip/pip-364.md): Introduce a new load balance algorithm AvgShedder ([#22946](https://github.com/apache/pulsar/pull/22946)) +- [PIP-366](https://github.com/apache/pulsar/blob/master/pip/pip-366.md): Support to specify different config for Configuration and Local Metadata Store ([#23033](https://github.com/apache/pulsar/pull/23033)) +- [PIP-367](https://github.com/apache/pulsar/blob/master/pip/pip-367.md): Propose a Contributor Repository for Pulsar ([#23061](https://github.com/apache/pulsar/pull/23061)) +- [PIP-368](https://github.com/apache/pulsar/blob/master/pip/pip-368.md): Support lookup based on the lookup properties ([#23075](https://github.com/apache/pulsar/pull/23075)) +- [PIP-369](https://github.com/apache/pulsar/blob/master/pip/pip-369.md): Flag based selective unload on changing ns-isolation-policy ([#23116](https://github.com/apache/pulsar/pull/23116)) +- [PIP-370](https://github.com/apache/pulsar/blob/master/pip/pip-370.md): configurable remote topic creation in geo-replication ([#23124](https://github.com/apache/pulsar/pull/23124)) +- [PIP-374](https://github.com/apache/pulsar/blob/master/pip/pip-374.md): Visibility of messages in receiverQueue for the consumers ([#23235](https://github.com/apache/pulsar/pull/23235)) +- [PIP-376](https://github.com/apache/pulsar/blob/master/pip/pip-376-Topic-Policies-Service-Pluggable.md): Make topic policies service pluggable ([#23248](https://github.com/apache/pulsar/pull/23248)) +- [PIP-378](https://github.com/apache/pulsar/blob/master/pip/pip-378.md): Add ServiceUnitStateTableView abstraction (ExtensibleLoadMangerImpl only) ([#23300](https://github.com/apache/pulsar/pull/23300)) +- [PIP-379](https://github.com/apache/pulsar/blob/master/pip/pip-379.md): Key_Shared Draining Hashes for Improved Message Ordering ([#23309](https://github.com/apache/pulsar/pull/23309)) +- [PIP-381](https://github.com/apache/pulsar/blob/master/pip/pip-381-large-positioninfo.md): Handle large PositionInfo state ([#23328](https://github.com/apache/pulsar/pull/23328)) +- [PIP-383](https://github.com/apache/pulsar/blob/master/pip/pip-383.md): Support granting/revoking permissions for multiple topics ([#23355](https://github.com/apache/pulsar/pull/23355)) ### Library updates and dependency changes @@ -404,6 +403,7 @@ For the complete list, check the [full changelog](https://github.com/apache/puls - [improve] Configure Rocksdb to use musl libc flavor of the native library ([#23375](https://github.com/apache/pulsar/pull/23375)) - [improve] Validate range of argument before long -> int conversion ([#22830](https://github.com/apache/pulsar/pull/22830)) - [cleanup] Cleanup some duplicated code ([#23204](https://github.com/apache/pulsar/pull/23204)) +- [improve][pip] Improve PIP process and voting timeline ([#23387](https://github.com/apache/pulsar/pull/23387)) ### Tests, Build & CI From b0e3c14fd5cc33bcc6b0adf907bd17c1abd6d920 Mon Sep 17 00:00:00 2001 From: Lari Hotari Date: Mon, 14 Oct 2024 23:31:59 +0300 Subject: [PATCH 9/9] Polish PIP reporting --- release-notes/versioned/pulsar-4.0.0.md | 52 ++++++++++++++++++++++++- 1 file changed, 50 insertions(+), 2 deletions(-) diff --git a/release-notes/versioned/pulsar-4.0.0.md b/release-notes/versioned/pulsar-4.0.0.md index 2b699abf84e2..c08bdb429bc7 100644 --- a/release-notes/versioned/pulsar-4.0.0.md +++ b/release-notes/versioned/pulsar-4.0.0.md @@ -9,7 +9,9 @@ sidebar_label: Apache Pulsar 4.0.0 Changes in 4.0.0 release since 3.3.0 release preparation was started. For the complete list, check the [full changelog](https://github.com/apache/pulsar/compare/188355b...v4.0.0) and [full PR list](https://github.com/apache/pulsar/pulls?q=is%3Apr+is%3Amerged+milestone%3A4.0.0+sort%3Acreated-asc). -### PIPs since 3.3.0 release +### PIPs accepted since 3.0.0 release + +#### PIPs accepted in 4.0.0 release - [PIP-327](https://github.com/apache/pulsar/blob/master/pip/pip-327.md): Support force topic loading for unrecoverable errors ([#21752](https://github.com/apache/pulsar/pull/21752)) - [PIP-337](https://github.com/apache/pulsar/blob/master/pip/pip-337.md): SSL Factory Plugin to customize SSL Context and SSL Engine generation ([#22016](https://github.com/apache/pulsar/pull/22016)) @@ -40,6 +42,53 @@ For the complete list, check the [full changelog](https://github.com/apache/puls - [PIP-379](https://github.com/apache/pulsar/blob/master/pip/pip-379.md): Key_Shared Draining Hashes for Improved Message Ordering ([#23309](https://github.com/apache/pulsar/pull/23309)) - [PIP-381](https://github.com/apache/pulsar/blob/master/pip/pip-381-large-positioninfo.md): Handle large PositionInfo state ([#23328](https://github.com/apache/pulsar/pull/23328)) - [PIP-383](https://github.com/apache/pulsar/blob/master/pip/pip-383.md): Support granting/revoking permissions for multiple topics ([#23355](https://github.com/apache/pulsar/pull/23355)) +- [PIP-384](https://github.com/apache/pulsar/blob/master/pip/pip-384.md): ManagedLedger interface decoupling ([#23363](https://github.com/apache/pulsar/pull/23363)) + +#### PIPs accepted in 3.3.0 release + +- [PIP-315](https://github.com/apache/pulsar/blob/master/pip/pip-315.md): Configurable max delay limit for delayed delivery ([\#21798](https://github.com/apache/pulsar/pull/21798)) +- [PIP-321](https://github.com/apache/pulsar/blob/master/pip/pip-321.md): Introduce allowed-cluster at the namespace level ([\#21648](https://github.com/apache/pulsar/pull/21648)) +- [PIP-324](https://github.com/apache/pulsar/blob/master/pip/pip-324-Alpine%20Docker%20images.md): Alpine Docker images ([\#21716](https://github.com/apache/pulsar/pull/21716)) +- [PIP-325](https://github.com/apache/pulsar/blob/master/pip/pip-325.md): Add command to abort transaction ([\#21731](https://github.com/apache/pulsar/pull/21731)) +- [PIP-326](https://github.com/apache/pulsar/blob/master/pip/pip-326.md): Create a BOM to ease dependency management ([\#21747](https://github.com/apache/pulsar/pull/21747)) +- [PIP-329](https://github.com/apache/pulsar/blob/master/pip/pip-329.md): Strategy for maintaining the latest tag to Pulsar docker images ([\#21872](https://github.com/apache/pulsar/pull/21872)) +- [PIP-330](https://github.com/apache/pulsar/blob/master/pip/pip-330.md): getMessagesById gets all messages ([\#21873](https://github.com/apache/pulsar/pull/21873)) +- [PIP-342](https://github.com/apache/pulsar/blob/master/pip/pip-342%20OTel%20client%20metrics%20support.md): Support OpenTelemetry metrics in Pulsar client ([\#22178](https://github.com/apache/pulsar/pull/22178)) +- [PIP-343](https://github.com/apache/pulsar/blob/master/pip/pip-343.md): Use picocli instead of jcommander ([\#22181](https://github.com/apache/pulsar/pull/22181)) +- [PIP-344](https://github.com/apache/pulsar/blob/master/pip/pip-344.md): Correct the behavior of the public API pulsarClient.getPartitionsForTopic(topicName) ([\#22182](https://github.com/apache/pulsar/pull/22182)) +- [PIP-335](https://github.com/apache/pulsar/blob/master/pip/pip-335%20Oxia%20metadata%20plugin.md): Oxia metadata plugin ([\#22009](https://github.com/apache/pulsar/pull/22009)) +- [PIP-339](https://github.com/apache/pulsar/blob/master/pip/pip-339.md): Introducing the \--log-topic Option for Pulsar Sinks and Sources ([\#22071](https://github.com/apache/pulsar/pull/22071)) +- [PIP-282](https://github.com/apache/pulsar/blob/master/pip/pip-282.md): Change definition of the recently joined consumers position ([\#20776](https://github.com/apache/pulsar/pull/20776)) + +#### PIPs accepted in 3.2.0 release + +- [PIP-323](https://github.com/apache/pulsar/blob/master/pip/pip-323.md): Complete Backlog Quota Telemetry ([\#21709](https://github.com/apache/pulsar/pull/21709)) +- [PIP-322](https://github.com/apache/pulsar/blob/master/pip/pip-322.md): Pulsar Rate Limiting Refactoring ([\#21680](https://github.com/apache/pulsar/pull/21680)) +- [PIP-320](https://github.com/apache/pulsar/blob/master/pip/pip-320.md): OpenTelemetry Scaffolding ([\#21635](https://github.com/apache/pulsar/pull/21635)) +- [PIP-318](https://github.com/apache/pulsar/blob/master/pip/pip-318.md): Don't retain null-key messages during topic compaction ([\#21541](https://github.com/apache/pulsar/pull/21541)) +- [PIP-315](https://github.com/apache/pulsar/blob/master/pip/pip-315.md): Configurable max delay limit for delayed delivery ([\#21490](https://github.com/apache/pulsar/pull/21490)) +- [PIP-313](https://github.com/apache/pulsar/blob/master/pip/pip-313.md): Support force unsubscribe using consumer api ([\#21452](https://github.com/apache/pulsar/pull/21452)) +- [PIP-312](https://github.com/apache/pulsar/blob/master/pip/pip-312.md): Use StateStoreProvider to manage state in Pulsar Functions endpoints ([\#21438](https://github.com/apache/pulsar/pull/21438)) +- [PIP-307](https://github.com/apache/pulsar/blob/master/pip/pip-307.md): Optimize Bundle Unload(Transfer) Protocol for ExtensibleLoadManager ([\#20748](https://github.com/apache/pulsar/pull/20748)) +- [PIP-307-dup](https://github.com/apache/pulsar/blob/master/pip/pip_307.md): Support subscribing multi topics for WebSocket ([\#21390](https://github.com/apache/pulsar/pull/21390)) +- [PIP-305](https://github.com/apache/pulsar/blob/master/pip/pip-305.md): Customize DNS servers to use for Pulsar Client ([\#21352](https://github.com/apache/pulsar/pull/21352)) +- [PIP-303](https://github.com/apache/pulsar/blob/master/pip/pip-303.md): Add optional parameters for getPartitionedStats ([\#21228](https://github.com/apache/pulsar/pull/21228)) +- [PIP-302](https://github.com/apache/pulsar/blob/master/pip/pip-302.md): Introduce refreshAsync API for TableView ([\#21271](https://github.com/apache/pulsar/pull/21271)) +- [PIP-301](https://github.com/apache/pulsar/blob/master/pip/pip-301.md): Introduce LoadBalanceResources to unify the load-date CRUD ([\#21129](https://github.com/apache/pulsar/pull/21129)) +- [PIP-300](https://github.com/apache/pulsar/blob/master/pip/pip-300.md): Add custom dynamic configuration for plugins ([\#21127](https://github.com/apache/pulsar/pull/21127)) +- [PIP-299](https://github.com/apache/pulsar/blob/master/pip/pip-299.md): Stop dispatch messages if the individual acks will be lost in the persistent storage ([\#21118](https://github.com/apache/pulsar/pull/21118)) +- [PIP-297](https://github.com/apache/pulsar/blob/master/pip/pip-297.md): Support terminating Function & Connector with the fatal exception ([\#21079](https://github.com/apache/pulsar/pull/21079)) +- [PIP-293](https://github.com/apache/pulsar/blob/master/pip/pip-293.md): Delete config disableBrokerInterceptors ([\#20993](https://github.com/apache/pulsar/pull/20993)) +- [PIP-290](https://github.com/apache/pulsar/blob/master/pip/pip-290.md): Provide a way to implement WSS E2E encryption and not need to expose the private key to the WebSocket Proxy ([\#20923](https://github.com/apache/pulsar/pull/20923)) +- [PIP-286](https://github.com/apache/pulsar/blob/master/pip/pip-286.md): Make the TopicCompactionService to support find entry based on publishTime or index ([\#20867](https://github.com/apache/pulsar/pull/20867)) +- [PIP-277](https://github.com/apache/pulsar/blob/master/pip/pip-277.md): Add current option in the Clusters list cmd ([\#20614](https://github.com/apache/pulsar/pull/20614)) +- [PIP-264](https://github.com/apache/pulsar/blob/master/pip/pip-264.md): Enhanced OTel-based metric system [\#21080](https://github.com/apache/pulsar/pull/21080) + +#### PIPs accepted in 3.1.0 release + +- [PIP-275](https://github.com/apache/pulsar/blob/master/pip/pip-275.md): Introduce topicOrderedExecutorThreadNum to deprecate numWorkerThreadsForNonPersistentTopic ([\#20504](https://github.com/apache/pulsar/pull/20504)) +- [PIP-255](https://github.com/apache/pulsar/issues/19806): Make the partition assignment strategy pluggable ([\#19806](https://github.com/apache/pulsar/issues/19806)) +- [PIP-278](https://github.com/apache/pulsar/blob/master/pip/pip-278.md): Support pluggable topic compaction service ([\#20624](https://github.com/apache/pulsar/pull/20624)) ### Library updates and dependency changes @@ -97,7 +146,6 @@ For the complete list, check the [full changelog](https://github.com/apache/puls - [feat][misc] PIP-264: Add OpenTelemetry authentication and token metrics ([#23016](https://github.com/apache/pulsar/pull/23016)) - [feat][misc] PIP-264: Add OpenTelemetry messaging rate limit metrics ([#23035](https://github.com/apache/pulsar/pull/23035)) - [feat][misc] PIP-264: Copy OpenTelemetry resource attributes to Prometheus labels ([#23005](https://github.com/apache/pulsar/pull/23005)) -- [improve] PIP-384: ManagedLedger interface decoupling ([#23363](https://github.com/apache/pulsar/pull/23363)) - [improve][broker] PIP-327: Support force topic loading for unrecoverable errors ([#21759](https://github.com/apache/pulsar/pull/21759)) - [improve][broker] PIP-347: Add role field in consumer's stat ([#22562](https://github.com/apache/pulsar/pull/22562)) - [improve][broker] PIP-355: Enhancing Broker-Level Metrics for Pulsar ([#22779](https://github.com/apache/pulsar/pull/22779))